Refactor ParsedMetadata as generic

[daweifeng-replit]

Why

This PR makes the ParsedMetadata type a generic parameter rather than a global interface that requires declaration merging. This allows for having multiple ParsedMetadata for different projects in a monorepo

What changed

• Changed ParsedMetadata from a global interface to a generic parameter in relevant types
• Updated ProcedureHandlerContext to accept a generic ParsedMetadata parameter
• Modified ServerHandshakeOptions to accept a generic ParsedMetadata parameter
• Updated ServerTransport to accept generic parameters for metadata schema and parsed metadata
• Update type parameters to procedure types (rpc, upload, subscription, stream)
• Updated tests to use the new generic parameters

Example:

      const requestSchema = Type.Object({
        data: Type.String(),
      });

      interface ParsedMetadata {
        data: string;
        extra: number;
      }

      const clientTransport = getClientTransport(
        'client',
        createClientHandshakeOptions(requestSchema, () => ({ data: 'foobar' })),
      );
      const serverTransport = getServerTransport(
        'SERVER',
        createServerHandshakeOptions(requestSchema, (metadata) => {
          return {
            data: metadata.data,
            extra: 42,
          };
        }),
      );

      const services = {
        test: createServiceSchema<object, ParsedMetadata>().define({
          getData: Procedure.rpc({
            requestInit: Type.Object({}),
            responseData: Type.Object({
              data: Type.String(),
              extra: Type.Number(),
            }),
            handler: async ({ ctx }) => {
              return Ok({ ...ctx.metadata });
            },
          }),
        }),
      };
      const server = createServer(serverTransport, services);
      const client = createClient<typeof services>(
        clientTransport,
        serverTransport.clientId,
      );

Versioning

• Breaking protocol change
• Breaking ts/js API change

[daweifeng-replit]

• Refactor ParsedMetadata as generic #324 👈 (View in Graphite)
• Refactor ServiceContext as generic #322
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[jackyzha0]

weird that we do unknown in some places but object in others as the default value for this

[daweifeng-replit]

That's right. It should be object here.

[masad-frost]

unknown where possible makes sense, object is basically any

[jackyzha0]

why do we need an additional assertion here when we didnt before? same question for L330

[daweifeng-replit]

because ParsedMetadata extends object now. It extends Record<string, unknown> before

[jackyzha0]

still weird, feels like we should be using <Connection, TSchema, object> here which should work?

[daweifeng-replit]

No, it doesn't work. The ServerTransport class has a method extendHandshake that takes ServerHandshakeOptions<MetadataSchema, ParsedMetadata>. These options include a validate function that expects the previous metadata to match the ParsedMetadata type. When we use any for ParsedMetadata, TypeScript allows any type to be passed. But when we try to use a specific type like { kept: string }, TypeScript enforces that the previous metadata must match that exact type 😢

[jackyzha0]

same comment as above

[jackyzha0]

lgtm to unblock but i'd like to do a future pass at somepoint to see if we can figure out if we can thread less generics through everything :')

[daweifeng-replit]

Merge activity

• Jun 16, 6:51 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• Jun 16, 6:53 PM UTC: Graphite rebased this pull request as part of a merge.
• Jun 16, 6:55 PM UTC: @daweifeng-replit merged this pull request with Graphite.