Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Made an Api to fetch organizations before authorization because we have to show this on Register portal in Talawa-admin #3288

Merged
merged 43 commits into from
Mar 2, 2025

Conversation

igennova
Copy link

@igennova igennova commented Feb 23, 2025

What kind of change does this PR introduce?

Issue Number:

Fixes #3244

Snapshots/Videos:
image

If relevant, did you update the documentation?

Summary

Changed Schema.graphql:

Updated or restructured the GraphQL schema to define the structure for the new API related to organizations.
Created organizations.ts:

Made a new file (organizations.ts) for implementing the logic and structure for the organizations-related API.
Created a New Test File for organizations.ts:

Set up a new test file for testing the functionality of the newly created organizations.ts API.

Does this PR introduce a breaking change?

Checklist

CodeRabbit AI Review

  • I have reviewed and addressed all critical issues flagged by CodeRabbit AI
  • I have implemented or provided justification for each non-critical suggestion
  • I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

  • I have written tests for all new changes/features
  • I have verified that test coverage meets or exceeds 95%
  • I have run the test suite locally and all tests pass

Other information

Have you read the contributing guide?

Summary by CodeRabbit

  • New Features
    • Introduced a new GraphQL query that lets clients fetch a list of organizations (up to 20 entries) with key details like name, avatar, and location.
    • Enhanced input validation and error handling improve the reliability and consistency of organization data retrieval.

Copy link

coderabbitai bot commented Feb 23, 2025

Warning

Rate limit exceeded

@igennova has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 0aa74c2 and 8587492.

📒 Files selected for processing (7)
  • schema.graphql (1 hunks)
  • src/graphql/inputs/QueryOrganizationInput.ts (1 hunks)
  • src/graphql/types/Query/index.ts (1 hunks)
  • src/graphql/types/Query/organizations.ts (1 hunks)
  • test/routes/graphql/Query/organizations.test.ts (1 hunks)
  • test/routes/graphql/documentNodes.ts (1 hunks)
  • test/routes/graphql/gql.tada.d.ts (1 hunks)

Walkthrough

This pull request adds a new organizations field to the GraphQL Query type for retrieving a list of organizations. The changes include schema updates to define the new field, resolver implementation to fetch up to 20 organizations, modifications to the input handling of the id field, and updates to introspection types. New tests and a document node have also been introduced to verify both successful data retrieval and error handling. No existing query fields or functionality were removed.

Changes

File(s) Change Summary
schema.graphql, src/.../Query/index.ts, src/.../Query/organizations.ts Added a new organizations query field in the GraphQL schema along with its resolver logic to fetch up to 20 Organization objects.
src/.../inputs/QueryOrganizationInput.ts, test/.../gql.tada.d.ts Modified the id field: now marked as optional/nullable with a runtime transformation rejecting null; updated introspection types to include organizations.
test/.../Query/organizations.test.ts, test/.../documentNodes.ts Introduced tests and a GraphQL document node for the organizations query, covering both successful responses and error scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant G as GraphQL Server
    participant R as Organizations Resolver
    participant D as Database (drizzleClient)
    
    C->>G: Send query for organizations
    G->>R: Invoke organizations resolver
    R->>D: Query for organizations (limit 20)
    D-->>R: Return organizations data or error
    alt Success
       R-->>G: Return list of organizations
       G-->>C: Respond with organizations array
    else Error
       R-->>G: Log error & throw generic error
       G-->>C: Respond with error message
    end
Loading

Possibly related PRs

Suggested reviewers

  • palisadoes

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

Copy link

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 10

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0aa74c2 and 7f3bce1.

📒 Files selected for processing (7)
  • schema.graphql (1 hunks)
  • src/graphql/inputs/QueryOrganizationInput.ts (1 hunks)
  • src/graphql/types/Query/index.ts (1 hunks)
  • src/graphql/types/Query/organizations.ts (1 hunks)
  • test/routes/graphql/Query/organizations.test.ts (1 hunks)
  • test/routes/graphql/documentNodes.ts (1 hunks)
  • test/routes/graphql/gql.tada.d.ts (1 hunks)
