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

Temp limit Progress Reports to only Active/Completed Projects #1614

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

rdonigian
Copy link
Contributor

@rdonigian rdonigian commented Oct 30, 2024

Until the logic to delete/not-create "useless" reports is applied in the API, we will filter them out here.

Monday

Summary by CodeRabbit

  • New Features

    • Enhanced filtering for progress reports to include only 'Active' or 'Completed' projects.
  • Bug Fixes

    • Improved data retrieval logic for more accurate reporting.

Copy link
Contributor

coderabbitai bot commented Oct 30, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the ProgressReportsGrid component located in ProgressReportsGrid.tsx. A new filter condition has been added to the GraphQL query within the useMemo hook, specifically filtering for engagement project statuses of 'Active' or 'Completed'. This adjustment refines the data retrieval logic to ensure that only relevant progress reports are fetched, while the overall component structure and rendering logic remain unchanged.

Changes

File Path Change Summary
src/scenes/Dashboard/ProgressReportsWidget/... Added a filter condition to the GraphQL query to include only 'Active' or 'Completed' project statuses.

Poem

In the garden where progress grows,
A filter now helps the data flow.
Active and completed, the reports align,
Fetching the best, oh how they shine!
With logic intact, the grid stands tall,
A hop and a skip, we embrace it all! 🐇✨


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.

@rdonigian rdonigian marked this pull request as ready for review October 30, 2024 16:44
@rdonigian rdonigian requested a review from CarsonF as a code owner October 30, 2024 16:44
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)
src/scenes/Dashboard/ProgressReportsWidget/ProgressReportsGrid.tsx (1)

194-198: Implementation looks good, but consider making status values configurable.

The filter implementation correctly achieves the PR objective of filtering progress reports by project status. However, consider these improvements:

  1. Extract status values to a constant or enum to improve maintainability:
const ALLOWED_PROJECT_STATUSES = ['Active', 'Completed'] as const;
  1. Add a comment explaining why these specific statuses were chosen:
// Filter to show only Active and Completed projects as these are the only
// statuses that should have meaningful progress reports
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cc9747a and e24d2ff.

📒 Files selected for processing (1)
  • src/scenes/Dashboard/ProgressReportsWidget/ProgressReportsGrid.tsx (1 hunks)
🔇 Additional comments (1)
src/scenes/Dashboard/ProgressReportsWidget/ProgressReportsGrid.tsx (1)

194-198: Verify the impact of filtering on existing users.

Let's ensure this filtering doesn't unexpectedly hide important data from users.

✅ Verification successful

Project status filtering is consistent with existing usage

Based on the codebase analysis:

  • The status filter ['Active', 'Completed'] aligns with existing project status handling in the application
  • The filter is used in the ProgressReportsGrid context where showing only active and completed projects is logical
  • Similar status filtering exists in other components (e.g., EngagementColumns.tsx and ProjectColumns.tsx) where 'Active' status is commonly used as a filter
  • The UI properly handles and displays project status information through various components, suggesting this is an expected behavior

The implementation appears to be a deliberate feature rather than a potential data visibility issue.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any existing usage of project status in queries or components
# to understand the impact of this filter

# Look for other instances of project status filtering
rg -l "project.*status.*Active.*Completed" --type typescript

# Look for any comments or documentation about project status handling
rg -l "project status" --type typescript

Length of output: 175


Script:

#!/bin/bash
# Search for any existing usage of project status in queries or components
# Let's try without file type restriction and use more specific patterns

# Look for other instances of project status filtering
rg -l "project.*status.*(\['Active', 'Completed'\]|Active.*Completed)"

# Look for any GraphQL queries or types related to project status
rg -l "type.*Project.*status|query.*project.*status"

# Look for any comments or documentation about project status
rg -i "project status" -A 2 -B 2

Length of output: 566


Script:

#!/bin/bash
# Let's examine the GraphQL schema and queries to understand the project status usage

# Look for GraphQL schema definitions
rg "type.*Project.*{" -A 10

# Search for GraphQL queries or fragments that include project status
rg "query.*{|fragment.*{" -A 20 | rg -A 20 -B 5 "project.*{|status"

# Check for any filters or where conditions related to project status
rg "where.*project.*status|filter.*project.*status" -A 3 -B 3

Length of output: 480


Script:

#!/bin/bash
# Let's try with simpler patterns to understand the project status usage

# Look for GraphQL schema definitions
rg "type Project" -A 10

# Look for files containing both project and status references
rg -l "project" | xargs rg "status"

# Search for any filtering conditions
rg "where: ?{" -A 5

Length of output: 8179

@CarsonF CarsonF changed the title apply project status filter to progress report widget Temp limit Progress Reports to only Active/Completed Projects Oct 30, 2024
@CarsonF CarsonF merged commit 63809e2 into develop Oct 30, 2024
7 checks passed
@CarsonF CarsonF deleted the 0236-add-progress-report-filter branch October 30, 2024 19:16
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