FE-1495: Prevent Brunch TypeScript contracts from drifting - #9312
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #9312 +/- ##
=======================================
Coverage 60.22% 60.22%
=======================================
Files 1430 1430
Lines 140558 140558
Branches 6609 6609
=======================================
Hits 84658 84658
Misses 54823 54823
Partials 1077 1077
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
PR SummaryLow Risk Overview TypeScript contracts are tied to their owning schemas or libraries instead of duplicate handwritten types: capture-store and session-log envelopes derive from Valibot ( Supporting fixes include prune CI copying Reviewed by Cursor Bugbot for commit ddecada. Bugbot is set up for automated code reviews on this repo. Configure here. |
a39ed9c to
eb2092a
Compare
b052dda to
d6ecb22
Compare
Enable type-aware and compiler-backed linting across the Brunch packages, share scoped rules with the app, and resolve the initial diagnostics without widening repository policy. Co-authored-by: Cursor <cursoragent@cursor.com>
Derive persisted, transport, and test types from their schemas and library contracts so runtime boundaries and TypeScript consumers cannot drift independently. Co-authored-by: Cursor <cursoragent@cursor.com>
39828d1 to
ddecada
Compare
Benchmark results
|
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| resolve_policies_for_actor | user: empty, selectivity: high, policies: 2002 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: medium, policies: 1002 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: high, policies: 3314 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: medium, policies: 1527 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: high, policies: 2078 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: medium, policies: 1033 | Flame Graph |
policy_resolution_medium
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| resolve_policies_for_actor | user: empty, selectivity: high, policies: 102 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: medium, policies: 52 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: high, policies: 269 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: medium, policies: 108 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: high, policies: 133 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: medium, policies: 63 | Flame Graph |
policy_resolution_none
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| resolve_policies_for_actor | user: empty, selectivity: high, policies: 2 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: medium, policies: 2 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: high, policies: 8 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: medium, policies: 3 | Flame Graph |
policy_resolution_small
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| resolve_policies_for_actor | user: empty, selectivity: high, policies: 52 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: empty, selectivity: medium, policies: 26 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: high, policies: 94 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: seeded, selectivity: medium, policies: 27 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: high, policies: 66 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: low, policies: 1 | Flame Graph | |
| resolve_policies_for_actor | user: system, selectivity: medium, policies: 29 | Flame Graph |
read_scaling_complete
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| entity_by_id;one_depth | 1 entities | Flame Graph | |
| entity_by_id;one_depth | 10 entities | Flame Graph | |
| entity_by_id;one_depth | 25 entities | Flame Graph | |
| entity_by_id;one_depth | 5 entities | Flame Graph | |
| entity_by_id;one_depth | 50 entities | Flame Graph | |
| entity_by_id;two_depth | 1 entities | Flame Graph | |
| entity_by_id;two_depth | 10 entities | Flame Graph | |
| entity_by_id;two_depth | 25 entities | Flame Graph | |
| entity_by_id;two_depth | 5 entities | Flame Graph | |
| entity_by_id;two_depth | 50 entities | Flame Graph | |
| entity_by_id;zero_depth | 1 entities | Flame Graph | |
| entity_by_id;zero_depth | 10 entities | Flame Graph | |
| entity_by_id;zero_depth | 25 entities | Flame Graph | |
| entity_by_id;zero_depth | 5 entities | Flame Graph | |
| entity_by_id;zero_depth | 50 entities | Flame Graph |
read_scaling_linkless
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| entity_by_id | 1 entities | Flame Graph | |
| entity_by_id | 10 entities | Flame Graph | |
| entity_by_id | 100 entities | Flame Graph | |
| entity_by_id | 1000 entities | Flame Graph | |
| entity_by_id | 10000 entities | Flame Graph |
representative_read_entity
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/block/v/1
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/book/v/1
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/building/v/1
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/organization/v/1
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/page/v/2
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/person/v/1
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/playlist/v/1
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/song/v/1
|
Flame Graph | |
| entity_by_id | entity type ID: https://blockprotocol.org/@alice/types/entity-type/uk-address/v/1
|
Flame Graph |
representative_read_entity_type
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| get_entity_type_by_id | Account ID: bf5a9ef5-dc3b-43cf-a291-6210c0321eba
|
Flame Graph |
representative_read_multiple_entities
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| entity_by_property | traversal_paths=0 | 0 | |
| entity_by_property | traversal_paths=255 | 1,resolve_depths=inherit:1;values:255;properties:255;links:127;link_dests:126;type:true | |
| entity_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:0;properties:0;links:0;link_dests:0;type:false | |
| entity_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:0;properties:0;links:1;link_dests:0;type:true | |
| entity_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:0;properties:2;links:1;link_dests:0;type:true | |
| entity_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:2;properties:2;links:1;link_dests:0;type:true | |
| link_by_source_by_property | traversal_paths=0 | 0 | |
| link_by_source_by_property | traversal_paths=255 | 1,resolve_depths=inherit:1;values:255;properties:255;links:127;link_dests:126;type:true | |
| link_by_source_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:0;properties:0;links:0;link_dests:0;type:false | |
| link_by_source_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:0;properties:0;links:1;link_dests:0;type:true | |
| link_by_source_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:0;properties:2;links:1;link_dests:0;type:true | |
| link_by_source_by_property | traversal_paths=2 | 1,resolve_depths=inherit:0;values:2;properties:2;links:1;link_dests:0;type:true |
scenarios
| Function | Value | Mean | Flame graphs |
|---|---|---|---|
| full_test | query-limited | Flame Graph | |
| full_test | query-unlimited | Flame Graph | |
| linked_queries | query-limited | Flame Graph | |
| linked_queries | query-unlimited | Flame Graph |

🌟 What is the purpose of this PR?
Brunch's TypeScript contracts could drift because its packages lacked a scoped, type-aware lint policy, and several runtime schemas, SDK payloads, and test protocols were restated as independent handwritten types. Stacked on the strategy and documentation work, this pull request makes those boundaries mechanically strict inside Brunch without imposing the policy on unrelated HASH workspaces.
🔗 Related links
.config/oxlint/brunch/🚫 Blocked by
🔍 What does this change?
Brunch packages and
apps/brunch-agentnow run Oxlint with multi-file analysis, type-aware rules, and compiler diagnostics, using shared presets under.config/oxlint/brunch/. Persisted records, AI SDK wire values, plugin proposals, and test protocols derive their TypeScript types from the schemas or library contracts that already own those values. Package Oxlint configs encode the existing harness / binding / plugin / transport direction rules.🏗️ Agent notes
Stacked as
ln/fe-1437-hash-monorepo-import→ln/fe-1494-strategic-controls→ this branch →ln/fe-1480-resolve-decision.This branch was previously
ln/fe-xxxx-tooling-expanse. After restack it contains only the two commits that are unique to FE-1495; the ten documentation/strategy commits live on #9311.Commits
77bd7cb1caAdd comprehensive Oxlint policy for Brunchb052dda955Unify Brunch TypeScript contract ownershipLint policy
.config/oxlint/brunch/base.jsonandreact.json..oxlintrc.jsonfiles extend those presets and enabletypeAwareplustypeCheck.lint:eslint/fix:eslintadd--type-checkso compiler diagnostics fail the task.no-restricted-importsencodes: no@local/*; no Petrinaut from Brunch libraries or the Brunch server; harness independent of bindings/plugins/transports/Flue; plugins storage-blind and substrate-independent; transports independent of bindings.Contract ownership
Types are inferred from Valibot schemas or imported from the owning library rather than restated:
apps/brunch-agentdepends onaiso application tests can use the SDK's published types instead of local copies. Intentional standalone types remain at historical archive and pruned-CI boundaries.Verification already run on the branch
Brunch formatting, Oxlint,
tsgo, Vite build, and Vitest across the four libraries and the application.Pre-Merge Checklist 🚀
🚢 Has this modified a publishable library?
This PR:
Brunch packages remain private. The
aidependency is on the private application workspace.📜 Does this require a change to the docs?
The changes in this PR:
AGENTS.mdrecords the Oxlint invocation for agents working in the Brunch context. No user-facing Petrinaut docs change.🕸️ Does this require a change to the Turbo Graph?
The changes in this PR:
Existing
lint:eslinttasks gain flags and config files; no new workspace orturbo.jsonchange.Standalone types at historical archive documents and pruned-CI helpers are intentional and out of policy scope.
🐾 Next steps
🛡 What tests cover this?
lint:eslint(Oxlint with type-aware rules and compiler diagnostics)lint:tsc❓ How to test this?
Run:
Confirm a forbidden import (for example
@hashintel/petrinautfrompackages/core) fails Oxlint with the configured message.📹 Demo
Not applicable — lint policy and type-ownership changes only.