Skip to content

[WEB-3309] fix: project stats endpoint#6544

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
fix-project-properties
Feb 4, 2025
Merged

[WEB-3309] fix: project stats endpoint#6544
sriramveeraghanta merged 1 commit intopreviewfrom
fix-project-properties

Conversation

@prateekshourya29
Copy link
Member

@prateekshourya29 prateekshourya29 commented Feb 4, 2025

Description

Project stats endpoint fix

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

References

https://app.plane.so/plane/projects/02c3e1d5-d7e2-401d-a773-45ecba45d745/issues/4fe57e15-6716-410b-b1d7-8f9bf8640d5e

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of filtering parameters on the analytics endpoint. Now, when multiple project identifiers are provided as a comma-separated list, they are accurately parsed and applied for more precise project filtering. This update enhances performance and consistency, ensuring users benefit from more dependable filtering when retrieving their project analytics.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Walkthrough

The changes update the ProjectStatsEndpoint in the analytics view by modifying how the project_ids parameter is processed. Instead of immediately converting the parameter to a list, it is now retrieved as a string. If the string is non-empty, it is split into a list before filtering the projects queryset. The change refines the control flow in the get method without affecting the external interface.

Changes

File Change Summary
apiserver/…/analytic/base.py Modified ProjectStatsEndpoint to read project_ids as a string from the request and conditionally split it into a list before filtering the projects queryset.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant P as ProjectStatsEndpoint
    participant DB as Database

    C->>P: GET request with project_ids
    P->>P: Retrieve project_ids as raw string
    alt project_ids exists
        P->>P: Split project_ids string into list
        P->>DB: Filter projects with provided IDs
    else No project_ids
        P->>P: Skip filtering projects
    end
    P->>C: Return project statistics
Loading

Suggested labels

🐛bug

Suggested reviewers

  • sriramveeraghanta
  • rahulramesha
  • SatishGandham

Poem

Oh, what a hop, what a delightful tweak,
A rabbit scurries through the code so sleek!
Project IDs are now split with care,
Filtering by list with style to spare,
Hopping happily in a garden of code,
Cheers to changes on this joyful road!
🐇✨

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10b5c62 and 88841e4.

📒 Files selected for processing (1)
  • apiserver/plane/app/views/analytic/base.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (1)
apiserver/plane/app/views/analytic/base.py (1)

459-460: LGTM! Good fix for handling empty project_ids parameter.

The changes improve the handling of empty project_ids parameter by:

  1. Getting the raw string value first
  2. Only splitting into a list when filtering

This fixes the bug where an empty string would be split into [""], causing invalid filtering.

Also applies to: 474-475

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

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.

@sriramveeraghanta sriramveeraghanta merged commit 99f3d58 into preview Feb 4, 2025
12 of 14 checks passed
@prateekshourya29 prateekshourya29 deleted the fix-project-properties branch February 16, 2025 13:22
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