fix: support pnpm v9 lockfiles

G-Rath commented 4 months ago

Summary

This was introduced with PNPN v9 and requires a couple of minor changes to support.

Pull Request checklist

[x] Add/update test to cover these changes
[x] ~Update documentation~
[x] Update CHANGELOG file

Other Information

Prior art around this: https://github.com/google/osv-scanner/pull/934

Summary by CodeRabbit

New Features
- Enhanced version handling to support git-based constraints with pseudo semantic versions.
- Implemented key format adjustments for versions starting with "v9+".
Documentation
- Updated lockfile documentation to include new settings for auto-installing peers and excluding links.
Tests
- Modified test specifications to include additional arguments in node_package_version method for comprehensive testing.

coderabbitai[bot] commented 4 months ago

Walkthrough

The update enriches shakapacker by enhancing git-based constraints handling and version formats in version_checker.rb. It introduces new pnpm-lock.v9.yaml files detailing dependencies and settings for peers installation and link exclusion, impacting both the library code and test specifications.

Changes

File Path	Change Summary
`lib/shakapacker/version_checker.rb`	Added git-based version handling and adjusted key formats for "v9+" versions.
`spec/fixtures/relative_path_pnpm-lock.v9.yaml` `spec/fixtures/without_pnpm-lock.v9.yaml`	Introduced lockfiles with version 9.0 settings and dependencies.
`spec/shakapacker/version_checker_spec.rb`	Expanded `node_package_version` method to include more arguments.

🐇✨ A hop, a skip, in the code we dip, New versions and fixes, on a digital trip. From v9 to the stars, our packets we zip, In the warren of code, not a single slip. Cheers to changes, with a carrot tip! 🥕 🌟🐰

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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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.

G-Rath commented 4 months ago

Note that CI is currently failing due to #470

justin808 commented 4 months ago

Tests broken. Should we fix first?

An error occurred while loading ./spec/system/hello_world_spec.rb.
Failure/Error: require_relative "../config/environment"

RuntimeError:
  **ERROR** Shakapacker: Shakapacker gem and node package versions do not match
  Detected: 7.2.3
       gem: 8.0.0.rc.2
  Ensure the installed version of the gem is the same as the version of
  your installed node package.
  Do not use >= or ~> in your Gemfile for shakapacker without a lockfile.
  Do not use ^ or ~ in your package.json for shakapacker without a lockfile.

justin808 commented 4 months ago

@G-Rath please rebase on main.

G-Rath commented 4 months ago

@justin808 done

shakacode / shakapacker