Skip to content

docs(server): update transport attachment and HTTP timing examples - #128

Merged
OTime-Coder merged 1 commit into
devfrom
codex/transport-route-docs
Sep 11, 2026
Merged

docs(server): update transport attachment and HTTP timing examples#128
OTime-Coder merged 1 commit into
devfrom
codex/transport-route-docs

Conversation

@OTime-Coder

@OTime-Coder OTime-Coder commented Sep 10, 2026

Copy link
Copy Markdown
Member

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 matched context.route?.path when the response finishes, including authentication rejections as unmatched.

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.0 was published to the public npm registry on September 11, 2026 at 07:18:01 UTC (15:18:01 Asia/Shanghai), under the rc dist-tag. The published package exports INodeTransport.attach(server), NodeHttpTransportContext.route, and NodeRoute.path, satisfying the API release conditions for these examples. The current dev requirements page already targets 1.0.0-rc.0. The latest and beta dist-tags still point to 1.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

  • Installed the frozen lockfile with Node.js 24.14.0 and pnpm 12.3.4.
  • git diff --check passed.
  • MDX compilation passed for all 24 changed pages.
  • Confirmed the changed code examples match across all eight locales and all existing Markdown links are preserved.
  • pnpm lint passed with warnings in unchanged files.
  • pnpm typecheck failed in unchanged framework examples and Showcase code: missing Angular/Vue/Vite dependencies, TS5097 import-extension errors, and Board connector label type mismatches.
  • pnpm build compiled 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.
  • GitHub CI failed at Typecheck Showcase: unchanged Board examples reference unsupported lineBreak and text fields (connector-routing/code/data.ts:101 and search-element-query/code/data.ts:48).

@OTime-Coder
OTime-Coder requested a review from jikkai September 10, 2026 12:32
@OTime-Coder
OTime-Coder marked this pull request as ready for review September 11, 2026 07:53
@OTime-Coder
OTime-Coder merged commit f45dd88 into dev Sep 11, 2026
0 of 2 checks passed
@OTime-Coder
OTime-Coder deleted the codex/transport-route-docs branch September 11, 2026 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants