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: remove caching for avatar and logo apis to handle updates on avatar and logos. #6072

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

pablohashescobar
Copy link
Collaborator

@pablohashescobar pablohashescobar commented Nov 19, 2024

Description

Remove caching from user related apis to handle updates to avatars and cover images. Old image links are still returned even when the new images are uploaded resulting in broken UI.

Summary by CodeRabbit

  • New Features

    • Simplified caching strategy for user and workspace-related endpoints.
  • Bug Fixes

    • Improved performance and data freshness by removing outdated caching mechanisms.
  • Chores

    • Updated caching behavior for various user and workspace methods to enhance data retrieval efficiency.

Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

Walkthrough

The changes in this pull request primarily involve the removal of caching decorators from various methods across multiple classes in the apiserver module. Notable modifications include the UserEndpoint, WorkSpaceViewSet, and WorkSpaceMemberViewSet classes, where caching mechanisms such as @cache_response and @invalidate_cache have been eliminated. This impacts how data is cached and invalidated for user and workspace-related operations, while the core logic and error handling within the methods remain unchanged.

Changes

File Path Change Summary
apiserver/plane/app/views/user/base.py Removed @cache_response from retrieve, retrieve_user_settings, and retrieve_instance_admin. Removed @invalidate_cache from partial_update, deactivate, UpdateUserOnBoardedEndpoint, and UpdateUserTourCompletedEndpoint.
apiserver/plane/app/views/workspace/base.py Removed @invalidate_cache from create, partial_update, and destroy methods in WorkSpaceViewSet. Removed @cache_response from get method in UserWorkSpacesEndpoint.
apiserver/plane/app/views/workspace/member.py Removed @cache_response from list, partial_update, and destroy methods in WorkSpaceMemberViewSet. Removed @invalidate_cache from partial_update, destroy, and leave methods.

Possibly related PRs

Suggested labels

🌟improvement

Suggested reviewers

  • sriramveeraghanta
  • aaryan610

Poem

🐇 In the code where rabbits play,
Caching's gone, it's a brand new day!
With updates swift and data fresh,
We hop along, no need to mesh.
So let us cheer for changes bright,
In the code, we find delight! 🌟


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 (1)
apiserver/plane/app/views/workspace/member.py (1)

Line range hint 156-165: Consider removing remaining cache invalidation decorators

The leave method still contains cache invalidation decorators while other methods had their caching removed. This inconsistency might still cause issues with avatar and logo updates.

Consider removing these decorators to maintain consistency with the PR's objective:

-    @invalidate_cache(
-        path="/api/workspaces/:slug/members/",
-        url_params=True,
-        user=False,
-        multiple=True,
-    )
-    @invalidate_cache(path="/api/users/me/settings/")
-    @invalidate_cache(
-        path="api/users/me/workspaces/", user=False, multiple=True
-    )
     @allow_permission(
         allowed_roles=[ROLE.ADMIN, ROLE.MEMBER, ROLE.GUEST], level="WORKSPACE"
     )
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c1ac6e4 and 51467e9.

📒 Files selected for processing (3)
  • apiserver/plane/app/views/user/base.py (0 hunks)
  • apiserver/plane/app/views/workspace/base.py (0 hunks)
  • apiserver/plane/app/views/workspace/member.py (1 hunks)
💤 Files with no reviewable changes (2)
  • apiserver/plane/app/views/user/base.py
  • apiserver/plane/app/views/workspace/base.py
🔇 Additional comments (2)
apiserver/plane/app/views/workspace/member.py (2)

Line range hint 1-400: Verify frontend handling of uncached responses

With the removal of caching for workspace member data, ensure that:

  1. The frontend correctly handles potentially slower responses
  2. Avatar and logo updates are properly reflected without manual refresh

Let's check for related frontend code:

#!/bin/bash
# Description: Look for frontend code that might need updates
# Search for avatar/logo-related components and API calls

# Find avatar/logo-related components
rg -l "avatar|logo" --type ts --type tsx

# Find workspace member API calls
rg -l "workspaces/.+/members" --type ts --type tsx

Line range hint 65-91: Monitor performance impact after cache removal

The removal of caching for the workspace member list aligns with the PR objective to handle immediate updates of avatars and logos. However, this could impact API response times for workspaces with many members.

Let's verify the potential performance impact:

Consider implementing:

  1. Client-side caching with proper cache invalidation for non-avatar/logo data
  2. Pagination if not already implemented
  3. Performance monitoring for this endpoint

@sriramveeraghanta sriramveeraghanta merged commit a3e8ee6 into preview Nov 19, 2024
14 of 15 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix-user-caching branch December 5, 2024 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants