Fix databases worker cache clearing bug by abnegate · Pull Request #10294 · appwrite/appwrite

abnegate · 2025-08-11T07:01:18Z

What does this PR do?

This PR fixes a cache invalidation issue in the Databases worker (src/Appwrite/Platform/Workers/Databases.php). Previously, after creating or deleting attributes and indexes, the collection structure cache was not being properly purged. This led to the UI displaying attributes as processing even after successful creation, as it was still serving stale cached data.

The fix ensures that both the collection document cache and the collection structure cache are purged, forcing the UI to fetch the most up-to-date collection information.

Test Plan

Reproduce the bug (before fix):
- Create a new database and collection.
- Add a new attribute to the collection (e.g., a string attribute).
- Observe the attribute status in the UI. It might remain in a processing state indefinitely or until another collection-modifying action is performed.
Verify the fix (after fix):
- Repeat the steps above.
- After creating the attribute, it should immediately or very quickly reflect its active status in the UI without needing further actions.
- Test with deleting attributes and creating/deleting indexes to ensure consistency.

Related PRs and Issues

N/A

Checklist

Have you read the Contributing Guidelines on issues?
If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

Co-authored-by: jakeb994 <[email protected]>

cursor · 2025-08-11T07:01:19Z

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

coderabbitai · 2025-08-11T07:01:25Z

📝 Walkthrough

Walkthrough

The Databases worker adds collection-level cache invalidation alongside existing document-level cache purges for attribute and index operations. For createAttribute and deleteAttribute, after purging document caches for the main and any related collections, purgeCachedCollection is also invoked for those collections. For createIndex and deleteIndex, the finally blocks now call purgeCachedCollection for the affected collection after purging its document cache. No public interfaces are changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

📜 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 3510b9d and b89d713.

📒 Files selected for processing (1)

src/Appwrite/Platform/Workers/Databases.php (4 hunks)

⏰ 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: Benchmark
GitHub Check: E2E Service Test (Webhooks)
GitHub Check: E2E Service Test (Databases)
GitHub Check: E2E Service Test (Locale)
GitHub Check: E2E Service Test (Tokens)
GitHub Check: E2E Service Test (FunctionsSchedule)
GitHub Check: E2E Service Test (GraphQL)
GitHub Check: E2E Service Test (Avatars)
GitHub Check: Unit Test
GitHub Check: E2E Service Test (Dev Keys)
GitHub Check: E2E General Test

🔇 Additional comments (6)

src/Appwrite/Platform/Workers/Databases.php (6)

228-229: LGTM! Proper cache invalidation for related collection.

The addition of purgeCachedCollection for the related collection ensures that collection structure cache is invalidated alongside the document cache, which is essential for UI consistency when relationship attributes are created.

232-233: LGTM! Consistent cache invalidation pattern.

The cache invalidation follows the correct pattern: first purge the document cache, then purge the collection structure cache. This ensures the UI will fetch fresh collection metadata after attribute creation.

388-389: LGTM! Cache invalidation correctly placed in finally block.

The collection cache purge is properly positioned in the finally block after the document cache purge, ensuring cache consistency even if exceptions occur during attribute deletion.

392-393: LGTM! Symmetric cache invalidation for related collections.

The cache invalidation pattern for related collections in deleteAttribute mirrors the createAttribute implementation, maintaining consistency across operations.

451-452: LGTM! Cache invalidation for index operations.

The addition of collection cache purging after index creation follows the established pattern and ensures the collection metadata reflects the new index state in the UI.

508-509: LGTM! Consistent cache invalidation for index deletion.

The cache invalidation pattern is consistent with other operations, ensuring collection structure changes are properly reflected after index deletion.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch cursor/fix-databases-worker-cache-clearing-bug-2799

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

Support

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

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.

github-actions · 2025-08-11T07:03:37Z

Security Scan Results for PR

Docker Image Scan Results

