[Bug]: T3 Connect doc gives the relay webhook path as /v1/hooks/:environmentId/..., but the relay routes on :endpointKey
维护者通常 1 天内回复
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 88/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- typescript
调研方向
编辑docs/internals/t3-connect.md第7–8行。先将路径与packages/contracts/src/relay.ts中的RELAY_HOOK_PATH以及apps/server/src/scheduledTasks/ScheduledTaskService.ts中的URL构造器进行比较;描述受管理隧道端点键,而不是环境ID。文档中的路径和标识符与实现一致时即为完成;relay和server测试是有用的检查,但应保持原样并通过。
由索引模型根据 Issue 内容生成。
描述
Before submitting
- I searched existing issues and did not find a duplicate.
- I included enough detail to reproduce or investigate the problem.
Area
Docs
Steps to reproduce
Summary: docs/internals/t3-connect.md says the relay forwards /v1/hooks/:environmentId/:hookId/:token to the environment's tunnel. The relay route and the server's URL builder both use a managed-tunnel endpoint key in that segment, not the environment ID, and the relay answers 404 hook_not_found when the environment ID is placed there. A reader who builds or debugs a relay webhook URL from this doc uses the wrong identifier and puts the environment ID into a URL that the code deliberately keeps it out of. The defect is limited to the documentation; webhook URLs the server hands out are correct.
- On
main, readdocs/internals/t3-connect.mdlines 7-8: "the relay forwards/v1/hooks/:environmentId/:hookId/:tokento the environment's tunnel". - Compare with the route the relay serves:
packages/contracts/src/relay.tsline 1245 definesconst RELAY_HOOK_PATH = "/v1/hooks/:endpointKey/:hookId/:token";. - Compare with the server's URL builder:
relayHookBaseUrlinapps/server/src/scheduledTasks/ScheduledTaskService.ts(about lines 80-95) builds${relayUrl}/v1/hooks/${endpointKey}, whereendpointKeyis the last-segment of the managed tunnel name and must match/^[0-9a-f]{16}$/. - Run the relay forwarder tests:
cd infra/relay && npx vp test run src/hooks/HookForwarder.test.ts. The case "returns 404 for unknown endpoints and unready endpoints" sendsPOST /v1/hooks/<environmentId>/hook-1/tokenand expects 404{"error":"hook_not_found"}. - Run the server webhook tests:
cd apps/server && npx vp test run src/scheduledTasks/ScheduledTaskService.webhook.test.ts. The case "builds the relay hook URL from the managed tunnel's key, never the environment id" expectshttps://relay.example.com/v1/hooks/0123456789abcdeffor a tunnel name ending in-0123456789abcdef.
Expected behavior
The T3 Connect internals doc should name the identifier the relay actually routes on: the managed endpoint key, the 16-hex hash suffix of the environment's managed tunnel name. The code states this design in infra/relay/src/deploymentConfig.ts: the key "covers user and environment, so one key names exactly one link, unlike the environment id, which any account can claim". relayHookBaseUrl's doc comment adds that "the URL never reveals the environment id".
Actual behavior
The doc names :environmentId as the first path parameter. Following it produces a URL the relay rejects: in a local run on main, HookForwarder.test.ts passed 26/26, including the case that confirms a request with the environment ID in the key slot gets 404 hook_not_found and is not forwarded. ScheduledTaskService.webhook.test.ts passed 32/32, including the case that confirms the server builds hook URLs from the tunnel key. On a running Nightly server (observation reported to me, not rerun for this report), a webhook task created with schedule_task returned a webhookUrl of the shape https://relay.t3.codes/v1/hooks/<16-hex key>/<url-encoded task id>/<token>; the 16-hex segment is not the environment ID, which is a UUID.
History: #15086 added the sentence when the route really was /v1/hooks/:environmentId/:hookId/:token. #15487 (commit f33b060caf) changed RELAY_HOOK_PATH to :endpointKey and rewrote the same doc sentence in the same commit, but kept :environmentId.
Evidence
- Expected source:
packages/contracts/src/relay.tsline 1245 (RELAY_HOOK_PATH),relayHookBaseUrlinapps/server/src/scheduledTasks/ScheduledTaskService.ts,resolveEndpointininfra/relay/src/hooks/HeldHooks.ts, and theMANAGED_ENDPOINT_KEY_PATTERNcomment ininfra/relay/src/deploymentConfig.ts. - Failure source:
docs/internals/t3-connect.mdlines 7-8. - Evidence provenance: observed
- Local verification: reproduced
- Reproduction completeness: complete
Primary violation evidence (observed): the :environmentId path in docs/internals/t3-connect.md lines 7-8, read on main against RELAY_HOOK_PATH, and the relay's 404 hook_not_found for an environment ID in that position in HookForwarder.test.ts, run locally. Both test suites are the project's own in-process harnesses, not a deployed relay. The live webhookUrl shape comes from the reported Nightly observation; no real key, token, task ID, or environment ID is included here.
Restoration check
Failing: docs/internals/t3-connect.md describes the relay hook path with :environmentId as its first parameter, which disagrees with RELAY_HOOK_PATH and with the 404 the relay returns for an environment ID in that position. Passing: the doc's hook path matches RELAY_HOOK_PATH (/v1/hooks/:endpointKey/:hookId/:token) and identifies the endpoint key as the managed tunnel's key rather than the environment ID, while the forwarder and webhook test suites above still pass unchanged.
Impact
Minor bug or occasional failure
Only an internals document is wrong; the relay, the server's URL builder, and the URLs handed to users agree with each other, so product behavior is unaffected. Following the doc gives a 404 hook_not_found for a hand-built URL and exposes an environment ID in a URL the design keeps it out of.
Version or commit
main @ 300f7f9d45ff19c01bc987dbf1c3bc3e9a3a59ee; also present in the latest nightly v0.0.46-nightly.20261007.2787. The latest stable release v0.0.45 predates relay webhook forwarding (neither #15086 nor #15487 is in it), so it is not affected.
Environment
Source inspection plus the repo's own tests: Node 22.23.2, vp test run (Vitest 5.0.1) after pnpm install --frozen-lockfile. Reported runtime observation: T3 Code Nightly 0.0.46-nightly.20261007.2774 server on macOS arm64.
Logs or stack traces
# infra/relay
npx vp test run src/hooks/HookForwarder.test.ts
Test Files 1 passed (1)
Tests 26 passed (26)
# apps/server
npx vp test run src/scheduledTasks/ScheduledTaskService.webhook.test.ts
Test Files 1 passed (1)
Tests 32 passed (32)
Screenshots, recordings, or supporting files
No response
Workaround
Use the webhookUrl the server returns for a webhook task, or read RELAY_HOOK_PATH in packages/contracts/src/relay.ts; both give the correct endpoint-key path.
- 主要语言
- TypeScript
- 星标
- 24.8k
- 派生
- 6.4k
- 平均合并
- 13 小时 9 分钟
- 30 天内合并 PR
- 271
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
pingdotgg/t3code 的其他 Issue
-
bug via-triage
难度 2/5 1-3 小时 新手友好度 62/100
pingdotgg/t3code#17157 · 1 条评论 ·
维护者通常 1 天内回复
-
[Bug]: Local environment can't be turned back on once disabled (toggle hidden behind "No environment selected")可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭bug via-triage
难度 2/5 1-3 小时 新手友好度 76/100
pingdotgg/t3code#17013 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
[Bug]: T3 Connect doc says held webhooks are kept per environment, but the relay keeps one inbox per link可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭documentation via-triage
难度 1/5 1-3 小时 新手友好度 83/100
pingdotgg/t3code#16995 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
bug via-triage
难度 2/5 1-3 小时 新手友好度 79/100
pingdotgg/t3code#16881 · 1 条评论 ·
维护者通常 1 天内回复
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 85/100
lukilabs/beautiful-mermaid#160 ·
-
难度 2/5 1-3 小时 新手友好度 66/100
rescript-lang/rescript-lang.org#1420 ·
维护者通常 2 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 82/100
chthollyphile/folia-major#520 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
databuddy-analytics/Databuddy#1106 ·
维护者通常 1 天内回复