feat(mercurius): update mercurius plugins, upgrade deps

kamilmysliwiec · kamilmysliwiec · commit d97e653b8c76 · 2023-02-07T11:40:29.000+01:00
diff --git a/packages/mercurius/lib/drivers/mercurius-federation.driver.ts b/packages/mercurius/lib/drivers/mercurius-federation.driver.ts
@@ -11,6 +11,8 @@ import { MercuriusDriverConfig } from '../interfaces/mercurius-driver-config.int
 import { buildMercuriusFederatedSchema } from '../utils/build-mercurius-federated-schema.util';
 import { registerMercuriusHooks } from '../utils/register-mercurius-hooks.util';
 import { registerMercuriusPlugin } from '../utils/register-mercurius-plugin.util';
+// TODO:
+// const { mercuriusFederationPlugin } = require('@mercuriusjs/federation');
 
 @Injectable()
 export class MercuriusFederationDriver extends AbstractGraphQLDriver<MercuriusDriverConfig> {
@@ -50,11 +52,12 @@ export class MercuriusFederationDriver extends AbstractGraphQLDriver<MercuriusDr
       throw new Error(`No support for current HttpAdapter: ${platformName}`);
     }
     const app = httpAdapter.getInstance<FastifyInstance>();
+    // TODO: replace with mercuriusFederationPlugin
     await app.register(mercurius, {
       ...adapterOptions,
     });
     await registerMercuriusPlugin(app, plugins);
-    await registerMercuriusHooks(app, hooks);
+    registerMercuriusHooks(app, hooks);
   }
 
   /* eslit-disable-next-line @typescript-eslint/no-empty-function */
diff --git a/packages/mercurius/lib/drivers/mercurius-gateway.driver.ts b/packages/mercurius/lib/drivers/mercurius-gateway.driver.ts
@@ -1,12 +1,12 @@
+import mercuriusGateway from '@mercuriusjs/gateway';
 import { AbstractGraphQLDriver } from '@nestjs/graphql';
 import { FastifyBaseLogger, FastifyInstance } from 'fastify';
 import { IncomingMessage, Server, ServerResponse } from 'http';
-import mercurius from 'mercurius';
-import { MercuriusDriverConfig } from '../interfaces/mercurius-driver-config.interface';
+import { MercuriusGatewayDriverConfig } from '../interfaces';
 import { registerMercuriusHooks } from '../utils/register-mercurius-hooks.util';
 import { registerMercuriusPlugin } from '../utils/register-mercurius-plugin.util';
 
