Skip to content

[WEB-3589] improvement: reset language to default on sign out#6775

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
improvement-language-support
Mar 19, 2025
Merged

[WEB-3589] improvement: reset language to default on sign out#6775
sriramveeraghanta merged 1 commit intopreviewfrom
improvement-language-support

Conversation

@prateekshourya29
Copy link
Member

@prateekshourya29 prateekshourya29 commented Mar 19, 2025

Description

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

References

WEB-3589

Summary by CodeRabbit

  • Refactor
    • Streamlined the app’s language initialization by always using a consistent default language, removing dynamic browser language detection.
    • Enhanced the sign-out process to also reset the language setting to its default.
    • Renamed language configuration references for improved clarity and maintainability.

@makeplane
Copy link

makeplane bot commented Mar 19, 2025

Pull Request Linked with Plane Issues

References

Comment Automatically Generated by Plane

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 2025

Walkthrough

This pull request renames the constant used for language storage from STORAGE_KEY to LANGUAGE_STORAGE_KEY across multiple files. In the translation store, methods for browser language detection have been removed and the language is now directly set to the fallback value. In addition, the sign-out routine has been updated to reset the language setting alongside the theme. These changes result in a simplified and consistent mechanism for handling language preferences.

Changes

File(s) Change Summary
packages/i18n/src/constants/language.ts, packages/i18n/src/store/index.ts Renamed constant from STORAGE_KEY to LANGUAGE_STORAGE_KEY. In the store, removed findSimilarLanguage and getBrowserLanguage methods and updated initializeLanguage to directly use FALLBACK_LANGUAGE.
web/core/store/root.store.ts Added imports for FALLBACK_LANGUAGE and LANGUAGE_STORAGE_KEY. Updated resetOnSignOut to set the language in local storage to FALLBACK_LANGUAGE alongside the theme.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant TranslationStore
    participant LocalStorage

    App->>TranslationStore: initializeLanguage()
    Note right of TranslationStore: Directly set language to FALLBACK_LANGUAGE
    TranslationStore->>LocalStorage: Save LANGUAGE_STORAGE_KEY = FALLBACK_LANGUAGE
Loading
sequenceDiagram
    participant User
    participant RootStore
    participant LocalStorage

    User->>RootStore: signOut()
    RootStore->>LocalStorage: Set theme in localStorage
    RootStore->>LocalStorage: Set LANGUAGE_STORAGE_KEY = FALLBACK_LANGUAGE
Loading

Possibly related PRs

Suggested reviewers

  • sriramveeraghanta
  • plane-bot

Poem

I'm a rabbit hopping through the code,
Changing names along the road,
Removing extra paths with care,
Ensuring language flows is fair.
Hop along, for clarity we share! 🐰✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 3f22642 and c9e945a.

📒 Files selected for processing (3)
  • packages/i18n/src/constants/language.ts (1 hunks)
  • packages/i18n/src/store/index.ts (3 hunks)
  • web/core/store/root.store.ts (2 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
packages/i18n/src/store/index.ts (2)
packages/i18n/src/constants/language.ts (2) (2)
  • LANGUAGE_STORAGE_KEY (22-22)
  • FALLBACK_LANGUAGE (3-3)
packages/i18n/src/types/language.ts (1) (1)
  • TLanguage (1-1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (7)
packages/i18n/src/constants/language.ts (1)

22-22: Improved naming convention for clarity

Renaming from STORAGE_KEY to LANGUAGE_STORAGE_KEY provides better context and makes the purpose of this constant clearer. This is a good improvement that increases code readability.

web/core/store/root.store.ts (2)

2-3: Good addition of imports for language reset functionality

Appropriate imports added to support the language reset functionality.


102-102: Implementation aligns with PR objective

This line implements the core functionality described in the PR objective - resetting the language to default when a user signs out. The placement after the theme reset is logically appropriate.

packages/i18n/src/store/index.ts (4)

6-6: Updated import to use renamed constant

Updated import to use the more descriptively named LANGUAGE_STORAGE_KEY instead of STORAGE_KEY for better clarity.


51-51: Storage key reference updated consistently

Updated to use the renamed LANGUAGE_STORAGE_KEY constant, ensuring consistency with the constant renaming in the language.ts file.


57-58: Simplified language initialization logic

The language initialization has been simplified to set the language directly to the fallback value rather than attempting to detect the browser language. This aligns with the PR objective of making language handling more deterministic.


262-262: Storage key reference updated consistently

Updated to use the renamed LANGUAGE_STORAGE_KEY constant in the language storage operation, maintaining consistency throughout the codebase.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

@sriramveeraghanta sriramveeraghanta merged commit f82d4a9 into preview Mar 19, 2025
5 of 6 checks passed
@sriramveeraghanta sriramveeraghanta deleted the improvement-language-support branch March 19, 2025 09:12
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.

2 participants