Encountering a Typescript issue with the updated Apollo server version within a NestJS application

Question

Encountering a Typescript issue with the updated Apollo server version within a NestJS application

After upgrading my nestJS application to use version 3.2 of apollo-server-plugin-base, I encountered two TypeScript errors related to a simple nestJS plugin:

import { Plugin } from '@nestjs/graphql'
import {
  ApolloServerPlugin,
  GraphQLRequestListener
} from 'apollo-server-plugin-base'

@Plugin()
export class LoggingPlugin implements ApolloServerPlugin {
  requestDidStart(): GraphQLRequestListener {
    console.log('Request started')
    return {
      willSendResponse() {
        console.log('Will send response')
      }
    }
  }
}

I am having trouble understanding the nature of these errors and would appreciate some assistance.

requestDidStart():

TS2416: Property 'requestDidStart' in type 'LoggingPlugin' is not assignable to the same property in the base type 'ApolloServerPlugin<BaseContext>'.
  Type '() => GraphQLRequestListener<BaseContext>' is not assignable to type '(requestContext: GraphQLRequestContext<BaseContext>) => Promise<void | GraphQLRequestListener<BaseContext>>'.
    Type 'GraphQLRequestListener<BaseContext>' is missing certain properties required by 'Promise<void | GraphQLRequestListener<BaseContext>>'.

willSendResponse:

TS2322: Type '() => void' is not compatible with the expected type '(requestContext: GraphQLRequestContextWillSendResponse<BaseContext>) => Promise<void>'.
  The error lies in 'Type 'void' being incompatible with type 'Promise<void>'

typescript nestjs apollo-server

Answer 1

Answer №1

Based on the error notification, it appears that adjusting requestDidStart to an asynchronous function is essential. This can be achieved by either returning a void promise like return Promise<void>.resolve();, or by simply including the async keyword in the method declaration - async requestDidStart().

Answer 2

Based on the error notification, it appears that adjusting requestDidStart to an asynchronous function is essential. This can be achieved by either returning a void promise like return Promise<void>.resolve();, or by simply including the async keyword in the method declaration - async requestDidStart().

Answer 3

Answer №2

Below is a snippet of code that I find effective in enhancing the logging experience:

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

@Plugin()
export class CustomLoggingPlugin implements ApolloServerPlugin {
    logger: Logger;

    constructor() {
        this.logger = new Logger('ApolloServer');
    }

    // This method is triggered every time a client sends a GraphQL request.
    async requestDidStart(requestContext: GraphQLRequestContext): Promise<GraphQLRequestListener> {
        this.logger.log(
            'Received request:\n' +
            requestContext.request.query +
            '\nVariables:' +
            JSON.stringify(requestContext.request.variables)
        );
        return {
            async willSendResponse() {
                // console.log('Preparing to send response...');
            },
        };
    }
}

Answer 4

Below is a snippet of code that I find effective in enhancing the logging experience:

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

@Plugin()
export class CustomLoggingPlugin implements ApolloServerPlugin {
    logger: Logger;

    constructor() {
        this.logger = new Logger('ApolloServer');
    }

    // This method is triggered every time a client sends a GraphQL request.
    async requestDidStart(requestContext: GraphQLRequestContext): Promise<GraphQLRequestListener> {
        this.logger.log(
            'Received request:\n' +
            requestContext.request.query +
            '\nVariables:' +
            JSON.stringify(requestContext.request.variables)
        );
        return {
            async willSendResponse() {
                // console.log('Preparing to send response...');
            },
        };
    }
}

Encountering a Typescript issue with the updated Apollo server version within a NestJS application

Answer №1

Answer №2

Similar questions

What is the best method for choosing visible elements within a scrollable container?

React-snap causing trouble with Firebase

Converting Enum Values into an Array

Matching TypeScript search field names with column names

Ensuring Type Compatibility Between Classes and Object Literals in TypeScript

Finding the IP address of a server in Angular: A Comprehensive Guide

The absence of a 'body' argument in the send() json() method within the Next.js API, coupled with TypeScript, raises an important argument

SwitchMap in Typescript allows you to switch to a

When utilizing the useRef hook in Material-UI, an error may arise stating: "The property 'value' is not found on the type 'never'."

The 'Subscription' type does not contain the properties _isScalar, source, operator, lift, and several others that are found in the 'Observable<any>' type

What is causing the warnings for a functional TypeScript multidimensional array?

In ReactJS, the way to submit a form using OnChange is by utilizing the

Ionic 4's http.get.subscribe method fails to retain the retrieved value

The type 'Handles' does not contain the properties present in type 'TextInput'

Changes made to one order's information can impact the information of another order

Utilize React to display a Selected button within a whitespace

Tips for selecting objects based on property in Typescript?

Creating UI Bootstrap dropdowns using ng-repeat on the fly

NestJS Logger: Issue setting logger types in main.ts

Steps for determining if a string is compatible with a user-defined type in Typescript