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

Using nodemon to get rid of the experimental warning #2715

Merged
merged 5 commits into from
Nov 25, 2024

Conversation

Suyash878
Copy link
Contributor

@Suyash878 Suyash878 commented Nov 24, 2024

What kind of change does this PR introduce?

Bug fix

Issue Number:

Fixes #2227

Did you add tests for your changes?

No

Snapshots/Videos:

image

If relevant, did you update the documentation?

No

Summary

Adding a new dependency nodemon which removes the experimental warning after starting the server, it uses its own file watching logic.

Does this PR introduce a breaking change?

No

Other information

None

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features

    • Development server now automatically restarts on file changes, enhancing the development experience.
    • New installation instructions for setting up Talawa-API using Devpod (CLI and GUI versions).
    • Added options for customizing the MinIO data directory.
  • Chores

    • Added nodemon as a new dependency for improved script execution.
    • Updated installation instructions to include prerequisites for Docker Desktop and improved overall clarity.

Copy link

coderabbitai bot commented Nov 24, 2024

Walkthrough

The changes in this pull request focus on modifications to the package.json file of the talawa-api project. The dev script has been updated to use nodemon instead of tsx --watch, enhancing the development server's functionality by enabling automatic restarts on file changes. Additionally, nodemon has been added as a new dependency in the devDependencies section. The INSTALLATION.md file has also been updated to include new sections for setting up the Talawa-API server using Devpod and to clarify Docker installation prerequisites.

Changes

File Change Summary
package.json Updated dev and dev:with-minio scripts to use nodemon for watching ./src/index.ts and added nodemon as a dependency in devDependencies.
INSTALLATION.md Added sections for "Install Using Devpod" (CLI and GUI), updated "Installation Using Docker," and added "Customize MinIO Data Directory." Minor adjustments made for clarity and formatting.

Assessment against linked issues

Objective Addressed Explanation
Rectify the ExperimentalWarning: Watch mode on starting the API app (#2227)

Possibly related PRs

Suggested labels

no-pr-activity

Suggested reviewers

  • palisadoes

Poem

🐇 In the meadow, where we play,
Nodemon's here to save the day!
With every change, the server's bright,
No more warnings, just pure delight!
Hopping through code, we cheer and sway,
Thank you, dear devs, for this fine display! 🌼


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

github-actions bot commented Nov 24, 2024

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: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 92443bb and 7ea886e.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • package.json (2 hunks)
🔇 Additional comments (1)
package.json (1)

149-149: Verify nodemon version compatibility and security

The addition of nodemon looks good, but let's verify its compatibility and security.

✅ Verification successful

Nodemon dependency addition is safe and compatible

The verification shows:

  • No security vulnerabilities found for nodemon
  • Nodemon requires Node.js >= 10, which is a very permissive requirement
  • No specific Node.js version constraint in package.json, so no compatibility conflicts
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check nodemon version compatibility and security advisories

# Check for any security advisories for nodemon
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: NPM, package: "nodemon") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
      firstPatchedVersion {
        identifier
      }
    }
  }
}'

# Check package.json for Node.js version requirements
echo "Node.js version requirements:"
cat package.json | jq '.engines?.node'

# Check nodemon's Node.js version compatibility
echo "nodemon's Node.js compatibility:"
npm view nodemon engines

Length of output: 576

package.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
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: 0

🧹 Outside diff range and nitpick comments (1)
INSTALLATION.md (1)

1289-1289: Consider adding Devpod version compatibility information.

The Devpod installation instructions are well-structured, but it would be helpful to specify:

  1. The minimum required version of Devpod
  2. Any known version compatibility issues
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 17f6c52 and 280adbe.

📒 Files selected for processing (2)
  • INSTALLATION.md (2 hunks)
  • package.json (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json
🔇 Additional comments (2)
INSTALLATION.md (2)

102-104: LGTM: Table of contents updates are accurate.

The new TOC entries correctly reflect the added Devpod installation sections.


1289-1289: LGTM: MinIO data directory customization section is well-documented.

The section provides clear instructions for both automated and manual configuration of the MinIO data directory.

@Suyash878 Suyash878 changed the title Adding a new dependency nodemon to get rid of the experimental warning Using nodemon to get rid of the experimental warning Nov 24, 2024
@palisadoes
Copy link
Contributor

  1. Why does your solution fix the issue?
  2. Is your solution hiding the underlying problem?

@Suyash878
Copy link
Contributor Author

Suyash878 commented Nov 25, 2024

nodemon does not rely on Node.js's watch experimental watch mode, it rather uses its own stable file watching implementation
which avoids the triggering the warning altogether.
And moreover nodemon is more stable and been around for years and can be trusted without invoking any experimental warnings.

Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.74%. Comparing base (9f4c0b0) to head (495432b).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2715   +/-   ##
========================================
  Coverage    97.74%   97.74%           
========================================
  Files          358      358           
  Lines        18114    18114           
  Branches      2599     2599           
========================================
  Hits         17706    17706           
  Misses         404      404           
  Partials         4        4           

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


🚨 Try these New Features:

@palisadoes palisadoes added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Nov 25, 2024
@palisadoes palisadoes merged commit 832d310 into PalisadoesFoundation:develop Nov 25, 2024
10 of 11 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Dec 3, 2024
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.

2 participants