Skip to content

Comments

fix: workspace user property migration#5908

Merged
pushya22 merged 2 commits intopreviewfrom
fix/workspace-user-properties-migration
Oct 30, 2024
Merged

fix: workspace user property migration#5908
pushya22 merged 2 commits intopreviewfrom
fix/workspace-user-properties-migration

Conversation

@NarayanBavisetti
Copy link
Collaborator

@NarayanBavisetti NarayanBavisetti commented Oct 24, 2024

fix:

  • changed the import statements of the models from the latest version to the version present at that particular time.

Summary by CodeRabbit

  • New Features
    • Enhanced data handling for user and project properties, improving the accuracy of workspace and project member associations.
    • Improved bulk operations for managing issue views, optimizing performance for large datasets.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Warning

Rate limit exceeded

@NarayanBavisetti has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 6 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 2671527 and 501e807.

Walkthrough

The changes involve modifications to a Django migration script located in apiserver/plane/db/migrations/0053_auto_20240102_1315.py. These modifications include adding necessary model imports for WorkspaceUserProperties, ProjectMember, and IssueView, and refining the data handling processes for bulk operations related to these models. The migration script now correctly utilizes these models to create and update instances based on existing data.

Changes

File Path Change Summary
apiserver/plane/db/migrations/0053_auto_20240102_1315.py Added imports for WorkspaceUserProperties, ProjectMember, and IssueView. Updated data handling for bulk_create and bulk_update operations.

Possibly related PRs

Suggested labels

⚙️backend, 🧹chore

Suggested reviewers

  • pablohashescobar
  • sriramveeraghanta

🐇 In the code we hop and play,
New imports brighten up the day!
With models ready, swift and bright,
Our migrations take their flight!
Bulk updates, creations, all in line,
A smoother path, oh how divine! 🌟


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

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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

🧹 Outside diff range and nitpick comments (3)
apiserver/plane/db/migrations/0053_auto_20240102_1315.py (3)

Line range hint 30-47: Add logging for skipped records and null checks

The function silently skips IssueProperty records without matching ProjectMember entries. Consider:

  1. Adding logging to track skipped records
  2. Adding null checks for view_props access

Here's a suggested improvement:

 for issue_property in IssueProperty.objects.all():
     project_member = ProjectMember.objects.filter(
         project_id=issue_property.project_id,
         member_id=issue_property.user_id,
     ).first()
     if project_member:
-        issue_property.filters = project_member.view_props.get("filters")
-        issue_property.display_filters = project_member.view_props.get(
-            "display_filters"
-        )
+        view_props = project_member.view_props or {}
+        issue_property.filters = view_props.get("filters", {})
+        issue_property.display_filters = view_props.get("display_filters", {})
         updated_issue_user_properties.append(issue_property)
+    else:
+        print(f"No ProjectMember found for IssueProperty {issue_property.id}")

Line range hint 53-69: Standardize batch size and add data validation

The implementation has several potential improvements:

  1. The batch_size (100) is inconsistent with other functions (2000)
  2. Missing handling of existing records
  3. No validation for nullable fields

Consider applying these improvements:

 def issue_view(apps, schema_editor):
     GlobalView = apps.get_model("db", "GlobalView")
     IssueView = apps.get_model("db", "IssueView")
     updated_issue_views = []
 
     for global_view in GlobalView.objects.all():
+        # Skip if view already exists
+        if IssueView.objects.filter(
+            workspace_id=global_view.workspace_id,
+            name=global_view.name
+        ).exists():
+            continue
+
         updated_issue_views.append(
             IssueView(
                 workspace_id=global_view.workspace_id,
                 name=global_view.name,
-                description=global_view.description,
+                description=global_view.description or "",
                 query=global_view.query,
                 access=global_view.access,
                 filters=global_view.query_data.get("filters", {}),
                 sort_order=global_view.sort_order,
                 created_by_id=global_view.created_by_id,
                 updated_by_id=global_view.updated_by_id,
             )
         )
-    IssueView.objects.bulk_create(updated_issue_views, batch_size=100)
+    IssueView.objects.bulk_create(updated_issue_views, batch_size=2000)

Line range hint 78-84: Add reverse migration handlers

The migration operations don't include reverse handlers, which could make it difficult to rollback changes if needed.

Consider adding reverse handlers to each RunPython operation:

     operations = [
-        migrations.RunPython(workspace_user_properties),
-        migrations.RunPython(project_user_properties),
-        migrations.RunPython(issue_view),
+        migrations.RunPython(
+            workspace_user_properties,
+            reverse_code=migrations.RunPython.noop
+        ),
+        migrations.RunPython(
+            project_user_properties,
+            reverse_code=migrations.RunPython.noop
+        ),
+        migrations.RunPython(
+            issue_view,
+            reverse_code=migrations.RunPython.noop
+        ),
     ]
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 14b31e3 and 2671527.

📒 Files selected for processing (1)
  • apiserver/plane/db/migrations/0053_auto_20240102_1315.py (3 hunks)
🔇 Additional comments (1)
apiserver/plane/db/migrations/0053_auto_20240102_1315.py (1)

Line range hint 7-24: Consider handling existing records and data validation

The migration creates new WorkspaceUserProperties records but doesn't handle potential existing records or validate view_props data. Consider:

  1. Adding a check for existing records to prevent duplicates
  2. Adding data validation for view_props to handle None/null values

Let's verify if there are any existing records:

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.

3 participants