fix: 修复代理模式下请求头没有正确携带的问题

hezhengxu2018 commented 1 month ago

proxy时因为一个低级的拼写错误没有正确的携带请求头，导致代理模式时返回的数据不正确。但是现在用户发起的请求中的user-agent和x-forwarded等头部信息也没有正确的携带。虽然影响不大但还是想和跑批时更新的请求做一下区分。

Summary by CodeRabbit

Bug Fixes
- Enhanced error handling and logging for task execution, improving traceability.
Improvements
- Updated HTTP header access method for better alignment with context structure.
- Clarified logic for manifest retrieval based on file type, ensuring correct API usage.
- Streamlined cache handling and response generation logic in package management.
- Improved method visibility and organization within the cache service and controller.
- Simplified task creation logic and cache removal processes in the controller.
- Updated expected outcomes for cache-related operations in the test cases.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in the ProxyCacheService, ProxyCacheController, and ShowPackageController classes involve enhancements to error handling, method visibility, and the organization of logic related to manifest retrieval and cache management. The getRewrittenManifest method has been made private, while a new method, replaceTarballUrl, has been introduced. The controller now utilizes a CacheService, simplifying method signatures and altering error handling. Test cases have been updated to reflect these changes, including the removal of tests for certain methods and adjustments to expected outcomes for DELETE operations.

Changes

File Path	Change Summary
app/core/service/ProxyCacheService.ts	- Updated `getPackageManifest` and `getPackageVersionManifest` with error handling. - Made `getRewrittenManifest` private and introduced `replaceTarballUrl` method. - Updated `getProxyResponse` to use `ctx.headers`.
app/port/controller/ProxyCacheController.ts	- Updated imports and switched to `CacheService`. - Modified `refreshProxyCaches` and `removeProxyCaches` methods for cache handling. - Changed `truncateProxyCaches` to throw `NotImplementedError`.
app/port/controller/package/ShowPackageController.ts	- Updated `show` method for cache handling and response construction, including error handling improvements.
test/core/service/ProxyCacheService.test.ts	- Removed `getRewrittenManifest()` tests and updated `executeTask()` test to focus on `getPackageVersionManifest`.
test/port/controller/ProxyCacheController/index.test.ts	- Removed tests for unauthorized DELETE access and updated expected responses for DELETE operations.

Possibly related PRs

#571: The changes in ProxyCacheService regarding error handling and method visibility are related to the comprehensive caching mechanism and methods for obtaining package manifests and versions introduced in this PR, which also modifies the ProxyCacheService.
#723: The modifications in the DownloadPackageVersionTarController to handle package downloads align with the changes in ProxyCacheService, particularly in how manifests and tarball URLs are managed and retrieved, ensuring compatibility with different path styles.

Suggested labels

enhancement

Suggested reviewers

elrrrrrrr
fengmk2

Poem

In the service where proxies play,
Headers shift in a clever way.
Errors now sing with a clearer tone,
Logging tasks, no longer alone.
With types well-handled, all in line,
Cache updates flow, oh how they shine! 🐇✨

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 , 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.47%. Comparing base (d6f0e1d) to head (3f5d7ba). Report is 7 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #719 +/- ## ======================================= Coverage 96.46% 96.47% ======================================= Files 188 188 Lines 18803 18874 +71 Branches 2463 2469 +6 ======================================= + Hits 18139 18209 +70 - Misses 664 665 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sweep-ai[bot] commented 4 weeks ago

Hey @hezhengxu2018, here are examples of how you can ask me to improve this pull request:

@sweep Fix the CI errors.

@sweep Add unit tests for the new `replaceTarballUrl` method in ProxyCacheService to verify it correctly replaces registry URLs in both package manifests and version manifests.

:book: For more information on how to use Sweep, please read our documentation.

hezhengxu2018 commented 4 weeks ago

修复请求上游仓库携带头部信息错误的问题引起的返回manifest异常的问题。
移除删除单条缓存记录的管理员权限需求，删除缓存和更新缓存一样都是日常的操作不需要有严格的控制。
将全量删除缓存设为 Not Implemented，原有实现过于粗暴且没有清除redis的缓存，之后计划通过schedule实现。

cnpm / cnpmcore