Skip to content

Register the CallSession ontology - #1106

Open
EgorPPS wants to merge 1 commit into
mainfrom
meshenger-callsession-ontology
Open

Register the CallSession ontology#1106
EgorPPS wants to merge 1 commit into
mainfrom
meshenger-callsession-ontology

Conversation

@EgorPPS

@EgorPPS EgorPPS commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

One audio/video call in a chat, transport-agnostic (full-mesh WebRTC or an SFU). Generalises the ad-hoc type: "call" Message so a call and its recording become readable across applications: who was in it, when, how long, and where the recording and transcript live.

Meshenger has written these envelopes since 2026-08-08 — this registers the schema they already conform to, rather than reserving a name.

Placement, which the schema encodes deliberately. The canonical envelope is written ONCE, on the vault that already holds the chat's canonical Chat envelope: the group's own vault for a group, the chat owner's vault for a 1:1. Not the caller's vault — the caller changes from call to call, the chat owner does not, so every call in a conversation ends up in one place. Every other participant holds a reference-mixin (isReference + canonicalOwnerEName + canonicalEnvelopeId) on their own vault so their apps can discover the call, and never a copy. Those fields are therefore part of the schema.

Body carries references and metadata only — media and transcript are w3ds:// file URIs, per-speaker tracks name their speaker by eName. No media bytes, no transcript text.

