Fix IsNew logic

[myieye]

I started working on deferring intermediate snapshot selection and ran into this bug. Somehow we both 😱 overlooked that the boolean logic was backwards and that it's important to check pending before root.

I expect to delete the IsNew check entirely, but this PR also corrects the snapshot data of a test, so I'd like to merge it first.

Summary by CodeRabbit

• New Features

  • Introduced enhanced tracking by capturing detailed snapshots during content updates, enriching the historical record for revisions.

• Refactor

  • Restructured internal identifiers to improve consistency.
  • Revised the logic for determining update status, ensuring a more reliable and accurate change history for a better review experience.

[coderabbitai]

Walkthrough

This pull request introduces modifications to both a JSON commit history file and the snapshot evaluation logic. The changes in the commit history file update various identifier properties and add a new snapshots array to a commit, reflecting a more detailed merged history. Meanwhile, the SnapshotWorker.IsNew method has its control flow reversed by checking pending snapshots before root snapshots and inverting the comparison conditions.

Changes

File(s)	Change Summary
src/SIL.Harmony.Tests/...Writing2ChangesAtOnceWithMergedHistory.verified.txt	Updated commit objects: added a new Snapshots array to the second commit; updated CommitId, CompareKey (Item3), and Id across the second, third, and fourth commits to new GUID values; adjusted corresponding properties in the snapshot and change entities.
src/SIL.Harmony/SnapshotWorker.cs	Modified the IsNew method in SnapshotWorker: changed the sequence of lookup from checking _rootSnapshots first to _pendingSnapshots first and reversed the logic for comparing snapshot IDs.

Sequence Diagram(s)

sequenceDiagram
    participant SW as SnapshotWorker
    participant PS as _pendingSnapshots
    participant RS as _rootSnapshots
    participant S as Snapshot Input

    S->>SW: Call IsNew(snapshot)
    SW->>PS: Lookup snapshot by entity ID
    alt Pending Snapshot Found
        PS-->>SW: Return pending snapshot
        SW->>SW: Compare pending snapshot ID with incoming snapshot
        SW-->>S: Return true if IDs match
    else No Pending Snapshot
        SW->>RS: Lookup snapshot by entity ID
        RS-->>SW: Return root snapshot
        SW->>SW: Compare root snapshot ID with incoming snapshot
        SW-->>S: Return true if IDs match
    end

Loading

Suggested reviewers

• hahn-kev

Poem

I'm a hopping rabbit with code so neat,
Carrots of change in every commit I meet.
IDs and snapshots spring to life anew,
Logic reversed shines like morning dew.
With a twitch of my nose, I cheer this spree—
Git burrows are joyful as can be!
🐇🌸

---

📜 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 55f4ac3 and 4c12f3d.

📒 Files selected for processing (2)

• src/SIL.Harmony.Tests/DataModelSimpleChanges.Writing2ChangesAtOnceWithMergedHistory.verified.txt (8 hunks)
• src/SIL.Harmony/SnapshotWorker.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: build
• GitHub Check: build
• GitHub Check: Analyze (csharp)

🔇 Additional comments (5)

src/SIL.Harmony/SnapshotWorker.cs (1)

242-254: Fixed backwards boolean logic in IsNew method

The changes to the IsNew method correctly fix two key issues:

1. The order of checking snapshots has been properly rearranged to check pending snapshots before root snapshots
2. The return conditions have been inverted to correctly identify when a snapshot is new

This aligns with the PR objective to fix the backwards boolean logic mentioned in the PR description. The method now correctly identifies whether a snapshot is new based on ID comparison.

src/SIL.Harmony.Tests/DataModelSimpleChanges.Writing2ChangesAtOnceWithMergedHistory.verified.txt (4)

53-69: Added snapshot data in test to align with implementation changes

The addition of the Snapshots array to the second Commit object properly updates the test data to reflect the changes in snapshot handling logic. This ensures the test case correctly validates the fixed IsNew logic implementation.

---

75-76: Updated commit identifiers for consistency

The updated commit IDs ensure consistency throughout the test data structure, maintaining the integrity of the relationships between commits and snapshots after the logic changes.

Also applies to: 88-90

---

108-109: Updated commit references in third commit

These changes ensure proper sequencing of commit IDs, maintaining the integrity of the commit history after adjusting the IsNew logic.

Also applies to: 121-123

---

139-140: Updated final commit references and snapshot IDs

These changes complete the update of all related identifiers in the test data, ensuring the entire commit history properly reflects the behavior of the fixed IsNew logic.

Also applies to: 149-150, 158-159, 171-173

✨ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.

[hahn-kev]

Nice catch. I think we need a way to test the SnapshotWorker directly as it's far too complicated to test indirectly which is why we've got so many issues here. Either that or we break it up to make it more testable.

As for the order, I actually think we should check both dictionaries for snapshots, maybe it won't matter based on our current patterns. Though I guess if you plan to remove it then it doesn't matter.