From 8d3380bb5eb417865e872fb5387b12784633736c Mon Sep 17 00:00:00 2001
From: Alexis Saettler <alexis@saettler.org>
Date: Mon, 31 May 2021 23:31:54 +0200
Subject: [PATCH] feat: change language dynamically (#932)

---
 .../Controllers/User/LocaleController.php     |  8 +--
 app/Http/Middleware/ShareInertiaData.php      |  7 +-
 app/Models/User/User.php                      |  1 +
 app/Services/User/UpdateLocale.php            |  7 +-
 .../Pages/Profile/Partials/UpdateLocale.vue   | 53 +++++++++------
 resources/js/Pages/Profile/Show.vue           |  3 +-
 resources/js/app.js                           |  7 +-
 resources/js/langs.js                         |  7 +-
 resources/lang/fr/app.php                     |  4 ++
 tests/Unit/Services/User/UpdateLocaleTest.php | 64 +++++++++++++++++++
 10 files changed, 126 insertions(+), 35 deletions(-)
 create mode 100644 tests/Unit/Services/User/UpdateLocaleTest.php

diff --git a/app/Http/Controllers/User/LocaleController.php b/app/Http/Controllers/User/LocaleController.php
index c40f7beb2..a504f5a9e 100644
--- a/app/Http/Controllers/User/LocaleController.php
+++ b/app/Http/Controllers/User/LocaleController.php
@@ -2,10 +2,10 @@
 
 namespace App\Http\Controllers\User;
 
-use Inertia\Response;
 use Illuminate\Http\Request;
 use App\Services\User\UpdateLocale;
 use App\Http\Controllers\Controller;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\Auth;
 
 class LocaleController extends Controller
@@ -23,8 +23,8 @@ public function update(Request $request)
             'locale' => $request->input('locale'),
         ]);
 
-        return response()->json([
-            'data' => true,
-        ], 200);
+        return $request->wantsJson()
+                    ? new JsonResponse('', 200)
+                    : back()->with('status', 'locale-changed');
     }
 }
diff --git a/app/Http/Middleware/ShareInertiaData.php b/app/Http/Middleware/ShareInertiaData.php
index f1310701b..d5c53703d 100644
--- a/app/Http/Middleware/ShareInertiaData.php
+++ b/app/Http/Middleware/ShareInertiaData.php
@@ -2,8 +2,8 @@
 
 namespace App\Http\Middleware;
 
+use App\Helpers\LocaleHelper;
 use Inertia\Inertia;
