PalisadoesFoundation / talawa-api

API Backend for the Talawa Mobile App. Click on the link below to see our documentation
https://docs.talawa.io/
GNU General Public License v3.0
204 stars 668 forks source link

Agenda Item By Event and Organization #2346

Closed gautam-divyanshu closed 2 weeks ago

gautam-divyanshu commented 3 weeks ago

What kind of change does this PR introduce? Query implementation

Issue Number:

Fixes #2345

Did you add tests for your changes?

Snapshots/Videos:

Screenshot from 2024-06-14 17-23-01

Screenshot from 2024-06-14 17-08-59

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Have you read the contributing guide?

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes introduce two new queries to the GraphQL schema: agendaItemByEvent and agendaItemByOrganization. These queries allow fetching agenda items based on a specific event ID or organization ID. Additionally, the organization field in the AgendaItemSchema was renamed to organizationId for better clarity and consistency.

Changes

File Path Change Summary
schema.graphql Added new queries agendaItemByEvent and agendaItemByOrganization to the Query type.
src/models/AgendaItem.ts Renamed the field from organization to organizationId in AgendaItemSchema.
src/resolvers/Query Added new files agendaItemByOrganization.ts and agendaItemByEvent.ts with respective resolvers.
src/typeDefs/queries.ts Updated query types to include agendaItemByEvent and agendaItemByOrganization.
src/types/generatedGraphQLTypes.ts Added new query arguments types (QueryAgendaItemByEventArgs, QueryAgendaItemByOrganizationArgs).
tests/resolvers/Query/... Created test files to verify the new query resolvers (agendaItemByEvent.spec.ts, agendaItemByOrganization.spec.ts).

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GraphQLServer
    participant Database

    Client->>GraphQLServer: Query agendaItemByEvent(relatedEventId: ID!)
    GraphQLServer->>Database: Fetch agenda items with relatedEventId
    Database-->>GraphQLServer: Return agenda items
    GraphQLServer-->>Client: Return agenda items

    Client->>GraphQLServer: Query agendaItemByOrganization(organizationId: ID!)
    GraphQLServer->>Database: Fetch agenda items with organizationId
    Database-->>GraphQLServer: Return agenda items
    GraphQLServer-->>Client: Return agenda items

Assessment against linked issues

Objective Addressed Explanation
Add a query to fetch agenda items for a specific event (#2345)
Add a query to fetch agenda items for a specific organization (#2345)

Poem

In code we weave a brand-new tale,
With queries swift, no chance to fail,
For events and groups our items find,
Linked by IDs so well-defined.
Oh code, you've grown so smart, so kind,
A masterpiece in every line! 🌟


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 3 weeks ago

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

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. :dart: 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
codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.50%. Comparing base (c0468a4) to head (84ea9fb). Report is 581 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #2346 +/- ## =========================================== + Coverage 98.17% 98.50% +0.32% =========================================== Files 184 350 +166 Lines 10767 25217 +14450 Branches 835 2349 +1514 =========================================== + Hits 10571 24841 +14270 - Misses 186 373 +187 + Partials 10 3 -7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

tasneemkoushar commented 2 weeks ago

@gautam-divyanshu in ActionItem.ts, shall we also change relatedEventId to eventId like you did for organizationId @palisadoes would like you get your view on that

gautam-divyanshu commented 2 weeks ago

hall we also chan

@tasneemkoushar Please confirm if it is AgendaItem.ts because I changed it for  AgendaItem.ts, according to me it won't matter because I changed organization to organizationId because for other file for this feature have organizationId, so to work this , I have to change 

tasneemkoushar commented 2 weeks ago

hall we also chan

@tasneemkoushar Please confirm if it is AgendaItem.ts because I changed it for  AgendaItem.ts, according to me it won't matter because I changed organization to organizationId because for other file for this feature have organizationId, so to work this , I have to change

yeah @gautam-divyanshu I meant AgendaItem.ts

tasneemkoushar commented 2 weeks ago

@gautam-divyanshu LGTM apart from that minor comment. I am approving this PR but lets wait for @palisadoes review once on that minor change

gautam-divyanshu commented 2 weeks ago

@gautam-divyanshu LGTM apart from that minor comment. I am approving this PR but lets wait for @palisadoes review once on that minor change

ok

gautam-divyanshu commented 2 weeks ago

@palisadoes Can we merge this?

gautam-divyanshu commented 2 weeks ago

I have to create other PRs that depend on it.