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(web): update language setting in extension based on client setting #99

Merged
merged 2 commits into from
Nov 20, 2024

Conversation

mulengawilfred
Copy link
Contributor

@mulengawilfred mulengawilfred commented Nov 20, 2024

What I've done

Made use of the language prop that is received from the client ( visualizer or classic ) to set the language displayed in the extension. Also made a small refactor to the tab CSS styles

What I haven't done

How I tested

Tested by running visualizer and classic locally and making changes to the client's language settings and checking the language displayed in the extension.
Link to video on Visualizer: https://eukarya-inc.slack.com/archives/C06S0GZR2DC/p1732069401402799
Link to video on Classic: https://eukarya-inc.slack.com/archives/C06S0GZR2DC/p1732069347418199

Which point I want you to review particularly

Notes

Summary by CodeRabbit

  • New Features

    • Enhanced language support in the SharedProviders component for improved internationalization.
    • Added the ability to set language externally via the extensionSetLang prop in the Provider component.
  • Bug Fixes

    • Restructured CSS for .homepage-tabs to improve specificity and maintainability without altering functionality.

Copy link

coderabbitai bot commented Nov 20, 2024

Walkthrough

The pull request introduces modifications to the SharedProviders and Provider components, enhancing language support for internationalization. The lang parameter is now required in the SharedProviders function, and a new prop, extensionSetLang, is added to the I18nProvider. This prop allows the Provider component to prioritize the external language setting over previous logic. Additionally, CSS for the .homepage-tabs class has been restructured for better organization without altering functionality.

Changes

File Change Summary
web/src/components/pages/extensions/sharedProviders.tsx - Added required lang parameter to SharedProviders function.
- Introduced extensionSetLang prop in I18nProvider.
web/src/i18n/provider.tsx - Updated Provider function signature to include optional extensionSetLang prop.
- Modified locale determination logic to prioritize extensionSetLang.
web/src/index.css - Restructured CSS rules for .homepage-tabs class, flattening nested rules for better organization.

Possibly related PRs

  • fix(web): amend tab styles on homepage #97: The changes in this PR involve modifications to the CSS styles for the .homepage-tabs class, which is relevant to the overall styling of components that may interact with the SharedProviders component, although it does not directly affect the functionality of the language support changes.

Suggested reviewers

  • airslice

Poem

In the garden of code, where rabbits play,
We've added some language, hip-hip-hooray!
With props and providers, our features expand,
Hopping through changes, all perfectly planned.
So let's celebrate with a joyful cheer,
For a world that speaks many tongues, oh so dear! 🐇✨


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

@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

🧹 Outside diff range and nitpick comments (2)
web/src/index.css (2)

21-24: Remove redundant ink bar styling

There are two declarations for the ink bar styling:

  1. Lines 21-24: Sets height and color
  2. Lines 33-35: Sets background color with !important

Consider consolidating these into a single rule to improve maintainability.

 .homepage-tabs .ant-tabs-ink-bar {
   height: 5px;
-  color: #ffffff;
+  background: #ffffff;
 }

-.homepage-tabs .ant-tabs .ant-tabs-ink-bar {
-  background: #ffffff !important;
-}

Also applies to: 33-35


26-50: Consider reducing the use of !important declarations

The extensive use of !important flags (lines 28, 34, 38, 42, 46) suggests potential specificity issues in the CSS cascade. While they work, they make the styles harder to maintain and override when needed.

Consider:

  1. Using more specific selectors
  2. Reviewing the global styles that necessitate these overrides
  3. Organizing styles to minimize specificity conflicts

Example of more specific selectors:

-.homepage-tabs .ant-tabs .ant-tabs-tab {
+.homepage-tabs.ant-tabs-wrapper .ant-tabs .ant-tabs-tab {
   color: rgba(255, 255, 255, 0.8);
-  font-size: 16px !important;
+  font-size: 16px;
   line-height: 22px;
   font-weight: 500;
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4a32f8d and 9a02bfa.

📒 Files selected for processing (3)
  • web/src/components/pages/extensions/sharedProviders.tsx (2 hunks)
  • web/src/i18n/provider.tsx (2 hunks)
  • web/src/index.css (1 hunks)
🔇 Additional comments (4)
web/src/components/pages/extensions/sharedProviders.tsx (1)

Line range hint 29-33: LGTM: Clean implementation of language setting propagation

The addition of extensionSetLang prop to the I18nProvider effectively implements the PR objective of updating the extension's language based on the client setting. The implementation maintains good separation of concerns by passing the language setting directly through props.

web/src/i18n/provider.tsx (2)

19-25: LGTM: Well-structured component signature

The addition of the optional extensionSetLang prop is well-typed and maintains backward compatibility.


36-36: Consider adding language validation and documentation

While the locale determination logic is correct, consider these improvements:

  1. Validate that extensionSetLang contains a supported language code
  2. Add a comment documenting the language selection precedence
+ // Language precedence: client setting > user preference > current language
+ const validLanguages = ['en', 'ja'];
+ const isValidLang = (lang?: string) => lang && validLanguages.includes(lang);
- const locale = extensionSetLang ? extensionSetLang : data?.me.lang ?? currentLang;
+ const locale = isValidLang(extensionSetLang) ? extensionSetLang : 
+   (isValidLang(data?.me.lang) ? data?.me.lang : currentLang);

Let's verify the supported languages in the codebase:

web/src/index.css (1)

21-50: LGTM! CSS restructuring improves maintainability

The flattening of nested rules and consistent class naming improves code organization while maintaining the same visual styling. The changes align well with the PR's objective of improving the extension UI.

@mulengawilfred mulengawilfred merged commit b43ae3e into main Nov 20, 2024
6 checks passed
@mulengawilfred mulengawilfred deleted the fix/language-update-from-client branch November 20, 2024 06:29
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