serverless-operations/serverless-step-functions

Support for API Gateway WebSocket (WS) invocation

Open

#440 geöffnet am 27. Juni 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (954 Stars) (189 Forks)batch import
enhancementhelp wanted

Beschreibung

Hey there - first off, thanks for making this plugin!

Feature request

State machines currently cannot be not invoked by websocket events

stepFunctions:
  stateMachines:
    myMachine:
      events:
        - websocket:
            route: $connect

Note: Full reproduction here

Initially I thought this was a bug (no error during deployment) but it looks like this just isn't supported currently.

Would be nice to have event feature parity with lambda functions :crossed_fingers:

Contributor Guide

Tech Stack
javascriptnodejsaws
Domain
backendcloudapi
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Serverless FrameworkAWS Step FunctionsAPI Gateway WebSocket
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 plugin's event handling code, particularly how other events like http are implemented. Look at the serverless.yml parsing and the generation of CloudFormation resources. The issue suggests adding support for websocket events, similar to Lambda's websocket event. Check the plugin's source to see where events are processed and add websocket event type.