schemaId e815ba40-ef85-4a2b-b6cf-e05a86d4afbd (already declared in Meshenger's platform self-description).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features
    • Added a formal schema for call session data, covering transport details, call metadata, participants, lifecycle status, timestamps, and archival state.
    • Supports optional recording, transcript, track, and canonical-reference information.
    • Enforces validation rules for required identifiers and prevents unsupported properties.

One audio/video call in a chat, transport-agnostic. Generalises the ad-hoc
'call' Message so a call and its recording are readable ACROSS applications:
who was in it, when, how long, and where the recording and transcript live.

Written by Meshenger since 2026-08-08. The canonical envelope is written once,
on the vault that already holds the chat's canonical Chat envelope (the group's
own vault for a group, the chat owner's for a 1:1) — not on the caller's, which
changes from call to call. Every other participant holds a reference-mixin
(isReference + canonicalOwnerEName + canonicalEnvelopeId), never a copy, which
is why those fields are part of the schema.

Body is references and metadata only: media and transcript are w3ds:// file
URIs, never bytes.
@EgorPPS
EgorPPS requested a review from coodos as a code owner August 8, 2026 09:57
@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a Draft-07 CallSession JSON schema. The schema defines call metadata, participants, lifecycle fields, recording and transcript references, canonical references, timestamps, archive state, and strict property validation.

Changes

CallSession schema

Layer / File(s) Summary
CallSession contract
services/ontology/schemas/callSession.json
Defines core call metadata, optional recording details, canonical references, timestamps, archive state, the required id field, and restrictions on undeclared properties.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: coodos

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the ontology and storage model but omits the required issue, change type, testing, and checklist sections. Add the required template sections, including the issue number, change type, test details, and completed checklist items.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: registering the CallSession ontology.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch meshenger-callsession-ontology

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 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 `@services/ontology/schemas/callSession.json`:
- Around line 49-51: Update the durationSec property in the call-session schema
to enforce a minimum value of 0, while preserving its existing number type and
optional/unknown behavior.
- Around line 67-74: Add a shared Draft-07 definition for non-empty w3ds://
references using the ^w3ds://.+ pattern, then reference it from mediaUri,
mediaSegments item values, tracks[].uri, and transcriptUri. Preserve the
existing array and object structure while replacing unrestricted string schemas
for these fields.
- Around line 117-127: Update the CallSession participant schema around
isReference, canonicalOwnerEName, and canonicalEnvelopeId to require isReference
and enforce conditional reference fields: true requires canonicalOwnerEName,
canonicalEnvelopeId, sharedBy, and sharedAt, while false rejects all canonical
pointer fields. Preserve the existing id requirement and use the schema’s
conditional validation mechanism.
🪄 Autofix

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 Plus

Run ID: 08dd0401-a2b5-4d68-8a80-6172aeb12e41

📥 Commits

Reviewing files that changed from the base of the PR and between a77e04a and 8c8b915.

📒 Files selected for processing (1)
  • services/ontology/schemas/callSession.json

Comment on lines +49 to +51
"durationSec": {
"type": "number",
"description": "Talk time in seconds; absent when unknown"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Reject negative durations.

durationSec accepts negative values. A call duration cannot be negative.

Add "minimum": 0 to this property.

🤖 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 `@services/ontology/schemas/callSession.json` around lines 49 - 51, Update the
durationSec property in the call-session schema to enforce a minimum value of 0,
while preserving its existing number type and optional/unknown behavior.

Comment on lines +67 to +74
"mediaUri": {
"type": "string",
"description": "w3ds:// file URI of the composite recording"
},
"mediaSegments": {
"type": "array",
"items": { "type": "string" },
"description": "w3ds:// file URIs, when the composite was split into parts"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Validate w3ds:// file references.

These fields accept any string, including an HTTP URL or non-URI value. This conflicts with the cross-application file-reference contract.

Add a shared Draft-07 definitions entry with a ^w3ds://.+ pattern. Apply it to mediaUri, mediaSegments items, tracks[].uri, and transcriptUri.

Also applies to: 85-88, 94-96

🤖 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 `@services/ontology/schemas/callSession.json` around lines 67 - 74, Add a
shared Draft-07 definition for non-empty w3ds:// references using the ^w3ds://.+
pattern, then reference it from mediaUri, mediaSegments item values,
tracks[].uri, and transcriptUri. Preserve the existing array and object
structure while replacing unrestricted string schemas for these fields.

Comment on lines +117 to +127
"isReference": {
"type": "boolean",
"description": "True on a participant's pointer to a canonical CallSession held elsewhere"
},
"canonicalOwnerEName": {
"type": "string",
"description": "On a reference: the vault holding the canonical envelope"
},
"canonicalEnvelopeId": {
"type": "string",
"description": "On a reference: the canonical envelope's id on that vault"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== locate file =="
git ls-files | grep -F 'services/ontology/schemas/callSession.json' || true

echo "== file outline/size =="
wc -l services/ontology/schemas/callSession.json
echo "== relevant schema sections =="
sed -n '1,220p' services/ontology/schemas/callSession.json | cat -n

echo "== search related definitions/usages =="
rg -n "isReference|canonicalOwnerEName|canonicalEnvelopeId"| head -n 200

Repository: MetaState-Prototype-Project/prototype

Length of output: 8080


🌐 Web query:

JSON Schema 2020-12 if then else boolean true required keyword behavior

💡 Result:

In JSON Schema 2020-12, the if, then, and else keywords provide conditional validation, functioning similarly to an if-then-else programming construct [1][2][3]. Interaction with Boolean Schemas and Defaults When the then or else keywords are missing, they are effectively treated as the boolean true schema, which always passes validation [1][3]. Specifically: - If the if subschema validates successfully and then is missing, the validation succeeds as if the then subschema were true [1][3]. - If the if subschema fails to validate and else is missing, the validation succeeds as if the else subschema were true [1][3]. - If the if keyword is entirely absent, then and else are ignored [2][4]. Interaction with the Required Keyword The required keyword behaves consistently within the conditional structure [3]. When then or else is applied, the required constraint is evaluated just like any other validation keyword [2][4]. Common patterns for conditional requirements include: - If a condition is met (if subschema passes), use then to mandate specific fields using required [5][6]. - If a condition is not met (if subschema fails), use else to mandate different fields [6]. Key Behavioral Rules - The evaluation result of the if subschema determines which branch (then or else) is evaluated [2][3]. The result of the if subschema itself does not directly dictate the overall validation outcome; rather, the success of the chosen branch (then or else) determines the success of the conditional block [1][2][4]. - Only the applicable branch (then or else) is evaluated for validation; the other is completely ignored [2][4]. - Annotations from the if subschema are collected regardless of the outcomes of the then or else branches [1][2]. - These keywords do not interact across subschema boundaries (e.g., within branches of an allOf) [2][4].

Citations:


Require complete canonical reference mixins.

The schema only requires id, so invalid records like {"id":"call-1","isReference":true} and records with canonical pointer fields but no isReference are accepted. Require isReference; when it is true, require canonicalOwnerEName, canonicalEnvelopeId, sharedBy, and sharedAt; when it is false, reject those pointer fields.

🤖 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 `@services/ontology/schemas/callSession.json` around lines 117 - 127, Update
the CallSession participant schema around isReference, canonicalOwnerEName, and
canonicalEnvelopeId to require isReference and enforce conditional reference
fields: true requires canonicalOwnerEName, canonicalEnvelopeId, sharedBy, and
sharedAt, while false rejects all canonical pointer fields. Preserve the
existing id requirement and use the schema’s conditional validation mechanism.

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