Fetch unlisted projects

[MohammadPCh]

• Show unlisted projects from Giveth on DeVouch DeVouch-BE#154

Summary by CodeRabbit

• New Features

  • Introduced an option to include unlisted projects in project queries.
  • Added a new parameter to filter project queries based on active status.

• Bug Fixes

  • Improved project filtering logic to accommodate the new inclusion parameter.

• Documentation

  • Updated type signatures and class definitions to reflect new parameters.

[coderabbitai]

Walkthrough

The changes introduce a new optional parameter includeUnlisted to the project filtering functionality within the application. This parameter allows queries to include unlisted projects based on their active status. The FilterProjectQueryInputParams type and the GetProjectsArgs class have been updated to accommodate this parameter. The filterProjectsQuery function and the allProjects query method have been modified to utilize the new filtering logic, ensuring that the inclusion of unlisted projects is handled correctly.

Changes

File	Change Summary
src/repositories/projectRepository.ts	Added includeUnlisted?: boolean; to FilterProjectQueryInputParams. Updated filterProjectsQuery to incorporate this parameter into the filtering logic.
src/resolvers/projectResolver.ts	Added @Field({ nullable: true }) includeUnlisted?: boolean; to GetProjectsArgs. Updated allProjects method to accept and pass this new argument to filterProjectsQuery.

Possibly related PRs

• feat: ajusts quary to make it the same as allProjects query #1754: The changes in this PR enhance the filtering logic in the totalProjectsPerDate function, which is related to the filtering logic in the filterProjectsQuery function from the main PR, as both involve conditions based on project status and review status.

Suggested reviewers

• kkatusic
• RamRamez

Poem

In the garden where projects bloom,
A new path opens, dispelling gloom.
With includeUnlisted, we now can see,
All the hidden gems, as bright as can be!
Hopping through code, with joy we cheer,
For every project, both far and near! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/repositories/projectRepository.ts (1)

86-86: Consider adding documentation for the new parameter

While the implementation is solid, it would be helpful to add JSDoc comments explaining:

• The purpose of the includeUnlisted parameter
• Expected behavior when true/false
• Default behavior when undefined

Example:

+/**
+ * When true, includes all active projects regardless of review status.
+ * When false or undefined, only includes active projects with 'Listed' review status.
+ */
includeUnlisted?: boolean;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 795e035 and 92f15c9.

📒 Files selected for processing (2)

• src/repositories/projectRepository.ts (3 hunks)
• src/resolvers/projectResolver.ts (3 hunks)

🔇 Additional comments (5)

src/repositories/projectRepository.ts (3)

86-86: LGTM! Clean type definition addition

The new optional boolean parameter is properly typed and follows TypeScript conventions.

---

101-101: LGTM! Parameter properly destructured

The new parameter is correctly added to the function's parameter destructuring.

---

129-136: LGTM! Secure implementation of the filter logic

The implementation:

• Properly handles the new filter condition
• Uses parameterized queries for security
• Maintains existing review status check when includeUnlisted is false

src/resolvers/projectResolver.ts (2)

271-273: LGTM! Clean field addition to GetProjectsArgs

The new field is properly decorated and follows the existing pattern in the class.

---

746-746: LGTM! Parameter correctly handled in allProjects query

The implementation:

• Properly extracts the parameter from args
• Correctly passes it to filterProjectsQuery
• Maintains existing functionality

Also applies to: 773-773

[kkatusic]

LGTM ;), thx @MohammadPCh

[mohammadranjbarz]

Thanks @MohammadPCh LGTM