Refactor DocumentTests to improve test coverage and structure

[ArnabChatterjee20k]

Summary by CodeRabbit

• Bug Fixes

  • Improved consistency of the updated timestamp when updating documents, ensuring the correct updated time is used throughout the operation.

• Tests

  • Added a test to verify that the updated timestamp changes appropriately when updating a document with preserved dates.

[coderabbitai]

Walkthrough

The update modifies the updateDocument method in the database logic to consistently use a pre-captured updatedAt timestamp during document updates. Additionally, a new test case is added to verify correct updating of the $updatedAt attribute when dates are preserved and non-date attributes change.

Changes

Cohort / File(s)	Change Summary
Database Logic Update src/Database/Database.php	Refactored updateDocument to capture updatedAt before the transaction and consistently use this value during updates.
End-to-End Date Handling Test tests/e2e/Adapter/Scopes/DocumentTests.php	Added a test case to verify $updatedAt changes correctly when preserving dates and updating non-date attributes.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Database
    participant Transaction

    Caller->>Database: updateDocument(document, ...)
    Database->>Database: Capture newUpdatedAt from input document
    Database->>Transaction: Start transaction
    Transaction->>Database: Execute update using newUpdatedAt
    Transaction-->>Database: Commit transaction
    Database-->>Caller: Return updated document

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

• Allow modifying createdAt and updatedAt #642: Refactors updateDocument with stricter null checks for date attributes and modifies handling of updatedAt, directly overlapping with the updateDocument logic in this PR.

Suggested reviewers

• abnegate

Poem

In the warren where timestamps hop,
We caught the date before the swap—
Now updates stay true,
And our tests prove it too,
As carrots for coders, we never stop! 🥕✨

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0e9b85b and 667878c.

📒 Files selected for processing (2)

• src/Database/Database.php (2 hunks)
• tests/e2e/Adapter/Scopes/DocumentTests.php (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/Database/Database.php (2)

src/Database/Document.php (2)

• getUpdatedAt (164-167)
• setAttribute (236-253)

src/Database/Adapter.php (1)

• withTransaction (372-404)

🔇 Additional comments (3)

src/Database/Database.php (2)

4104-4105: ✅ Good call capturing $updatedAt before the transaction

Grabbing the original $updatedAt into $newUpdatedAt eliminates the race where later mutations inside the transaction would cause getUpdatedAt() to return the post-merge value, preventing the timestamp from being refreshed.
LGTM.

---

4254-4255: Updated-at logic now uses the pre-captured value

The new ternary guarantees:

$updatedAt = ($newUpdatedAt === null || !$this->preserveDates)
             ? $time            // auto-bump
             : $newUpdatedAt;   // keep caller-supplied value

which exactly matches the intended “preserve dates unless caller gave one” rule.
Looks correct and fixes the previously failing edge case tested in DocumentTests.

tests/e2e/Adapter/Scopes/DocumentTests.php (1)

4837-4855: LGTM! Well-implemented test case for preserve dates functionality.

This test case effectively verifies the correct behavior of $updatedAt attribute updates when preserve dates is enabled and only non-date attributes are modified. The test logic is sound:

1. Properly enables preserve dates mode
2. Creates a document with custom $createdAt to establish baseline
3. Captures initial $updatedAt for comparison
4. Updates with a new document containing only non-date attribute changes
5. Correctly asserts that $updatedAt is automatically updated by the system
6. Includes proper cleanup

This addresses an important edge case ensuring that $updatedAt is properly maintained even when date attributes aren't explicitly set in update operations.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dat-588

---

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 generate unit tests to generate unit tests 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.

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.