🔇 Additional comments (1)
test/routes/graphql/gql.tada.d.ts (1)

152-152: LGTM! The type definition for the organizations query is well-structured.

The organizations field is correctly defined as a nullable list of Organization objects, which aligns with the PR's objective of fetching organizations for display on the registration portal.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7f3bce1 and 8587492.

📒 Files selected for processing (4)
  • schema.graphql (1 hunks)
  • src/graphql/types/Query/index.ts (1 hunks)
  • test/routes/graphql/documentNodes.ts (1 hunks)
  • test/routes/graphql/gql.tada.d.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (3)
src/graphql/types/Query/index.ts (1)

24-24: Maintain alphabetical ordering of imports.

The import for "./organizations" should be placed between "./organization" and "./post" to maintain alphabetical ordering.

test/routes/graphql/documentNodes.ts (1)

519-530: Consider adding fields useful for registration.

Since this query is intended for the registration portal, consider adding fields that would help users identify and select the correct organization.

schema.graphql (1)

2890-2891: New Organizations Query Field Added
The new query field organizations: [Organization] with its accompanying description clearly communicates its purpose for fetching organizations before registration, aligning well with the PR objectives. Please ensure that the corresponding resolver enforces the business logic (i.e. limiting the results to 20 entries) as intended.

Copy link

codecov bot commented Feb 23, 2025

Codecov Report

Attention: Patch coverage is 83.33333% with 5 lines in your changes missing coverage. Please review.

Project coverage is 48.40%. Comparing base (0aa74c2) to head (8587492).
Report is 25 commits behind head on develop-postgres.

Files with missing lines Patch % Lines
src/graphql/types/Query/organizations.ts 80.95% 4 Missing ⚠️
src/graphql/inputs/QueryOrganizationInput.ts 87.50% 1 Missing ⚠️
Additional details and impacted files
@@                 Coverage Diff                  @@
##           develop-postgres    #3288      +/-   ##
====================================================
+ Coverage             48.36%   48.40%   +0.03%     
====================================================
  Files                   458      459       +1     
  Lines                 34516    34545      +29     
  Branches                966      971       +5     
====================================================
+ Hits                  16695    16720      +25     
- Misses                17821    17825       +4     

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

@igennova
Copy link
Author

@coderabbit.ai full review

Copy link

coderabbitai bot commented Feb 23, 2025

@igennova I'll review the changes in detail.

The changes look generally well-structured and include proper testing. Here are a few suggestions for improvement:

  1. Consider implementing pagination for the organizations query. While the current limit of 20 is good, as the system grows, you might need proper pagination support.

  2. The error handling could be more specific. Instead of a generic "Error fetching organizations", consider passing through the specific error message (after sanitizing sensitive details).

  3. Consider adding a test case for when no organizations exist in the database to ensure proper handling of empty results.

  4. In QueryOrganizationInput.ts, the transformation function that throws "id is required" when null seems unnecessary since the field is already marked as optional. This might lead to confusing behavior where an optional field throws an error.

Let me know if you'd like me to elaborate on any of these points.

@igennova
Copy link
Author

@palisadoes Please Review this

@palisadoes palisadoes added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Feb 24, 2025
@palisadoes
Copy link
Contributor

@disha1202 PTAL

@igennova
Copy link
Author

Hi @palisadoes , I hope you're doing well!
I just wanted to kindly follow up and check if you’ve had a chance to review the pull request.
If you need any additional information or changes, feel free to let me know!

@palisadoes
Copy link
Contributor

@Dante291 @duplixx PTAL this is ready for review

Copy link
Member

@noman2002 noman2002 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add test for the missing lines.
Rest everything looks fine.

@palisadoes palisadoes merged commit bb75fdd into PalisadoesFoundation:develop-postgres Mar 2, 2025
15 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants