docs(server): update transport attachment and HTTP timing examples - #128
Merged
Conversation
jikkai
approved these changes
Sep 10, 2026
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.
The Server SDK Quick Start and module assembly still wire HTTP requests and WebSocket upgrades manually. Use
transport.attach(server)and add an HTTP duration example that records the matchedcontext.route?.pathwhen the response finishes, including authentication rejections asunmatched.Update Quick Start, module boundaries, and Middleware and Events across all eight supported locales (24 MDX files). Preserve the new repository’s page structure and links. This carries forward https://github.com/dream-num/office.univer.ai/pull/12 into the Server SDK section.
Release verification
@univerjs-pro/collaboration-transport-node@1.0.0-rc.0was published to the public npm registry on September 11, 2026 at 07:18:01 UTC (15:18:01 Asia/Shanghai), under thercdist-tag. The published package exportsINodeTransport.attach(server),NodeHttpTransportContext.route, andNodeRoute.path, satisfying the API release conditions for these examples. The currentdevrequirements page already targets1.0.0-rc.0. Thelatestandbetadist-tags still point to1.0.0-beta.2; consumers need the documented RC version.Route metadata originated in https://github.com/dream-num/univer-collaboration-sdk/pull/58 and attachment in https://github.com/dream-num/univer-collaboration-sdk/commit/7ca22fc6690eaae91c6f128ac04224d3ffb989d0.
Validation
git diff --checkpassed.pnpm lintpassed with warnings in unchanged files.pnpm typecheckfailed in unchanged framework examples and Showcase code: missing Angular/Vue/Vite dependencies, TS5097 import-extension errors, and Board connector label type mismatches.pnpm buildcompiled successfully, but the full build did not complete. Static generation used 9 workers for 11,997 pages, encountered agent-documentation timeouts, and the build exited with SIGTERM after the user reported memory exhaustion. Do not treat this as a passing production build.Typecheck Showcase: unchanged Board examples reference unsupportedlineBreakandtextfields (connector-routing/code/data.ts:101andsearch-element-query/code/data.ts:48).