GoogleCloudPlatform / GoogleCloudPlatform/functions-framework-nodejs
Implicit Request interface extension causes error 'property rawBody does not exist on type'
- Lenguaje dominante
- TypeScript
- Estrellas
- 1.4k
- Forks
- 181
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Cloud functions implicitly extend express Request interface with rawBody (see https://github.com/GoogleCloudPlatform/functions-framework-nodejs/blob/master/src/invoker.ts#L44):
```ts
// We optionally annotate the express Request with a rawBody field.
// Express leaves the Express namespace open to allow merging of new fields.
declare global {
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace Express {
export interface Request {
rawBody?: Buffer;
}
}
}
```
I get error ` Property 'rawBody' does not exist on type 'Request'` when implement handler which uses Request.rawBody attribute like below:
```ts
import {Response, Request} from 'express';
export class HandlerClass{
public async http(request: Request, response: Response): Promise {
const body = request.rawBody;
...
}
}
```
As a workaround I have to create and use my own type instead of native Express Request:
```ts
import * as express from 'express';
export interface Request extends express.Request {
rawBody: Buffer;
}
```
If you have a look at the `firebase-functions` repository then you will see they use explicit extension of Request interface and then use it in code (https://github.com/firebase/firebase-functions/blob/master/src/providers/https.ts#L33)
I think `functions-framework-nodejs` should change implicit interface extension to explicit and provide stand-alone Request with rawBody attribute to avoid this workaround mess in depended applications code.
Guía de contribución
Línea de trabajo
Comienza con src/invoker.ts y compara su ampliación implícita de Express Request con la extensión explícita de Request utilizada en src/providers/https.ts de firebase-functions. Determina cómo debería exponer el framework rawBody a las aplicaciones TypeScript dependientes y, después, verifica que un handler que use el tipo Request proporcionado pueda acceder a request.rawBody sin una solución local alternativa.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- express, node.js, typescript
- Área
- api, backend
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100