Resolve #2752: Correct WebSocket room injection and backpressure docs#2764
Merged
ayden94 merged 1 commit intoJul 14, 2026
Merged
Conversation
WebSocket room examples injected the type-only WebSocketRoomService contract without a runtime DI token, so the documented pattern failed DI. Cross-runtime room broadcast documentation also promised backpressure behavior that only the Node.js-backed adapter implements. - book/intermediate/ch13-websockets(.ko).md: inject WebSocketGatewayLifecycleService via @Inject(...) and type the parameter as WebSocketRoomService; limit backpressure claims to the Node.js-backed adapter. - packages/websockets/README(.ko).md: same injection token and backpressure runtime limit corrections in the Rooms section. - docs/getting-started/migrate-from-nestjs(.ko).md: state the injection token and backpressure runtime limit in the WebSocket migration bullet. - docs/CONTEXT(.ko).md, docs/reference/package-surface(.ko).md: mirror the injection token and backpressure runtime limit in discoverability summaries. - tooling/governance/verify-platform-consistency-governance.mjs: extend the contract companion comment to cover the new WebSocket room injection token and backpressure runtime limit discoverability. - tooling/governance/websocket-room-injection-backpressure-discoverability.test.ts: regression test asserting the injection token and backpressure runtime limit stay documented across governed English and Korean docs.
ayden94
deleted the
issue-2752-correct-websocket-room-injection-backpressure-docs
branch
July 14, 2026 01:33
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
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.
Summary
Linked context: #2752 —
[audit][area:protocol-adapters] Correct WebSocket room injection and backpressure documentation (priority:p2).WebSocket room examples injected the type-only
WebSocketRoomServicecontract without a runtime DI token, so the documented pattern failed DI. Cross-runtime room broadcast documentation also promised backpressure behavior that only the Node.js-backed adapter implements.Changes
book/intermediate/ch13-websockets.md/.ko.md(Section 13.5): injectWebSocketGatewayLifecycleServicevia@Inject(...)and type the constructor parameter asWebSocketRoomService; limit backpressure claims to the Node.js-backed adapter and state that fetch-style runtimes do not apply a backpressure policy to room broadcasts. Summary bullet updated to mention the injection token.packages/websockets/README.md/.ko.md(Rooms section): same injection token and backpressure runtime limit corrections.docs/getting-started/migrate-from-nestjs.md/.ko.md: state the injection token and backpressure runtime limit in the WebSocket migration bullet.docs/CONTEXT.md/.ko.md,docs/reference/package-surface.md/.ko.md: mirror the injection token and backpressure runtime limit in discoverability summaries.tooling/governance/verify-platform-consistency-governance.mjs: extend the contract companion comment to cover the new WebSocket room injection token and backpressure runtime limit discoverability.tooling/governance/websocket-room-injection-backpressure-discoverability.test.ts: regression test asserting the injection token and backpressure runtime limit stay documented across governed English and Korean docs.Testing
pnpm docs:sync-check— passed (42 en/ko page pairs, 10 navigation metadata pairs).pnpm verify:platform-consistency-governance— passed.pnpm exec vitest run tooling/governance/websocket-room-injection-backpressure-discoverability.test.ts— 2 tests passed.pnpm exec vitest run tooling/governance/verify-platform-consistency-governance.test.ts— 102 tests passed.pnpm exec vitest run packages/websockets/src/public-surface.test.ts— 6 tests passed.Release impact
Docs-only change. No public
@fluojs/*package behavior, API surface, package contents, or release metadata changed.Public export documentation
@param/@returnstags where applicable.@exampleblocks and README scenario examples still play complementary roles.해당 없음 — no public exports under
packages/*/srcchanged.Behavioral contract
The corrected room injection token and backpressure runtime limit are now documented as intentional limitations: fetch-style runtimes do not apply a backpressure policy to room broadcasts, and
WebSocketRoomServiceis a type-only contract that must be injected via the lifecycle service token. The regression test intooling/governance/websocket-room-injection-backpressure-discoverability.test.tskeeps these facts aligned across governed docs.Platform consistency governance (SSOT)
pnpm docs:sync-checkandpnpm verify:platform-consistency-governancepass. The governance script comment block and the new regression test are the CI/tooling and regression-test companions for this contract-governing doc update.Closes #2752