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

Bug fix #2377

Closed Suyash878 closed 15 hours ago

Suyash878 commented 3 days ago

Issue Number:

Fixes #2285

Did you add tests for your changes?

Not relevant here

Snapshots/Videos:

340234898-ed22dc2c-4567-4aea-976b-e4938ea9f005

If relevant, did you update the documentation?

Not relevant here

Summary

This PR is in reference to my closed PR #2353 which failed a check.

Does this PR introduce a breaking change?

No

Other information

None

Have you read the contributing guide?

Yes

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

This update focuses on enhancing the codebase by updating dependencies, refining GraphQL schema and resolvers, and implementing rigorous test cases. Major changes include dependency version updates, added and modified fields in schemas, improved resolver functionalities, logging, and error handling, particularly addressing server configuration issues such as the absence of the SERVER_PORT variable.

Changes

File/Groups Change Summary
package.json Updated various dependencies including @graphql-inspector/cli, express-rate-limit, mongodb, and @graphql-codegen.
schema.graphql Added and modified fields like campaigns in Fund, and adjusted inputs such as UpdateAgendaItemInput.
src/index.ts Updated startServer function to handle static server host and port, and improved logging.
src/models/... Renamed schema fields and enhanced logging setup in various model files like Fund and FundraisingCampaign.
src/resolvers/... Introduced and updated resolvers for Fund and FundraisingCampaign and improved error handling in Mutation resolvers.
src/typeDefs Adjusted and added type definitions including enums, inputs, and queries.
src/types/generatedGraphQLTypes.ts Updates to type declarations including various inputs and query types.
src/utilities/dateValidator.ts Modified validateDate function to ensure date validation logic.
tests/resolvers/... Introduced and modified test cases for various resolver functions to ensure proper functionality and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Database

    Client->>Server: Start Server
    alt If SERVER_PORT exists
        Server->>Server: Use SERVER_PORT from .env
    else
        Server->>Server: Default to static port 4000
    end
    Server->>Database: Initialize connection
    Server->>Client: Server ready on port (default/static)

Assessment against linked issues

Objective (Issue #2285) Addressed Explanation
The API should default to a SERVER_PORT if the variable is not in the .env file βœ…
Valid passing tests to ensure this is not repeated βœ…

Poem

In the code's lush garden, dependencies grow tall,
Fields in our schemas dance in the hall.
Servers hum their tune on port 4000 they bloom,
Tests ensure resilience, no errors loom.
With logs brightly shining, no bugs in sight,
A rabbit’s joy in the moonlit night. πŸ‡βœ¨


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 days 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
Suyash878 commented 3 days ago

@palisadoes Kindly review.

codecov[bot] commented 2 days ago

Codecov Report

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

Project coverage is 98.51%. Comparing base (c0468a4) to head (4290066). Report is 597 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #2377 +/- ## =========================================== + Coverage 98.17% 98.51% +0.33% =========================================== Files 184 349 +165 Lines 10767 25242 +14475 Branches 835 2351 +1516 =========================================== + Hits 10571 24866 +14295 - 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.