feat(server-sdk): expose ingress enabled option on createIngress/updateIngress#692
Open
stefanking-difference wants to merge 1 commit into
Open
Conversation
…ress The `enabled` field already exists on the protobuf CreateIngressRequest/UpdateIngressRequest (protocol#935) and is enforced by the ingress service (ingress#319), but was not surfaced through the typed CreateIngressOptions/UpdateIngressOptions, so callers had to send it via raw Twirp. Expose it in both option types and map it into the requests. Setting enabled=false rejects new connection attempts while preserving the stream key.
🦋 Changeset detectedLatest commit: 4b0e227 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds an
enabled?: booleanoption toCreateIngressOptionsandUpdateIngressOptions, and maps it into the underlyingCreateIngressRequest/UpdateIngressRequest.Why
The
enabledfield already exists on the protobuf messages (added in livekit/protocol#935) and is enforced by the ingress service (livekit/ingress#319), but the Node server SDK never surfaced it through the typed options. To disable an ingress session without deleting it — so the stream key survives — callers currently have to bypass the SDK and send a raw TwirpUpdateIngress(or use thelkCLI). This closes that gap soenabledis settable through the normal typed API, mirroring howenableTranscodingis handled.Suggested by LiveKit's Developer Solutions Engineer in a support thread about non-destructive ingress disabling.
Changes
CreateIngressOptions.enabled?: boolean+ mapped intoCreateIngressRequestUpdateIngressOptions.enabled?: boolean+ mapped intoUpdateIngressRequestTesting
pnpm --filter livekit-server-sdk build— clean (declaration emit;enabledtype-checks against@livekit/protocol@1.48.0)pnpm --filter livekit-server-sdk test— 12/12 passing--checkand eslint clean on the changed file