serverless-operations/serverless-step-functions

Support for API Gateway WebSocket (WS) invocation

Open

#440 opened on Jun 27, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (189 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (954 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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

Research direction
Study how websocket events are handled in the Serverless Framework for Lambda functions, then explore the plugin's event handling code to integrate websocket support for state machines. Look at the plugin's existing event types (e.g., http, schedule) as a reference pattern.
Tech stack
javascriptnodejs
Domain
backendapicloud
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Serverless FrameworkAWS Step Functions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60