Package	Version	Vulnerability	Severity
binutils	2.42-r0	CVE-2025-0840	HIGH
git	2.45.3-r0	CVE-2025-48384	HIGH
git	2.45.3-r0	CVE-2025-48385	HIGH
git-init-template	2.45.3-r0	CVE-2025-48384	HIGH
git-init-template	2.45.3-r0	CVE-2025-48385	HIGH
icu	74.2-r0	CVE-2025-5222	HIGH
icu-data-en	74.2-r0	CVE-2025-5222	HIGH
icu-dev	74.2-r0	CVE-2025-5222	HIGH
icu-libs	74.2-r0	CVE-2025-5222	HIGH
libexpat	2.6.4-r0	CVE-2024-8176	HIGH
libxml2	2.12.7-r0	CVE-2024-56171	HIGH
libxml2	2.12.7-r0	CVE-2025-24928	HIGH
libxml2	2.12.7-r0	CVE-2025-27113	HIGH
libxml2	2.12.7-r0	CVE-2025-32414	HIGH
libxml2	2.12.7-r0	CVE-2025-32415	HIGH
pyc	3.12.9-r0	CVE-2024-12718	HIGH
pyc	3.12.9-r0	CVE-2025-4138	HIGH
pyc	3.12.9-r0	CVE-2025-4330	HIGH
pyc	3.12.9-r0	CVE-2025-4517	HIGH
python3	3.12.9-r0	CVE-2024-12718	HIGH
python3	3.12.9-r0	CVE-2025-4138	HIGH
python3	3.12.9-r0	CVE-2025-4330	HIGH
python3	3.12.9-r0	CVE-2025-4517	HIGH
python3-pyc	3.12.9-r0	CVE-2024-12718	HIGH
python3-pyc	3.12.9-r0	CVE-2025-4138	HIGH
python3-pyc	3.12.9-r0	CVE-2025-4330	HIGH
python3-pyc	3.12.9-r0	CVE-2025-4517	HIGH
python3-pycache-pyc0	3.12.9-r0	CVE-2024-12718	HIGH
python3-pycache-pyc0	3.12.9-r0	CVE-2025-4138	HIGH
python3-pycache-pyc0	3.12.9-r0	CVE-2025-4330	HIGH
python3-pycache-pyc0	3.12.9-r0	CVE-2025-4517	HIGH
sqlite-libs	3.45.3-r1	CVE-2025-29087	HIGH
xz	5.6.2-r0	CVE-2025-31115	HIGH
xz-libs	5.6.2-r0	CVE-2025-31115	HIGH
golang.org/x/crypto	v0.31.0	CVE-2025-22869	HIGH
golang.org/x/oauth2	v0.24.0	CVE-2025-22868	HIGH
stdlib	1.22.10	CVE-2025-47907	HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

github-actions · 2025-08-11T07:13:08Z

✨ Benchmark results

Requests per second: 992
Requests with 200 status code: 178,600
P99 latency: 0.187626205

⚡ Benchmark Comparison

Metric	This PR	Latest version
RPS	992	982
200	178,600	176,718
P99	0.187626205	0.197442663

abnegate · 2025-08-11T07:27:31Z

Handling in utopia

abnegate · 2025-08-11T12:20:23Z

Going to go with this approach for short term as the utopia side has some complexities

Purge collection cache alongside document cache in database operations

b89d713

Co-authored-by: jakeb994 <[email protected]>

abnegate marked this pull request as ready for review August 11, 2025 07:03

abnegate closed this Aug 11, 2025

abnegate reopened this Aug 11, 2025

abnegate merged commit 12d0853 into 1.7.x Aug 11, 2025
48 checks passed

abnegate deleted the cursor/fix-databases-worker-cache-clearing-bug-2799 branch August 11, 2025 12:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix databases worker cache clearing bug#10294

Fix databases worker cache clearing bug#10294
abnegate merged 1 commit into1.7.xfrom
cursor/fix-databases-worker-cache-clearing-bug-2799

abnegate commented Aug 11, 2025

Uh oh!

cursor bot commented Aug 11, 2025

Uh oh!

coderabbitai bot commented Aug 11, 2025 •

edited

Loading

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

abnegate commented Aug 11, 2025

Uh oh!

abnegate commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

abnegate commented Aug 11, 2025

What does this PR do?

Test Plan

Related PRs and Issues

Checklist

Uh oh!

cursor bot commented Aug 11, 2025

Uh oh!

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

Uh oh!

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Security Scan Results for PR

Docker Image Scan Results

Source Code Scan Results

Uh oh!

github-actions bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✨ Benchmark results

⚡ Benchmark Comparison

Uh oh!

abnegate commented Aug 11, 2025

Uh oh!

abnegate commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coderabbitai bot commented Aug 11, 2025 •

edited

Loading

github-actions bot commented Aug 11, 2025 •

edited

Loading

github-actions bot commented Aug 11, 2025 •

edited

Loading