CodeGenieApp / CodeGenieApp/serverless-express

Route path routes to null when rawPath is empty from API Gateway

Aperta
#612 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
5.3k
Fork
676
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

When using API Gateway (v2 payload) with a custom domain and base path mapping, for example `api.example.com/v1`, where api.example.com is the custom domain and v1 is the base path, API Gateway will route the request to the lambda regardless of a trailing forward slash. For example `api.example.com/v1` or `api.example.com/v1/` will route to the lambda.

The issue with this is that when the trailing forward slash is missing, the lambda payload will contain a raw path that is empty:
```js
{
version: '2.0',
routeKey: '$default',
rawPath: '',
rawQueryString: ''
...
}
```

When using an express app with the serverless-express library, this results in a 404 response from the express app and a body containing the text `Cannot GET null`.

I'm not sure if this is an issue with express or serverless-express, but a workaround could be to place a default value in `function getRequestValuesFromApiGatewayEvent({ event })` to prevent this from happening. For example, line 13 of `event-sources/aws/api-gateway-v2.js` could be changed from:
```js
const requestPathOrRawPath = requestPath || rawPath
```
**to:**
```js
const requestPathOrRawPath = requestPath || rawPath || '/'
```

It sees most logical that both `api.example.com/v1` or `api.example.com/v1/` route to the same location. In my case I have a health check route at '/':
```js
app.all('/', (req: Request, res: Response) => {
res.send({
// Health check stats
})
})
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da event-sources/aws/api-gateway-v2.js, in particolare da getRequestValuesFromApiGatewayEvent e dall'assegnazione di requestPathOrRawPath. Verifica come un evento API Gateway v2 con un rawPath vuoto viene convertito nel percorso della richiesta Express; il lavoro è completato quando le richieste con e senza la barra finale vengono risolte nel percorso radice invece di produrre Cannot GET null.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
aws, express, javascript, nodejs
Ambito
api, backend
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
52/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.