fix(): address minor issues, fix subscriptions support (mercurius)

kamilmysliwiec · kamilmysliwiec · commit da8c23ac915c · 2022-02-01T14:37:49.000+01:00
diff --git a/packages/apollo/lib/drivers/apollo-base.driver.ts b/packages/apollo/lib/drivers/apollo-base.driver.ts
@@ -15,6 +15,7 @@ import {
 import { GraphQLError, GraphQLFormattedError } from 'graphql';
 import * as omit from 'lodash.omit';
 import { ApolloDriverConfig } from '../interfaces';
+import { createAsyncIterator } from '../utils/async-iterator.util';
 
 const apolloPredefinedExceptions: Partial<
   Record<HttpStatus, typeof ApolloError | typeof UserInputError>
@@ -97,6 +98,23 @@ export abstract class ApolloBaseDriver<
     return options;
   }
 
+  public subscriptionWithFilter(
+    instanceRef: unknown,
+    filterFn: (
+      payload: any,
+      variables: any,
+      context: any,
+    ) => boolean | Promise<boolean>,
+    createSubscribeContext: Function,
+  ) {
+    return <TPayload, TVariables, TContext, TInfo>(
+      ...args: [TPayload, TVariables, TContext, TInfo]
+    ): any =>
+      createAsyncIterator(createSubscribeContext()(...args), (payload: any) =>
+        filterFn.call(instanceRef, payload, ...args.slice(1)),
+      );
+  }
+
   protected async registerExpress(
     apolloOptions: T,
     { preStartHook }: { preStartHook?: () => void } = {},
diff --git a/packages/apollo/lib/utils/async-iterator.util.ts b/packages/apollo/lib/utils/async-iterator.util.ts
diff --git a/packages/graphql/lib/drivers/abstract-graphql.driver.ts b/packages/graphql/lib/drivers/abstract-graphql.driver.ts
@@ -36,6 +36,18 @@ export abstract class AbstractGraphQLDriver<
     return clonedOptions;
   }
 
