Skip to content

fix(app-shell): 让 spec-symbol-parity 的「编译期」断言真的被 CI 编译 (#3181) - #3187

Merged
os-zhuang merged 1 commit into
mainfrom
claude/issue-3181-typetests-gate
Aug 2, 2026
Merged

fix(app-shell): 让 spec-symbol-parity 的「编译期」断言真的被 CI 编译 (#3181)#3187
os-zhuang merged 1 commit into
mainfrom
claude/issue-3181-typetests-gate

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Fixes #3181

注:正文里的泛型都在 < 后带一个空格(Assert< Equal< 1, 2 > >)。GitHub 的 sanitizer 会把 < 紧跟字母的片段当成标签吃掉,加空格才能存活。

问题

packages/app-shell/src/__tests__/spec-symbol-parity.test.ts 里那些 type _X = Assert< Equal< A, B > > 从来没有被任何编译器读过:

  • packages/app-shell/tsconfig.json构建配置,exclude 掉了 **/*.test.ts(正确 —— 否则测试会 emit 进 dist);
  • CI 唯一的类型 gate 就是跑这份配置(pnpm type-check → turbo → 每包 tsc --noEmit);
  • eslint 不是 type-aware;vitest 里类型在运行前已被擦除。

于是在该文件末尾追加一个必然为假的 Assert< Equal< 1, 2 > >,pnpm type-check 依然 exit 0。这个文件自己的头注释引用 #3009 批评的正是这种「declared ≠ enforced」地雷,而它自己就踩在上面。#3185 刚刚反转的 DecisionOutputDef pin 在此之前也只是装饰。

改动

  1. 新增 packages/app-shell/tsconfig.typetests.json —— noEmit 的独立 project,显式列出文件名,不用 glob
  2. packages/app-shell/package.json:"type-check": "tsc --noEmit && tsc -p tsconfig.typetests.json",并另给一个 type-check:typetests 方便本地单跑。链在 type-check 上是本仓既有约定(见 packages/types),也意味着它直接落在现有 CI Type Check job 里,不需要新增 workflow 步骤。
  3. scripts/check-type-check-coverage.mjs 增加对应棘轮:若某包存在 tsconfig.typetests.jsontype-check 没有 chain 它、或它会 emit、或它的 include 里一个测试文件都没有,则直接失败。否则今天修好的 gate 明天会以同样的方式悄悄失效(这是 issue 里的方案 3)。

为什么显式列文件,而不是把 exclude 里的 test glob 拿掉

app-shell 的测试树还有大量既有类型错误(check-type-check-coverage.mjsTEST_DEBT 里记着 53 个;issue 用另一套配置量到 189 个)。用 glob 会把这些一次性扫进来,结果不是有人去修,而是下一个 agent 直接删掉整个 project。全量修复明确不在本 PR 范围内,继续留在 #3181 正文里跟踪。

同理,这个文件没有命名为 tsconfig.test.json:那个名字在本仓的含义是「本包所有测试都编译」,coverage guard 会据此要求删掉 TEST_DEBT 条目 —— 那只是把一个假的「已检查」换成另一个假的「已检查」。

关于 changeset

纯 CI/工具链改动,对已发布产物无行为影响,按 AGENTS.md「纯 bug 修复不需要 changeset」处理;changeset-check job 只校验 fixed 组完整性,不要求每个 PR 带 changeset。

验证

1. 正向:新 gate 在干净 main + 本改动上通过

$ pnpm type-check --filter=@object-ui/app-shell
@object-ui/app-shell:type-check: > tsc --noEmit && tsc -p tsconfig.typetests.json
 Tasks:    29 successful, 29 total
EXIT=0

$ node scripts/check-type-check-coverage.mjs
✅  type-check coverage: 43/45 via `type-check`, 1 via their own build, 0 known-broken (0 errors outstanding), 1 not compiled.
✅  test type-check coverage: 21/36 packages compile their tests, 15 declared debt (240 errors outstanding), 1 with a narrow type-assertion project.

2. 反向对照:追加一个必然为假的断言

spec-symbol-parity.test.ts 末尾临时追加 type _Probe = Assert< Equal< 1, 2 > >;

旧 gate(本 PR 之前 CI 唯一跑的那个)—— 依然放行,复现 issue:

$ cd packages/app-shell && tsc --noEmit
OLD_GATE_EXIT=0

新 gate —— 失败:

$ pnpm type-check --filter=@object-ui/app-shell
@object-ui/app-shell:type-check: > tsc --noEmit && tsc -p tsconfig.typetests.json
@object-ui/app-shell:type-check: src/__tests__/spec-symbol-parity.test.ts(293,23): error TS2344: Type 'false' does not satisfy the constraint 'true'.
Failed:    @object-ui/app-shell#type-check
 ERROR  run failed: command  exited (2)
TURBO_EXIT=2

移除探针后重新变绿:

$ pnpm type-check --filter=@object-ui/app-shell
 Tasks:    29 successful, 29 total
TURBO_EXIT=0

3. 反向对照:棘轮本身

type-check 改回 tsc --noEmit(即「配置还在,但没人跑它」):

$ node scripts/check-type-check-coverage.mjs
❌  type-check coverage regressed:

    • @object-ui/app-shell (packages/app-shell) has a tsconfig.typetests.json that its "type-check" script never
      runs, so its compile-time assertions are erased at runtime and compiled by nothing —
      the exact state objectui#3181 fixed. ...
EXIT=1

4. 运行时测试未受影响

$ npx vitest run packages/app-shell/src/__tests__/spec-symbol-parity.test.ts
 Test Files  1 passed (1)
      Tests  25 passed (25)

5. CI

新 gate 走的是既有 Type Check job(pnpm type-check → turbo → app-shell 的 type-check),外加同 job 里已有的 Verify type-check coverage 步骤跑加固后的棘轮 —— 不是只存在于本地的 npm script。见本 PR 的 CI 检查结果。

🤖 Generated with Claude Code


Generated by Claude Code

…assertions (#3181)

The file's `type _X = Assert<Equal<A, B>>` lines were never read by any
compiler. `packages/app-shell/tsconfig.json` is the BUILD config and excludes
`**/*.test.ts`; CI's only type gate drives that config (`pnpm type-check` ->
turbo -> per-package `tsc --noEmit`), eslint is not type-aware, and vitest
erases types before it runs. A provably-false `Assert<Equal<1, 2>>` appended to
the file passed `pnpm type-check` at exit 0 — the same "declared != enforced"
landmine the file's own header cites #3009 for.

Adds `packages/app-shell/tsconfig.typetests.json`: an emit-free project with an
EXPLICIT include list (not a glob), chained from the package's `type-check`
script so it runs in the existing CI `Type Check` job. The list is explicit
because app-shell's wider test tree still has a pre-existing error backlog,
already declared as TEST_DEBT — a glob would sweep that in and the project would
get deleted rather than fixed. That backlog stays tracked in #3181.

`scripts/check-type-check-coverage.mjs` grows the matching ratchet: a
`tsconfig.typetests.json` that `type-check` does not chain, that emits, or that
includes no test file is now a hard failure, so this gate cannot go quiet the
same way the assertions did.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012C2cd7tL8QDoZ2QKN3djJ5
@vercel

vercel Bot commented Aug 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Aug 2, 2026 8:39am

Request Review

@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

✅ Console Performance Budget

Metric Value Budget
Main entry (gzip) 28.1 KB 350 KB
Entry file index-CjN9fx1G.js
Status PASS

📦 Bundle Size Report

Package Size Gzipped
app-shell (index.js) 8.47KB 3.09KB
app-shell (runtime-config.js) 7.42KB 2.32KB
app-shell (types.js) 0.01KB 0.04KB
app-shell (urlParams.js) 7.57KB 2.97KB
auth (AuthContext.js) 0.31KB 0.24KB
auth (AuthGuard.js) 1.17KB 0.53KB
auth (AuthProvider.js) 22.10KB 4.37KB
auth (AuthShell.js) 3.49KB 1.40KB
auth (ForgotPasswordForm.js) 12.12KB 3.41KB
auth (LoginForm.js) 17.86KB 5.29KB
auth (PreviewBanner.js) 0.90KB 0.50KB
auth (RegisterForm.js) 6.43KB 2.09KB
auth (SocialSignInButtons.js) 9.60KB 3.89KB
auth (UserMenu.js) 3.40KB 1.22KB
auth (auth-gate-events.js) 1.29KB 0.66KB
auth (authStyles.js) 5.04KB 1.72KB
auth (createAuthClient.js) 35.76KB 9.11KB
auth (createAuthenticatedFetch.js) 4.37KB 1.69KB
auth (index.js) 2.35KB 1.07KB
auth (org-roles.js) 6.66KB 2.78KB
auth (phone-identifier.js) 1.11KB 0.66KB
auth (types.js) 0.59KB 0.35KB
auth (useAuth.js) 4.91KB 0.87KB
auth (useIsWorkspaceAdmin.js) 1.61KB 0.85KB
collaboration (CommentThread.js) 18.38KB 4.49KB
collaboration (LiveCursors.js) 3.17KB 1.27KB
collaboration (PresenceAvatars.js) 3.65KB 1.42KB
collaboration (PresenceProvider.js) 2.79KB 1.13KB
collaboration (index.js) 1.25KB 0.53KB
collaboration (useCommentSearch.js) 1.98KB 0.88KB
collaboration (useConflictResolution.js) 7.75KB 1.86KB
collaboration (useMentionNotifications.js) 1.81KB 0.68KB
collaboration (usePresence.js) 6.33KB 1.84KB
collaboration (useRealtimeSubscription.js) 7.91KB 2.01KB
components (index.js) 475.95KB 104.41KB
core (index.js) 2.25KB 0.80KB
create-plugin (index.js) 9.28KB 2.98KB
data-objectstack (index.js) 136.20KB 34.74KB
fields (index.js) 223.45KB 54.66KB
i18n (LocalizationContext.js) 1.76KB 0.96KB
i18n (currency.js) 1.22KB 0.64KB
i18n (i18n.js) 4.32KB 1.77KB
i18n (index.js) 2.46KB 0.96KB
i18n (pickLocalized.js) 1.70KB 0.83KB
i18n (provider.js) 5.37KB 1.72KB
i18n (useObjectLabel.js) 26.14KB 6.07KB
i18n (useSafeTranslation.js) 3.26KB 1.44KB
layout (index.js) 38.47KB 10.67KB
mobile (MobileProvider.js) 0.92KB 0.49KB
mobile (ResponsiveContainer.js) 0.94KB 0.38KB
mobile (breakpoints.js) 1.51KB 0.70KB
mobile (createOfflineDataSource.js) 5.61KB 1.74KB
mobile (index.js) 1.50KB 0.62KB
mobile (offlineQueue.js) 3.91KB 1.35KB
mobile (pwa.js) 0.97KB 0.49KB
mobile (serviceWorker.js) 1.48KB 0.62KB
mobile (serviceWorkerSource.js) 3.41KB 1.48KB
mobile (useBreakpoint.js) 1.54KB 0.65KB
mobile (useGesture.js) 6.96KB 1.98KB
mobile (useOfflineSync.js) 1.99KB 0.72KB
mobile (usePullToRefresh.js) 2.53KB 0.85KB
mobile (useResponsive.js) 0.71KB 0.42KB
mobile (useResponsiveConfig.js) 1.36KB 0.63KB
mobile (useSpecGesture.js) 4.05KB 1.53KB
mobile (useTouchTarget.js) 1.01KB 0.54KB
permissions (MePermissionsProvider.js) 8.75KB 3.06KB
permissions (PermissionContext.js) 0.31KB 0.25KB
permissions (PermissionGuard.js) 0.89KB 0.45KB
permissions (PermissionProvider.js) 3.67KB 1.12KB
permissions (evaluator.js) 4.41KB 1.44KB
permissions (index.js) 0.91KB 0.41KB
permissions (store.js) 0.91KB 0.42KB
permissions (useFieldPermissions.js) 1.28KB 0.52KB
permissions (usePermissions.js) 1.55KB 0.71KB
plugin-ai (index.js) 15.71KB 3.79KB
plugin-calendar (index.js) 44.90KB 12.35KB
plugin-charts (index.js) 60.53KB 17.12KB
plugin-chatbot (index.js) 180.09KB 42.72KB
plugin-dashboard (index.js) 111.87KB 28.82KB
plugin-designer (index.js) 210.51KB 42.50KB
plugin-detail (index.js) 224.52KB 54.98KB
plugin-editor (index.js) 2.46KB 1.10KB
plugin-form (index.js) 111.38KB 26.93KB
plugin-gantt (index.js) 162.26KB 39.53KB
plugin-grid (index.js) 184.69KB 48.91KB
plugin-kanban (index.js) 47.82KB 13.18KB
plugin-list (index.js) 104.87KB 25.31KB
plugin-map (index.js) 16.80KB 5.24KB
plugin-markdown (index.js) 13.65KB 4.67KB
plugin-report (index.js) 40.48KB 10.57KB
plugin-timeline (index.js) 25.76KB 7.32KB
plugin-tree (index.js) 8.34KB 2.82KB
plugin-view (index.js) 83.54KB 20.39KB
providers (DataSourceProvider.js) 0.75KB 0.39KB
providers (MetadataProvider.js) 1.37KB 0.59KB
providers (ThemeProvider.js) 1.90KB 0.85KB
providers (UploadProvider.js) 11.71KB 3.53KB
providers (index.js) 0.44KB 0.22KB
providers (types.js) 0.01KB 0.04KB
react-runtime (index.js) 5.67KB 2.37KB
react (LazyPluginLoader.js) 3.77KB 1.33KB
react (SchemaRenderer.js) 19.28KB 6.38KB
react (data-invalidation.js) 5.05KB 2.08KB
react (index.js) 1.02KB 0.55KB
sdui-parser (codegen.js) 4.09KB 1.74KB
sdui-parser (index.js) 4.47KB 2.03KB
sdui-parser (parse.js) 10.04KB 2.82KB
sdui-parser (types.js) 0.29KB 0.24KB
sdui-parser (validate.js) 4.69KB 1.48KB
types (ai.js) 0.20KB 0.17KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 2.87KB 0.99KB
types (base.js) 0.20KB 0.18KB
types (blocks.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (data-display.js) 0.20KB 0.18KB
types (data-protocol.js) 0.20KB 0.19KB
types (data.js) 0.20KB 0.18KB
types (designer.js) 1.87KB 0.85KB
types (disclosure.js) 0.20KB 0.18KB
types (error-code.js) 1.54KB 0.88KB
types (feedback.js) 0.20KB 0.18KB
types (field-types.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (http-retry.js) 4.32KB 2.02KB
types (index.js) 2.46KB 1.21KB
types (layout.js) 0.20KB 0.18KB
types (managed-by.js) 0.19KB 0.18KB
types (mobile.js) 0.20KB 0.18KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (permissions.js) 0.20KB 0.18KB
types (plugin-scope.js) 0.20KB 0.18KB
types (record-components.js) 0.20KB 0.19KB
types (record-semantics.js) 1.28KB 0.67KB
types (registry.js) 0.20KB 0.18KB
types (reports.js) 0.20KB 0.18KB
types (spec-report.js) 5.05KB 1.93KB
types (system-fields.js) 3.33KB 1.54KB
types (theme.js) 0.20KB 0.18KB
types (ui-action.js) 3.40KB 1.71KB
types (views.js) 0.20KB 0.18KB
types (widget.js) 0.20KB 0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@os-zhuang
os-zhuang marked this pull request as ready for review August 2, 2026 08:46
@os-zhuang
os-zhuang added this pull request to the merge queue Aug 2, 2026
Merged via the queue into main with commit 496825f Aug 2, 2026
16 checks passed
@os-zhuang
os-zhuang deleted the claude/issue-3181-typetests-gate branch August 2, 2026 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

spec-symbol-parity.test.ts 的「编译期」断言从未被编译 —— 整个 tripwire 是哑的

2 participants