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: ignore duplicate identifier #104

Merged
merged 3 commits into from
Feb 2, 2025
Merged

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Feb 2, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced module compatibility by adding explicit support for ES module imports alongside existing CommonJS support.
    • Improved security capabilities with new options for robust token management and secure HTTP interactions.

Copy link
Contributor

coderabbitai bot commented Feb 2, 2025

Warning

Rate limit exceeded

@fengmk2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 66c114b and 601a694.

📒 Files selected for processing (2)
  • src/app/extend/context.ts (1 hunks)
  • src/index.ts (0 hunks)

Walkthrough

The pull request updates the package dependency and module configuration in package.json by moving from version ^4.0.1 to ^4.0.4 for the egg dependency and adding a new ES module entry point. In addition, the augmentation of the Context interface in src/app/extend/context.ts has been enhanced with new getter methods and function signatures related to CSRF management and secure HTTP requests, alongside TypeScript ignore comments to bypass potential type-check issues.

Changes

File(s) Change Summary
package.json Updated dependency "egg": "^4.0.1""^4.0.4"; added "module": "./dist/esm/index.js" to support ES modules while retaining "main": "./dist/commonjs/index.js".
src/app/extend/context.ts Enhanced SecurityContext in module augmentation for Context by adding new getters (securityOptions, nonce, csrf) and function signatures (ensureCsrfSecret, rotateCsrfSecret, assertCsrf, safeCurl), with accompanying TypeScript ignore comments.

Sequence Diagram(s)

sequenceDiagram
    participant User as "User Request"
    participant Context as "SecurityContext (Context)"
    participant SecManager as "Security Methods"

    User->>Context: Initiate request
    Context->>SecManager: get nonce & CSRF token
    Context->>SecManager: assertCsrf()
    alt CSRF check fails
        SecManager-->>Context: Error/Exception
    else CSRF check passes
        SecManager-->>Context: OK
    end
    Context->>SecManager: safeCurl() for HTTP request
    SecManager-->>Context: Response
    Context-->>User: Return processed response
Loading

Poem

In coding fields I hop with glee,
A rabbit sings of changes free.
Dependencies now leap to shine,
And CSRF guards all align.
A gentle nudge, a trusted call—
I bound ahead, embracing all!
🐇✨


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

pkg-pr-new bot commented Feb 2, 2025

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/security/@eggjs/security@104

commit: 601a694

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
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 58f097a and 66c114b.

📒 Files selected for processing (2)
  • package.json (2 hunks)
  • src/app/extend/context.ts (1 hunks)
🧰 Additional context used
🪛 ESLint
src/app/extend/context.ts

[error] 273-273: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)


[error] 276-276: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)


[error] 278-278: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)

🪛 GitHub Check: Node.js / Test (windows-latest, 20)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (windows-latest, 18.19.0)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 22)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 20)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 18.19.0)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 18.19.0)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 22)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 20)
src/app/extend/context.ts

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Node.js / Test (windows-latest, 22)
🔇 Additional comments (2)
src/app/extend/context.ts (1)

271-285: LGTM! Well-structured module augmentation.

The Context interface augmentation is well-defined with proper type definitions for security-related methods.

🧰 Tools
🪛 ESLint

[error] 273-273: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)


[error] 276-276: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)


[error] 278-278: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)

🪛 GitHub Check: Node.js / Test (windows-latest, 20)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (windows-latest, 18.19.0)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 22)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 20)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 18.19.0)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 18.19.0)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 22)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 20)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

package.json (1)

66-66: LGTM! Enhanced module system compatibility.

The changes improve the package by:

  • Updating the egg dependency to the latest version
  • Adding proper ESM support through the module field

Also applies to: 114-115

Comment on lines 273 to 279
// @ts-ignore
get securityOptions(): Partial<SecurityConfig & SecurityHelperConfig>;
isSafeDomain(domain: string, customWhiteList?: string[]): boolean;
// @ts-ignore
get nonce(): string;
// @ts-ignore
get csrf(): string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Replace @ts-ignore with @ts-expect-error.

The @ts-ignore directive will silently do nothing if there's no error on the following line. Using @ts-expect-error is safer as it will fail if the error no longer exists, helping maintain type safety.

Apply this diff to improve type safety:

-    // @ts-ignore
+    // @ts-expect-error
     get securityOptions(): Partial<SecurityConfig & SecurityHelperConfig>;
     isSafeDomain(domain: string, customWhiteList?: string[]): boolean;
-    // @ts-ignore
+    // @ts-expect-error
     get nonce(): string;
-    // @ts-ignore
+    // @ts-expect-error
     get csrf(): string;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// @ts-ignore
get securityOptions(): Partial<SecurityConfig & SecurityHelperConfig>;
isSafeDomain(domain: string, customWhiteList?: string[]): boolean;
// @ts-ignore
get nonce(): string;
// @ts-ignore
get csrf(): string;
// @ts-expect-error
get securityOptions(): Partial<SecurityConfig & SecurityHelperConfig>;
isSafeDomain(domain: string, customWhiteList?: string[]): boolean;
// @ts-expect-error
get nonce(): string;
// @ts-expect-error
get csrf(): string;
🧰 Tools
🪛 ESLint

[error] 273-273: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)


[error] 276-276: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)


[error] 278-278: Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free.

(@typescript-eslint/ban-ts-comment)

🪛 GitHub Check: Node.js / Test (windows-latest, 20)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (windows-latest, 18.19.0)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 22)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 20)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (ubuntu-latest, 18.19.0)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 18.19.0)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 22)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

🪛 GitHub Check: Node.js / Test (macos-latest, 20)

[failure] 273-273:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 276-276:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free


[failure] 278-278:
Use "@ts-expect-error" instead of "@ts-ignore", as "@ts-ignore" will do nothing if the following line is error-free

Copy link

codecov bot commented Feb 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.77%. Comparing base (2c950d3) to head (601a694).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #104      +/-   ##
==========================================
- Coverage   97.28%   95.77%   -1.52%     
==========================================
  Files          32       32              
  Lines        1364     1798     +434     
  Branches      344      308      -36     
==========================================
+ Hits         1327     1722     +395     
- Misses         37       76      +39     

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

@fengmk2 fengmk2 merged commit 2d1a44b into master Feb 2, 2025
17 of 18 checks passed
@fengmk2 fengmk2 deleted the ignore-duplicate-identifier branch February 2, 2025 17:23
fengmk2 pushed a commit that referenced this pull request Feb 2, 2025
[skip ci]

## [4.0.1](v4.0.0...v4.0.1) (2025-02-02)

### Bug Fixes

* ignore duplicate identifier ([#104](#104)) ([2d1a44b](2d1a44b))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant