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

Added logic to LanguageController for showing "Language changed" notification in the newly set language #7

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

kerwin-wildsea
Copy link
Contributor

@kerwin-wildsea kerwin-wildsea commented Nov 19, 2024

This PR includes a minor addition which applies the newly set locale to the translation function.
This way, the notification shows in the newly selected language.

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Updated notification titles to dynamically reflect the selected language based on user input.
  • Bug Fixes

    • Enhanced existing tests to ensure correct user authentication context during language switching.
  • Tests

    • Introduced a new test case to verify that notifications are sent in the newly selected language, covering multiple locales.

Copy link

coderabbitai bot commented Nov 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the LanguageController class and the addition of a new test case in the LanguageSwitcherTest.php file. In the LanguageController, the notification title generation has been updated to include a locale parameter based on the incoming request's lang value, while the existing validation and control flow remain unchanged. The test suite has been enhanced with a new parameterized test case that verifies notifications are sent in the selected language, alongside minor adjustments to existing tests.

Changes

File Change Summary
src/Http/Controllers/LanguageController.php Updated notification title generation to include locale parameter based on request's lang value; other logic unchanged.
tests/src/LanguageSwitcherTest.php Added a new parameterized test case for verifying notifications in selected languages; modified existing tests for user authentication context. Import statement for Notification added.

Possibly related PRs

Poem

In the land of code where rabbits play,
A language switch brings joy today!
Notifications sing in tongues anew,
As we hop along, our tests are true.
With every change, we dance and cheer,
For coding magic is finally here! 🐇✨


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

🧹 Outside diff range and nitpick comments (2)
src/Http/Controllers/LanguageController.php (1)

Line range hint 21-41: Consider wrapping database operations in a transaction

While the language update logic is well-structured, database operations should be wrapped in a transaction to ensure data consistency, especially when dealing with potential race conditions in concurrent requests.

Consider applying this change:

     public function index(Request $request): RedirectResponse
     {
         $request->validate([
             'lang' => 'required|string',
             'model' => 'required|string',
             'model_id' => 'required',
         ]);
 
+        return DB::transaction(function () use ($request) {
         if (Schema::hasColumn(app($request->get('model'))->getTable(), 'lang')) {
             $model = app($request->get('model'))->find($request->get('model_id'));
             $model->lang = $request->get('lang');
             $model->save();
         } else {
             $lang = UserLanguage::query()
                 ->where('model_type', $request->get('model'))
                 ->where('model_id', $request->get('model_id'))
                 ->first();
 
             if ($lang) {
                 $lang->lang = $request->get('lang');
                 $lang->save();
             } else {
                 UserLanguage::query()->create([
                     'model_type' => $request->get('model'),
                     'model_id' => $request->get('model_id'),
                     'lang' => $request->get('lang'),
                 ]);
             }
         }
+        });
tests/src/LanguageSwitcherTest.php (1)

64-80: Consider enhancing test coverage

While the current test is good, consider these improvements for more robust testing:

  1. Add more common locales (e.g., 'fr', 'es', 'ja')
  2. Include explicit RTL/LTR mix testing
  3. Add edge cases for invalid locales
  4. Verify additional notification attributes (success status, persistence)

Example enhancement:

 })->with(['locale' => ['en', 'nl', 'ar', 'de']]);
+})->with(['locale' => [
+    'common' => ['en', 'fr', 'es', 'de'],
+    'rtl' => ['ar', 'he'],
+    'asian' => ['ja', 'zh'],
+    'edge_cases' => ['invalid-locale', '']
+]]);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 53517a7 and 7147142.

📒 Files selected for processing (2)
  • src/Http/Controllers/LanguageController.php (1 hunks)
  • tests/src/LanguageSwitcherTest.php (2 hunks)
🔇 Additional comments (5)
src/Http/Controllers/LanguageController.php (3)

Line range hint 13-19: LGTM: Method signature and validation are well-defined

The method properly validates all required parameters with appropriate type hints and return type.


Line range hint 49-54: LGTM: Redirection logic is well-implemented

The redirection handling properly respects configuration settings and provides flexible navigation options.


43-47: Verify locale existence before using it in translation

While the notification now uses the newly set language, it's important to verify that the locale exists to prevent potential translation issues.

Run this script to check available locales and their usage:

tests/src/LanguageSwitcherTest.php (2)

3-3: LGTM: Import statement is correctly placed

The Notification import is properly added and necessary for the new test functionality.


64-80: LGTM: Well-structured test implementation

The test case effectively verifies that notifications are displayed in the newly selected language, which directly addresses the PR's objective.

@3x1io 3x1io merged commit cdca2db into tomatophp:master Nov 21, 2024
6 checks passed
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