[Documentation] GraphQL rate limit guard source code gives an error

[Rafat97]

I'm submitting a...

• [ ] Regression
• [ ] Bug report
• [ ] Feature request
• [x] Documentation issue or request (new chapter/page)
• [ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Docs link

https://docs.nestjs.com/security/rate-limiting#graphql

Current Code

@Injectable()
export class GqlThrottlerGuard extends ThrottlerGuard {
  getRequestResponse(context: ExecutionContext) {
    const gqlCtx = GqlExecutionContext.create(context);
    const ctx = gqlCtx.getContext();
    return { req: ctx.req, res: ctx.res };
  }
}

Error Message:

TypeError: Cannot read properties of undefined (reading 'header') at GqlThrottlerGuard.handleRequest (C:\Users\User\Documents\GitHub\erp\node_modules\@nestjs\throttler\src\throttler.guard.ts:89:9) at processTicksAndRejections (node:internal/process/task_queues:96:5)

Minimal reproduction of the problem with instructions

https://stackblitz.com/edit/nestjs-typescript-starter-evkpln?file=src/config/config.module.ts

What is the motivation / use case for changing the behavior?

Code will be

@Injectable()
export class GqlThrottlerGuard extends ThrottlerGuard {
  getRequestResponse(context: ExecutionContext) {
    const gqlCtx = GqlExecutionContext.create(context);
    const ctx = gqlCtx.getContext();
    return { req: ctx.req, res: ctx.req.res };
  }
}

Environment

For Tooling issues:

• Node version: v16

• Platform: Windows

Others:

[jmcdo29]

Please provide a minimum reproduction repository (Git repository/StackBlitz/CodeSandbox project).

why reproductions are required

[Rafat97]

Please provide a minimum reproduction repository (Git repository/StackBlitz/CodeSandbox project).

why reproductions are required

https://stackblitz.com/edit/nestjs-typescript-starter-evkpln?file=src/config/config.module.ts

Error In the console

Solution

[Rafat97]

Can I update documentation? @jmcdo29

[jmcdo29]

Rather than accessing ctx.req.res you should be able to set the gql context option to be context: ({ req, res }) => ({ req, res }) and get the current solution that the docs show

[Rafat97]

Rather than accessing ctx.req.res you should be able to set the gql context option to be context: ({ req, res }) => ({ req, res }) and get the current solution that the docs show

May be we should mention this here. Or we can create an example.

What do you think @jmcdo29?