Use batch mode inside Ad4mModel.save()

[lucksus]

Creating instances of Subject Classes / Ad4mModels will always at least result in two commits or more, since the constructor must at least write one link, plus the default source link.

P-Diff-Sync has a fast-track method for updating the other agents via p2p remote call (instead of DHT sync) if there is only one commit difference.

So currently we never use this fast-track method.

The newly introduced batch mode can reduce an arbitrary number of link changes into one commit to the link language. Ad4mModel.save() already had an optional parameter with which the calling context could provide a batch ID, but had to initiate and commit the batch.

Now, if no batch ID is provided, save() will create a new batch and commit it at the end, resulting in only one commit to the link language.

This PR sits on top of #607 since it needs the deadlock fixes in there. Otherwise, extensive use of the batch mode would run into deadlocks almost certainly as seen in the tests.

Summary by CodeRabbit

• Bug Fixes
  • Improved data consistency when saving by ensuring data is refreshed only after batch operations are committed.
  • Enhanced reliability when handling batch saves, distinguishing between internal and external batch management.

[coderabbitai]

Walkthrough

The save method in the Ad4mModel class was updated to refine batch processing and data refreshing logic. The method now distinguishes between internally created and externally provided batch IDs, committing and refreshing data only when appropriate based on batch ownership.

Changes

File	Change Summary
core/src/model/Ad4mModel.ts	Refactored save method to clarify batch creation, commit, and data refresh flow based on batch origin.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Ad4mModel
    participant BatchManager

    Caller->>Ad4mModel: save(batchId?)
    alt batchId not provided
        Ad4mModel->>BatchManager: createBatch()
        Ad4mModel->>BatchManager: setCollections()
        Ad4mModel->>BatchManager: commitBatch()
        Ad4mModel->>Ad4mModel: getData()
    else batchId provided
        Ad4mModel->>BatchManager: setCollections()
        Note right of Ad4mModel: Commit and getData deferred to caller
    end
    Ad4mModel-->>Caller: (return)

Loading

Poem

A batch or not, the question's clear,
Save now knows just when to steer—
If it makes the batch, it seals the fate,
Commits the work, then fetches straight.
But if you bring your own along,
The data waits—commit is strong!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5511a43 and b034cd1.

📒 Files selected for processing (1)

• core/src/model/Ad4mModel.ts (2 hunks)

🔇 Additional comments (2)

core/src/model/Ad4mModel.ts (2)

701-706: Wrap batch lifecycle in try / finally to avoid leaking open batches

If any of the subsequent async calls (createSubject, add, innerUpdate) throw, the batch that was created here will remain open and un-committed.
Persisting a dangling batch can block other writes or trigger dead-locks (cf. #607).

-    let batchCreatedHere = false;
-    if(!batchId) {
-      batchId = await this.perspective.createBatch()
-      batchCreatedHere = true;
-    }
+    let batchCreatedHere = false;
+    if (!batchId) {
+      batchId = await this.perspective.createBatch();
+      batchCreatedHere = true;
+    }
+
+    try {
+      /* rest of save() goes here */
+    } finally {
+      if (batchCreatedHere) {
+        // Commit even when an error is thrown in the body so that the batch
+        // does not linger and block further writes.
+        await this.perspective.commitBatch(batchId);
+      }
+    }

This preserves the current behaviour while guaranteeing cleanup.
If the perspective exposes an explicit abort/discard API you may prefer that in the catch/finally block.
[ suggest_essential_refactor ]

---

734-740: Minor nits – typo & property access consistency

1. Comment typo: “bacht is committedl” → “batch is committed”.
2. You mix this.perspective (getter) and this.#perspective (private field). For consistency with the rest of the class (e.g. lines 725/726) use the # field:

-      await this.perspective.commitBatch(batchId)
-      await this.getData();
+      await this.#perspective.commitBatch(batchId);
+      await this.getData();

(No functional change, but keeps style uniform and avoids accidental override if a subclass shadows the getter.)
[ suggest_nitpick ]

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.