-export class MercuriusGatewayDriver extends AbstractGraphQLDriver<MercuriusDriverConfig> {
+export class MercuriusGatewayDriver extends AbstractGraphQLDriver<MercuriusGatewayDriverConfig> {
   get instance(): FastifyInstance<
     Server,
     IncomingMessage,
@@ -16,7 +16,7 @@ export class MercuriusGatewayDriver extends AbstractGraphQLDriver<MercuriusDrive
     return this.httpAdapterHost?.httpAdapter?.getInstance?.();
   }
 
-  public async start(options: MercuriusDriverConfig) {
+  public async start(options: MercuriusGatewayDriverConfig) {
     const httpAdapter = this.httpAdapterHost.httpAdapter;
     const platformName = httpAdapter.getType();
 
@@ -26,11 +26,11 @@ export class MercuriusGatewayDriver extends AbstractGraphQLDriver<MercuriusDrive
 
     const { plugins, hooks, ...mercuriusOptions } = options;
     const app = httpAdapter.getInstance<FastifyInstance>();
-    await app.register(mercurius, {
+    await app.register(mercuriusGateway, {
       ...mercuriusOptions,
     });
     await registerMercuriusPlugin(app, plugins);
-    await registerMercuriusHooks(app, hooks);
+    registerMercuriusHooks(app, hooks, 'graphqlGateway');
   }
 
   public async stop(): Promise<void> {}
diff --git a/packages/mercurius/lib/drivers/mercurius.driver.ts b/packages/mercurius/lib/drivers/mercurius.driver.ts
@@ -42,7 +42,7 @@ export class MercuriusDriver extends AbstractGraphQLDriver<MercuriusDriverConfig
       ...options,
     });
     await registerMercuriusPlugin(app, plugins);
-    await registerMercuriusHooks(app, hooks);
+    registerMercuriusHooks(app, hooks);
   }
 
   public async stop(): Promise<void> {}
diff --git a/packages/mercurius/lib/interfaces/mercurius-gateway-driver-config.interface.ts b/packages/mercurius/lib/interfaces/mercurius-gateway-driver-config.interface.ts
@@ -6,12 +6,12 @@ import {
 } from '@nestjs/graphql';
 import { MercuriusCommonOptions } from 'mercurius';
 import { MercuriusHooks } from './mercurius-hook.interface';
-import { MercuriusPlugin } from './mercurius-plugin.interface';
+import { MercuriusPlugins } from './mercurius-plugin.interface';
 
 export type MercuriusGatewayDriverConfig = GqlModuleOptions &
   MercuriusCommonOptions &
   MercuriusGatewayOptions &
-  MercuriusPlugin &
+  MercuriusPlugins &
   MercuriusHooks;
 
 export type MercuriusGatewayDriverConfigFactory =
diff --git a/packages/mercurius/lib/utils/build-mercurius-federated-schema.util.ts b/packages/mercurius/lib/utils/build-mercurius-federated-schema.util.ts
@@ -1,7 +1,6 @@
 import { loadPackage } from '@nestjs/common/utils/load-package.util';
-import { transformSchema } from '@nestjs/graphql';
-import { BuildFederatedSchemaOptions } from '@nestjs/graphql';
-import { GraphQLSchema, isObjectType, buildASTSchema } from 'graphql';
+import { BuildFederatedSchemaOptions, transformSchema } from '@nestjs/graphql';
+import { buildASTSchema, GraphQLSchema, isObjectType } from 'graphql';
 
 export function buildMercuriusFederatedSchema({
   typeDefs,
diff --git a/packages/mercurius/lib/utils/register-mercurius-hooks.util.ts b/packages/mercurius/lib/utils/register-mercurius-hooks.util.ts
@@ -5,6 +5,7 @@ import { isArray, isNull, isUndefined } from './validation.util';
 export function registerMercuriusHooks(
   app: FastifyInstance,
   hooks?: MercuriusGatewayHooksObject | null,
+  key: 'graphql' | 'graphqlGateway' = 'graphql',
 ): void {
   if (isUndefined(hooks) || isNull(hooks)) {
     return;
@@ -16,10 +17,10 @@ export function registerMercuriusHooks(
     }
 
     if (isArray<any>(hookFn)) {
-      hookFn.forEach((fn) => app.graphql.addHook(hookName, fn));
+      hookFn.forEach((fn) => (app[key] as any).addHook(hookName, fn));
       return;
     }
 
-    app.graphql.addHook(hookName, hookFn);
+    (app[key] as any).addHook(hookName, hookFn);
   });
 }
diff --git a/packages/mercurius/package.json b/packages/mercurius/package.json
@@ -28,6 +28,7 @@
   },
   "devDependencies": {
     "@mercuriusjs/gateway": "^1.0.0",
+    "@mercuriusjs/federation": "^1.0.0",
     "@nestjs/common": "9.2.1",
     "@nestjs/platform-fastify": "9.2.1",
     "@nestjs/testing": "8.4.7",
@@ -37,15 +38,23 @@
   },
   "peerDependencies": {
     "@apollo/subgraph": "^2.0.0",
+    "@mercuriusjs/gateway": "^1.0.0",
+    "@mercuriusjs/federation": "^1.0.0",
     "@nestjs/common": "^9.2.1",
     "@nestjs/graphql": "^10.1.7",
     "fastify": "^4.12.0",
     "graphql": "^16.0.0",
-    "mercurius": "^10.0.0 || ^11.0.0 || ^12.0.0"
+    "mercurius": "^12.0.0"
   },
   "peerDependenciesMeta": {
     "@apollo/subgraph": {
       "optional": true
+    },
+    "@mercuriusjs/gateway": {
+      "optional": true
+    },
+    "@mercuriusjs/federation": {
+      "optional": true
     }
   }
 }
diff --git a/packages/mercurius/tests/graphql-federation/gateway/config/config.service.ts b/packages/mercurius/tests/graphql-federation/gateway/config/config.service.ts
@@ -1,12 +1,12 @@
 import { Injectable } from '@nestjs/common';
 import {
-  MercuriusDriverConfig,
-  MercuriusDriverConfigFactory,
+  MercuriusGatewayDriverConfig,
+  MercuriusGatewayDriverConfigFactory,
 } from '../../../../lib';
 
 @Injectable()
