serverless/serverless

WebsocketsDeployment doesn't respect custom resources.

Open

#8.434 geöffnet am 23. Okt. 2020

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (46.915 Stars) (5.734 Forks)batch import
bugcat/aws-event-websocketgood first issuehelp wanted

Beschreibung

I have custom integration API GW websockets - sqs, which requires to add few custom resources like

WSToSQSIntegration:
  Type: AWS::ApiGatewayV2::Integration
  Properties:
    ApiId:
      Ref: WebsocketsApi
      ....
WSToSQSRoute:
  Type: AWS::ApiGatewayV2::Route
  Properties:
    ApiId:
      Ref: WebsocketsApi
    RouteKey: "$default"
    AuthorizationType: NONE
    ....

Whenever any of those resource is changed after running sls deploy api not updates because WebsocketsDeployment{hash} stays the same.

The reason behind that in a way deployment id is built for websockets, hash of cloudformation part template without custom resources. https://github.com/serverless/serverless/blob/9c0f6461b73976958ebdd7e2762c6d1fbd469da1/lib/plugins/aws/package/compile/events/websockets/lib/deployment.js#L24-L30 where as for the rest api it just a simple new Date().getTime().toString(); which is instanceId https://github.com/serverless/serverless/blob/f93b27bf684d9a14b1e67ec554a7719ca3628135/lib/plugins/aws/package/compile/events/apiGateway/lib/deployment.js#L8-L10

Proposal is to replace hash part with same instanceId for websockets.

I'm ready to submit PR if maintainers give it a go. Thanks

Contributor Guide

Tech Stack
javascriptnodejsaws
Domain
backendclouddevops
Issue Type
bug
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
serverless frameworkAWS CloudFormationNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
Investigate the difference between WebSockets and REST API deployment hash generation. The fix involves replacing the hash computation in lib/plugins/aws/package/compile/events/websockets/lib/deployment.js with the same instanceId approach used in lib/plugins/aws/package/compile/events/apiGateway/lib/deployment.js. Ensure that custom resources are accounted for in the deployment hash. No linked PRs exist, so the solution can be implemented and tested.