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

[NoMongo] : Restore the GraphQL Introspection GitHub Action Test (Fixes #3235) #3250

Open
wants to merge 4 commits into
base: develop-postgres
Choose a base branch
from

Conversation

raggettii
Copy link
Contributor

@raggettii raggettii commented Jan 11, 2025

What kind of change does this PR introduce?
Functionality restored by uncommenting the part of code asked in the issue
ie.
image

Issue Number:

Fixes #3235

Snapshots/Videos:
image

If relevant, did you update the documentation?

Summary

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

  • Workflow Enhancement

    • Added a new GitHub Actions job to perform GraphQL schema validation.
    • GraphQL inspection now runs automatically during pull request checks.
    • Excludes checks when changes are from Dependabot.
    • Improved error handling for repository cloning and document validation.
    • Updated Node.js version used in the workflow to '20.x'.
  • New Dependencies

    • Added @graphql-inspector/cli to development dependencies.
    • Updated @testing-library/dom dependency version.

@raggettii raggettii requested a review from palisadoes as a code owner January 11, 2025 03:57
Copy link
Contributor

coderabbitai bot commented Jan 11, 2025

Walkthrough

The pull request activates the Graphql-Inspector job in the GitHub Actions workflow located in the .github/workflows/pull-request.yml file. This job runs under the condition that the actor is not dependabot and includes steps for checking out the repository, setting up Node.js (now updated to version '20.x'), installing dependencies, cloning the API repository with enhanced error handling, and validating documents against the GraphQL schema.

Changes

File Change Summary
.github/workflows/pull-request.yml Activated Graphql-Inspector job with steps for cloning API repository and validating GraphQL documents; updated Node.js version to '20.x'; enhanced error handling during cloning and validation.
package.json Added dependency @graphql-inspector/cli with version ^5.0.8 in devDependencies and removed the previous version of @testing-library/dom.

Assessment against linked issues

Objective Addressed Explanation
Restore the GraphQL Introspection GitHub Action Test [#3235]
Make tests pass [#3235] Actual test pass status not confirmed in the PR.

Possibly related PRs

Suggested reviewers

  • palisadoes
  • varshith257
  • AVtheking
  • gautam-divyanshu

Poem

🐰 Hop, hop, GraphQL's back in town!
Workflows dancing, no more frown
Introspection tests now take the stage
Coding rabbits turn a new page!
Let the schema validation begin! 🚀


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
Contributor

@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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e343b0c and 189f415.

📒 Files selected for processing (1)
  • .github/workflows/pull-request.yml (1 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml

[error] 306-306: trailing spaces

(trailing-spaces)


[error] 312-312: trailing spaces

(trailing-spaces)


[error] 314-314: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test Application
  • GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (1)
.github/workflows/pull-request.yml (1)

291-294: LGTM! Job definition is clear and well-structured.

The job definition follows the workflow conventions and has appropriate conditions.

.github/workflows/pull-request.yml Outdated Show resolved Hide resolved
.github/workflows/pull-request.yml Outdated Show resolved Hide resolved
.github/workflows/pull-request.yml Outdated Show resolved Hide resolved
.github/workflows/pull-request.yml Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.17%. Comparing base (e9aec17) to head (fd81ad5).
Report is 8 commits behind head on develop-postgres.

Additional details and impacted files
@@                  Coverage Diff                  @@
##           develop-postgres    #3250       +/-   ##
=====================================================
+ Coverage             10.74%   90.17%   +79.43%     
=====================================================
  Files                   309      330       +21     
  Lines                  7802     8491      +689     
  Branches               1729     1934      +205     
=====================================================
+ Hits                    838     7657     +6819     
+ Misses                 6900      604     -6296     
- Partials                 64      230      +166     

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

@raggettii
Copy link
Contributor Author

@coderabbitai resolve

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
.github/workflows/pull-request.yml (1)

306-306: Remove trailing spaces.

There are trailing spaces on lines 306, 312, and 318 that should be removed for consistent formatting.

Also applies to: 312-312, 318-318

🧰 Tools
🪛 yamllint (1.35.1)

[error] 306-306: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 189f415 and 6fe60c2.

📒 Files selected for processing (2)
  • .github/workflows/pull-request.yml (1 hunks)
  • package.json (1 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml

[error] 306-306: trailing spaces

(trailing-spaces)


[error] 312-312: trailing spaces

(trailing-spaces)


[error] 318-318: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test Application
  • GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (5)
package.json (1)

116-116: LGTM! Implementation of local @graphql-inspector/cli package.

The addition of @graphql-inspector/cli as a local dev dependency aligns with best practices for CI/CD environments.

.github/workflows/pull-request.yml (4)

291-294: LGTM! Well-structured job configuration.

The job is properly configured with:

  • Appropriate condition to exclude dependabot
  • Clear descriptive name
  • Correct runner specification

299-302: LGTM! Appropriate Node.js version selection.

Using Node.js 20.x LTS version aligns with the package.json requirements while ensuring better stability.


307-322: LGTM! Robust error handling for repository cloning.

The implementation includes proper error handling for:

  • Branch existence verification
  • Clone operation failure
  • Clear error messages
🧰 Tools
🪛 yamllint (1.35.1)

[error] 312-312: trailing spaces

(trailing-spaces)


[error] 318-318: trailing spaces

(trailing-spaces)


324-335: LGTM! Comprehensive document validation with proper error handling.

The validation step includes thorough checks for:

  • schema.graphql file existence
  • GraphQL TypeScript files presence
  • Clear error messaging

Copy link
Contributor

coderabbitai bot commented Jan 11, 2025

✅ Actions performed

Comments resolved and changes approved.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 11, 2025
@raggettii
Copy link
Contributor Author

@palisadoes review
the failed test image
the changes in the package.json are made as per the suggestion of coderabbitai
image

@palisadoes palisadoes changed the title Fixed: NoMongo: Restore the GraphQL Introspection GitHub Action Test (issue-#3235) Fixed: NoMongo: Restore the GraphQL Introspection GitHub Action Test (Fixes #3235) Jan 11, 2025
@palisadoes palisadoes added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Jan 11, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 11, 2025
Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
.github/workflows/pull-request.yml (1)

307-322: Remove trailing spaces.

The cloning logic is robust with proper error handling, but there are trailing spaces that should be removed.

Apply this diff to fix the formatting:

       - name: Clone API Repository
         run: |
           # Retrieve the complete branch name directly from the GitHub context
           FULL_BRANCH_NAME=${{ github.base_ref }}
           echo "FULL_BRANCH_NAME: $FULL_BRANCH_NAME"
-          
+
           # Clone the specified repository using the extracted branch name
           if ! git ls-remote --heads https://github.com/PalisadoesFoundation/talawa-api.git $FULL_BRANCH_NAME | grep -q .; then
             echo "Error: Branch $FULL_BRANCH_NAME does not exist in talawa-api repository"
             exit 1
           fi
-          
+
           if ! git clone --branch $FULL_BRANCH_NAME --depth 1 https://github.com/PalisadoesFoundation/talawa-api; then
             echo "Error: Failed to clone talawa-api repository"
             exit 1
           fi
-        
+
🧰 Tools
🪛 yamllint (1.35.1)

[error] 312-312: trailing spaces

(trailing-spaces)


[error] 318-318: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 261caf9 and fd81ad5.

📒 Files selected for processing (1)
  • .github/workflows/pull-request.yml (1 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/pull-request.yml

[error] 306-306: trailing spaces

(trailing-spaces)


[error] 312-312: trailing spaces

(trailing-spaces)


[error] 318-318: trailing spaces

(trailing-spaces)


[error] 323-323: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Test Application
  • GitHub Check: Analyse Code With CodeQL (javascript)
🔇 Additional comments (4)
.github/workflows/pull-request.yml (4)

291-294: LGTM! Clear job definition with appropriate conditions.

The job is well-defined with a descriptive name and includes proper conditions to prevent running for dependabot PRs.


299-303: LGTM! Using recommended Node.js LTS version.

Good job implementing the recommended Node.js 20.x LTS version for better stability and ecosystem compatibility.


324-326: Switch to local installation of @graphql-inspector/cli.

The GraphQL Inspector is still being installed globally despite previous recommendations to use local installation.

Apply this diff to use local installation:

-      - name: Install GraphQL Inspector
-        run: |
-          npm install -g @graphql-inspector/cli

The package should be added to package.json instead:

{
  "devDependencies": {
+   "@graphql-inspector/cli": "^5.0.0"
  }
}

328-339: LGTM! Robust validation with proper error handling.

The validation step includes proper error handling for:

  • Missing schema.graphql file
  • Missing GraphQL TypeScript files

@varshith257 varshith257 changed the title Fixed: NoMongo: Restore the GraphQL Introspection GitHub Action Test (Fixes #3235) [NoMongo] : Restore the GraphQL Introspection GitHub Action Test (Fixes #3235) Jan 11, 2025
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@palisadoes
Copy link
Contributor

palisadoes commented Jan 18, 2025

@raggettii

  1. This needs to be fixed.
  2. The introspection test needs to pass for this PR to be merged.
  3. This was mentioned in the issue
    image

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
Status: In review
Development

Successfully merging this pull request may close these issues.

2 participants