Websocket Support for API Gateway

[nicosuave]

Describe your idea/feature/enhancement

As per the announcement of WebSocket support in API Gateway, adding WebSocket support to SAM would facilitate local development.

Proposal

Add WebSocket support to API Gateway functionality.

This may be entirely out of scope of the SAM project, but came to mind when initially exploring API Gateway with WebSocket support.

[abbottdev]

I think this would be extremely useful, if you're using the websocket endpoints as a consumer and not http then you're not testing what you're deploying. 👍

[redtopia]

I just started researching API Gateway Websockets and was about to dive into some test code. I was planning to do some testing using HTTP endpoints, but now I'm wondering if this is even possible. Any ideas?

[alexandrecanuto]

I'd love to see that as well.

[kauphylover]

We'd love to see this supported in SAM asap.

[virtuoushub]

It looks like it is? https://github.com/aws-samples/simple-websockets-chat-app

See:

• https://github.com/aws-samples/simple-websockets-chat-app#aws-cli-commands
• https://github.com/aws-samples/simple-websockets-chat-app/blob/master/template.yaml#L20-L25

[redtopia]

@virtuoushub I'm not 100% sure, but I think that can only be packaged and deployed using the sam cli, but not actually run.

[virtuoushub]

@redtopia ah, I think you are correct. I have successfully packaged and deployed; but running locally I have not tested. Thanks for clarifying.

[kellengreen]

That example is only for packaging and deploying. API Gateway websocket support for localhost is still lacking in SAM.

[0num4]

I want this. XD

[timveletta]

👍

[anhdt-eas]

Please help asap.

[thomasrepnik]

Would love to see this feature, because my application relies heavily on websockets. This would make the local development/testing much easier.

[goldsam]

My company would really benefit from the ability to do local websocket testing

[mike-tedford]

+1

We will need this for local development on our new application which may use web sockets. Please update soon

[ghost]

+1
Any progress on this proposal?

[agarbutt]

This continues to be a big gap in this tooling. Yes, it seems that engineers can make do by creating a test stage. However, it really makes testing a bit more of a challenge, as developers, need to deploy their stacks to an account prior to testing. I would prefer to leverage a continuous build, test, integrate, deploy pipeline to keep my feedback cycles short and quick. The lack of support within the sam tool to execute a lambda function via a wss:// or ws:// local endpoint is prohibitive.

[592da]

any progress ?

[abbottdev]

Can we get an update here?

[v-y-a-s]

I think this would really help. Also, there is no way to test custom authorizer locally.

connect: handler: handler.connect events: - websocket: route: $connect # authorizers are only for connect routes authorizer: name: auth identitySource: - 'route.request.header.Auth'

Having the auth function deployed, the checks do happen, but there is now way to test it locally as such. Took me a while to figure this out.

Another main issue, not having any means to hot reload as code is being changed. This really hurts

[djdenv]

Following. Would really be ideal to have this feature in SAM...

[MatteoGioioso]

Any update on this?

[elembie]

+1 Following for an update

[mwalker638]

+1 - would like to see when released.

[barmag]

+1 I hope this is implemented soon. My use case is end-to-end testing of asynchronous application

[JohnRudolfLewis]

+1 Please add this feature

[danballance]

+1 this feature would be extremely useful.

[spankyed]

+1 Idek what sam is but I need my websockets local. Thanks.

[praneetap]

Thanks for sending this pull request. We are hesitant to merge this today because with the current resources we would not be able to commit to maintaining this feature in the long run - maintain feature parity and fix issues with the implementation in a timely manner. Given the reaction we can see that this is important to the community and we recommend one of the two alternatives -

1. We highly recommend you to use SAM Accelerate to test this in your development environment in the cloud. Here is a helpful video to learn more about it, and here is the installation instructions for the beta version. Please let us know if this helps with your testing needs.
2. If testing in the cloud is not an option for you, we are considering adding plugin support if there is enough interest. Upvote and comment on this tracking issue, if building this as a plugin would be something you would be interested in instead.

[theimowski]

FWIW I tried to run SAM Accelerate with the sample WS API Gateway provided by AWS team, but it failed. Details here: #3459

[lfbertucci]

+1 Following

[seanieb]

I honestly can't believe that AWS would ship WebSockets for a API gateway and have not support local development. It's tacitly saying that if you want to use AWS you'll need to have individual Accounts for development. The cost and speed implications for such a policy will result in AWS's loss of developers.

[tim-koehler]

Is there still no official or unofficial solution for local development!?

[netleafdev]

Is there still no official or unofficial solution for local development!?

Perhaps it's because they insist on hiring only people who can pass their cringe requirements for leetcode that require a month or more of full-time studying only students or recent grads have time for, covering questions which have almost no usefulness in real-world scenarios that aren't easy to google the solution for. And, after working there for a year or two, those same people leave for more lucrative positions that also have this requirement. Before they even reach a senior level tenure for most of us, they already have enough cash to retire. It leaves the most experienced people to just stop applying after a while, hence the large number of open senior/leadership positions across FAANG, half of which are labeled urgent yet remain there for months.

Solution? Have a leetcode OR seniority/experience + project assignment & presentation/defense instead. If I were a hiring manager there, I'd hire on the spot anyone who can successfully implement this issue. Will that happen? No. So let's buckle up to be ignored.

[praneetap]

FWIW I tried to run SAM Accelerate with the sample WS API Gateway provided by AWS team, but it failed. Details here: #3459

@theimowski This should be fixed. Please let us know if you have any more feedback for us on Accelerate!

[boblund]

I've recently created a github repo that I use to locally test my AWS websocket work. It also supports local testing of S3 static websites and apis served by API Gateway.

[jfuss]

Thank you for the interest. To support this today in cloud, you can use sam sync. We are still exploring a Plugin based solution for local development to allow the community to enable/extend features like this. Give that, we are closing this in favor of the Plugins tracking issue: #3265

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[heaven-born]

why close this ticket in favor of the Plugins tracking issue if the Plugins don't solve the issue automatically? There must be someone who will create the plugin at least.

SAM Accelerate doesn't solve the issue for all cases either, so this ticket is basically closed with no resolution.

[goldsam]

I've been waiting over three years! REOPEN THIS TICKET!

[redtopia]

@jfuss it seems that there is interest in making this feature available. I can tell you that the ONLY reason why I am not using websockets on AWS is because I have no way to get them to work in local development environments.

[satokenta940]

Is it currently stagnant? I think it is necessary to support Websocket.

[goldsam]

Hey AWS - Perhaps you haven't noticed, but Azure has been gaining a lot of ground on you lately. Perhaps this is in part due to their robust tooling offerings? 😮

[brazilianbytes]

Hi everyone,

Late this month, I came here to confirm this lack of feature, but I tried to make this work until SAM fixed the issue. Please check my guide: https://medium.com/solutions-architect-rocks/java-websockets-powered-by-aws-lambda-8cd974024030