Support API Gateway websocket api via LambdaServer by wiowou · Pull Request #1804 · aws/aws-lambda-dotnet

wiowou · 2024-09-05T01:46:30Z

Issue #, if available:

Description of changes:
Added a websocket option to the Amazon.Lambda.AspNetCoreServer project so that API Gateway websocket api's can also use the LambdaServer (DI, controllers, etc) given the user does the following:

References the same lambda to handle the RouteKeys in API Gateway for which they have controller routes set up.
Sets up controller routes as POST with path=RouteKey

Unit tests are passing.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

bhoradc · 2024-09-27T14:03:39Z

Hi @wiowou,

Thank you for contributing the PR. Our team will review it and get back to you as soon we can.

Regards,
Chaitanya

wiowou · 2024-09-30T00:22:54Z

Thank you, @bhoradc !

-Behram

Sync dev and main

* doc: update readme to point at changelog correctly (aws#2243) * Bump tj-actions/changed-files from 47.0.0 to 47.0.1 (aws#2239) Bumps [tj-actions/changed-files](https://github.com/tj-actions/changed-files) from 47.0.0 to 47.0.1. - [Release notes](https://github.com/tj-actions/changed-files/releases) - [Changelog](https://github.com/tj-actions/changed-files/blob/main/HISTORY.md) - [Commits](tj-actions/changed-files@24d32ff...e002140) --- updated-dependencies: - dependency-name: tj-actions/changed-files dependency-version: 47.0.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump aws-actions/configure-aws-credentials from 5.0.0 to 5.1.1 (aws#2238) Bumps [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) from 5.0.0 to 5.1.1. - [Release notes](https://github.com/aws-actions/configure-aws-credentials/releases) - [Changelog](https://github.com/aws-actions/configure-aws-credentials/blob/main/CHANGELOG.md) - [Commits](aws-actions/configure-aws-credentials@a03048d...61815dc) --- updated-dependencies: - dependency-name: aws-actions/configure-aws-credentials dependency-version: 5.1.1 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add grouping for GitHub Actions updates (aws#2247) Group all GitHub Actions updates into a single PR. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Samuel <sam.r.c@hotmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

chore: Daily ASP.NET Core version update in Dockerfiles

Update Lambda Runtime Images for NET 11 (aws#2302)

Merge dev to master

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds support for API Gateway WebSocket API events to be processed through Amazon.Lambda.AspNetCoreServer so WebSocket RouteKeys can be routed into ASP.NET Core controllers / DI via LambdaServer.

Changes:

Introduces APIGatewayWebsocketApiProxyFunction (and typed TStartup variant) to translate WebSocket events into ASP.NET Core requests (POST + path from RouteKey).
Refactors APIGatewayProxyFunction to allow overriding HTTP path/method/header derivation and adds ConnectionId propagation.
Adds a test web app controller + request fixture + unit test validating routing/serialization behavior.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
Libraries/test/TestWebApp/WebsocketApiLambdaFunction.cs	Adds a test Lambda entrypoint using the new WebSocket proxy base class.
Libraries/test/TestWebApp/Controllers/RouteKeyController.cs	Adds a controller route simulating API Gateway `RouteKey` routing via POST.
Libraries/test/Amazon.Lambda.AspNetCoreServer.Test/values-post-withbody-websocketapi-request.json	Adds a sample WebSocket event payload fixture for tests.
Libraries/test/Amazon.Lambda.AspNetCoreServer.Test/TestApiGatewayWebsocketApiCalls.cs	Adds a unit test invoking the WebSocket proxy function end-to-end.
Libraries/test/Amazon.Lambda.AspNetCoreServer.Test/Amazon.Lambda.AspNetCoreServer.Test.sln	Adds a solution file for the test project.
Libraries/src/Amazon.Lambda.AspNetCoreServer/APIGatewayWebsocketApiProxyFunction{TStartup}.cs	Adds the typed Startup variant for WebSocket proxy functions.
Libraries/src/Amazon.Lambda.AspNetCoreServer/APIGatewayWebsocketApiProxyFunction.cs	Adds the WebSocket proxy implementation (path/method/headers).
Libraries/src/Amazon.Lambda.AspNetCoreServer/APIGatewayProxyFunction.cs	Refactors request marshalling to use overridable parsing hooks; propagates ConnectionId.
Libraries/src/Amazon.Lambda.AspNetCoreServer.Hosting/ServiceCollectionExtensions.cs	Adds new `LambdaEventSource.WebsocketApi` wiring to runtime server selection.
Libraries/src/Amazon.Lambda.AspNetCoreServer.Hosting/Internal/LambdaRuntimeSupportServer.cs	Adds runtime support server for WebSocket API Minimal API hosting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

GarrettBeatty · 2026-05-14T02:20:29Z

hi thanks for the pr. can you rebase it on top of dev branch and change the target branch to dev please?

wiowou · 2026-05-15T00:20:54Z

hi @GarrettBeatty - rebased to dev. It's been over a year since I've looked at this code and the tests for the websocket api are fairly simple. I don't know that I can do a real test of this anytime soon (as I did back then), since much of my setup and access has changed significantly. FYI, I'm piggy-backing off the APIGatewayHttpApiV2ProxyRequest and APIGatewayHttpApiV2ProxyResponse events.

The websocket runtime-support server was wired to the v2 APIGatewayHttpApiV2ProxyFunction handler with v2 request/response types, so AddAWSLambdaHosting(LambdaEventSource.WebsocketApi) never ran the websocket-specific path/method/header overrides and dropped fields like ConnectionId. Switch it to the v1 APIGatewayWebsocketApiProxyFunction flow and have the websocket MinimalApi inherit from the REST one, overriding only the three websocket virtuals. Tighten doc comments on the new types and on ParseHttpPath/ParseHttpMethod/AddMissingRequestHeaders, and remove the stray test .sln (the project builds via the existing .csproj from Libraries.sln).

GarrettBeatty · 2026-05-15T01:24:46Z

i cleaned up the pr and made some small adjustments (i think there was a bug). 26b9cd0

Records the public-API addition of APIGatewayWebsocketApiProxyFunction + LambdaEventSource.WebsocketApi as a Minor bump on Amazon.Lambda.AspNetCoreServer and Amazon.Lambda.AspNetCoreServer.Hosting.

GarrettBeatty · 2026-05-15T01:30:15Z

https://github.com/aws/aws-lambda-dotnet/actions/runs/25895285353

GarrettBeatty · 2026-05-15T01:58:59Z

i deployed some test function and connected via websocket and confirmed i see stuff in the logs


  WS-ROUTE route=$connect    connId=dYiMndS4oAMCIjg=
  WS-ROUTE route=$default    connId=dYiMndS4oAMCIjg= body={"action":"$default","msg":"hello from smoke test"}

so it seems to work

philasmar · 2026-05-15T15:28:06Z

+        protected override HandlerWrapper CreateHandlerWrapper(IServiceProvider serviceProvider)
+        {
+            var handler = new APIGatewayWebsocketMinimalApi(serviceProvider);
+#pragma warning disable CA2252


why do we need this?

46dc956#diff-dec0ad4ae2f92f72fd5cabb763659b9a222002446a2e7fb9c77120d231c18d88R363 from the response streaming pr

wiowou · 2026-05-16T00:03:28Z

@GarrettBeatty Thank you so much! I see the correct events were actually APIGatewayProxyRequest/Response ...was that the bug (dropping attributes) or was there more?

Support API Gateway websocket api via LambdaServer

25c0c33

muhammad-othman requested review from normj and philasmar September 6, 2024 17:26

philasmar and others added 25 commits December 15, 2025 13:41

Merge pull request aws#2229 from aws/dev

1f5717a

Sync dev and main

update permissions (aws#2231) (aws#2232)

ad0ebab

Merge branch 'dev'

1dbfbf2

Merge branch 'dev'

a4310dc

Merge branch 'dev'

3f6de4a

Merge pull request aws#2258 from aws/dev

fd18ef2

chore: Daily ASP.NET Core version update in Dockerfiles

Merge branch 'dev'

6e7c60b

Merge branch 'dev'

15145bf

Merge branch 'dev'

bc0c745

Merge branch 'dev'

281133d

Merge branch 'dev'

e61e9a5

Merge branch 'dev'

3af4abf

Merge branch 'dev'

c28fcfa

Merge pull request aws#2296 from aws/dev

f3cf8cc

Merge pull request aws#2307 from aws/dev

dc91547

Update Lambda Runtime Images for NET 11 (aws#2302)

Merge branch 'dev'

a5b74f6

Merge branch 'dev'

52d0de4

Merge branch 'dev'

cb78042

Merge branch 'dev'

64a47bb

Merge branch 'dev'

e9d0d74

Merge pull request aws#2334 from aws/dev

caea55b

Merge dev to master

Merge branch 'dev'

5820339

Merge branch 'dev'

ffa4585

Merge branch 'dev'

35b2e8f

aws-sdk-dotnet-automation added 3 commits April 29, 2026 17:33

Merge branch 'dev'

c63d743

Merge branch 'dev'

dfbb7ac

Merge branch 'dev'

5de51e0

GarrettBeatty requested a review from Copilot May 12, 2026 18:59

Copilot AI reviewed May 12, 2026

View reviewed changes

Copilot started reviewing on behalf of GarrettBeatty May 12, 2026 19:20 View session

pr fixes: api gateway websocket api

40cdd7f

wiowou requested review from a team as code owners May 13, 2026 00:54

bk-play added 3 commits May 12, 2026 21:26

fixed merge conflict. Logical changes remain

4c22317

fix lambda runtime support server

0fc8136

simplify calls

5ad44ab

pr fixes: api gateway websocket api

acd15d7

GarrettBeatty changed the base branch from master to dev May 15, 2026 00:55

GarrettBeatty changed the base branch from dev to master May 15, 2026 00:55

Merge branch 'dev' into websocket

89a6b33

GarrettBeatty changed the base branch from master to dev May 15, 2026 00:57

github-advanced-security AI found potential problems May 15, 2026

View reviewed changes

Comment thread Libraries/test/TestWebApp/Controllers/RouteKeyController.cs Dismissed

Add autover change file for websocket support

05ae11c

Records the public-API addition of APIGatewayWebsocketApiProxyFunction + LambdaEventSource.WebsocketApi as a Minor bump on Amazon.Lambda.AspNetCoreServer and Amazon.Lambda.AspNetCoreServer.Hosting.

GarrettBeatty approved these changes May 15, 2026

View reviewed changes

philasmar reviewed May 15, 2026

View reviewed changes

philasmar approved these changes May 15, 2026

View reviewed changes

GarrettBeatty merged commit 44ba589 into aws:dev May 15, 2026
4 of 6 checks passed

Conversation

wiowou commented Sep 5, 2024

Uh oh!

bhoradc commented Sep 27, 2024

Uh oh!

wiowou commented Sep 30, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GarrettBeatty commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wiowou commented May 15, 2026

Uh oh!

GarrettBeatty commented May 15, 2026

Uh oh!

Uh oh!

GarrettBeatty commented May 15, 2026

Uh oh!

GarrettBeatty commented May 15, 2026

Uh oh!

philasmar May 15, 2026

Choose a reason for hiding this comment

Uh oh!

GarrettBeatty May 15, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wiowou commented May 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

GarrettBeatty commented May 14, 2026 •

edited

Loading