Merge pull request #2538 from tugascript/tugascript/add-plugins-to-mercurius

feat(mercurius): add plugins option

Author: kamilmysliwiec

packages/mercurius/lib/drivers/mercurius-federation.driver.ts

@@ -9,9 +9,16 @@ import { IncomingMessage, Server, ServerResponse } from 'http';
 import mercurius from 'mercurius';
 import { MercuriusDriverConfig } from '../interfaces/mercurius-driver-config.interface';
 import { buildMercuriusFederatedSchema } from '../utils/build-mercurius-federated-schema.util';
+import { registerMercuriusPlugin } from '../utils/register-mercurius-plugin.util';
 
 @Injectable()
 export class MercuriusFederationDriver extends AbstractGraphQLDriver<MercuriusDriverConfig> {
+  constructor(
+    private readonly graphqlFederationFactory: GraphQLFederationFactory,
+  ) {
+    super();
+  }
+
   get instance(): FastifyInstance<
     Server,
     IncomingMessage,
@@ -21,17 +28,12 @@ export class MercuriusFederationDriver extends AbstractGraphQLDriver<MercuriusDr
     return this.httpAdapterHost?.httpAdapter?.getInstance?.();
   }
 
-  constructor(
-    private readonly graphqlFederationFactory: GraphQLFederationFactory,
-  ) {
-    super();
-  }
-
   public async start(options: MercuriusDriverConfig) {
-    const adapterOptions = await this.graphqlFederationFactory.mergeWithSchema(
-      options,
-      buildMercuriusFederatedSchema,
-    );
+    const { plugins, ...adapterOptions } =
+      await this.graphqlFederationFactory.mergeWithSchema(
+        options,
+        buildMercuriusFederatedSchema,
+      );
 
     if (adapterOptions.definitions && adapterOptions.definitions.path) {
       await this.graphQlFactory.generateDefinitions(
@@ -50,6 +52,7 @@ export class MercuriusFederationDriver extends AbstractGraphQLDriver<MercuriusDr
     await app.register(mercurius, {
       ...adapterOptions,
     });
+    await registerMercuriusPlugin(app, plugins);
   }
 
   /* eslit-disable-next-line @typescript-eslint/no-empty-function */

packages/mercurius/lib/drivers/mercurius-gateway.driver.ts

@@ -3,6 +3,7 @@ import { FastifyInstance, FastifyLoggerInstance } from 'fastify';
 import { IncomingMessage, Server, ServerResponse } from 'http';
 import mercurius from 'mercurius';
 import { MercuriusDriverConfig } from '../interfaces/mercurius-driver-config.interface';
+import { registerMercuriusPlugin } from '../utils/register-mercurius-plugin.util';
 
 export class MercuriusGatewayDriver extends AbstractGraphQLDriver<MercuriusDriverConfig> {
   get instance(): FastifyInstance<
@@ -22,10 +23,12 @@ export class MercuriusGatewayDriver extends AbstractGraphQLDriver<MercuriusDrive
       throw new Error(`No support for current HttpAdapter: ${platformName}`);
     }
 
+    const { plugins, ...mercuriusOptions } = options;
     const app = httpAdapter.getInstance<FastifyInstance>();
     await app.register(mercurius, {
-      ...options,
+      ...mercuriusOptions,
     });
+    await registerMercuriusPlugin(app, plugins);
   }
 
   public async stop(): Promise<void> {}

packages/mercurius/lib/drivers/mercurius.driver.ts

@@ -5,6 +5,7 @@ import { printSchema } from 'graphql';
 import { IncomingMessage, Server, ServerResponse } from 'http';
 import mercurius from 'mercurius';
 import { MercuriusDriverConfig } from '../interfaces/mercurius-driver-config.interface';
+import { registerMercuriusPlugin } from '../utils/register-mercurius-plugin.util';
 
 export class MercuriusDriver extends AbstractGraphQLDriver<MercuriusDriverConfig> {
   get instance(): FastifyInstance<
@@ -17,7 +18,7 @@ export class MercuriusDriver extends AbstractGraphQLDriver<MercuriusDriverConfig
   }
 
   public async start(mercuriusOptions: MercuriusDriverConfig) {
-    const options =
+    const { plugins, ...options } =
       await this.graphQlFactory.mergeWithSchema<MercuriusDriverConfig>(
         mercuriusOptions,
       );
@@ -39,6 +40,7 @@ export class MercuriusDriver extends AbstractGraphQLDriver<MercuriusDriverConfig
     await app.register(mercurius, {
       ...options,
     });
+    await registerMercuriusPlugin(app, plugins);
   }
 
   public async stop(): Promise<void> {}

packages/mercurius/lib/interfaces/index.ts

@@ -1,3 +1,4 @@
 export * from './mercurius-driver-config.interface';
 export * from './mercurius-federation-driver-config.interface';
 export * from './mercurius-gateway-driver-config.interface';
+export * from './mercurius-plugin.interface';

packages/mercurius/lib/interfaces/mercurius-driver-config.interface.ts

@@ -4,8 +4,11 @@ import {
   GqlOptionsFactory,
 } from '@nestjs/graphql';
 import { MercuriusOptions } from 'mercurius';
+import { MercuriusPlugins } from './mercurius-plugin.interface';
 
-export type MercuriusDriverConfig = GqlModuleOptions & MercuriusOptions;
+export type MercuriusDriverConfig = GqlModuleOptions &
+  MercuriusOptions &
+  MercuriusPlugins;
 
 export type MercuriusDriverConfigFactory =
   GqlOptionsFactory<MercuriusDriverConfig>;

packages/mercurius/lib/interfaces/mercurius-gateway-driver-config.interface.ts

@@ -4,10 +4,12 @@ import {
   GqlOptionsFactory,
 } from '@nestjs/graphql';
 import { MercuriusCommonOptions, MercuriusGatewayOptions } from 'mercurius';
+import { MercuriusPlugin } from './mercurius-plugin.interface';
 
 export type MercuriusGatewayDriverConfig = GqlModuleOptions &
   MercuriusCommonOptions &
-  MercuriusGatewayOptions;
+  MercuriusGatewayOptions &
+  MercuriusPlugin;
 
 export type MercuriusGatewayDriverConfigFactory =
   GqlOptionsFactory<MercuriusGatewayDriverConfig>;

packages/mercurius/lib/interfaces/mercurius-plugin.interface.ts

@@ -0,0 +1,24 @@
+import {
+  FastifyPluginAsync,
+  FastifyPluginCallback,
+  FastifyPluginOptions,
+  FastifyRegisterOptions,
+} from 'fastify';
+
+export interface MercuriusPlugin<
+  Options extends FastifyPluginOptions = unknown,
+> {
+  plugin:
+    | FastifyPluginCallback<Options>
+    | FastifyPluginAsync<Options>
+    | Promise<{
+        default: FastifyPluginCallback<Options>;
+      }>;
+  options?: FastifyRegisterOptions<Options>;
+}
+
+export interface MercuriusPlugins<
+  Options extends FastifyPluginOptions = unknown,
+> {
+  plugins?: MercuriusPlugin<Options>[];
+}

packages/mercurius/lib/utils/register-mercurius-plugin.util.ts

@@ -0,0 +1,21 @@
+import { FastifyInstance } from 'fastify';
+import { MercuriusPlugin } from '../interfaces/mercurius-plugin.interface';
+import { isArray, isNull, isUndefined } from './validation.util';
+
+export async function registerMercuriusPlugin(
+  app: FastifyInstance,
+  plugins?: MercuriusPlugin[],
+): Promise<void> {
+  if (
+    isUndefined(plugins) ||
+    isNull(plugins) ||
+    !isArray(plugins) ||
+    plugins.length === 0
+  ) {
+    return;
+  }
+
+  for (const plugin of plugins) {
+    await app.register(plugin.plugin, plugin.options);
+  }
+}

packages/mercurius/lib/utils/validation.util.ts

@@ -0,0 +1,9 @@
+export const isUndefined = (value: unknown): value is undefined => {
+  return typeof value === 'undefined';
+};
+
+export const isNull = (value: unknown): value is null => value === null;
+
+export const isArray = <T>(value: unknown): value is T[] => {
+  return Array.isArray(value);
+};

packages/mercurius/tests/e2e/code-first-plugin.spec.ts

@@ -0,0 +1,51 @@
+import { INestApplication } from '@nestjs/common';
+import { FastifyAdapter } from '@nestjs/platform-fastify';
+import { Test } from '@nestjs/testing';
+import { FastifyInstance } from 'fastify';
+import { ApplicationModule } from '../plugins/code-first-plugin/app.module';
+import { NEW_PLUGIN_URL } from '../plugins/mocks/utils/constants';
+
+describe('Code-first with plugins', () => {
+  let app: INestApplication;
+
+  beforeEach(async () => {
+    const module = await Test.createTestingModule({
+      imports: [ApplicationModule],
+    }).compile();
+
+    app = module.createNestApplication(new FastifyAdapter());
+    await app.init();
+  });
+
+  it('should get the plugin', async () => {
+    const fastifyInstance: FastifyInstance = app.getHttpAdapter().getInstance();
+    await fastifyInstance.ready();
+
+    const response = await fastifyInstance.inject({
+      method: 'GET',
+      url: NEW_PLUGIN_URL,
+    });
+    const data = JSON.parse(response.body);
+    expect(fastifyInstance.printPlugins().includes('mockPlugin')).toBe(true);
+    expect(response.statusCode).toBe(200);
+    expect(data.from).toBe(NEW_PLUGIN_URL);
+  });
+
+  it('it should query dog', async () => {
+    const fastifyInstance: FastifyInstance = app.getHttpAdapter().getInstance();
+    await fastifyInstance.ready();
+
+    const response = await fastifyInstance.graphql(`
+      {
+        getAnimalName
+      }
+    `);
+    expect(response.data).toEqual({
+      getAnimalName: 'dog',
+    });
+  });
+
+  afterEach(async () => {
+    await app.close();
+  });
+});