feat(graphql): migrate to type-graphql 2.0.0-rc.2

lchudinov · lchudinov · commit 226823c2b80f · 2026-01-31T09:18:07.000+05:00
Signed-off-by: Leonty Chudinov &lt;leonty.chudinov@gmail.com&gt;
diff --git a/examples/graphql/package.json b/examples/graphql/package.json
@@ -49,6 +49,7 @@
     "!*/__tests__"
   ],
   "dependencies": {
+    "@graphql-yoga/subscription": "^5.0.5",
     "@loopback/boot": "^8.0.9",
     "@loopback/core": "^7.0.8",
     "@loopback/graphql": "^0.12.9",
diff --git a/examples/graphql/src/__tests__/acceptance/graphql-context.acceptance.ts b/examples/graphql/src/__tests__/acceptance/graphql-context.acceptance.ts
@@ -3,6 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {createPubSub} from '@graphql-yoga/subscription';
 import {createBindingFromClass} from '@loopback/core';
 import {GraphQLBindings, GraphQLServer} from '@loopback/graphql';
 import {expect, supertest} from '@loopback/testlab';
@@ -45,6 +46,7 @@ describe('GraphQL context', () => {
     });
 
     server.bind('recipes').to([...sampleRecipes]);
+    server.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
     const repoBinding = createBindingFromClass(RecipeRepository);
     server.add(repoBinding);
     server.add(createBindingFromClass(RecipesDataSource));
diff --git a/examples/graphql/src/__tests__/acceptance/graphql-middleware-options.acceptance.ts b/examples/graphql/src/__tests__/acceptance/graphql-middleware-options.acceptance.ts
@@ -3,8 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {createPubSub} from '@graphql-yoga/subscription';
 import {createBindingFromClass} from '@loopback/core';
-import {GraphQLServer} from '@loopback/graphql';
+import {GraphQLBindings, GraphQLServer} from '@loopback/graphql';
 import {supertest} from '@loopback/testlab';
 import {RecipesDataSource} from '../../datasources';
 import {RecipeResolver} from '../../graphql-resolvers/recipe-resolver';
@@ -38,6 +39,7 @@ describe('GraphQL middleware', () => {
     });
     server.resolver(RecipeResolver);
     server.bind('recipes').to([...sampleRecipes]);
+    server.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
     const repoBinding = createBindingFromClass(RecipeRepository);
     server.add(repoBinding);
     server.add(createBindingFromClass(RecipesDataSource));
diff --git a/examples/graphql/src/__tests__/acceptance/graphql-middleware.acceptance.ts b/examples/graphql/src/__tests__/acceptance/graphql-middleware.acceptance.ts
@@ -3,6 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {createPubSub} from '@graphql-yoga/subscription';
 import {createBindingFromClass} from '@loopback/core';
 import {GraphQLBindings, GraphQLServer} from '@loopback/graphql';
 import {expect, supertest} from '@loopback/testlab';
@@ -76,6 +77,7 @@ describe('GraphQL middleware', () => {
     server = new GraphQLServer({host: '127.0.0.1', port: 0});
     server.resolver(RecipeResolver);
     server.bind('recipes').to([...sampleRecipes]);
+    server.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
     const repoBinding = createBindingFromClass(RecipeRepository);
     server.add(repoBinding);
     server.add(createBindingFromClass(RecipesDataSource));
diff --git a/examples/graphql/src/__tests__/acceptance/graphql-subscription.acceptance.ts b/examples/graphql/src/__tests__/acceptance/graphql-subscription.acceptance.ts
@@ -3,8 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {createPubSub} from '@graphql-yoga/subscription';
 import {Application, createBindingFromClass} from '@loopback/core';
-import {GraphQLServer} from '@loopback/graphql';
+import {GraphQLBindings, GraphQLServer} from '@loopback/graphql';
 import {
   createRestAppClient,
   expect,
@@ -51,6 +52,7 @@ describe('GraphQL server subscription', () => {
     server.bind('recipes').to([...sampleRecipes]);
     const repoBinding = createBindingFromClass(RecipeRepository);
     server.add(repoBinding);
+    server.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
     server.add(createBindingFromClass(RecipesDataSource));
     server.add(createBindingFromClass(RecipeService));
     await server.start();
@@ -99,6 +101,7 @@ describe('GraphQL application subscription', () => {
     app.bind('recipes').to([...sampleRecipes]);
     const repoBinding = createBindingFromClass(RecipeRepository);
     app.add(repoBinding);
+    server.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
     app.add(createBindingFromClass(RecipesDataSource));
     app.add(createBindingFromClass(RecipeService));
     await app.start();
diff --git a/examples/graphql/src/__tests__/acceptance/graphql.acceptance.ts b/examples/graphql/src/__tests__/acceptance/graphql.acceptance.ts
@@ -3,8 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {createPubSub} from '@graphql-yoga/subscription';
 import {Application, createBindingFromClass} from '@loopback/core';
-import {GraphQLServer} from '@loopback/graphql';
+import {GraphQLBindings, GraphQLServer} from '@loopback/graphql';
 import {
   createRestAppClient,
   givenHttpServerConfig,
@@ -35,6 +36,7 @@ describe('GraphQL server', () => {
     server.resolver(RecipeResolver);
 
     server.bind('recipes').to([...sampleRecipes]);
+    server.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
     const repoBinding = createBindingFromClass(RecipeRepository);
     server.add(repoBinding);
     server.add(createBindingFromClass(RecipesDataSource));
@@ -68,6 +70,7 @@ describe('GraphQL application', () => {
     server.resolver(RecipeResolver);
 
     app.bind('recipes').to([...sampleRecipes]);
+    server.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
     const repoBinding = createBindingFromClass(RecipeRepository);
     app.add(repoBinding);
     app.add(createBindingFromClass(RecipesDataSource));
diff --git a/examples/graphql/src/application.ts b/examples/graphql/src/application.ts
@@ -3,6 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {createPubSub} from '@graphql-yoga/subscription';
 import {BootMixin} from '@loopback/boot';
 import {ApplicationConfig} from '@loopback/core';
 import {GraphQLBindings, GraphQLComponent} from '@loopback/graphql';
@@ -30,6 +31,8 @@ export class GraphqlDemoApplication extends BootMixin(
 
     this.expressMiddleware('middleware.express.GraphQL', server.expressApp);
 
+    this.bind(GraphQLBindings.PUB_SUB).to(createPubSub());
+
     // It's possible to register a graphql context resolver
     this.bind(GraphQLBindings.GRAPHQL_CONTEXT_RESOLVER).to(async context => {
       return {...context};
diff --git a/examples/graphql/src/graphql-resolvers/recipe-resolver.ts b/examples/graphql/src/graphql-resolvers/recipe-resolver.ts
@@ -11,8 +11,7 @@ import {
   GraphQLBindings,
   Int,
   mutation,
-  Publisher,
-  pubSub,
+  PubSub,
   query,
   resolver,
   ResolverData,
@@ -33,6 +32,8 @@ export class RecipeResolver implements ResolverInterface<Recipe> {
     @repository('RecipeRepository')
     private readonly recipeRepo: RecipeRepository,
     @service(RecipeService) private readonly recipeService: RecipeService,
+    // inject pubSub for publishing a notification
+    @inject(GraphQLBindings.PUB_SUB) private pubSub: PubSub,
     // It's possible to inject the resolver data
     @inject(GraphQLBindings.RESOLVER_DATA) private resolverData: ResolverData,
   ) {}
@@ -49,12 +50,9 @@ export class RecipeResolver implements ResolverInterface<Recipe> {
   }
 
   @mutation(returns => Recipe)
-  async addRecipe(
-    @arg('recipe') recipe: RecipeInput,
-    @pubSub('recipeCreated') publish: Publisher<Recipe>,
-  ): Promise<Recipe> {
+  async addRecipe(@arg('recipe') recipe: RecipeInput): Promise<Recipe> {
     const result = await this.recipeRepo.add(recipe);
-    await publish(result);
+    this.pubSub.publish('recipeCreated', result);
     return result;
   }
 
diff --git a/extensions/graphql/package.json b/extensions/graphql/package.json
@@ -52,12 +52,12 @@
     "debug": "^4.4.3",
     "express": "^4.22.1",
     "graphql": "^16.12.0",
-    "graphql-subscriptions": "^2.0.0",
     "graphql-ws": "^5.16.2",
-    "type-graphql": "^2.0.0-beta.2",
+    "type-graphql": "^2.0.0-rc.2",
     "ws": "^8.19.0"
   },
   "devDependencies": {
+    "@graphql-yoga/subscription": "^5.0.5",
     "@loopback/boot": "^8.0.9",
     "@loopback/build": "^12.0.8",
     "@loopback/core": "^7.0.8",
diff --git a/extensions/graphql/src/__tests__/fixtures/graphql-resolvers/recipe/recipe.resolver.ts b/extensions/graphql/src/__tests__/fixtures/graphql-resolvers/recipe/recipe.resolver.ts
@@ -3,11 +3,12 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {inject} from '@loopback/core';
 import {
   arg,
   fieldResolver,
-  Publisher,
-  pubSub,
+  GraphQLBindings,
+  PubSub,
   query,
   resolver,
 } from '../../../../';
@@ -17,7 +18,7 @@ import {Recipe} from './recipe.model';
 
 @resolver(of => Recipe)
 export class RecipeResolver {
-  constructor() {}
+  constructor(@inject(GraphQLBindings.PUB_SUB) private pubSub: PubSub) {}
 
   @query(returns => [Recipe])
   async recipes(): Promise<Recipe[]> {
@@ -30,13 +31,10 @@ export class RecipeResolver {
   }
 
   @mutation(returns => Recipe)
-  async addRecipe(
-    @arg('recipe') recipe: RecipeInput,
-    @pubSub('recipeCreated') publish: Publisher<Recipe>,
-  ): Promise<Recipe> {
+  async addRecipe(@arg('recipe') recipe: RecipeInput): Promise<Recipe> {
     const result = new Recipe();
     result.title = recipe.title;
-    await publish(result);
+    this.pubSub.publish('recipeCreated', result);
     return result;
   }
 }
diff --git a/extensions/graphql/src/booters/resolver.booter.ts b/extensions/graphql/src/booters/resolver.booter.ts
@@ -18,7 +18,6 @@ import {
 } from '@loopback/core';
 import debugFactory from 'debug';
 import {getMetadataStorage} from 'type-graphql';
-import {ResolverClassMetadata} from 'type-graphql/dist/metadata/definitions';
 import {registerResolver} from '../graphql.server';
 
 const debug = debugFactory('loopback:graphql:resolver-booter');
@@ -59,9 +58,7 @@ export class GraphQLResolverBooter extends BaseArtifactBooter {
   async load() {
     await super.load();
 
-    const resolverClasses: ResolverClassMetadata[] =
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      (getMetadataStorage() as any).resolverClasses;
+    const resolverClasses = getMetadataStorage().resolverClasses;
     this.resolvers = this.classes.filter(cls => {
       return resolverClasses.some(r => /*!r.isAbstract && */ r.target === cls);
     });
diff --git a/extensions/graphql/src/decorators/index.ts b/extensions/graphql/src/decorators/index.ts
@@ -15,7 +15,6 @@ import {
   InputType,
   Mutation,
   ObjectType,
-  PubSub,
   Query,
   Resolver,
   Root,
@@ -41,4 +40,3 @@ export const inputType = InputType;
 export const objectType = ObjectType;
 export const authorized = Authorized;
 export const subscription = Subscription;
-export const pubSub = PubSub;
diff --git a/extensions/graphql/src/graphql.server.ts b/extensions/graphql/src/graphql.server.ts
@@ -33,7 +33,6 @@ import cors from 'cors';
 import express from 'express';
 import fs from 'fs';
 import {GraphQLSchema, lexicographicSortSchema} from 'graphql';
-import {PubSub, PubSubEngine} from 'graphql-subscriptions';
 import {useServer} from 'graphql-ws/lib/use/ws';
 import * as http from 'http';
 import * as https from 'https';
@@ -44,7 +43,7 @@ import {
   ResolverInterface,
   BuildSchemaOptions as TypeGrahpQLBuildSchemaOptions,
 } from 'type-graphql';
-import {Middleware} from 'type-graphql/dist/interfaces/Middleware';
+import {Middleware} from 'type-graphql/build/typings/typings/middleware';
 import {WebSocketServer} from 'ws';
 import {LoopBackContainer} from './graphql.container';
 import {GraphQLBindings, GraphQLTags} from './keys';
@@ -99,8 +98,8 @@ export class GraphQLServer extends Context implements Server {
   /**
    * Get a list of middleware
    */
-  async getMiddlewareList(): Promise<Middleware<object>[]> {
-    const view = this.createView<Middleware<object>>(
+  async getMiddlewareList<T extends {}>(): Promise<Middleware<T>[]> {
+    const view = this.createView<Middleware<T>>(
       filterByTag(GraphQLTags.MIDDLEWARE),
     );
     return view.values();
@@ -110,9 +109,7 @@ export class GraphQLServer extends Context implements Server {
    * Register a GraphQL middleware
    * @param middleware - GraphQL middleware
    */
-  middleware<T extends object = object>(
-    middleware: Middleware<T>,
-  ): Binding<Middleware<T>> {
+  middleware<T extends {}>(middleware: Middleware<T>): Binding<Middleware<T>> {
     return this.bind<Middleware<T>>(BindingKey.generate(`graphql.middleware`))
       .to(middleware)
       .tag(GraphQLTags.MIDDLEWARE);
@@ -140,10 +137,7 @@ export class GraphQLServer extends Context implements Server {
         optional: true,
       })) ?? ((resolverData, roles) => true);
 
-    const pubSub: PubSubEngine | undefined =
-      (await this.get(GraphQLBindings.PUB_SUB_ENGINE, {
-        optional: true,
-      })) ?? new PubSub();
+    const pubSub = await this.get(GraphQLBindings.PUB_SUB, {optional: true});
 
     // build TypeGraphQL executable schema
     const buildSchemaOptions: TypeGrahpQLBuildSchemaOptions = {
diff --git a/extensions/graphql/src/index.ts b/extensions/graphql/src/index.ts
@@ -4,7 +4,6 @@
 // License text available at https://opensource.org/licenses/MIT
 
 export * from 'type-graphql';
-export * from 'type-graphql/dist/interfaces';
 export * from './decorators';
 export * from './graphql.component';
 export * from './graphql.container';
diff --git a/extensions/graphql/src/keys.ts b/extensions/graphql/src/keys.ts
@@ -5,8 +5,7 @@
 
 import {ExpressMiddlewareOptions} from '@apollo/server/dist/esm/express4';
 import {BindingKey, Constructor, CoreBindings} from '@loopback/core';
-import {PubSubEngine} from 'graphql-subscriptions';
-import {AuthChecker, ResolverData} from 'type-graphql';
+import {AuthChecker, PubSub, ResolverData} from 'type-graphql';
 import {GraphQLComponent} from './graphql.component';
 import {GraphQLServer} from './graphql.server';
 import {GraphQLServerOptions, GraphQLWsContextResolver} from './types';
@@ -55,9 +54,7 @@ export namespace GraphQLBindings {
   /**
    * Binding key for the GraphQL pub/sub engine
    */
-  export const PUB_SUB_ENGINE = BindingKey.create<PubSubEngine>(
-    'graphql.pubSubEngine',
-  );
+  export const PUB_SUB = BindingKey.create<PubSub>('graphql.pubSub');
 
   /**
    * Binding key for the GraphQL resolver data - which is bound per request
diff --git a/extensions/graphql/src/types.ts b/extensions/graphql/src/types.ts
@@ -9,7 +9,7 @@ import {ExecutionArgs} from 'graphql';
 import {GraphQLExecutionContextValue, SubscribeMessage} from 'graphql-ws';
 
 export {Float, ID, Int, ResolverInterface} from 'type-graphql';
-export {Middleware as GraphQLMiddleware} from 'type-graphql/dist/interfaces/Middleware';
+export {Middleware as GraphQLMiddleware} from 'type-graphql/build/typings/typings/middleware';
 
 /**
  * Options for GraphQL component
diff --git a/package-lock.json b/package-lock.json