-export class ConfigService implements MercuriusDriverConfigFactory {
-  public createGqlOptions(): Partial<MercuriusDriverConfig> {
+export class ConfigService implements MercuriusGatewayDriverConfigFactory {
+  public createGqlOptions(): MercuriusGatewayDriverConfig {
     return {
       gateway: {
         services: [
diff --git a/packages/mercurius/tests/graphql-federation/gateway/gateway-async-class.module.ts b/packages/mercurius/tests/graphql-federation/gateway/gateway-async-class.module.ts
@@ -1,14 +1,14 @@
 import { Module } from '@nestjs/common';
 import { GraphQLModule } from '@nestjs/graphql';
 import { MercuriusDriverConfig } from '../../../lib';
-import { MercuriusDriver } from '../../../lib/drivers';
+import { MercuriusGatewayDriver } from '../../../lib/drivers';
 import { ConfigModule } from './config/config.module';
 import { ConfigService } from './config/config.service';
 
 @Module({
   imports: [
     GraphQLModule.forRootAsync<MercuriusDriverConfig>({
-      driver: MercuriusDriver,
+      driver: MercuriusGatewayDriver,
       useClass: ConfigService,
       imports: [ConfigModule],
       inject: [ConfigService],
diff --git a/packages/mercurius/tests/graphql-federation/gateway/gateway-async-existing.module.ts b/packages/mercurius/tests/graphql-federation/gateway/gateway-async-existing.module.ts
@@ -1,14 +1,14 @@
 import { Module } from '@nestjs/common';
 import { GraphQLModule } from '@nestjs/graphql';
 import { MercuriusDriverConfig } from '../../../lib';
-import { MercuriusDriver } from '../../../lib/drivers';
+import { MercuriusGatewayDriver } from '../../../lib/drivers';
 import { ConfigModule } from './config/config.module';
 import { ConfigService } from './config/config.service';
 
 @Module({
   imports: [
     GraphQLModule.forRootAsync<MercuriusDriverConfig>({
-      driver: MercuriusDriver,
+      driver: MercuriusGatewayDriver,
       useExisting: ConfigService,
       imports: [ConfigModule],
       inject: [ConfigService],
diff --git a/packages/mercurius/tests/graphql-federation/gateway/gateway-async.module.ts b/packages/mercurius/tests/graphql-federation/gateway/gateway-async.module.ts
@@ -1,14 +1,14 @@
 import { Module } from '@nestjs/common';
 import { GraphQLModule } from '@nestjs/graphql';
-import { MercuriusDriver } from '../../../lib/drivers';
+import { MercuriusGatewayDriver } from '../../../lib/drivers';
 import { MercuriusDriverConfig } from '../../../lib/interfaces';
 import { ConfigModule } from './config/config.module';
 import { ConfigService } from './config/config.service';
 
 @Module({
   imports: [
     GraphQLModule.forRootAsync<MercuriusDriverConfig>({
-      driver: MercuriusDriver,
+      driver: MercuriusGatewayDriver,
       useFactory: async (configService: ConfigService) => ({
         ...configService.createGqlOptions(),
       }),

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ export class MercuriusDriver extends AbstractGraphQLDriver<MercuriusDriverConfig`
`42`	`42`	`...options,`
`43`	`43`	`});`
`44`	`44`	`await registerMercuriusPlugin(app, plugins);`
`45`		`- await registerMercuriusHooks(app, hooks);`
	`45`	`+ registerMercuriusHooks(app, hooks);`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`public async stop(): Promise<void> {}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import { isArray, isNull, isUndefined } from './validation.util';`
`5`	`5`	`export function registerMercuriusHooks(`
`6`	`6`	`app: FastifyInstance,`
`7`	`7`	`hooks?: MercuriusGatewayHooksObject \| null,`
	`8`	`+ key: 'graphql' \| 'graphqlGateway' = 'graphql',`
`8`	`9`	`): void {`
`9`	`10`	`if (isUndefined(hooks) \|\| isNull(hooks)) {`
`10`	`11`	`return;`
`@@ -16,10 +17,10 @@ export function registerMercuriusHooks(`
`16`	`17`	`}`
`17`	`18`
`18`	`19`	`if (isArray<any>(hookFn)) {`
`19`		`- hookFn.forEach((fn) => app.graphql.addHook(hookName, fn));`
	`20`	`+ hookFn.forEach((fn) => (app[key] as any).addHook(hookName, fn));`
`20`	`21`	`return;`
`21`	`22`	`}`
`22`	`23`
`23`		`- app.graphql.addHook(hookName, hookFn);`
	`24`	`+ (app[key] as any).addHook(hookName, hookFn);`
`24`	`25`	`});`
`25`	`26`	`}`