Feat : Implemented field connection resolver for organization events

[AnshulKahar2729]

What kind of change does this PR introduce?

feature
Issue Number:

Fixes #2319

Did you add tests for your changes?

Yes

Have you read the contributing guide?

Yes

Summary by CodeRabbit

• New Features

  • Introduced pagination support for events with new EventsConnection and EventsConnectionEdge types.
  • Added a resolver for fetching organization-specific events.
  • Updated port mapping for Redis service to enhance connectivity.
  • Added a new command for Docker development to streamline setup.

• Bug Fixes

  • Improved error handling in event fetching and cursor parsing.

• Documentation

  • Expanded comments for clarity within the GraphQL schema.

• Tests

  • Added unit tests for event resolvers and cursor parsing functionality.

[github-actions]

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

[coderabbitai]

Walkthrough

The pull request introduces significant updates to the GraphQL schema, enhancing readability and organization. It adds pagination support for events through new types, EventsConnection and EventsConnectionEdge, and modifies existing types and resolvers to accommodate this functionality. Additionally, it includes unit tests for the new resolver to ensure robust error handling and correct data retrieval.

Changes

Files	Change Summary
schema.graphql	Added EventsConnection and EventsConnectionEdge types; reformatted union types and modified existing types for clarity.
src/resolvers/Organization/events.ts	Implemented a resolver for organization-specific events with pagination support and error handling.
tests/resolvers/Organization/events.spec.ts	Created unit tests for the events resolver and cursor parsing functions.
docker-compose.dev.yaml, package.json	Updated port mapping for Redis service and added a new Docker development script.

Assessment against linked issues

Objective	Addressed	Explanation
Add pagination support to EventsByOrganization query (2319)	✅

Possibly related PRs

• Agenda Item By Event and Organization #2346: Modifications to the schema.graphql file related to new queries for agenda items, which may connect with the overall schema organization improvements.

Suggested labels

Ready 4 PR Review

Suggested reviewers

• (No suggested reviewers provided)

Poem

🐰 In the meadow where events do play,
New paths of pagination light the way.
With edges and connections clear and bright,
Fetching data now feels just right!
Hops of joy for the code we see,
A better schema, oh so free! 🌼

---

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 generate interesting stats about this repository and render them as a table.
  -- @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.

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.

[codecov]

Codecov Report

Attention: Patch coverage is 95.12195% with 4 lines in your changes missing coverage. Please review.

Project coverage is 99.08%. Comparing base (6093752) to head (dd74c7b).
Report is 3 commits behind head on develop.

Files with missing lines	Patch %	Lines
src/resolvers/Organization/events.ts	95.12%	4 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2532      +/-   ##
===========================================
+ Coverage    98.89%   99.08%   +0.18%     
===========================================
  Files          349      350       +1     
  Lines        17769    17851      +82     
  Branches      2371     2374       +3     
===========================================
+ Hits         17573    17687     +114     
+ Misses         193      164      -29     
+ Partials         3        0       -3     

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

[AnshulKahar2729]

I will fix that code coverage soon; another failed one is schema.graphql which was needed to change

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

package.json (1)

29-29: Approve the addition of the Docker development command.

The new "docker:dev" command is a useful addition to streamline the development setup process using Docker Compose. It enhances the project's functionality by providing a convenient way to start the development environment with a single command.

Consider making sudo optional.

Using sudo may not be necessary for all users, depending on their Docker configuration. Consider making it optional or providing instructions for users who may not need to use sudo to run Docker commands.

To make sudo optional, you can modify the command like this:

-"docker:dev" : "sudo /usr/libexec/docker/cli-plugins/docker-compose -f docker-compose.dev.yaml up"
+"docker:dev" : "/usr/libexec/docker/cli-plugins/docker-compose -f docker-compose.dev.yaml up"

And provide instructions in the project's documentation or README file for users who may need to use sudo.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 16c3996 and bd58553.

Files selected for processing (4)

• docker-compose.dev.yaml (1 hunks)
• package.json (1 hunks)
• src/resolvers/Organization/events.ts (1 hunks)
• tests/resolvers/Organization/events.spec.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• src/resolvers/Organization/events.ts
• tests/resolvers/Organization/events.spec.ts

[coderabbitai]

Tip

Codebase Verification

Port change inconsistency detected across project files

The change of the Redis external port from 6379 to 6380 in docker-compose.dev.yaml appears to be inconsistent with other parts of the project:

• The production environment (docker-compose.prod.yaml) still uses port 6379 for both internal and external mapping.
• Both development and production environments set REDIS_PORT=6379 as an environment variable.
• The INSTALLATION.md file still refers to 6379 as the default Redis port in multiple places.

Please review the following action items:

1. Determine if the port change to 6380 in docker-compose.dev.yaml is intentional.
2. If intentional, update all relevant files for consistency:
   • Update docker-compose.prod.yaml to use the new port (6380).
   • Update the REDIS_PORT environment variable in both docker-compose.dev.yaml and docker-compose.prod.yaml.
   • Update the INSTALLATION.md file to reflect the new port number.
3. If unintentional, revert the change in docker-compose.dev.yaml back to 6379.
4. After making the necessary changes, review the application code to ensure it uses the correct port for Redis connections.

Analysis chain

Verify the reason for the Redis port change and ensure consistency.

The external port for the Redis service has been changed from 6379 to 6380. While this change does not affect the internal workings of the Redis container, it may impact how clients connect to the service.

Please provide the reason for this port change. Additionally, ensure that this change is consistently applied across the codebase, including any configuration files, connection strings, or documentation that references the Redis port.

To verify the impact of this change, please run the following script:

If the script yields any results, please update those instances to use the new port (6380) to maintain consistency across the project.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash

# Search for occurrences of the old Redis port (6379) in YAML files
echo "Searching for occurrences of the old Redis port (6379) in YAML files..."
rg --type yaml $'6379'

# Search for occurrences of the old Redis port (6379) in JavaScript files
echo "Searching for occurrences of the old Redis port (6379) in JavaScript files..."
rg --type js $'6379'

# Search for occurrences of the old Redis port (6379) in Markdown files (documentation)
echo "Searching for occurrences of the old Redis port (6379) in Markdown files..."
rg --type md $'6379'

Length of output: 1103