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

Update PackageVersionFileController.ts #716

Closed
wants to merge 5 commits into from
Closed

Conversation

i18nsite
Copy link

@i18nsite i18nsite commented Oct 17, 2024

fix #696
支持https://unpkg.com/ & https://www.jsdelivr.com/ 风格的路径

Summary by CodeRabbit

  • New Features
    • Introduced a new HTTP method rawNpmVer for handling GET requests with specific version specifications in the URL, allowing for more precise access to package files.
    • Added a new HTTP method rawNpm for simplified access to the latest version of package files, enhancing user experience.

Copy link
Contributor

coderabbitai bot commented Oct 17, 2024

Walkthrough

The pull request introduces two new HTTP method handlers, rawNpmVer and rawNpm, in the PackageVersionFileController class. The rawNpmVer method handles GET requests for paths formatted as /npm/:fullname@:versionSpec/:path(.+), while the rawNpm method handles GET requests for paths formatted as /npm/:fullname/:path(.+), defaulting the versionSpec to "latest". These additions facilitate npm-style version specification and simplified access for the latest version of package files. No other changes to existing methods or logic are present.

Changes

File Path Change Summary
app/port/controller/PackageVersionFileController.ts Added methods async rawNpmVer(...) and async rawNpm(...) to handle GET requests for npm-style version paths.

Assessment against linked issues

Objective Addressed Explanation
Support npm path format suffix for easier importmap usage (#696)

Possibly related PRs

🐰 In the garden of code, I hop with glee,
New paths for packages, as easy as can be!
With rawNpm now here, the imports align,
A sprinkle of joy in each versioned line.
So let’s celebrate this change, oh so bright,
For fetching our files is now pure delight! 🌼


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.

CodeRabbit Configuration 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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between efac8a9 and 7fef0b5.

📒 Files selected for processing (1)
  • app/port/controller/PackageVersionFileController.ts (1 hunks)
🧰 Additional context used

app/port/controller/PackageVersionFileController.ts Outdated Show resolved Hide resolved
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 (1)
app/port/controller/PackageVersionFileController.ts (1)

174-189: LGTM! Consider these improvements for better maintainability.

The rawNpmVer method successfully implements support for npm-style paths, aligning with the PR objectives. The logic for extracting version information and handling scoped packages is correct. Here are some suggestions to further improve the code:

  1. Add input validation for the fullname parameter to ensure it's properly formatted.
  2. Include explanatory comments for the version extraction logic to improve readability.
  3. Consider renaming the method to something more descriptive, like handleNpmStylePath, to better reflect its purpose.

Here's a suggested refactor incorporating these improvements:

@HTTPMethod({
  path: `/npm/:fullname(${FULLNAME_REG_STRING})/:path(.+)`,
  method: HTTPMethodEnum.GET,
})
async handleNpmStylePath(@Context() ctx: EggContext,
    @HTTPParam() fullname: string,
    @HTTPParam() path: string,
    @HTTPQuery() meta: string) {
  // Validate fullname format
  if (!fullname.match(FULLNAME_REG_STRING)) {
    throw new Error('Invalid package name format');
  }

  // Extract version from fullname, defaulting to 'latest' if not present
  // For scoped packages, split from the end to preserve the scope
  const parts = fullname.split('@');
  let ver = parts.length > 2 ? parts.pop() : 'latest';
  fullname = parts.join('@');

  // Call the existing raw method with extracted information
  return await this.raw(ctx, fullname, ver, path, meta);
}

This refactored version includes input validation, explanatory comments, and a more descriptive method name.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a650902 and b911aba.

📒 Files selected for processing (1)
  • app/port/controller/PackageVersionFileController.ts (1 hunks)
🧰 Additional context used

@fengmk2
Copy link
Member

fengmk2 commented Oct 18, 2024

unpkg 的路径我们支持这种 https://www.yuque.com/egg/cnpm/files ,这个变更不符合我们的要求。

@fengmk2 fengmk2 closed this Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

能不支持和jsdelivr&unpkg一样的npm路径格式后缀,这样方便在importmap中用
2 participants