feat(): add support for plugins

lib/decorators/index.ts

@@ -10,6 +10,7 @@ export * from './interface-type.decorator';
 export * from './mutation.decorator';
 export * from './object-type.decorator';
 export * from './parent.decorator';
+export * from './plugin.decorator';
 export * from './query.decorator';
 export * from './resolve-field.decorator';
 export * from './resolve-property.decorator';

lib/decorators/plugin.decorator.ts

@@ -0,0 +1,11 @@
+import { SetMetadata } from '@nestjs/common';
+import { PLUGIN_METADATA } from '../graphql.constants';
+
+/**
+ * Decorator that marks a class as a Apollo plugin.
+ */
+export function Plugin(): ClassDecorator {
+  return (target: Function) => {
+    SetMetadata(PLUGIN_METADATA, true)(target);
+  };
+}

lib/federation/graphql-federation.factory.ts

@@ -6,14 +6,19 @@ import { mergeSchemas } from 'graphql-tools';
 import { isEmpty } from 'lodash';
 import { GraphQLSchemaBuilder } from '../graphql-schema-builder';
 import { GqlModuleOptions } from '../interfaces';
-import { ResolversExplorerService, ScalarsExplorerService } from '../services';
+import {
+  PluginsExplorerService,
+  ResolversExplorerService,
+  ScalarsExplorerService,
+} from '../services';
 import { extend } from '../utils';
 
 @Injectable()
 export class GraphQLFederationFactory {
   constructor(
     private readonly resolversExplorerService: ResolversExplorerService,
     private readonly scalarsExplorerService: ScalarsExplorerService,
+    private readonly pluginsExplorerService: PluginsExplorerService,
     private readonly gqlSchemaBuilder: GraphQLSchemaBuilder,
   ) {}
 
@@ -23,6 +28,11 @@ export class GraphQLFederationFactory {
     const transformSchema = async schema =>
       options.transformSchema ? options.transformSchema(schema) : schema;
 
+    options.plugins = extend(
+      options.plugins || [],
+      this.pluginsExplorerService.explore(),
+    );
+
     let schema: GraphQLSchema;
     if (options.autoSchemaFile) {
       schema = await this.generateSchema(options);
@@ -68,7 +78,7 @@ export class GraphQLFederationFactory {
 
     const autoGeneratedSchema: GraphQLSchema = await this.gqlSchemaBuilder.buildFederatedSchema(
       options.autoSchemaFile,
-      options.buildSchemaOptions,
+      options,
       this.resolversExplorerService.getAllCtors(),
     );
     const executableSchema = buildFederatedSchema({

lib/federation/graphql-federation.module.ts

@@ -24,7 +24,11 @@ import {
   GqlOptionsFactory,
 } from '../interfaces';
 import { GraphQLSchemaBuilderModule } from '../schema-builder/schema-builder.module';
-import { ResolversExplorerService, ScalarsExplorerService } from '../services';
+import {
+  PluginsExplorerService,
+  ResolversExplorerService,
+  ScalarsExplorerService,
+} from '../services';
 import { generateString, mergeDefaults, normalizeRoutePath } from '../utils';
 import { GraphQLFederationFactory } from './graphql-federation.factory';
 
@@ -35,6 +39,7 @@ import { GraphQLFederationFactory } from './graphql-federation.factory';
     GraphQLFactory,
     MetadataScanner,
     ResolversExplorerService,
+    PluginsExplorerService,
     ScalarsExplorerService,
     GraphQLAstExplorer,
     GraphQLTypesLoader,

lib/graphql-schema-builder.ts

@@ -4,6 +4,7 @@ import { isString } from '@nestjs/common/utils/shared.utils';
 import { GraphQLSchema, printSchema, specifiedDirectives } from 'graphql';
 import { resolve } from 'path';
 import { GRAPHQL_SDL_FILE_HEADER } from './graphql.constants';
+import { GqlModuleOptions } from './interfaces';
 import { BuildSchemaOptions } from './interfaces/build-schema-options.interface';
 import { GraphQLSchemaFactory } from './schema-builder/graphql-schema.factory';
 import { FileSystemHelper } from './schema-builder/helpers/file-system.helper';
@@ -19,14 +20,16 @@ export class GraphQLSchemaBuilder {
 
   async build(
     autoSchemaFile: string | boolean,
-    options: BuildSchemaOptions = {},
+    options: GqlModuleOptions,
     resolvers: Function[],
   ): Promise<any> {
     const scalarsMap = this.scalarsExplorerService.getScalarsMap();
     try {
+      const buildSchemaOptions = options.buildSchemaOptions || {};
       return await this.buildSchema(resolvers, autoSchemaFile, {
-        ...options,
+        ...buildSchemaOptions,
         scalarsMap,
+        schemaDirectives: options.schemaDirectives,
       });
     } catch (err) {
       if (err && err.details) {
@@ -38,19 +41,21 @@ export class GraphQLSchemaBuilder {
 
   async buildFederatedSchema(
     autoSchemaFile: string | boolean,
-    options: BuildSchemaOptions = {},
+    options: GqlModuleOptions,
     resolvers: Function[],
   ) {
     const scalarsMap = this.scalarsExplorerService.getScalarsMap();
     try {
+      const buildSchemaOptions = options.buildSchemaOptions || {};
       return await this.buildSchema(resolvers, autoSchemaFile, {
-        ...options,
+        ...buildSchemaOptions,
         directives: [
           ...specifiedDirectives,
           ...this.loadFederationDirectives(),
-          ...((options && options.directives) || []),
+          ...((buildSchemaOptions && buildSchemaOptions.directives) || []),
         ],
         scalarsMap,
+        schemaDirectives: options.schemaDirectives,
         skipCheck: true,
       });
     } catch (err) {

lib/graphql.constants.ts

@@ -4,6 +4,7 @@ export const RESOLVER_PROPERTY_METADATA = 'graphql:resolve_property';
 export const RESOLVER_DELEGATE_METADATA = 'graphql:delegate_property';
 export const SCALAR_NAME_METADATA = 'graphql:scalar_name';
 export const SCALAR_TYPE_METADATA = 'graphql:scalar_type';
+export const PLUGIN_METADATA = 'graphql:plugin';
 export const PARAM_ARGS_METADATA = '__routeArguments__';
 export const SUBSCRIPTION_OPTIONS_METADATA = 'graphql:subscription_options;';
 

lib/graphql.factory.ts

@@ -12,14 +12,19 @@ import { forEach, isEmpty } from 'lodash';
 import { GraphQLAstExplorer } from './graphql-ast.explorer';
 import { GraphQLSchemaBuilder } from './graphql-schema-builder';
 import { GqlModuleOptions } from './interfaces';
-import { ResolversExplorerService, ScalarsExplorerService } from './services';
+import {
+  PluginsExplorerService,
+  ResolversExplorerService,
+  ScalarsExplorerService,
+} from './services';
 import { extend, removeTempField } from './utils';
 
 @Injectable()
 export class GraphQLFactory {
   constructor(
     private readonly resolversExplorerService: ResolversExplorerService,
     private readonly scalarsExplorerService: ScalarsExplorerService,
+    private readonly pluginsExplorerService: PluginsExplorerService,
     private readonly graphqlAstExplorer: GraphQLAstExplorer,
     private readonly gqlSchemaBuilder: GraphQLSchemaBuilder,
   ) {}
@@ -32,13 +37,18 @@ export class GraphQLFactory {
       this.scalarsExplorerService.explore(),
       resolvers,
     );
+    options.plugins = extend(
+      options.plugins || [],
+      this.pluginsExplorerService.explore(),
+    );
+
     const transformSchema = async (schema: GraphQLSchema) =>
       options.transformSchema ? await options.transformSchema(schema) : schema;
 
     if (options.autoSchemaFile) {
       const autoGeneratedSchema: GraphQLSchema = await this.gqlSchemaBuilder.build(
         options.autoSchemaFile,
-        options.buildSchemaOptions,
+        options,
         this.resolversExplorerService.getAllCtors(),
       );
       const executableSchema = makeExecutableSchema({

lib/graphql.module.ts

@@ -20,7 +20,11 @@ import {
   GqlOptionsFactory,
 } from './interfaces/gql-module-options.interface';
 import { GraphQLSchemaBuilderModule } from './schema-builder/schema-builder.module';
-import { ResolversExplorerService, ScalarsExplorerService } from './services';
+import {
+  PluginsExplorerService,
+  ResolversExplorerService,
+  ScalarsExplorerService,
+} from './services';
 import {
   extend,
   generateString,
@@ -35,6 +39,7 @@ import {
     MetadataScanner,
     ResolversExplorerService,
     ScalarsExplorerService,
+    PluginsExplorerService,
     GraphQLAstExplorer,
     GraphQLTypesLoader,
     GraphQLSchemaBuilder,

lib/interfaces/build-schema-options.interface.ts

@@ -32,4 +32,9 @@ export interface BuildSchemaOptions {
    * GraphQL directives
    */
   directives?: GraphQLDirective[];
+
+  /**
+   * GraphQL schema directives mapping
+   */
+  schemaDirectives?: Record<string, any>;
 }

lib/schema-builder/graphql-schema.factory.ts

@@ -1,5 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { getIntrospectionQuery, graphql, GraphQLSchema } from 'graphql';
+import { SchemaDirectiveVisitor } from 'graphql-tools';
 import { BuildSchemaOptions } from '../interfaces';
 import { SchemaGenerationError } from './errors/schema-generation.error';
 import { MutationTypeFactory } from './factories/mutation-type.factory';
@@ -45,6 +46,13 @@ export class GraphQLSchemaFactory {
         throw new SchemaGenerationError(errors);
       }
     }
+    if (options.schemaDirectives) {
+      SchemaDirectiveVisitor.visitSchemaDirectives(
+        schema,
+        options.schemaDirectives,
+      );
+    }
+
     return schema;
   }
 }

lib/services/index.ts

@@ -1,5 +1,6 @@
 export * from './base-explorer.service';
 export * from './gql-arguments-host';
 export * from './gql-execution-context';
+export * from './plugins-explorer.service';
 export * from './resolvers-explorer.service';
 export * from './scalars-explorer.service';

lib/services/plugins-explorer.service.ts

@@ -0,0 +1,34 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
+import { ModulesContainer } from '@nestjs/core/injector/modules-container';
+import { GRAPHQL_MODULE_OPTIONS, PLUGIN_METADATA } from '../graphql.constants';
+import { GqlModuleOptions } from '../interfaces/gql-module-options.interface';
+import { BaseExplorerService } from './base-explorer.service';
+
+@Injectable()
+export class PluginsExplorerService extends BaseExplorerService {
+  constructor(
+    private readonly modulesContainer: ModulesContainer,
+    @Inject(GRAPHQL_MODULE_OPTIONS)
+    private readonly gqlOptions: GqlModuleOptions,
+  ) {
+    super();
+  }
+
+  explore() {
+    const modules = this.getModules(
+      this.modulesContainer,
+      this.gqlOptions.include || [],
+    );
+    return this.flatMap<any>(modules, instance => this.filterPlugins(instance));
+  }
+
+  filterPlugins<T = any>(wrapper: InstanceWrapper<T>) {
+    const { instance } = wrapper;
+    if (!instance) {
+      return undefined;
+    }
+    const metadata = Reflect.getMetadata(PLUGIN_METADATA, instance.constructor);
+    return metadata ? instance : undefined;
+  }
+}

lib/services/scalars-explorer.service.ts

@@ -31,7 +31,9 @@ export class ScalarsExplorerService extends BaseExplorerService {
     );
   }
 
-  filterImplicitScalar<T extends any = any>(wrapper: InstanceWrapper<T>) {
+  filterImplicitScalar<T extends Record<string, Function | string> = any>(
+    wrapper: InstanceWrapper<T>,
+  ) {
     const { instance } = wrapper;
     if (!instance) {
       return undefined;
@@ -47,10 +49,10 @@ export class ScalarsExplorerService extends BaseExplorerService {
       ? {
           [(metadata as any) as string]: new GraphQLScalarType({
             name: (metadata as any) as string,
-            description: instance['description'],
-            parseValue: bindContext(instance.parseValue),
-            serialize: bindContext(instance.serialize),
-            parseLiteral: bindContext(instance.parseLiteral),
+            description: instance['description'] as string,
+            parseValue: bindContext(instance.parseValue as Function),
+            serialize: bindContext(instance.serialize as Function),
+            parseLiteral: bindContext(instance.parseLiteral as Function),
           }),
         }
       : undefined;
@@ -66,7 +68,9 @@ export class ScalarsExplorerService extends BaseExplorerService {
     );
   }
 
-  filterExplicitScalar<T extends any = any>(wrapper: InstanceWrapper<T>) {
+  filterExplicitScalar<T extends Record<string, Function | string> = any>(
+    wrapper: InstanceWrapper<T>,
+  ) {
     const { instance } = wrapper;
     if (!instance) {
       return undefined;
@@ -89,10 +93,10 @@ export class ScalarsExplorerService extends BaseExplorerService {
             instance.constructor,
           scalar: new GraphQLScalarType({
             name: scalarNameMetadata,
-            description: instance['description'],
-            parseValue: bindContext(instance.parseValue),
-            serialize: bindContext(instance.serialize),
-            parseLiteral: bindContext(instance.parseLiteral),
+            description: instance['description'] as string,
+            parseValue: bindContext(instance.parseValue as Function),
+            serialize: bindContext(instance.serialize as Function),
+            parseLiteral: bindContext(instance.parseLiteral as Function),
           }),
         }
       : undefined;

lib/utils/extend.util.ts

@@ -1,6 +1,6 @@
 import { defaultTo, isArray, isString } from 'lodash';
 
-export function extend(obj1: any, obj2: any) {
+export function extend(obj1: unknown, obj2: unknown) {
   if (isString(obj1)) {
     return isString(obj2)
       ? [defaultTo(obj1, ''), defaultTo(obj2, '')]
@@ -10,7 +10,7 @@ export function extend(obj1: any, obj2: any) {
     return defaultTo(obj1, []).concat(defaultTo(obj2, []));
   }
   return {
-    ...(obj1 || {}),
-    ...(obj2 || {}),
+    ...((obj1 as object) || {}),
+    ...((obj2 as object) || {}),
   };
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/graphql",
-  "version": "7.0.0-next.2",
+  "version": "7.0.0-next.6",
   "description": "Nest - modern, fast, powerful node.js web framework (@graphql)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",