fix: not allow to override the `app.locals.__` method #15

fengmk2 · 2025-01-12T01:59:44Z

Summary by CodeRabbit

New Features
- Enhanced localization method implementation with improved property definition
- Added test coverage for localization functionality
Tests
- Introduced new test cases for ctx.locals.__() method
- Added test to prevent overriding of app.locals.__

coderabbitai · 2025-01-12T01:59:51Z

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the I18n class in src/app.ts by changing how the gettextInContext function is assigned to app.locals. Instead of direct assignment, the code now uses Object.defineProperties() to define __ and gettext properties with specific configurations. Correspondingly, the test file test/i18n.test.ts has been updated with two new test cases to verify the behavior of localization methods and their immutability.

Changes

File	Change Summary
`src/app.ts`	Replaced direct assignment of `gettextInContext` with `Object.defineProperties()`, making `__` and `gettext` enumerable properties of `app.locals`
`test/i18n.test.ts`	Added two new test cases: - Verifying `ctx.locals.__()` functionality - Ensuring `app.locals.__` cannot be overridden

Sequence Diagram

sequenceDiagram
    participant I18n
    participant app.locals
    I18n->>app.locals: Object.defineProperties()
    app.locals-->>I18n: Define __ and gettext
    Note over app.locals: Properties are enumerable
    Note over app.locals: Properties are read-only

Poem

🐰 A rabbit's tale of locales so bright,
Properties defined with careful might,
Enumerable, yet firmly set,
No override shall make us fret!
Translation magic, sealed just right! 🌈

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4de5740 and db57fff.

📒 Files selected for processing (2)

src/app.ts (1 hunks)
test/i18n.test.ts (1 hunks)

Finishing Touches

📝 Generate Docstrings (Beta)

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.

pkg-pr-new · 2025-01-12T02:00:32Z

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/i18n/@eggjs/i18n@15

commit: db57fff

codecov · 2025-01-12T02:01:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.29%. Comparing base (7ddd9f8) to head (db57fff).
Report is 3 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff             @@
##            master      #15      +/-   ##
===========================================
- Coverage   100.00%   96.29%   -3.71%     
===========================================
  Files            4        6       +2     
  Lines           30      486     +456     
  Branches         1       75      +74     
===========================================
+ Hits            30      468     +438     
- Misses           0       18      +18

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

[skip ci] ## [3.0.1](v3.0.0...v3.0.1) (2025-01-12) ### Bug Fixes * not allow to override the `app.locals.__` method ([#15](#15)) ([6e8447c](6e8447c))

fix: not allow to override the app.locals.__ method

db57fff

fengmk2 merged commit 6e8447c into master Jan 12, 2025
16 of 18 checks passed

fengmk2 deleted the fix-override branch January 12, 2025 02:03

fengmk2 pushed a commit that referenced this pull request Jan 12, 2025

Release 3.0.1

d0eec80

[skip ci] ## [3.0.1](v3.0.0...v3.0.1) (2025-01-12) ### Bug Fixes * not allow to override the `app.locals.__` method ([#15](#15)) ([6e8447c](6e8447c))

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: not allow to override the `app.locals.__` method #15

fix: not allow to override the `app.locals.__` method #15

fengmk2 commented Jan 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 12, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

pkg-pr-new bot commented Jan 12, 2025

codecov bot commented Jan 12, 2025 •

edited

Loading

fix: not allow to override the app.locals.__ method #15

fix: not allow to override the app.locals.__ method #15

Conversation

fengmk2 commented Jan 12, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 12, 2025 • edited Loading

Review failed

Walkthrough

Changes

Sequence Diagram

Poem

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

pkg-pr-new bot commented Jan 12, 2025

codecov bot commented Jan 12, 2025 • edited Loading

Codecov Report

fix: not allow to override the `app.locals.__` method #15

fix: not allow to override the `app.locals.__` method #15

fengmk2 commented Jan 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 12, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jan 12, 2025 •

edited

Loading