-use Laravel\Jetstream\Jetstream;
 use Illuminate\Support\Facades\Session;
 
 /**
@@ -26,6 +26,7 @@ public function handle($request, $next)
             'jetstream' => function () use ($request) {
                 return [
                     'flash' => $request->session()->get('flash', []),
+                    'languages' => LocaleHelper::getLocaleList(),
                 ];
             },
             'user' => function () use ($request) {
@@ -33,7 +34,9 @@ public function handle($request, $next)
                     return;
                 }
 
-                return [];
+                return [
+                    'two_factor_enabled' => ! is_null($request->user()->two_factor_secret),
+                ];
             },
             'errorBags' => function () {
                 return collect(optional(Session::get('errors'))->getBags() ?: [])->mapWithKeys(function ($bag, $key) {
diff --git a/app/Models/User/User.php b/app/Models/User/User.php
index 273ee8b29..c08f25076 100644
--- a/app/Models/User/User.php
+++ b/app/Models/User/User.php
@@ -32,6 +32,7 @@ class User extends Authenticatable implements MustVerifyEmail
         'nickname',
         'uuid',
         'show_help',
+        'locale',
     ];
 
     /**
diff --git a/app/Services/User/UpdateLocale.php b/app/Services/User/UpdateLocale.php
index 76bdb0f9c..aacff3aae 100644
--- a/app/Services/User/UpdateLocale.php
+++ b/app/Services/User/UpdateLocale.php
@@ -4,6 +4,7 @@
 
 use App\Models\User\User;
 use App\Services\BaseService;
+use Illuminate\Validation\Rule;
 
 class UpdateLocale extends BaseService
 {
@@ -19,7 +20,11 @@ public function rules(): array
     {
         return [
             'user_id' => 'required|integer|exists:users,id',
-            'locale' => 'required|string',
+            'locale' => [
+                'required',
+                'string',
+                Rule::in(config('lang-detector.languages')),
+            ],
         ];
     }
 
diff --git a/resources/js/Pages/Profile/Partials/UpdateLocale.vue b/resources/js/Pages/Profile/Partials/UpdateLocale.vue
index a7378d487..2360dc310 100644
--- a/resources/js/Pages/Profile/Partials/UpdateLocale.vue
+++ b/resources/js/Pages/Profile/Partials/UpdateLocale.vue
@@ -9,14 +9,10 @@
     </template>
 
     <template #form>
-      <select v-model="form.locale">
-        <option value="en">
-          {{ $t('app.locale_en') }}
-        </option>
-        <option value="fr">
-          {{ $t('app.locale_fr') }}
-        </option>
-      </select>
+      <select-box v-model="form.locale"
+                  :options="localesFiltered"
+                  :required="true"
+      />
     </template>
 
     <template #actions>
@@ -30,44 +26,61 @@
 <script>
 import LoadingButton from '@/Shared/LoadingButton';
 import FormSection from '@/Shared/Layout/FormSection';
+import SelectBox from '@/Shared/Select';
+import { useForm } from '@inertiajs/inertia-vue3';
 
 export default {
   components: {
     LoadingButton,
     FormSection,
+    SelectBox,
   },
 
   props: {
     user: {
       type: Object,
       default: null,
+    },
+    locales: {
+      type: Array,
+      default: () => [],
     }
   },
 
   data() {
     return {
-      form: {
-        locale: null,
-      },
-      loadingState: '',
+      form: useForm({
+        locale: '',
+      }),
     };
   },
 
+  computed: {
+    localesFiltered: function() {
+      return _.map(this.locales, locale => {
+        return {
+          value: locale.lang,
+          label: locale['name-orig'] + (locale['name-orig'] !== locale.name ? ' (' + locale.name + ')' : ''),
+        };
+      });
+    }
+  },
+
   mounted() {
     this.form.locale = this.$page.props.auth.user.locale;
   },
 
   methods: {
     updateLocale() {
-      axios.post('/locale', this.form)
-        .then(response => {
-          this.flash(this.$t('app.saved'), 'success');
-
-          this.loadingState = null;
+      Promise.all([
+        this.loadLanguage(this.form.locale, true),
+        this.form.post('/locale', {
+          preserveScroll: true,
+          onSuccess: () => {
+            this.flash(this.$t('app.saved'), 'success');
+          },
         })
-        .catch(error => {
-          this.loadingState = null;
-        });
+      ]);
     },
   },
 };
diff --git a/resources/js/Pages/Profile/Show.vue b/resources/js/Pages/Profile/Show.vue
index 744a1cde2..d0f30d936 100644
--- a/resources/js/Pages/Profile/Show.vue
+++ b/resources/js/Pages/Profile/Show.vue
@@ -6,7 +6,7 @@
 
         <update-password-form class="mt1" />
 
-        <update-locale :user="$page.props.auth.user" class="mt1" />
+        <update-locale :user="$page.props.auth.user" :locales="$page.props.jetstream.languages" class="mt1" />
 
         <two-factor-authentication-form class="mt1" />
 
@@ -28,7 +28,6 @@ export default {
 
   components: {
     Layout,
-    // DeleteUserForm,
     LogoutOtherBrowserSessionsForm,
     TwoFactorAuthenticationForm,
     UpdatePasswordForm,
diff --git a/resources/js/app.js b/resources/js/app.js
index 7b01390be..8085feb5b 100644
--- a/resources/js/app.js
+++ b/resources/js/app.js
@@ -30,7 +30,12 @@ langs.loadLanguage(document.querySelector('html').getAttribute('lang'), true)
 
   Sentry.init(app, process.env.MIX_SENTRY_RELEASE);
 
-  app.mixin({ methods: _.assign({ route }, require('./methods').default) })
+  app.mixin({ methods: _.assign({
+    route,
+    loadLanguage: function(locale, set) {
+      return langs.loadLanguage(locale, set);
+    }
+  }, require('./methods').default) })
     .use(InertiaPlugin)
     .use(langs.i18n)
     .mount(el);
diff --git a/resources/js/langs.js b/resources/js/langs.js
index df48dd50f..f8587fbd3 100644
--- a/resources/js/langs.js
+++ b/resources/js/langs.js
@@ -6,14 +6,12 @@ import pluralization from './pluralization.js';
 
 export default {
   i18n: createI18n({
-    locale: 'en',
+    locale: 'en', // default locale
     fallbackLocale: 'en',
     messages: {'en': messages},
     pluralizationRules: pluralization,
   }),
 
-  loadedLanguages : ['en'], // our default language that is preloaded
-
   _setI18nLanguage (lang) {
     if (this.i18n.mode === 'legacy') {
       this.i18n.global.locale = lang;
@@ -26,12 +24,11 @@ export default {
 
   _loadLanguageAsync (lang) {
     if (this.i18n.locale !== lang) {
-      if (!this.loadedLanguages.includes(lang)) {
+      if (!this.i18n.global.availableLocales.includes(lang)) {
         return this._loadLanguageMessagesAsync(lang)
           .then(msgs => {
             if (msgs !== null) {
               this.i18n.global.setLocaleMessage(lang, msgs);
-              this.loadedLanguages.push(lang);
             }
             return this.i18n;
           });
diff --git a/resources/lang/fr/app.php b/resources/lang/fr/app.php
index 85ac3f73b..7f28624c5 100644
--- a/resources/lang/fr/app.php
+++ b/resources/lang/fr/app.php
@@ -162,4 +162,8 @@
     'demo_mode_read_more' => 'En savoir plus',
     'demo_mode_deactivated' => 'Cette fonctionnalité est désactivées en mode démo.',
     'demo_mode_desc' => 'Il s’agit d’un compte de démo. Certaines fonctionnalités sont désactivées. Les données sont réinitialisées toutes les 5 minutes.',
+
+    'locale_en' => 'Anglais',
+    'locale_fr' => 'Français',
+
 ];
diff --git a/tests/Unit/Services/User/UpdateLocaleTest.php b/tests/Unit/Services/User/UpdateLocaleTest.php
new file mode 100644
index 000000000..cb4ba3d35
--- /dev/null
+++ b/tests/Unit/Services/User/UpdateLocaleTest.php
@@ -0,0 +1,64 @@
+<?php
+
+namespace Tests\Unit\Services\User;
+
+use Tests\TestCase;
+use App\Models\User\User;
+use App\Services\User\UpdateLocale;
+use Illuminate\Validation\ValidationException;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+
+class UpdateLocaleTest extends TestCase
+{
+    use DatabaseTransactions;
+
+    /** @test */
+    public function it_update_the_locale(): void
+    {
+        $user = User::factory()->create([
+            'locale' => 'xx',
+        ]);
+
+        $request = [
+            'user_id' => $user->id,
+            'locale' => 'en',
+        ];
+
+        (new UpdateLocale)->execute($request);
+
+        $user->refresh();
+        $this->assertEquals('en', $user->locale);
+    }
+
+    /** @test */
+    public function it_fails_if_given_locale_is_wrong(): void
+    {
+        $user = User::factory()->create([
+            'locale' => 'en',
+        ]);
+
+        $request = [
+            'user_id' => $user->id,
+            'locale' => 'xx',
+        ];
+
+        $this->expectException(ValidationException::class);
+        (new UpdateLocale)->execute($request);
+    }
+
+    /** @test */
+    public function it_fails_if_given_locale_is_empty(): void
+    {
+        $user = User::factory()->create([
+            'locale' => 'en',
+        ]);
+
+        $request = [
+            'user_id' => $user->id,
+            'locale' => '',
+        ];
+
+        $this->expectException(ValidationException::class);
+        (new UpdateLocale)->execute($request);
+    }
+}