Document nulls #633

fogelito · 2025-07-23T14:48:02Z

Summary by CodeRabbit

Tests
- Added a new test to verify handling of null values in documents, ensuring correct behavior when accessing or checking keys with null values.
- Updated test configuration to stop execution immediately upon the first test failure for faster feedback.

coderabbitai · 2025-07-23T14:48:09Z

"""

Walkthrough

A new test method testDocumentNulls is added to DocumentTest to verify behavior of null values and isset checks on array keys and Document objects. The Document constructor is updated to explicitly unset a reference variable after a loop. Additionally, the PHPUnit configuration is updated to stop test execution immediately upon the first failure.

Changes

File(s)	Change Summary
tests/unit/DocumentTest.php	Added `testDocumentNulls` method testing `null` values and `isset` behavior on arrays and Document objects.
src/Database/Document.php	Added `unset($value);` after a `foreach` by-reference loop in `Document` constructor to clear reference.
phpunit.xml	Modified PHPUnit config to set `stopOnFailure="true"` to halt on first test failure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A test for nulls, both false and true,
In Document's world, what does isset do?
PHPUnit now halts when failures brew,
Rabbits debug with a keen-eyed view.
🐇 Hopping through code, seeking what's new!
"""

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 d70dca1 and 5e2b293.

📒 Files selected for processing (1)

tests/unit/DocumentTest.php (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

tests/unit/DocumentTest.php

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

GitHub Check: Adapter Tests (SharedTables/Postgres)
GitHub Check: Adapter Tests (Pool)
GitHub Check: Adapter Tests (MySQL)
GitHub Check: Adapter Tests (SharedTables/MariaDB)
GitHub Check: Adapter Tests (SharedTables/SQLite)
GitHub Check: Adapter Tests (SharedTables/MySQL)
GitHub Check: Adapter Tests (Mirror)
GitHub Check: Adapter Tests (SQLite)
GitHub Check: Adapter Tests (MariaDB)
GitHub Check: Adapter Tests (Postgres)
GitHub Check: Unit Test

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch document-nulls

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

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

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (2)

tests/unit/DocumentTest.php (2)
11-11: Remove unused import.

The Authorization class is imported but not used in the test method. This creates unnecessary clutter and potential confusion.
-use Utopia\Database\Validator\Authorization;
75-77: Clean up commented debug code.

Remove the commented debug code as it's not needed in the final test.
-//        $doc = new \ArrayObject($nulls);
-//        var_dump(isset($doc['error']));
-//        var_dump(isset($doc['$shmuel']));

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f7a26a2 and 0d398a2.

📒 Files selected for processing (1)

tests/unit/DocumentTest.php (2 hunks)

🧬 Code Graph Analysis (1)

tests/unit/DocumentTest.php (2)

src/Database/Validator/Authorization.php (1)

Authorization (7-225)

src/Database/Document.php (2)

Document (12-460)

getAttribute (212-219)

🧰 Additional context used

🧬 Code Graph Analysis (1)

tests/unit/DocumentTest.php (2)

src/Database/Validator/Authorization.php (1)

Authorization (7-225)

src/Database/Document.php (2)

Document (12-460)

getAttribute (212-219)

🔇 Additional comments (2)

tests/unit/DocumentTest.php (2)

87-88: Good baseline testing of PHP array behavior.

These assertions correctly establish the expected behavior of null values in plain PHP arrays before testing Document behavior.

91-97: Correct testing of Document null value behavior.

These assertions properly test that Document instances handle null values consistently with plain arrays - returning null for access and false for isset().

…ulls

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

phpunit.xml (1)

10-10: Reconsider enabling stopOnFailure globally

Fail-fast shortens feedback loops but hides subsequent failures, reducing diagnostic value—especially in CI where you typically want a full report. Consider enabling this flag only for local runs (e.g., via a separate phpunit.dev.xml or an env-driven override) and keep the default config collecting all failures.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0d398a2 and b793ce2.

📒 Files selected for processing (2)

phpunit.xml (1 hunks)
tests/unit/DocumentTest.php (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

tests/unit/DocumentTest.php

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

GitHub Check: Adapter Tests (SharedTables/Postgres)
GitHub Check: Adapter Tests (Pool)
GitHub Check: Adapter Tests (MySQL)
GitHub Check: Adapter Tests (SharedTables/SQLite)
GitHub Check: Adapter Tests (SharedTables/MySQL)
GitHub Check: Adapter Tests (SharedTables/MariaDB)
GitHub Check: Adapter Tests (Mirror)
GitHub Check: Adapter Tests (Postgres)
GitHub Check: Adapter Tests (MariaDB)

test

0d398a2

coderabbitai bot reviewed Jul 23, 2025

View reviewed changes

Merge branch 'main' of github.com:utopia-php/database into document-n…

8a1a739

…ulls

utopia-php deleted a comment from coderabbitai bot Jul 23, 2025

fogelito added 2 commits July 23, 2025 19:22

Test

0573b80

formatting

b793ce2

coderabbitai bot reviewed Jul 23, 2025

View reviewed changes

fogelito and others added 8 commits July 23, 2025 19:29

Change name

20a1707

message

d5a8f72

message

f1db879

Unset value

b0e9f49

Bug fix

8bb8cdb

Cat Dog

d70dca1

Last test

5e2b293

stopOnFailure

14e3384

fogelito requested a review from abnegate July 24, 2025 09:56

abnegate approved these changes Jul 24, 2025

View reviewed changes

abnegate merged commit d5e57c2 into main Jul 24, 2025
15 checks passed

abnegate deleted the document-nulls branch July 24, 2025 09:58

coderabbitai bot mentioned this pull request Jul 24, 2025

Optimize update document #635

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Document nulls #633

Document nulls #633

Uh oh!

fogelito commented Jul 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 23, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Document nulls #633

Document nulls #633

Uh oh!

Conversation

fogelito commented Jul 23, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fogelito commented Jul 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 23, 2025 •

edited

Loading