Fix $skipPermissionsUpdate #640

fogelito · 2025-07-28T09:28:05Z

Summary by CodeRabbit

Bug Fixes
- Improved handling of permission updates during document modifications to ensure permissions are only updated when necessary.
Tests
- Added a new test to verify correct behavior when skipping permission updates during document creation or update.

coderabbitai · 2025-07-28T09:28:11Z

Walkthrough

The default initialization of the $skipPermissionsUpdate variable in the createOrUpdateDocumentsWithIncrease method of src/Database/Database.php was changed from false to true. Additionally, a new test method testSkipPermissions was added in tests/e2e/Adapter/Scopes/DocumentTests.php to verify the behavior of skipping permission updates. No other logic or public API signatures were altered.

Changes

Cohort / File(s)	Change Summary
Permissions Update Flag Initialization `src/Database/Database.php`	Changed default value of `$skipPermissionsUpdate` from `false` to `true` in `createOrUpdateDocumentsWithIncrease` method. No other logic modified.
New Permission Skipping Test `tests/e2e/Adapter/Scopes/DocumentTests.php`	Added `testSkipPermissions` method to test skipping permission updates during document create-or-update operations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Skip permissions updates #636: Adds a $skipPermissions parameter to the updateDocument method to control permission updates, directly related to the flag initialization changed in this PR.
Skip permissions update #611: Introduces and propagates a $skipPermissions boolean parameter through updateDocument methods, similar in intent to the flag adjustment here.
Revert "Skip permissions update" #631: Removes the $skipPermissions parameter and enforces always updating permissions, modifying the same logic but in an opposite direction.

Suggested reviewers

abnegate

Poem

A hop and a skip, permissions anew,
Now true by default, the flag hops through.
No more false starts, just a swift review,
The code is concise, the changes are few.
🐇✨

📜 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 5f6c1fb and f76954b.

📒 Files selected for processing (1)

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

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

tests/e2e/Adapter/Scopes/DocumentTests.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). (10)

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

✨ 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-constructor

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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7281582 and 15e985b.

📒 Files selected for processing (1)

src/Database/Database.php (2 hunks)

🔇 Additional comments (2)

src/Database/Database.php (2)

4944-4944: Verify consistency with updateDocument method.

The same logic change has been applied here as in the updateDocument method - changing $skipPermissionsUpdate default from false to true. This maintains consistency between the two methods.

However, the same concerns apply: ensure that defaulting to skip permissions updates when no explicit permissions comparison occurs is the intended behavior for batch operations.

The change is consistent with the updateDocument method, but verify that the default behavior change is intentional for batch document operations.

4113-4121: Permissions comparison logic remains intact.

The conditional logic that compares original and current permissions and updates $skipPermissionsUpdate accordingly remains unchanged. This means:

If permissions exist on the document, they will be compared

If permissions are identical, $skipPermissionsUpdate remains true

If permissions differ, $skipPermissionsUpdate is set to false

This preserves the core functionality while changing only the default behavior when permissions comparison doesn't occur.

Also applies to: 4946-4954

src/Database/Database.php

coderabbitai

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 15e985b and 5f6c1fb.

📒 Files selected for processing (2)

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

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

src/Database/Database.php

🧰 Additional context used

🪛 GitHub Actions: Linter

tests/e2e/Adapter/Scopes/DocumentTests.php

[error] 1-1: PHP CS Fixer (pint) PSR-12 style check failed: function declaration braces placement issue.

⏰ 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). (10)

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

🔇 Additional comments (1)

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

391-452: LGTM! Well-structured test for skipping permissions functionality.

The test implementation is solid with proper defensive checks, clear test data setup, and appropriate assertions. It correctly validates the behavior of skipping permission updates during document operations by:

Checking adapter support for upserts

Creating test data with incremental documents

Modifying existing and adding new documents

Properly managing authorization state

Verifying exactly 2 documents are affected (1 updated + 1 added)

This test effectively validates the fix for $skipPermissionsUpdate mentioned in the PR objectives.

tests/e2e/Adapter/Scopes/DocumentTests.php

fogelito added 5 commits July 28, 2025 09:51

check isset

7d61325

Use array_key_exists

cdec2ab

Use isset

2613dde

Use array_key_exists

2d37031

$skipPermissionsUpdate true

4b9fb29

Remove comment

15e985b

coderabbitai bot reviewed Jul 28, 2025

View reviewed changes

src/Database/Database.php Outdated Show resolved Hide resolved

fogelito added 4 commits July 28, 2025 13:38

$skipPermissionsUpdate true

e46c4ff

Remove comment

957a496

Add test

5f6c1fb

formatting

f76954b

coderabbitai bot reviewed Jul 28, 2025

View reviewed changes

tests/e2e/Adapter/Scopes/DocumentTests.php Outdated Show resolved Hide resolved

abnegate approved these changes Jul 28, 2025

View reviewed changes

abnegate merged commit a893ea6 into main Jul 28, 2025
15 checks passed

abnegate deleted the document-constructor branch July 28, 2025 12:28

This was referenced Jul 28, 2025

Skip permissions update true #641

Merged

Mongo upsert #619

Closed

Fix encode permissions #645

Merged

Fix update documents #646

Merged

coderabbitai bot mentioned this pull request Sep 4, 2025

Pass old to update on next, rename to upsert #685

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix $skipPermissionsUpdate #640

Fix $skipPermissionsUpdate #640

Uh oh!

fogelito commented Jul 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 28, 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!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix $skipPermissionsUpdate #640

Fix $skipPermissionsUpdate #640

Uh oh!

Conversation

fogelito commented Jul 28, 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 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

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!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fogelito commented Jul 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 28, 2025 •

edited

Loading