Repository navigation
feat(architecture): observed dependency ratchet（Phase 2） #447
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| { | ||
| "$schema": "./observed-baseline.schema.json", | ||
| "schema_version": "ai-bim-observed-baseline/v1", | ||
| "approved_on": "2026-07-30", | ||
| "approved_by": "introduce-executable-architecture-contracts Phase 2", | ||
| "method": "Generated by scripts/dev/export_observed_architecture.py from the committed source tree at the time of approval. Entries recorded here are grandfathered: the ratchet permits them and fails closed on anything new. Removing an entry is always allowed and is the intended direction of travel.", | ||
| "service_edges": [ | ||
| { | ||
| "from": "bim-review-coordinator", | ||
| "to": "bim-streaming-server", | ||
| "status": "declared", | ||
| "note": "Permitted by architecture-contract.json may_call (internal-conversion-request, internal-runtime-status, audited-stage-control-intent)." | ||
| }, | ||
| { | ||
| "from": "bim-review-coordinator", | ||
| "to": "governance-service", | ||
| "status": "declared", | ||
| "note": "Permitted by architecture-contract.json may_call (coordinator-governance-proxy)." | ||
| }, | ||
| { | ||
| "from": "bim-review-coordinator", | ||
| "to": "kit-manager-api", | ||
| "status": "declared", | ||
| "note": "Permitted by architecture-contract.json may_call (audited-runtime-lifecycle-intent)." | ||
| }, | ||
| { | ||
| "from": "kit-manager-api", | ||
| "to": "bim-streaming-server", | ||
| "status": "declared", | ||
| "note": "Permitted by architecture-contract.json may_call (kit-fleet-operations, runtime-telemetry)." | ||
| }, | ||
| { | ||
| "from": "kit-manager-web", | ||
| "to": "bim-review-coordinator", | ||
| "status": "undeclared-node", | ||
| "debt": { | ||
| "owner": "introduce-executable-architecture-contracts", | ||
| "reason": "apps/kit-manager-web is a second browser client that reaches the coordinator public API, but architecture-contract.json declares only web-viewer-sample as a browser node. The edge itself respects ARCH-HTTP-001 because it targets coordinator:8004; the gap is the missing service declaration, not a boundary violation. Declaring the node changes desired architecture and therefore needs its own delta rather than being smuggled in with the ratchet.", | ||
| "target_phase": "phase-3" | ||
| } | ||
| }, | ||
| { | ||
| "from": "kit-manager-web", | ||
| "to": "kit-manager-api", | ||
| "status": "undeclared-node", | ||
| "debt": { | ||
| "owner": "introduce-executable-architecture-contracts", | ||
| "reason": "compose.runtime-manager.yml starts kit-manager-web after kit-manager-api. This is a startup ordering dependency for an operator console that is not yet a declared contract node. Recorded as debt alongside the kit-manager-web declaration gap; a browser client reaching an internal service directly would violate ARCH-HTTP-001 and must be resolved, not merely re-baselined, when the node is declared.", | ||
| "target_phase": "phase-3" | ||
| } | ||
| }, | ||
| { | ||
| "from": "web-viewer-sample", | ||
| "to": "bim-review-coordinator", | ||
| "status": "declared", | ||
| "note": "Permitted by architecture-contract.json may_call (public-rest, socket-io) and by browser_access_policy http_api_entrypoints." | ||
| } | ||
| ], | ||
| "cycles": [ | ||
| { | ||
| "scope": "module-graph:bim-streaming-server", | ||
| "members": [ | ||
| "ezplus.bim_review_stream.messaging", | ||
| "ezplus.bim_review_stream.messaging.extension", | ||
| "ezplus.bim_review_stream.messaging.kit_struct_log" | ||
| ], | ||
| "debt": { | ||
| "owner": "bim-streaming-server", | ||
| "reason": "The Kit extension package __init__ re-exports extension and kit_struct_log, which import back from the package. This is the conventional Omniverse extension entry-point shape; breaking it requires reworking the extension surface.", | ||
| "target_phase": "phase-3" | ||
| } | ||
| }, | ||
| { | ||
| "scope": "module-graph:governance-service", | ||
| "members": ["diff_engine", "diff_engine.engine"], | ||
| "debt": { | ||
| "owner": "governance-service", | ||
| "reason": "diff_engine/__init__.py re-exports from engine.py while engine.py imports package-level helpers. Untangling requires moving shared helpers into a leaf module.", | ||
| "target_phase": "phase-3" | ||
| } | ||
| }, | ||
| { | ||
| "scope": "module-graph:web-viewer-sample", | ||
| "members": ["App.tsx", "StreamOnlyWindow.tsx", "Window.tsx"], | ||
| "debt": { | ||
| "owner": "web-viewer-sample", | ||
| "reason": "App, Window, and StreamOnlyWindow mutually reference each other for routing and stream-only fallback. The a4-console-convergence and migrate-console-to-hifi-design changes own this surface; splitting it here would conflict with them.", | ||
| "target_phase": "phase-3" | ||
| } | ||
| } | ||
| ], | ||
| "cycle_budgets": [ | ||
| { "scope": "service-graph", "maximum": 0, "note": "No service-level dependency cycle is permitted." }, | ||
| { "scope": "module-graph:bim-review-coordinator", "maximum": 0 }, | ||
| { "scope": "module-graph:bim-streaming-server", "maximum": 1 }, | ||
| { "scope": "module-graph:governance-service", "maximum": 1 }, | ||
| { "scope": "module-graph:kit-manager-api", "maximum": 0 }, | ||
| { "scope": "module-graph:kit-manager-web", "maximum": 0 }, | ||
| { "scope": "module-graph:web-viewer-sample", "maximum": 1 } | ||
| ] | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "$id": "https://ai-bim-governance.local/schemas/observed-baseline.schema.json", | ||
| "title": "AI-BIM approved observed architecture baseline", | ||
| "description": "Grandfathered dependency edges and cycles. The ratchet allows what is recorded here and fails closed on anything new.", | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "required": [ | ||
| "schema_version", | ||
| "approved_on", | ||
| "approved_by", | ||
| "method", | ||
| "service_edges", | ||
| "cycles", | ||
| "cycle_budgets" | ||
| ], | ||
| "definitions": { | ||
| "debt": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "required": ["owner", "reason", "target_phase"], | ||
| "properties": { | ||
| "owner": { "type": "string", "minLength": 1 }, | ||
| "reason": { "type": "string", "minLength": 1 }, | ||
| "target_phase": { "type": "string", "minLength": 1 } | ||
| } | ||
| } | ||
| }, | ||
| "properties": { | ||
| "$schema": { "type": "string", "minLength": 1 }, | ||
| "schema_version": { "const": "ai-bim-observed-baseline/v1" }, | ||
| "approved_on": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, | ||
| "approved_by": { "type": "string", "minLength": 1 }, | ||
| "method": { "type": "string", "minLength": 1 }, | ||
| "service_edges": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "required": ["from", "to", "status"], | ||
| "properties": { | ||
| "from": { "type": "string", "minLength": 1 }, | ||
| "to": { "type": "string", "minLength": 1 }, | ||
| "status": { "enum": ["declared", "undeclared-edge", "undeclared-node"] }, | ||
| "note": { "type": "string", "minLength": 1 }, | ||
| "debt": { "$ref": "#/definitions/debt" } | ||
| } | ||
| } | ||
| }, | ||
| "cycles": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "required": ["scope", "members", "debt"], | ||
| "properties": { | ||
| "scope": { "type": "string", "minLength": 1 }, | ||
| "members": { | ||
| "type": "array", | ||
| "minItems": 2, | ||
| "items": { "type": "string", "minLength": 1 } | ||
| }, | ||
| "debt": { "$ref": "#/definitions/debt" } | ||
| } | ||
| } | ||
| }, | ||
| "cycle_budgets": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "additionalProperties": false, | ||
| "required": ["scope", "maximum"], | ||
| "properties": { | ||
| "scope": { "type": "string", "minLength": 1 }, | ||
| "maximum": { "type": "integer", "minimum": 0 }, | ||
| "note": { "type": "string", "minLength": 1 } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Correct the baseline-removal claim.
An observed edge is permitted only when it remains in the baseline or is declared by both the architecture contract and a delta. Removing a baseline entry while the source edge remains undeclared will fail the ratchet, so removal is not “always allowed.”
Suggested wording
📝 Committable suggestion
🤖 Prompt for AI Agents