Skip to content
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

fix: Logout all users instead of redis session migration for tenant to org migration #39392

Merged
merged 1 commit into from
Feb 21, 2025

Conversation

trishaanand
Copy link
Contributor

@trishaanand trishaanand commented Feb 21, 2025

…overcome performance bottleneck for redis session migration

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

🔍 Cypress test results

Caution

If you modify the content in this section, you are likely to disrupt the CI result for your PR.

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes
    • Optimized the migration process to avoid startup delays in clustered environments.
  • New Features
    • Added a new migration step that clears cached data to help ensure system freshness.

These updates enhance overall startup performance and improve data freshness for a smoother user experience.

…overcome performance bottleneck for redis session migration
Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Walkthrough

The changes modify the migration process by removing a Redis data migration call in the existing migration class and adding a new migration class. The first change omits the call to migrateRedisData() from the execute() method to address timeout issues in Kubernetes. The new migration class, Migration066_CacheBustTenantOrgMigration, introduces logic to scan Redis keys with a wildcard pattern, delete them in batches, and log progress during the cache bust process.

Changes

File(s) Change Summary
app/.../Migration065_CopyTenantIdToOrganizationId.java Removed the call to migrateRedisData() in the execute() method with an explanatory comment regarding Kubernetes startup probe timeouts.
app/.../Migration066_CacheBustTenantOrgMigration.java Added a new migration class with an execute() method that scans for and deletes Redis keys in batches, logs progress, and includes an empty rollback method.

Sequence Diagram(s)

sequenceDiagram
    participant M as Migration066_CacheBustTenantOrgMigration
    participant R as ReactiveRedisOperations

    M->>R: scanForKeysAcrossCluster(pattern="*")
    Note right of M: Process keys in batches of 1000
    R-->>M: Batch of matching keys
    M->>R: Delete keys from batch
    M->>M: Log progress (every 10,000 keys)
    M->>M: Complete migration and log final count
Loading

Possibly related PRs

Suggested labels

Bug, Enhancement, Production, Needs Triaging, ok-to-test

Suggested reviewers

  • sharat87
  • mohanarpit
  • abhvsn

Poem

In the realm of code we play,
Where keys are cleared in a clever way.
Old calls retire, new paths arise,
Redis keys vanish under watchful eyes.
A migration tale both swift and bright,
Cheers to our code taking flight!
🚀✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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 github-actions bot added the Bug Something isn't working label Feb 21, 2025
Copy link
Contributor

@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)
app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration066_CacheBustTenantOrgMigration.java (2)

17-18: Add a brief Javadoc comment to clarify purpose.
Providing a short explanation of the migration's goal (i.e., clearing out potentially stale Redis keys after tenant-to-org migration) would make maintenance and future reference easier.


30-57: Consider more granular patterns or configurable chunk sizes.
Scanning all keys with "*" could be too broad and may inadvertently delete non-related data. Allowing a refined pattern or introducing configuration for chunk size (currently 1000) might offer safer and more targeted performance.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c6b76b8 and 8225ac3.

📒 Files selected for processing (2)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration065_CopyTenantIdToOrganizationId.java (1 hunks)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration066_CacheBustTenantOrgMigration.java (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: server-spotless / spotless-check
  • GitHub Check: server-unit-tests / server-unit-tests
🔇 Additional comments (2)
app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration066_CacheBustTenantOrgMigration.java (1)

25-27: Validate whether blocking is appropriate.
Calling .block() in a migration is generally acceptable, but ensure there's no risk of blocking the main thread if an environment is configured with limited startup time.

app/server/appsmith-server/src/main/java/com/appsmith/server/migrations/db/ce/Migration065_CopyTenantIdToOrganizationId.java (1)

60-63: Ensure downstream processes are unaffected.
The removal/comment-out of migrateRedisData() is justified due to migration timeout issues, but confirm there's no overlooked dependency on this migration step.

@trishaanand
Copy link
Contributor Author

Force merging this in since cypress tests for migration would not assert for anything.

@trishaanand trishaanand merged commit d1a9c18 into release Feb 21, 2025
16 checks passed
@trishaanand trishaanand deleted the fix/logout-all-users branch February 21, 2025 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants