8000 Transfer control for the migration by ArnabChatterjee20k · Pull Request #9997 · appwrite/appwrite · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Transfer control for the migration #9997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 11, 2025

Conversation

ArnabChatterjee20k
Copy link
Contributor
@ArnabChatterjee20k ArnabChatterjee20k commented Jun 11, 2025

What does this PR do?

(Provide a description of what this PR does and why it's needed.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Screenshots may also be helpful.)

Related PRs and Issues

  • (Related PR or issue)

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?

Summary by CodeRabbit

  • Bug Fixes
    • Improved migration reliability by ensuring transfers only run when the source has no errors, preventing failed migrations from proceeding.

Copy link
coderabbitai bot commented Jun 11, 2025

Walkthrough

The migration workflow was updated to include a conditional check that ensures the migration transfer only proceeds if the source has no errors. If errors are present in the source, the transfer step is skipped, but shutdown procedures for both source and destination still execute as before.

Changes

File Change Summary
src/Appwrite/Platform/Workers/Migrations.php Added a condition to check for source errors before initiating the migration transfer process.

Sequence Diagram(s)

sequenceDiagram
    participant Worker
    participant Source
    participant Destination

    Worker->>Source: getErrors()
    alt No errors
        Worker->>Worker: Set stage to "migrating"
        Worker->>Worker: Update migration document
        Worker->>Destination: Execute transfer
    else Source has errors
        Worker->>Worker: Skip transfer run
    end
    Worker->>Destination: Shutdown
    Worker->>Source: Shutdown
Loading

Poem

A rabbit checks the source with care,
If errors lurk, it won’t go there.
No transfer run, but shutdown’s due,
The process neat, the logic true.
With cautious hops and tidy code,
This migration takes a safer road! 🐇✨

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

Copy link
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/Appwrite/Platform/Workers/Migrations.php (2)

282-296: Also update status when switching to the migrating stage

Great call adding the pre-check that skips the transfer when the source already contains errors.
However, we now only update stage to migrating while leaving status at its previous value (processing).
Down-stream consumers may rely on both fields evolving in tandem – all other stage transitions in this worker update both attributes.

-                $migration->setAttribute('stage', 'migrating');
+                $migration
+                    ->setAttribute('stage', 'migrating')
+                    ->setAttribute('status', 'migrating');

This keeps the state machine self-consistent and avoids confusion in dashboards or client SDKs that watch the document.


288-292: Use exceptions on JSON encoding to surface silent failures

json_encode() can silently return false (e.g. on UTF-8 errors).
Leveraging JSON_THROW_ON_ERROR makes data-loss obvious and will bubble the problem up to existing error handling.

-                        $migration->setAttribute('resourceData', json_encode($transfer->getCache()));
-                        $migration->setAttribute('statusCounters', json_encode($transfer->getStatusCounters()));
+                        $migration->setAttribute('resourceData', json_encode($transfer->getCache(), JSON_THROW_ON_ERROR));
+                        $migration->setAttribute('statusCounters', json_encode($transfer->getStatusCounters(), JSON_THROW_ON_ERROR));

This minor change improves robustness with negligible overhead.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 077c80c and 84f4a5d.

📒 Files selected for processing (1)
  • src/Appwrite/Platform/Workers/Migrations.php (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/Appwrite/Platform/Workers/Migrations.php (2)
src/Appwrite/SDK/Method.php (1)
  • getErrors (291-294)
app/realtime.php (1)
  • getCache (127-147)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: Setup & Build Appwrite Image
  • GitHub Check: scan

Copy link

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
binutils 2.42-r0 CVE-2025-0840 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-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-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-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-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

Source Code Scan Results

🎉 No vulnerabilities found!

@abnegate abnegate merged commit 7fb4dc5 into appwrite:1.8.x Jun 11, 2025
37 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jun 11, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0