Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] (type-safe-api) WebSocket API support for Python #741

Open
1 of 11 tasks
cogwirrel opened this issue Mar 28, 2024 · 3 comments
Open
1 of 11 tasks

[FEATURE] (type-safe-api) WebSocket API support for Python #741

cogwirrel opened this issue Mar 28, 2024 · 3 comments
Labels

Comments

@cogwirrel
Copy link
Member

cogwirrel commented Mar 28, 2024

Describe the feature

Add support for WebSocket APIs in Python

Use Case

Consistency with remainder of PDK

Proposed Solution

Need to add the following:

  • Runtime: operation handler wrappers
  • Runtime: @connect/@disconnect handler wrappers
  • Runtime: interceptors
  • Runtime: server sdk (wrapping API Gateway Management API SDK)
  • Infrastructure
  • Handler stubs
  • @connect/@disconnect handler stubs
  • WebSocket client library
  • Integration with InfrastructurePyProject

Other Information

The majority of scaffolding is there already for runtime/handlers/infra - the mustache templates for the python-async-xxx projects in packages/type-safe-api/scripts/generators are copy/pasted REST API implementations that need to be modified to work for websockets.

The projen projects (eg generated-python-async-runtime-project.ts) will likely need to be tweaked slightly to add any dependencies required.

The client library will need to be added - follow the same pattern as the TypeScript websocket client library.

Make sure to remove the validation check once implemented:

runtimeLanguages.includes(Language.PYTHON)

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

PDK version used

0.23.26

What languages will this feature affect?

Python

Environment details (OS name and version, etc.)

OSX

@cogwirrel cogwirrel added feature-request New feature or request needs-triage labels Mar 28, 2024
Copy link

github-actions bot commented Jun 3, 2024

This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

@github-actions github-actions bot added the stale label Jun 3, 2024
Copy link

Closing this issue as it hasn't seen activity for a while. Please add a comment @mentioning a maintainer to reopen. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

@cogwirrel cogwirrel reopened this Sep 17, 2024
Copy link

Closing this issue as it hasn't seen activity for a while. Please add a comment @mentioning a maintainer to reopen. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

@cogwirrel cogwirrel reopened this Sep 30, 2024
@github-actions github-actions bot removed the stale label Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant