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: switching language does not load the translation of the components library #4205

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

likui628
Copy link
Collaborator

@likui628 likui628 commented Aug 20, 2024

closes #4191

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Enhanced internationalization support by streamlining module exports.
  • Bug Fixes

    • Removed the loadMessages function to prevent potential confusion regarding its usage in the localization process.
  • Refactor

    • Simplified the language loading process by modifying the logic in how locale messages are handled, ensuring a more straightforward approach.

@likui628 likui628 requested review from anncwb, vince292007 and a team as code owners August 20, 2024 14:58
Copy link

changeset-bot bot commented Aug 20, 2024

⚠️ No Changeset found

Latest commit: 9261c68

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Aug 20, 2024

Walkthrough

The recent changes primarily involve the removal of the loadMessages function from the public API in various localization modules. This adjustment streamlines the internationalization setup, indicating a shift in how localization messages are managed across the application. While essential functions like $t and setupI18n remain intact, the elimination of loadMessages suggests a new approach to handling language loading, potentially addressing issues related to redundant loading operations.

Changes

Files Change Summary
apps/web-antd/src/locales/index.ts Removed loadMessages from exports, keeping $t, antdLocale, and setupI18n.
apps/web-ele/src/locales/index.ts Removed loadMessages from exports, keeping $t, elementLocale, and setupI18n.
apps/web-naive/src/locales/index.ts Removed loadMessages from exports, keeping $t and setupI18n.
playground/src/locales/index.ts Removed loadMessages from exports, keeping $t, antdLocale, and setupI18n.
packages/locales/src/i18n.ts Simplified loadLocaleMessages function by removing loadedLanguages tracking, affecting control flow.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant LocaleManager
    
    User->>App: Switch Language
    App->>LocaleManager: Load Locale Messages
    LocaleManager-->>App: Return Messages
    App-->>User: Update UI
Loading

Assessment against linked issues

Objective Addressed Explanation
Bug: i18n反复切换异常 (Ensure multiple language switches work) The removal of loadMessages may impede proper message loading during switches.

Poem

🐰 In the meadow, hopping free,
Language flowers bloom for me.
Load once, no more to repeat,
Messages dance on nimble feet!
Change is here, let joy abound,
In every word, sweet sounds resound. 🌼


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

@likui628 likui628 added the bug Something isn't working label Aug 20, 2024
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, codebase verification and nitpick comments (1)
playground/src/locales/index.ts (1)

94-94: loadMessages is used externally.

The loadMessages function is used in multiple external modules, including those in the apps/web-* directories. This indicates that it is not solely for internal use within the packages/locales module.

  • apps/web-naive/src/locales/index.ts
  • apps/web-antd/src/locales/index.ts
  • apps/web-ele/src/locales/index.ts
Analysis chain

Confirm internal use of loadMessages.

The loadMessages function is no longer exported, indicating it is intended for internal use within this module. Ensure that no external modules rely on this function.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that no external modules rely on the `loadMessages` function.

# Test: Search for the usage of `loadMessages` in the codebase. Expect: No external usage.
rg --type ts --type js 'loadMessages' --glob '!playground/src/locales/index.ts'

Length of output: 816


Script:

#!/bin/bash
# Check the directory structure to understand the relationship between the files.
# This will help determine if the usages of `loadMessages` are internal or external.

# List the directory structure for the relevant parts of the repository.
tree -L 2 packages
tree -L 2 apps

Length of output: 1824

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 04c2b9d and e99227c.

Files selected for processing (5)
  • apps/web-antd/src/locales/index.ts (1 hunks)
  • apps/web-ele/src/locales/index.ts (1 hunks)
  • apps/web-naive/src/locales/index.ts (1 hunks)
  • packages/locales/src/i18n.ts (3 hunks)
  • playground/src/locales/index.ts (1 hunks)
Additional comments not posted (4)
apps/web-naive/src/locales/index.ts (1)

31-31: Confirm internal use of loadMessages.

The loadMessages function is no longer exported, indicating it is intended for internal use within this module. Ensure that no external modules rely on this function.

Verification successful

No external reliance on loadMessages. The loadMessages function is not used by external modules, confirming its internal use within this module.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that no external modules rely on the `loadMessages` function.

# Test: Search for the usage of `loadMessages` in the codebase. Expect: No external usage.
rg --type ts --type js 'loadMessages' --glob '!apps/web-naive/src/locales/index.ts'

Length of output: 812

packages/locales/src/i18n.ts (1)

Line range hint 55-75: Evaluate the impact of removing loadedLanguages.

The removal of the loadedLanguages set simplifies the logic but may lead to redundant loading of locale messages. Consider the performance implications and ensure this aligns with the intended behavior.

Verification successful

Removal of loadedLanguages is justified and does not cause redundant loading. The loadLocaleMessages function already checks if the current locale matches the requested one and skips reloading if they are the same. This prevents unnecessary loading operations. Ensure that calls to loadLocaleMessages with different languages are intentional and optimized for performance.

  • The loadLocaleMessages function is used in several components and includes a check to avoid redundant loading.
  • The removal of loadedLanguages simplifies the code without introducing performance issues under normal circumstances.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Evaluate the performance impact of repeatedly loading locale messages.

# Test: Check for potential performance issues related to loading the same language multiple times.
# This script will simulate loading a language multiple times and measure the time taken.

# Simulate loading the same language multiple times
START_TIME=$(date +%s%3N)
for i in {1..10}; do
  # Simulate loading a language (replace with actual loading logic if necessary)
  echo "Loading language $i"
done
END_TIME=$(date +%s%3N)

echo "Total time taken: $((END_TIME - START_TIME)) ms"

Length of output: 798


Script:

#!/bin/bash
# Search for the implementation of the loadLocaleMessages function
ast-grep --lang typescript --pattern 'async function loadLocaleMessages($_) { $$$ }'

Length of output: 1020


Script:

#!/bin/bash
# Search for all calls to the loadLocaleMessages function to understand its usage
rg 'loadLocaleMessages'

Length of output: 1316

apps/web-antd/src/locales/index.ts (1)

94-94: Confirm internal use of loadMessages.

The loadMessages function is no longer exported, indicating it is intended for internal use within this module. Ensure that no external modules rely on this function.

Verification successful

No external reliance on loadMessages confirmed.

The loadMessages function is not imported from apps/web-antd/src/locales/index.ts in any of the identified files, indicating that it is used internally within those modules. No external modules rely on this function.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that no external modules rely on the `loadMessages` function.

# Test: Search for the usage of `loadMessages` in the codebase. Expect: No external usage.
rg --type ts --type js 'loadMessages' --glob '!apps/web-antd/src/locales/index.ts'

Length of output: 813


Script:

#!/bin/bash
# Description: Check if `loadMessages` is imported from `apps/web-antd/src/locales/index.ts` in any of the identified files.

# Search for import statements of `loadMessages` in the identified files.
rg 'import.*loadMessages' packages/locales/src/i18n.ts playground/src/locales/index.ts apps/web-naive/src/locales/index.ts apps/web-ele/src/locales/index.ts

Length of output: 158

apps/web-ele/src/locales/index.ts (1)

94-94: Confirm internal use of loadMessages.

The loadMessages function is no longer exported, indicating it is intended for internal use within this module. Ensure that no external modules rely on this function.

Verification successful

No external reliance on loadMessages from apps/web-ele/src/locales/index.ts.

The loadMessages function is not imported by other modules, indicating it is used internally within the module. The instances found in other files are likely independent implementations.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that no external modules rely on the `loadMessages` function.

# Test: Search for the usage of `loadMessages` in the codebase. Expect: No external usage.
rg --type ts --type js 'loadMessages' --glob '!apps/web-ele/src/locales/index.ts'

Length of output: 814


Script:

#!/bin/bash
# Check if any of the files import `loadMessages` from `apps/web-ele/src/locales/index.ts`
rg "import .*loadMessages.* from ['\"]\.\./\.\./apps/web-ele/src/locales/index['\"]" packages/locales/src/typing.ts packages/locales/src/i18n.ts playground/src/locales/index.ts apps/web-antd/src/locales/index.ts apps/web-naive/src/locales/index.ts

Length of output: 253

@vince292007 vince292007 merged commit cd65294 into main Aug 21, 2024
15 checks passed
@vince292007 vince292007 deleted the fixture/issue-4191 branch August 21, 2024 02:06
@github-actions github-actions bot locked and limited conversation to collaborators Sep 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: i18n反复切换异常
2 participants