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

add filter condition to remove endaoment projects from recently updated query sort #1921

Merged
merged 1 commit into from
Jan 29, 2025

Conversation

divine-comedian
Copy link
Collaborator

@divine-comedian divine-comedian commented Jan 28, 2025

fix for #1919

not sure how to test it locally

Summary by CodeRabbit

  • Bug Fixes
    • Refined project filtering logic when sorting by recently updated projects
    • Excluded specific organization-labeled projects from recent updates view

Copy link
Contributor

coderabbitai bot commented Jan 28, 2025

Walkthrough

The pull request modifies the filterProjectsQuery function in the project repository to enhance project sorting logic. The primary change involves introducing a new filtering condition when sorting by recently updated projects. Specifically, the implementation now excludes projects associated with the Endaoment organization label, effectively removing these projects from the sorted results when using the RecentlyUpdated sorting criterion.

Changes

File Change Summary
src/repositories/projectRepository.ts - Added import for ORGANIZATION_LABELS from ../entities/organization
- Updated filterProjectsQuery sorting logic to exclude Endaoment organization projects when sorting by recently updated

Possibly related PRs

Suggested reviewers

  • kkatusic
  • mohammadranjbarz

Poem

🐰 A Rabbit's Sorting Tale

In repositories deep and wide,
Where projects and labels reside,
A filter springs with cunning grace,
Endaoment's mark now finds no place!
Code hops, logic leaps with might! 🚀

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

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 (1)
src/repositories/projectRepository.ts (1)

200-204: Consider extracting the filter condition for reusability.

The endaoment filter might be needed in other sorting cases in the future. Consider extracting it into a separate method like addEndaomentFilter for consistency and reusability:

+const addEndaomentFilter = (query: SelectQueryBuilder<Project>) => {
+  return query.andWhere('organization.label != :label', {
+    label: ORGANIZATION_LABELS.ENDAOMENT,
+  });
+};

 case SortingField.RecentlyUpdated:
   query
     .orderBy('project.updatedAt', OrderDirection.DESC)
-    .andWhere('organization.label != :label', {
-      label: ORGANIZATION_LABELS.ENDAOMENT,
-    });
+    addEndaomentFilter(query);
   break;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ad5949d and ce160da.

📒 Files selected for processing (1)
  • src/repositories/projectRepository.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (3)
src/repositories/projectRepository.ts (3)

26-26: LGTM!

The import of ORGANIZATION_LABELS is correctly added and aligns with the PR objective to filter endaoment projects.


200-204: Implementation looks good!

The changes:

  • Correctly implement the PR objective to filter out endaoment projects
  • Are properly scoped to only affect the RecentlyUpdated sorting
  • Follow TypeORM query builder patterns

200-204: Verify the impact of the new filter condition.

The implementation correctly adds the filter to exclude endaoment projects from recently updated results. However, let's verify:

  1. The existence and value of ORGANIZATION_LABELS.ENDAOMENT
  2. The potential impact on query performance
✅ Verification successful

The filter implementation is verified and safe to use

  • The ORGANIZATION_LABELS.ENDAOMENT constant is properly defined and consistently used across the codebase
  • The query performance impact is acceptable as organization filtering is lightweight
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the ENDAOMENT label constant and analyze query performance

# Test 1: Check if ENDAOMENT is defined in organization.ts
echo "Checking ENDAOMENT label definition:"
ast-grep --pattern 'export const ORGANIZATION_LABELS = {
  $$$
  ENDAOMENT: $_,
  $$$
}'

# Test 2: Check if there are any other references to ENDAOMENT that might be affected
echo -e "\nChecking other ENDAOMENT references:"
rg -l "ENDAOMENT" --type ts

# Test 3: Analyze the query performance impact
echo -e "\nChecking for existing indexes on organization.label:"
ast-grep --pattern 'CreateIndexOptions|@Index\(' 

Length of output: 1622

@kkatusic kkatusic self-requested a review January 29, 2025 09:06
Copy link
Collaborator

@kkatusic kkatusic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@divine-comedian I tested this, it's not showing Endaoment projects in "Recently updated" list. Approved ;)

@divine-comedian divine-comedian merged commit 80df1f3 into staging Jan 29, 2025
6 checks passed
@divine-comedian divine-comedian deleted the remove-endaoment-recentlyUpdated branch January 29, 2025 16:36
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