Skip to content

MSG-1: shared vocabulary hoist + SESSION-1 deferral (draft)#23

Merged
JarbasAl merged 3 commits into
devfrom
spec/msg1-shared-vocabulary
May 24, 2026
Merged

MSG-1: shared vocabulary hoist + SESSION-1 deferral (draft)#23
JarbasAl merged 3 commits into
devfrom
spec/msg1-shared-vocabulary

Conversation

@JarbasAl
Copy link
Copy Markdown
Member

@JarbasAl JarbasAl commented May 24, 2026

OVOS-MSG-1 — Bus Message Specification

Two scoped changes to MSG-1.

§2.1.1 — topic-component identifier rule

Identifiers used as structural components of a topic name (skill IDs, pipeline IDs, intent names, transformer IDs, context keys, etc.) MUST NOT contain :, ., or whitespace. These characters are reserved for the segmenting and routing conventions of MSG-1. Specs that mint such identifiers reference this rule rather than restating it.

§4 — session carrier ownership

MSG-1 owns the existence of Message.context.session as the carrier, the names session_id and lang, and the propagation rule that derivations preserve session unchanged. The wire shape, field set, registry mechanism, omission semantics, and the reserved session_id == "default" value are owned by OVOS-SESSION-1.

Out of scope

  • The internal shape of session beyond naming session_id and lang.
  • Transport, encryption, authentication, retry, delivery and ordering guarantees.

Status

Draft.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 24, 2026

Warning

Review limit reached

@JarbasAl, we couldn't start this review because you've used your available PR reviews for now.

Your plan includes 1 review of capacity. Refill in 23 minutes and 3 seconds.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more review capacity refills, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than trial, open-source, and free plans. In all cases, review capacity refills continuously over time.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b300424c-804d-4b25-b779-3adaccd24dbb

📥 Commits

Reviewing files that changed from the base of the PR and between 47bdc04 and 9b2952b.

📒 Files selected for processing (1)
  • message-object.md
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title directly references both main changes: hoisting shared vocabulary and deferring session semantics to OVOS-SESSION-1, accurately summarizing the primary objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch spec/msg1-shared-vocabulary

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

§2.1.1 (new) — fix the colon/dot/whitespace forbidden rule for any
identifier that other specs mint for use as a structural component of
a topic name (skill_id, pipeline_id, transformer_id, intent_name,
component_id, …). Replaces per-spec restatement of the same rule in
PIPELINE-1 §7, CONTEXT-1 §2/§3, TRANSFORM-1 §1, etc.

§4 / §4.1 / §4.3 / §7 — defer the wire shape of `session`, the
`session_id` value space, the reserved `"default"` marker, the
omission-as-deferral semantics, and the closed field set to the new
OVOS-SESSION-1. This spec retains: the fact that `session` is the
carrier inside `Message.context`, the naming of `session_id` /
`lang`, and the propagation rule across forward/reply/response.

§4.2 (`lang`) unchanged — remains owned here.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@JarbasAl JarbasAl force-pushed the spec/msg1-shared-vocabulary branch from fd4c510 to fbbe93c Compare May 24, 2026 18:51
…ternals

Per design principle: a forward-reference to another spec's section
is a smell that the definition belongs in the other spec and should
not appear here. MSG-1 owns the existence of `session` as a context
key and its propagation rule; everything inside session is
SESSION-1's, and MSG-1 should not name it.

Removed:
- All `session_id` mentions (preamble, §1, §5, §5.4, §7).
- All `OVOS-SESSION-1 §X` forward-references (§4, §5.1, §7, See also).
- The "reserved \"default\" marker" prose in conformance.

Retained:
- The bare statement that `session` rides inside Message.context
  and that its shape/fields/semantics live in OVOS-SESSION-1.
- The propagation rule (which is MSG-1's, not SESSION-1's).
- One See-also line pointing readers at SESSION-1 by name only.

Also: fix a broken half-sentence in the preamble left by an earlier
edit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
message-object.md (1)

338-339: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Broken section reference to non-existent §4.3

Line 339 points to §4.3, but section 4 currently ends at §4.2. This creates a dead normative reference in derivation behavior.

Suggested fix
-    session on the result (§4.3).
+    session on the result (§4.1).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@message-object.md` around lines 338 - 339, The reference "§4.3" in the
sentence "populate a default session on the result (§4.3)" is dead because
section 4 currently ends at §4.2; update the reference to point to the correct
target (either change "§4.3" to "§4.2" if that is the intended section, or add
the missing §4.3 section with the normative text about default session
derivation) and ensure the phrasing and cross-reference in message-object.md and
any related headings (e.g., the text that explains default session behavior) are
consistent so the normative link resolves correctly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@message-object.md`:
- Around line 464-465: The cross-reference "§4.4" in the phrase "opaque layer-2
substrate of §3.4 / §4.4." is invalid; update that reference to point to the
actual section that defines "session’s layer-2 substrate framing" (or replace
the numeric reference with the explicit section title if uncertain). Locate the
exact text fragment "opaque layer-2 substrate of §3.4 / §4.4." and change "§4.4"
to the correct section number or the section heading that defines the session
layer-2 substrate framing so the cross-reference is accurate.

---

Outside diff comments:
In `@message-object.md`:
- Around line 338-339: The reference "§4.3" in the sentence "populate a default
session on the result (§4.3)" is dead because section 4 currently ends at §4.2;
update the reference to point to the correct target (either change "§4.3" to
"§4.2" if that is the intended section, or add the missing §4.3 section with the
normative text about default session derivation) and ensure the phrasing and
cross-reference in message-object.md and any related headings (e.g., the text
that explains default session behavior) are consistent so the normative link
resolves correctly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d6abf7e1-2bf0-424a-97a2-4023349b0f48

📥 Commits

Reviewing files that changed from the base of the PR and between f685e8a and 47bdc04.

📒 Files selected for processing (1)
  • message-object.md

Comment thread message-object.md Outdated
@JarbasAl JarbasAl marked this pull request as ready for review May 24, 2026 21:39
@JarbasAl JarbasAl merged commit 73fec74 into dev May 24, 2026
1 check was pending
@JarbasAl JarbasAl deleted the spec/msg1-shared-vocabulary branch May 26, 2026 22:14
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.

1 participant