+  public subscriptionWithFilter(
+    instanceRef: unknown,
+    filterFn: (
+      payload: any,
+      variables: any,
+      context: any,
+    ) => boolean | Promise<boolean>,
+    createSubscribeContext: Function,
+  ) {
+    return createSubscribeContext();
+  }
+
   protected getNormalizedPath(options: TOptions): string {
     const prefix = this.applicationConfig.getGlobalPrefix();
     const useGlobalPrefix = prefix && options.useGlobalPrefix;
diff --git a/packages/graphql/lib/graphql.module.ts b/packages/graphql/lib/graphql.module.ts
@@ -7,7 +7,7 @@ import {
 } from '@nestjs/common/interfaces';
 import { HttpAdapterHost } from '@nestjs/core';
 import { MetadataScanner } from '@nestjs/core/metadata-scanner';
-import { AbstractGraphQLDriver } from '.';
+import { AbstractGraphQLDriver } from './drivers/abstract-graphql.driver';
 import { GraphQLFederationFactory } from './federation/graphql-federation.factory';
 import { GraphQLAstExplorer } from './graphql-ast.explorer';
 import { GraphQLSchemaBuilder } from './graphql-schema.builder';
diff --git a/packages/graphql/lib/schema-builder/storages/type-metadata.storage.ts b/packages/graphql/lib/schema-builder/storages/type-metadata.storage.ts
@@ -202,7 +202,7 @@ export class TypeMetadataStorageHost {
   }
 
   addMethodParamMetadata(metadata: MethodArgsMetadata) {
-    this.params.push(metadata);
+    this.params.unshift(metadata);
   }
 
   compile(orphanedTypes: (Function | object)[] = []) {
diff --git a/packages/graphql/lib/services/resolvers-explorer.service.ts b/packages/graphql/lib/services/resolvers-explorer.service.ts
@@ -3,6 +3,7 @@ import { isUndefined } from '@nestjs/common/utils/shared.utils';
 import {
   createContextId,
   MetadataScanner,
+  ModuleRef,
   ModulesContainer,
   REQUEST,
 } from '@nestjs/core';
@@ -18,7 +19,8 @@ import { Module } from '@nestjs/core/injector/module';
 import { REQUEST_CONTEXT_ID } from '@nestjs/core/router/request/request-constants';
 import { GraphQLResolveInfo } from 'graphql';
 import { head, identity } from 'lodash';
-import { GqlModuleOptions, SubscriptionOptions } from '..';
+import { SubscriptionOptions } from '../decorators/subscription.decorator';
+import { AbstractGraphQLDriver } from '../drivers/abstract-graphql.driver';
 import { GqlParamtype } from '../enums/gql-paramtype.enum';
 import { Resolver } from '../enums/resolver.enum';
 import { GqlParamsFactory } from '../factories/params.factory';
@@ -30,8 +32,8 @@ import {
   SUBSCRIPTION_OPTIONS_METADATA,
   SUBSCRIPTION_TYPE,
 } from '../graphql.constants';
+import { GqlModuleOptions } from '../interfaces';
 import { ResolverMetadata } from '../interfaces/resolver-metadata.interface';
-import { createAsyncIterator } from '../utils/async-iterator.util';
 import { decorateFieldResolverWithMiddleware } from '../utils/decorate-field-resolver.util';
 import { extractMetadata } from '../utils/extract-metadata.util';
 import { BaseExplorerService } from './base-explorer.service';
@@ -49,6 +51,7 @@ export class ResolversExplorerService extends BaseExplorerService {
     private readonly externalContextCreator: ExternalContextCreator,
     @Inject(GRAPHQL_MODULE_OPTIONS)
     private readonly gqlOptions: GqlModuleOptions,
+    private readonly moduleRef: ModuleRef,
   ) {
     super();
   }
@@ -58,13 +61,15 @@ export class ResolversExplorerService extends BaseExplorerService {
       this.modulesContainer,
       this.gqlOptions.include || [],
     );
+    const gqlAdapter = this.moduleRef.get(AbstractGraphQLDriver);
     const resolvers = this.flatMap(modules, (instance, moduleRef) =>
-      this.filterResolvers(instance, moduleRef),
+      this.filterResolvers(gqlAdapter, instance, moduleRef),
     );
     return this.groupMetadata(resolvers);
   }
 
   filterResolvers(
+    gqlAdapter: AbstractGraphQLDriver,
     wrapper: InstanceWrapper,
     moduleRef: Module,
   ): ResolverMetadata[] {
@@ -118,6 +123,7 @@ export class ResolversExplorerService extends BaseExplorerService {
             instance[resolver.methodName],
           );
           return this.createSubscriptionMetadata(
+            gqlAdapter,
             createContext,
             subscriptionOptions,
             resolver,
@@ -238,6 +244,7 @@ export class ResolversExplorerService extends BaseExplorerService {
   }
 
   createSubscriptionMetadata(
+    gqlAdapter: AbstractGraphQLDriver,
     createSubscribeContext: Function,
     subscriptionOptions: SubscriptionOptions,
     resolverMetadata: ResolverMetadata,
@@ -255,16 +262,11 @@ export class ResolversExplorerService extends BaseExplorerService {
         ...resolverMetadata,
         callback: {
           ...baseCallbackMetadata,
-          subscribe: <TPayload, TVariables, TContext, TInfo>(
-            ...args: [TPayload, TVariables, TContext, TInfo]
-          ) =>
-            createAsyncIterator(createSubscribeContext()(...args), (payload) =>
-              (subscriptionOptions.filter as Function).call(
-                instanceRef,
-                payload,
-                ...args.slice(1),
-              ),
-            ),
+          subscribe: gqlAdapter.subscriptionWithFilter(
+            instanceRef,
+            subscriptionOptions.filter,
+            createSubscribeContext,
+          ),
         },
       };
     }
diff --git a/packages/graphql/lib/utils/index.ts b/packages/graphql/lib/utils/index.ts
@@ -1,4 +1,3 @@
-export * from './async-iterator.util';
 export * from './extend.util';
 export * from './extract-metadata.util';
 export * from './generate-token.util';
diff --git a/packages/mercurius/lib/drivers/mercurius.driver.ts b/packages/mercurius/lib/drivers/mercurius.driver.ts
@@ -51,6 +51,21 @@ export class MercuriusDriver extends AbstractGraphQLDriver<MercuriusDriverConfig
     return options;
   }
 
+  public subscriptionWithFilter(
+    instanceRef: unknown,
+    filterFn: (
+      payload: any,
+      variables: any,
+      context: any,
+    ) => boolean | Promise<boolean>,
+    createSubscribeContext: Function,
+  ) {
+    return mercurius.withFilter(
+      createSubscribeContext(),
+      (...args: unknown[]) => filterFn.call(instanceRef, ...args),
+    ) as any;
+  }
+
   private wrapContextResolver(
     targetOptions: MercuriusDriverConfig,
     originalOptions: MercuriusDriverConfig = { ...targetOptions },
diff --git a/packages/mercurius/tests/graphql-federation/gateway/config/config.service.ts b/packages/mercurius/tests/graphql-federation/gateway/config/config.service.ts
@@ -2,14 +2,12 @@ import { Injectable } from '@nestjs/common';
 import {
   MercuriusDriverConfig,
   MercuriusDriverConfigFactory,
-  MercuriusGatewayDriver,
 } from '../../../../lib';
 
 @Injectable()
 export class ConfigService implements MercuriusDriverConfigFactory {
   public createGqlOptions(): Partial<MercuriusDriverConfig> {
     return {
-      driver: MercuriusGatewayDriver,
       gateway: {
         services: [
           { name: 'users', url: 'http://localhost:3011/graphql' },
diff --git a/packages/mercurius/tests/subscriptions/app/notification.resolver.ts b/packages/mercurius/tests/subscriptions/app/notification.resolver.ts
@@ -17,14 +17,12 @@ export class NotificationResolver {
 
   @UseGuards(AuthGuard)
   @Subscription(() => Notification, {
-    // filter(payload, variables, context) {
-    //   // console.log('in filter', { payload, variables, context });
-    //   // return (
-    //   //   context.user === payload.newNotification.recipient &&
-    //   //   payload.newNotification.id === variables.id
-    //   // );
-    //   return true;
-    // },
+    filter(payload, variables, context) {
+      return (
+        context.user === payload.newNotification.recipient &&
+        payload.newNotification.id === variables.id
+      );
+    },
   })
   newNotification(
     @Args('id', {

Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ export class TypeMetadataStorageHost {`
`202`	`202`	`}`
`203`	`203`
`204`	`204`	`addMethodParamMetadata(metadata: MethodArgsMetadata) {`
`205`		`- this.params.push(metadata);`
	`205`	`+ this.params.unshift(metadata);`
`206`	`206`	`}`
`207`	`207`
`208`	`208`	`compile(orphanedTypes: (Function \| object)[] = []) {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-export * from './async-iterator.util';`
`2`	`1`	`export * from './extend.util';`
`3`	`2`	`export * from './extract-metadata.util';`
`4`	`3`	`export * from './generate-token.util';`