[QUESTION] Middleware binding on graphql requests?

[x] I’ve read the docs of nestjs-pino

[x] I’ve read the docs of pino

[x] I couldn’t find the same question about nestjs-pino

Question I saw it mentioned in this issue that the module should work on graphql requests, however, as far as I can tell, middleware applied via MiddlewareConsumer is not executed when using the nestjs/graphql module. While the logger will work, there is no instance bound to the request from asynclocalstorage, and using the assign method result in an error being thrown.

Is my understanding incorrect? Does something special need to be done to get this functional on graphql requests? I’m thinking the bindLoggerMiddleware needs to be exposed so it can be bound by the graphql context.

Please mention other relevant information such as Node.js version and Operating System.

n/a

[iamolegga]

@julestruong if you need such info you have to use plugins. Here is the reference from my current project:

import { Logger } from '@nestjs/common';
import { Plugin } from '@nestjs/graphql';
import { GraphQLRequestContext } from 'apollo-server-core';
import {
  ApolloServerPlugin,
  GraphQLRequestListener,
  GraphQLRequestContextDidEncounterErrors,
} from 'apollo-server-plugin-base';

@Plugin()
export class GraphQLLogger implements ApolloServerPlugin {
  private readonly logger = new Logger(GraphQLLogger.name);

  async requestDidStart(
    startCtx: GraphQLRequestContext,
  ): Promise<GraphQLRequestListener> {
    return new Listener(
      {
        query: startCtx.request.query,
        operationName: startCtx.request.operationName,
      },
      this.logger,
      // bad bad bad bad typings in lib
    ) as unknown as GraphQLRequestListener;
  }
}

class Listener<T = unknown>
  // bad bad bad bad typings in lib
  implements
    Pick<GraphQLRequestListener<T>, 'didEncounterErrors' | 'willSendResponse'>
{
  private readonly start: number;

  constructor(
    private readonly logData: Record<string, unknown>,
    private readonly logger: Logger,
  ) {
    this.start = Date.now();
  }

  async didEncounterErrors(
    errorsCtx: GraphQLRequestContextDidEncounterErrors<T>,
  ): Promise<void> {
    this.logData.errors = errorsCtx.errors;
  }

  async willSendResponse(): Promise<void> {
    this.logger.log(
      {
        graphql: this.logData,
        responseTime: Date.now() - this.start,
      },
      this.logData.errors ? 'request errored' : 'request completed',
    );
  }
}

also I recommend add to config:

  autoLogging: {
    ignorePaths: [
      // ...

      '/graphql',
    ],
  },

[iamolegga]

@julestruong current plugin will work pretty the same as autologging, but with your custom data. It’s just to prevent log duplication, but it’s up to you