Fix setting locale for fallback routes when omitting main locale

Author: ivanvermeyen

src/Middleware/SetLocale.php

@@ -4,7 +4,9 @@
 
 use Closure;
 use CodeZero\LocalizedRoutes\LocaleHandler;
+use CodeZero\Localizer\Detectors\UrlDetector;
 use Illuminate\Support\Facades\App;
+use Illuminate\Support\Facades\Config;
 
 class SetLocale
 {
@@ -20,10 +22,52 @@ public function handle($request, Closure $next)
     {
         // This package sets a custom route attribute for the locale.
         // If it is present, use this as the locale.
-        $locale = $request->route()->getAction('localized-routes-locale');
+        $locale = $request->route()->getAction('localized-routes-locale')
+            ?: $this->getLocaleFromFallbackRoute($request);
 
         App::make(LocaleHandler::class)->handleLocale($locale);
 
         return $next($request);
     }
+
+    /**
+     * Get locale from fallback route.
+     *
+     * @param \Illuminate\Http\Request $request
+     *
+     * @return string|null
+     */
+    protected function getLocaleFromFallbackRoute(\Illuminate\Http\Request $request)
+    {
+        if ( ! $request->route()->isFallback) {
+            return null;
+        }
+
+        $locale = App::make(UrlDetector::class)->detect();
+        $localeIsSupported = in_array($locale, $this->getSupportedLocales());
+        $omittedLocale = Config::get('localized-routes.omit_url_prefix_for_locale');
+
+        if ( ! $localeIsSupported && $omittedLocale) {
+            return $omittedLocale;
+        }
+
+        return $locale;
+    }
+
+    /**
+     * Get the supported locales and not the custom domains.
+     *
+     * @return array
+     */
+    protected function getSupportedLocales()
+    {
+        $locales = Config::get('localized-routes.supported-locales', []);
+        $keys = array_keys($locales);
+
+        if ( ! empty($locales) && is_numeric($keys[0])) {
+            return $locales;
+        }
+
+        return $keys;
+    }
 }

tests/Unit/Macros/LocalizedUrlMacroTest.php

@@ -2,6 +2,7 @@
 
 namespace CodeZero\LocalizedRoutes\Tests\Unit\Macros;
 
+use CodeZero\LocalizedRoutes\Middleware\SetLocale;
 use CodeZero\LocalizedRoutes\Tests\Stubs\Model;
 use CodeZero\LocalizedRoutes\Tests\Stubs\ModelWithCustomRouteParameters;
 use CodeZero\LocalizedRoutes\Tests\TestCase;
@@ -247,15 +248,15 @@ public function it_returns_a_localized_url_for_a_localized_fallback_route()
     public function it_returns_a_localized_url_for_a_non_localized_fallback_route_if_the_url_contains_a_supported_locale()
     {
         $this->setSupportedLocales(['en', 'nl']);
-        $this->setAppLocale('nl');
+        $this->setAppLocale('en');
 
         Route::fallback(function () {
             return response([
                 'current' => Route::localizedUrl(),
                 'en' => Route::localizedUrl('en'),
                 'nl' => Route::localizedUrl('nl'),
             ], 404);
-        })->name('404');
+        })->middleware(SetLocale::class)->name('404');
 
         $response = $this->call('GET', '/nl/non/existing/route');
         $response->assertNotFound();
@@ -294,15 +295,15 @@ public function it_returns_a_localized_url_for_a_non_localized_fallback_route_wh
     {
         $this->setSupportedLocales(['en', 'nl']);
         $this->setOmitUrlPrefixForLocale('nl');
-        $this->setAppLocale('nl');
+        $this->setAppLocale('en');
 
         Route::fallback(function () {
             return response([
                 'current' => Route::localizedUrl(),
                 'en' => Route::localizedUrl('en'),
                 'nl' => Route::localizedUrl('nl'),
             ], 404);
-        })->name('404');
+        })->middleware(SetLocale::class)->name('404');
 
         $response = $this->call('GET', '/non/existing/route');
         $response->assertNotFound();

tests/Unit/Middleware/SetLocaleTest.php

@@ -55,6 +55,26 @@ public function it_sets_the_right_locale_when_accessing_localized_routes_with_om
         $this->assertEquals('en', $response->original);
     }
 
+    /** @test */
+    public function it_sets_the_right_locale_when_accessing_non_localized_fallback_routes_with_omitted_prefix()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setOmitUrlPrefixForLocale('nl');
+        $this->setAppLocale('en');
+
+        Route::fallback(function () {
+            return App::getLocale();
+        })->middleware(SetLocale::class);
+
+        $response = $this->call('GET', '/non/existing/route');
+        $response->assertOk();
+        $this->assertEquals('nl', $response->original);
+
+        $response = $this->call('GET', '/en/non/existing/route');
+        $response->assertOk();
+        $this->assertEquals('en', $response->original);
+    }
+
     /** @test */
     public function it_sets_the_locale_for_localized_routes_within_route_groups()
     {