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

fix: rc version should match * version #692

Merged
merged 1 commit into from
May 30, 2024
Merged

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented May 30, 2024

closes cnpm/unpkg-white-list#63

Summary by CodeRabbit

  • Bug Fixes
    • Improved package version checking to support wildcard (*) versions, ensuring better compatibility and flexibility.
    • Fixed issues in handling release candidate (rc) versions in package version checks.

@fengmk2 fengmk2 added the bug Something isn't working label May 30, 2024
Copy link
Contributor

coderabbitai bot commented May 30, 2024

Walkthrough

The recent updates involve enhancing the PackageVersionFileService to better handle package version checks, including support for wildcard (*) versions. Additionally, a bugfix in listFiles.test.ts ensures compatibility with release candidate (rc) versions, improving the reliability and accuracy of package version validations.

Changes

Files/Groups Change Summary
app/core/service/PackageVersionFileService.ts Updated the logic for checking package versions to include wildcard (*) versions and improved the condition checks for package configuration.
test/port/controller/PackageVersionFileController/listFiles.test.ts Implemented a bugfix to support rc versions, including setting configuration flags, creating packages with specific versions and descriptions, making HTTP requests with different versions, and asserting responses.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant PackageVersionFileController
    participant PackageVersionFileService
    participant PackageRegistry

    Client->>PackageVersionFileController: Request for package files
    PackageVersionFileController->>PackageVersionFileService: Check package version
    PackageVersionFileService->>PackageRegistry: Fetch package configuration
    PackageRegistry-->>PackageVersionFileService: Return package configuration
    PackageVersionFileService-->>PackageVersionFileController: Return version check result
    PackageVersionFileController-->>Client: Respond with package files or error
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure the rule for package version checking includes wildcard (*) support (#63)
Fix the bug to support rc versions in package version checks (#63)

Poem

In code we trust, with versions so grand,
Wildcards and rc, now perfectly planned.
Packages flow, like rivers so free,
Bugs fixed and tested, for all to see.
A rabbit's delight, in lines of code,
Enhancing the path, on which we all rode.
🌟🐇✨


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

Outside diff range and nitpick comments (5)
app/core/service/PackageVersionFileService.ts (3)

Line range hint 97-98: Specify a more precise type instead of using any.

- this.#unpkgWhiteListAllowPackages = manifest.allowPackages ?? {} as any;
- this.#unpkgWhiteListAllowScopes = manifest.allowScopes ?? [] as any;
+ this.#unpkgWhiteListAllowPackages = manifest.allowPackages ?? {} as Record<string, { version: string }>;
+ this.#unpkgWhiteListAllowScopes = manifest.allowScopes ?? [] as string[];

Line range hint 198-199: Use template literals for better readability and consistency.

- this.logger.warn('[PackageVersionFileService.syncPackageReadme:warn] remove tmpdir: %s, error: %s',
-   tmpdir, err);
+ this.logger.warn(`[PackageVersionFileService.syncPackageReadme:warn] remove tmpdir: ${tmpdir}, error: ${err}`);

Line range hint 301-305: Remove unnecessary else clause to simplify control flow.

- } else if (file.toLowerCase() === 'README') {
-   fallback = i;
- }
+ if (file.toLowerCase() === 'README') {
+   fallback = i;
+ }
test/port/controller/PackageVersionFileController/listFiles.test.ts (2)

Line range hint 9-9: Define a specific type for publisher to enhance type safety.

let publisher: User; // Assuming User is a defined type

Line range hint 10-10: Define a specific type for adminUser to enhance type safety.

let adminUser: AdminUser; // Assuming AdminUser is a defined type
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 9beaf41 and 7bd72a4.
Files selected for processing (2)
  • app/core/service/PackageVersionFileService.ts (1 hunks)
  • test/port/controller/PackageVersionFileController/listFiles.test.ts (1 hunks)
Additional Context Used
Biome (16)
app/core/service/PackageVersionFileService.ts (14)

49-49: This type annotation is trivially inferred from its initialization.


97-97: Unexpected any. Specify a different type.


98-98: Unexpected any. Specify a different type.


198-199: Template literals are preferred over string concatenation.


301-305: This else clause can be omitted because previous branches break early.


301-302: This expression always returns false, because the string is converted and will never match


17-20: All these imports are only used as types.


20-21: All these imports are only used as types.


21-22: All these imports are only used as types.


22-23: All these imports are only used as types.


24-25: All these imports are only used as types.


25-26: All these imports are only used as types.


26-27: All these imports are only used as types.


27-28: All these imports are only used as types.

test/port/controller/PackageVersionFileController/listFiles.test.ts (2)

9-9: This variable implicitly has the any type.


10-10: This variable implicitly has the any type.

Additional comments not posted (3)
app/core/service/PackageVersionFileService.ts (2)

119-119: Ensure proper version matching for non-wildcard configurations.


116-116: Consider adding a more informative error message or a link to documentation.

- throw new ForbiddenError(`"${fullname}" is not allow to unpkg files, see ${unpkgWhiteListUrl}`);
+ throw new ForbiddenError(`"${fullname}" is not allowed to unpkg files. For more information, see ${unpkgWhiteListUrl}`);

Likely invalid or redundant comment.

test/port/controller/PackageVersionFileController/listFiles.test.ts (1)

924-1010: Ensure consistent handling of release candidate versions.

Copy link

codecov bot commented May 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.82%. Comparing base (96648fd) to head (7bd72a4).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #692   +/-   ##
=======================================
  Coverage   96.82%   96.82%           
=======================================
  Files         181      181           
  Lines       18014    18014           
  Branches     2345     2340    -5     
=======================================
  Hits        17442    17442           
  Misses        572      572           

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

@fengmk2
Copy link
Member Author

fengmk2 commented May 30, 2024

学习了 semver 的一个新知识点。

Learned a semver of new things to know.

@fengmk2 fengmk2 changed the title fiix: rc version should match * version fix: rc version should match * version May 30, 2024
@fengmk2 fengmk2 merged commit 0b62238 into master May 30, 2024
13 checks passed
@fengmk2 fengmk2 deleted the fix-sermver-version branch May 30, 2024 01:33
fengmk2 pushed a commit that referenced this pull request May 30, 2024
[skip ci]

## [3.61.1](v3.61.0...v3.61.1) (2024-05-30)

### Bug Fixes

* rc version should match `*` version ([#692](#692)) ([0b62238](0b62238))
fengmk2 pushed a commit that referenced this pull request May 30, 2024
> Update #692, Declare compatibility using + notation

1. 🤖 Ensure version matching by `semver`
---------

> 更新 #692 , 兼容版本声明为 `+` 的场景
1. 🤖 统一通过 `semver` 进行版本匹配判断

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Added support for prerelease versions when checking package version
compatibility.

- **Tests**
- Updated test cases to include operations related to a new object `baz`
with version `*`.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
fengmk2 pushed a commit that referenced this pull request May 30, 2024
[skip ci]

## [3.61.2](v3.61.1...v3.61.2) (2024-05-30)

### Bug Fixes

* support + wildcast ([#694](#694)) ([c8f5ee8](c8f5ee8)), closes [#692](#692)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[提问]规则生效时间
1 participant