Add Search Functionality for Agenda Item Categories

[im-vedant]

What kind of change does this PR introduce?

Feature

Issue Number:

Fixes : PalisadoesFoundation/talawa-admin#2372

Snapshots/Videos:

https://www.loom.com/share/fb28b6228fc649158f8db6eba1ab1fc6

Summary

Search Functionality: Implemented a search feature to filter agenda item categories based on user input.

Summary by CodeRabbit

• New Features

  • Enhanced agenda item category filtering with a new name_contains search option
  • Added ability to filter agenda item categories by substring within their name
  • Introduced more flexible querying for agenda item categories by organization

• Improvements

  • Added role-based access control directive for enhanced security

[coderabbitai]

Walkthrough

This pull request introduces a new filtering mechanism for agenda item categories by adding an AgendaItemCategoryWhereInput input type. The changes enable more granular querying of agenda item categories by allowing filtering based on a substring match in the category name. The modification spans multiple files, including GraphQL schema, type definitions, resolvers, and helper functions, to implement this new filtering capability while maintaining existing functionality.

Changes

File	Change Summary
schema.graphql	Added new input type AgendaItemCategoryWhereInput and updated agendaItemCategoriesByOrganization query to accept optional filtering
src/resolvers/Query/agendaItemCategoriesByOrganization.ts	Imported getWhere function and modified resolver to apply additional filtering
src/resolvers/Query/helperFunctions/getWhere.ts	Added AgendaItemCategoryWhereInput to supported where input types
src/typeDefs/inputs.ts	Added new AgendaItemCategoryWhereInput input type with name_contains field
src/typeDefs/queries.ts	Updated agendaItemCategoriesByOrganization query signature to include where argument
src/types/generatedGraphQLTypes.ts	Added AgendaItemCategoryWhereInput type definition and updated query arguments

Sequence Diagram

sequenceDiagram
    participant Client
    participant GraphQL
    participant Resolver
    participant Database
    
    Client->>GraphQL: Query agendaItemCategoriesByOrganization
    GraphQL->>Resolver: Pass organizationId and optional where filter
    Resolver->>Resolver: Apply getWhere to filter conditions
    Resolver->>Database: Find categories with organizationId and name filter
    Database-->>Resolver: Return filtered categories
    Resolver-->>GraphQL: Return filtered agenda item categories
    GraphQL-->>Client: Respond with filtered results

Loading

Possibly related PRs

• Updating the main branch to the latest develop code #2329: Adds the initial agendaItemCategoriesByOrganization query to the schema, which is foundational to the current filtering enhancement

Poem

🐰 Filtering magic, oh so neat!
Categories now dance to our beat
A substring search, quick and light
Making queries a delightful sight
Hop hop hooray for code so bright! 🎉

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3a5276a and 2ccda70.

📒 Files selected for processing (6)

• schema.graphql (2 hunks)
• src/resolvers/Query/agendaItemCategoriesByOrganization.ts (2 hunks)
• src/resolvers/Query/helperFunctions/getWhere.ts (2 hunks)
• src/typeDefs/inputs.ts (1 hunks)
• src/typeDefs/queries.ts (1 hunks)
• src/types/generatedGraphQLTypes.ts (4 hunks)

🔇 Additional comments (10)

src/resolvers/Query/agendaItemCategoriesByOrganization.ts (2)

3-3: Import statement is correct and consistent with new functionality.
This import from getWhere aligns with your new filtering feature.

---

12-15: Good approach using getWhere for dynamic filtering.
By destructuring the where object, you keep the resolver succinct, while leveraging a central helper for constructing filter queries. This pattern is generally easier to maintain and scale.

src/typeDefs/queries.ts (1)

35-38: Enhanced flexibility through the where argument.
Adding the where: AgendaItemCategoryWhereInput parameter provides a more granular search capability for agenda categories. Ensure all usage sites are updated accordingly, including any client-side code calling this query.
[approve]

src/typeDefs/inputs.ts (1)

98-101: New AgendaItemCategoryWhereInput broadens search filters.
This input shape is straightforward and effective for substring-based filtering. Consider whether additional fields (e.g., isDisabled) are needed in your use cases.

src/resolvers/Query/helperFunctions/getWhere.ts (2)

18-18: Import structure is properly extended.
Adding AgendaItemCategoryWhereInput maintains consistency with the newly introduced filtering logic.

---

46-46: Unified filter logic allows seamless category-based search.
Expanding the intersection type to include AgendaItemCategoryWhereInput ensures that category-based conditions flow into the same flexible filtering pipeline used across the codebase.

src/types/generatedGraphQLTypes.ts (2)

213-215: Great addition for flexible filtering!
This newly introduced AgendaItemCategoryWhereInput type will allow more granular control over agenda item category queries. Confirm that all resolvers, especially agendaItemCategoriesByOrganization, properly handle the name_contains filter to avoid any null or undefined references.

---

2470-2470: Ensure backward compatibility for existing query consumers.
The addition of the optional where parameter is a non-breaking change. However, confirm that clients which do not send this parameter will still receive the unfiltered results as intended.

schema.graphql (2)

143-145: Leverage the new filtering capabilities.
The new AgendaItemCategoryWhereInput with name_contains expands the possibilities for refined searches. Consider adding additional fields (e.g., partial match for description) if needed.

---

1563-1563: Updated query with optional filter parameter.
Including the optional where argument means tooling and clients can apply substring-based searches on agenda item categories. Verify that null is handled correctly if no filter is provided.

---

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

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.

[github-actions]

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

1. We don't merge PRs with poor code quality.
   1. Follow coding best practices such that CodeRabbit.ai approves your PR.
2. We don't merge PRs with failed tests.
   1. When tests fail, click on the Details link to learn more.
   2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
   3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[github-actions]

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.72%. Comparing base (3a5276a) to head (2ccda70).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2805   +/-   ##
========================================
  Coverage    97.72%   97.72%           
========================================
  Files          364      364           
  Lines        18543    18545    +2     
  Branches      2676     2676           
========================================
+ Hits         18121    18123    +2     
  Misses         417      417           
  Partials         5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.