feat(Http): support API versions with float + load also non-versioned…

… routes file
wrk-flow · Nov 22, 2024 · a646777 · a646777
1 parent 9039c7b
commit a646777
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 19 deletions.
diff --git a/src/Contracts/HasVersionedApiRoutes.php b/src/Contracts/HasVersionedApiRoutes.php
@@ -10,7 +10,7 @@ interface HasVersionedApiRoutes
      * Return api version you want to support. Automatically looks for
      * {Domain}/Http/routes/{domainPrefix}_api_v{version}.php file and uses a prefix api/v{version}.
      *
-     * @return array<int>
+     * @return array<float>
      */
     public function apiVersions(): array;
 }
diff --git a/src/Providers/Pipes/BootProviderRoutesPipe.php b/src/Providers/Pipes/BootProviderRoutesPipe.php
@@ -21,7 +21,7 @@
 use LogicException;
 use Psr\Log\LoggerInterface;
 
-class BootProviderRoutesPipe implements AppServiceProviderPipeContract
+final class BootProviderRoutesPipe implements AppServiceProviderPipeContract
 {
     public function __construct(
         private readonly Container $container,
@@ -44,7 +44,7 @@ public function handle(AppServiceProviderEntity $appServiceProvider, Closure $ne
         $next($appServiceProvider);
     }
 
-    protected function loadRoutes(AppServiceProviderEntity $appServiceProvider): void
+    private function loadRoutes(AppServiceProviderEntity $appServiceProvider): void
     {
         $dir = $appServiceProvider->serviceRootDir;
         $serviceFileName = $appServiceProvider->serviceFileName;
@@ -65,7 +65,7 @@ protected function loadRoutes(AppServiceProviderEntity $appServiceProvider): voi
         }
     }
 
-    protected function loadApiRoute(string $dir, string $serviceFileName, string $urlPrefix, ?int $version = null): bool
+    private function loadApiRoute(string $dir, string $serviceFileName, string $urlPrefix, ?float $version = null): bool
     {
         $versionFileSuffix = $version === null ? '' : '_v' . $version;
         $versionRoutePrefix = $version === null ? '' : 'v' . $version . '/';
@@ -79,7 +79,7 @@ protected function loadApiRoute(string $dir, string $serviceFileName, string $ur
         );
     }
 
-    protected function registerRoute(
+    private function registerRoute(
         string $dir,
         string $fileSuffix,
         string $serviceFileName,
@@ -100,12 +100,12 @@ protected function registerRoute(
         return true;
     }
 
-    protected function getRouteFilePath(string $dir, string $serviceFileName, string $fileSuffix): string
+    private function getRouteFilePath(string $dir, string $serviceFileName, string $fileSuffix): string
     {
         return $dir . sprintf('/Http/routes/%s_%s.php', $serviceFileName, $fileSuffix);
     }
 
-    protected function tryToLoadCustomRoutes(
+    private function tryToLoadCustomRoutes(
         AppServiceProviderEntity $appServiceProvider,
         string $dir,
         string $serviceFileName,
@@ -180,18 +180,19 @@ protected function tryToLoadCustomRoutes(
         return $didLoadRoutes;
     }
 
-    protected function tryToLoadApiRoutes(
+    private function tryToLoadApiRoutes(
         AppServiceProviderEntity $appServiceProvider,
         string $dir,
         string $serviceFileName,
         string $urlPrefix
     ): bool {
-        // Force the user to use versioned api or un-versioned api routes
+        // Support using old non-versioned apis with versioned apis
+        $didLoadRoutes = $this->loadApiRoute($dir, $serviceFileName, $urlPrefix);
+
         if ($appServiceProvider->serviceProvider instanceof HasVersionedApiRoutes === false) {
-            return $this->loadApiRoute($dir, $serviceFileName, $urlPrefix);
+            return $didLoadRoutes;
         }
 
-        $didLoadRoutes = false;
         foreach ($appServiceProvider->serviceProvider->apiVersions() as $version) {
             if ($this->loadApiRoute($dir, $serviceFileName, $urlPrefix, $version)) {
                 $didLoadRoutes = true;
@@ -201,7 +202,7 @@ protected function tryToLoadApiRoutes(
         return $didLoadRoutes;
     }
 
-    protected function makeRoute(): RouteRegistrar
+    private function makeRoute(): RouteRegistrar
     {
         return $this->container->make(RouteRegistrar::class);
     }

diff --git a/src/Testing/Providers/Concerns/AssertProviderRegistersRoutes.php b/src/Testing/Providers/Concerns/AssertProviderRegistersRoutes.php
@@ -44,14 +44,14 @@ public function assertRoutes(
         foreach ($expectUrlsByMethod as $method => $urls) {
             $registeredUrls = $routes->get($method);
 
-            $currentUrls = [];
+            $expectedUrls = [];
             foreach ($urls as $index => $value) {
                 $url = is_callable($value) ? $index : $value;
-                $currentUrls[] = $url;
+                $expectedUrls[] = $url;
             }
 
             if ($onlyGiven) {
-                Assert::assertEquals(array_keys($registeredUrls), $currentUrls);
+                Assert::assertEquals($expectedUrls, array_keys($registeredUrls));
             }
 
             $errorMessage = 'Not found in: ' . implode(', ', array_keys($registeredUrls));

diff --git a/tests/Feature/Providers/Pipes/LoadProviderRoutesPipe/LoadProviderRoutesPipeTest.php b/tests/Feature/Providers/Pipes/LoadProviderRoutesPipe/LoadProviderRoutesPipeTest.php
@@ -78,10 +78,10 @@ public function testWithApiOnly(): void
         ], WithApiServiceProvider::class, true);
     }
 
-    public function testWithVersionedApiOnly(): void
+    public function testWithVersionedApi(): void
     {
         $this->assertRoutes($this->app(), [
-            'GET' => ['api/v1/test/1-api', 'api/v2/test/2-api'],
+            'GET' => ['api/test/api', 'api/v1/test/1-api', 'api/v1.1/test/1.1-api', 'api/v2/test/2-api'],
         ], WithVersionedApiServiceProvider::class, true);
     }
 

diff --git a/...ders/Pipes/LoadProviderRoutesPipe/WithVersionedApi/Http/routes/with_versioned_api_api.php b/...ders/Pipes/LoadProviderRoutesPipe/WithVersionedApi/Http/routes/with_versioned_api_api.php
@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Support\Facades\Route;
+
+Route::get('api', static function () {
+});
diff --git a/...Pipes/LoadProviderRoutesPipe/WithVersionedApi/Http/routes/with_versioned_api_api_v1.1.php b/...Pipes/LoadProviderRoutesPipe/WithVersionedApi/Http/routes/with_versioned_api_api_v1.1.php
@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Support\Facades\Route;
+
+Route::get('1.1-api', static function () {
+});
diff --git a/...oviders/Pipes/LoadProviderRoutesPipe/WithVersionedApi/WithVersionedApiServiceProvider.php b/...oviders/Pipes/LoadProviderRoutesPipe/WithVersionedApi/WithVersionedApiServiceProvider.php
@@ -18,6 +18,6 @@ public function getRoutePrefix(string $generatedPrefix): string
 
     public function apiVersions(): array
     {
-        return [1, 2];
+        return [1, 1.1, 2];
     }
 }
diff --git a/tests/Unit/Providers/Pipes/LoadProviderRoutesPipeTest.php b/tests/Unit/Providers/Pipes/LoadProviderRoutesPipeTest.php
@@ -18,7 +18,7 @@
 use Psr\Log\NullLogger;
 use stdClass;
 
-class LoadProviderRoutesPipeTest extends TestCase
+final class LoadProviderRoutesPipeTest extends TestCase
 {
     public function invalidNumericRoutes(): array
     {