Rename oauth-api endpoint into admin-api

Author: jolelievre

.github/workflows/symfony-console.yml

@@ -12,7 +12,7 @@ jobs:
   symfony-console:
     strategy:
       matrix:
-        app-id: [ admin, oauth-api, front ]
+        app-id: [ admin, admin-api, front ]
     permissions:
       contents: read  # for actions/checkout to fetch code
     name: Symfony Console
@@ -59,10 +59,10 @@ jobs:
           ./bin/console cache:clear --env=prod --no-warmup --app-id=${{ matrix.app-id }}
 
       - name: Check app listeners for OAuth API
-        if: matrix.app-id == 'oauth-api'
+        if: matrix.app-id == 'admin-api'
         run: |
-          apiListeners=$(./bin/console debug:event-dispatcher kernel.request --app-id=oauth-api | grep 'PrestaShopBundle\\EventListener\\API' | wc -l)
-          adminListeners=$(./bin/console debug:event-dispatcher kernel.request --app-id=oauth-api | grep 'PrestaShopBundle\\EventListener\\Admin' | wc -l)
+          apiListeners=$(./bin/console debug:event-dispatcher kernel.request --app-id=admin-api | grep 'PrestaShopBundle\\EventListener\\API' | wc -l)
+          adminListeners=$(./bin/console debug:event-dispatcher kernel.request --app-id=admin-api | grep 'PrestaShopBundle\\EventListener\\Admin' | wc -l)
           echo $apiListeners API listeners detected
           echo $adminListeners Admin listeners detected
           if [ $adminListeners -ne 0 ]; then

oauth-api/.htaccess admin-api/.htaccess

@@ -28,8 +28,8 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
-define('_PS_APP_ID_', 'oauth-api');
 require __DIR__ . '/../config/config.inc.php';
+define('_PS_APP_ID_', AdminAPIKernel::APP_ID);
 
 //small test to clear cache after upgrade
 if (Configuration::get('PS_UPGRADE_CLEAR_CACHE')) {
@@ -60,7 +60,7 @@
     ->loadEnv($dotEnvFile)
 ;
 
-$kernel = new OAuthAPIKernel(_PS_ENV_, _PS_MODE_DEV_);
+$kernel = new AdminAPIKernel(_PS_ENV_, _PS_MODE_DEV_);
 // When using the HttpCache, you need to call the method in your front controller instead of relying on the configuration parameter
 //Request::enableHttpMethodParameterOverride();
 $request = Request::createFromGlobals();

oauth-api/bundles/apiplatform admin-api/bundles/apiplatform

@@ -30,7 +30,6 @@
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
-define('_PS_APP_ID_', 'admin');
 if (!defined('_PS_ADMIN_DIR_')) {
     define('_PS_ADMIN_DIR_', __DIR__);
 }
@@ -40,6 +39,7 @@
 }
 
 require _PS_ADMIN_DIR_ . '/../config/config.inc.php';
+define('_PS_APP_ID_', AdminKernel::APP_ID);
 
 //small test to clear cache after upgrade
 if (Configuration::get('PS_UPGRADE_CLEAR_CACHE')) {

oauth-api/index.php admin-api/index.php

@@ -26,10 +26,12 @@
 
 declare(strict_types=1);
 
-class OAuthAPIKernel extends AppKernel
+class AdminAPIKernel extends AppKernel
 {
+    public const APP_ID = 'admin-api';
+
     public function getAppId(): string
     {
-        return 'oauth-api';
+        return self::APP_ID;
     }
 }

admin-dev/index.php

@@ -25,8 +25,10 @@
  */
 class AdminKernel extends AppKernel
 {
+    public const APP_ID = 'admin';
+
     public function getAppId(): string
     {
-        return 'admin';
+        return self::APP_ID;
     }
 }

app/OAuthAPIKernel.php app/AdminAPIKernel.php

@@ -25,8 +25,10 @@
  */
 class FrontKernel extends AppKernel
 {
+    public const APP_ID = 'front';
+
     public function getAppId(): string
     {
-        return 'front';
+        return self::APP_ID;
     }
 }

app/AdminKernel.php

@@ -6,7 +6,7 @@ imports:
 
 framework:
   router:
-    resource: "%kernel.project_dir%/app/config/oauth-api/routing.yml"
+    resource: "%kernel.project_dir%/app/config/admin-api/routing.yml"
     strict_requirements: ~
 
 api_platform:

app/FrontKernel.php

@@ -4,6 +4,6 @@ imports:
 
 framework:
   router:
-    resource: "%kernel.project_dir%/app/config/oauth-api/routing_dev.yml"
+    resource: "%kernel.project_dir%/app/config/admin-api/routing_dev.yml"
     strict_requirements: ~
   profiler: { only_exceptions: false }

app/config/oauth-api/config.yml app/config/admin-api/config.yml

@@ -4,6 +4,6 @@ imports:
 
 framework:
   router:
-    resource: "%kernel.project_dir%/app/config/oauth-api/routing_test.yml"
+    resource: "%kernel.project_dir%/app/config/admin-api/routing_test.yml"
     strict_requirements: ~
   profiler: { only_exceptions: false }

app/config/oauth-api/config_dev.yml app/config/admin-api/config_dev.yml

@@ -1,5 +1,5 @@
 _api_oauth2_routing:
-  resource: "@PrestaShopBundle/Resources/config/routing/oauth-api.yml"
+  resource: "@PrestaShopBundle/Resources/config/routing/admin-api.yml"
 
 _api_platform_routing:
   resource: .

app/config/oauth-api/config_prod.yml app/config/admin-api/config_prod.yml

@@ -109,7 +109,7 @@ api_platform:
   enable_entrypoint: false
   enable_swagger: false
   enable_swagger_ui: false
-  # We define mapping here because even though the API routes are oncly accessible via the oauth-api endpoint we still need
+  # We define mapping here because even though the API routes are oncly accessible via the admin-api endpoint we still need
   # to parse the Api Platform resources to extract the scopes
   mapping:
     paths:

app/config/oauth-api/config_test.yml app/config/admin-api/config_test.yml

@@ -2,9 +2,8 @@
 <?php
 
 use PrestaShopBundle\Console\PrestaShopApplication;
-use Symfony\Component\Console\Input\ArgvInput;
-use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
+use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\ErrorHandler\Debug;
 
@@ -16,9 +15,9 @@ use Symfony\Component\ErrorHandler\Debug;
 set_time_limit(0);
 
 try {
-  require_once __DIR__ . '/../config/config.inc.php';
+    require_once __DIR__ . '/../config/config.inc.php';
 } catch (PrestaShopException) {
-  // Prevent breaking all CLI command when the shop is not installed
+    // Prevent breaking all CLI command when the shop is not installed
 }
 
 $input = new ArgvInput();
@@ -28,10 +27,10 @@ $debug = getenv('SYMFONY_DEBUG') !== '0' && !$input->hasParameterOption(['--no-d
 // Handle PrestaShop global option app-id, by default use the Admin kernel
 $appId = $input->getParameterOption(['--app-id'], getenv('APP_ID') ?: 'admin');
 $kernelClass = match ($appId) {
-  'admin' => AdminKernel::class,
-  'front' => FrontKernel::class,
-  'oauth-api' => OAuthAPIKernel::class,
-  default => throw new InvalidArgumentException('Unknown PrestaShop kernel matching the ID ' . $appId),
+    AdminKernel::APP_ID => AdminKernel::class,
+    FrontKernel::APP_ID => FrontKernel::class,
+    AdminAPIKernel::APP_ID => AdminAPIKernel::class,
+    default => throw new InvalidArgumentException('Unknown PrestaShop kernel matching the ID ' . $appId),
 };
 
 if ($debug) {

app/config/oauth-api/routing.yml app/config/admin-api/routing.yml

@@ -239,7 +239,7 @@
         "classmap": [
             "app/AppKernel.php",
             "app/AdminKernel.php",
-            "app/OAuthAPIKernel.php",
+            "app/AdminAPIKernel.php",
             "app/FrontKernel.php",
             "app/AppCache.php"
         ]

app/config/oauth-api/routing_dev.yml app/config/admin-api/routing_dev.yml

@@ -36,9 +36,9 @@
 }
 
 // Include some configurations & composer autoload
-define('_PS_APP_ID_', 'front');
 require_once _PS_FRONT_DIR_ . '/config/config.inc.php';
 require_once _PS_FRONT_DIR_ . '/vendor/autoload.php';
+define('_PS_APP_ID_', FrontKernel::APP_ID);
 
 // Load .env file from the root of project if present
 (new Dotenv(false))->loadEnv(_PS_FRONT_DIR_ . '/.env');

app/config/oauth-api/routing_test.yml app/config/admin-api/routing_test.yml

@@ -26,11 +26,11 @@
 
 namespace PrestaShop\PrestaShop\Adapter\Cache\Clearer;
 
+use AdminAPIKernel;
 use AdminKernel;
 use AppKernel;
 use FrontKernel;
 use Hook;
-use OAuthAPIKernel;
 use PrestaShop\PrestaShop\Core\Cache\Clearer\CacheClearerInterface;
 use Psr\Log\LoggerInterface;
 use Throwable;
@@ -79,7 +79,7 @@ public function clear()
                 set_time_limit(0);
 
                 $environments = ['prod', 'dev'];
-                $applicationKernelClasses = [AdminKernel::class, OAuthAPIKernel::class, FrontKernel::class];
+                $applicationKernelClasses = [AdminKernel::class, AdminAPIKernel::class, FrontKernel::class];
                 $baseCommandLine = 'php -d memory_limit=-1 ' . $kernel->getProjectDir() . '/bin/console ';
                 foreach ($applicationKernelClasses as $applicationKernelClass) {
                     foreach ($environments as $environment) {

app/config/oauth-api/security.yml app/config/admin-api/security.yml

@@ -28,10 +28,17 @@
 
 namespace PrestaShopBundle\Console;
 
+use AdminAPIKernel;
+use AdminKernel;
+use FrontKernel;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputOption;
 
+/**
+ * Dedicated application for Symfony console that addition adds default parameter app-id
+ * to all the commands to allow switching from one kernel to another.
+ */
 class PrestaShopApplication extends Application
 {
     protected function getDefaultInputDefinition(): InputDefinition
@@ -43,7 +50,7 @@ protected function getDefaultInputDefinition(): InputDefinition
             InputOption::VALUE_REQUIRED,
             'Specify a PrestaShop Application ID.',
             'admin',
-            ['admin', 'oauth-api', 'front']
+            [AdminKernel::APP_ID, AdminAPIKernel::APP_ID, FrontKernel::APP_ID]
         ));
 
         return $definition;

app/config/oauth-api/services.yml app/config/admin-api/services.yml

@@ -248,7 +248,7 @@ private function getOAuthApiBaseUrl(Request $request): string
         // Get root url right before the admin folder part
         $rootUrl = substr($uri, 0, strpos($uri, $adminFolderName));
 
-        return $rootUrl . '/oauth-api';
+        return $rootUrl . '/admin-api';
     }
 
     private function getFormHandler(): FormHandlerInterface

app/config/config.yml

@@ -0,0 +1,2 @@
+_admin_oauth2:
+  resource: "admin-api/oauth2.yml"

bin/console

@@ -28,9 +28,9 @@
 
 namespace Tests\Integration\ApiPlatform\EndPoint;
 
+use AdminAPIKernel;
 use ApiPlatform\Symfony\Bundle\Test\ApiTestCase as ApiPlatformTestCase;
 use ApiPlatform\Symfony\Bundle\Test\Client;
-use OAuthAPIKernel;
 use PrestaShop\PrestaShop\Core\Domain\ApiClient\Command\AddApiClientCommand;
 use PrestaShop\PrestaShop\Core\Domain\Configuration\ShopConfigurationInterface;
 use PrestaShop\PrestaShop\Core\Domain\Language\Command\AddLanguageCommand;
@@ -67,7 +67,7 @@ public static function tearDownAfterClass(): void
      */
     protected static function getKernelClass(): string
     {
-        return OAuthAPIKernel::class;
+        return AdminAPIKernel::class;
     }
 
     protected static function createClient(array $kernelOptions = [], array $defaultOptions = []): Client

composer.json

@@ -2,7 +2,7 @@
 # URLs
 URL_FO="https://localhost:8002/"
 URL_BO="https://localhost:8002/admin-dev/"
-URL_API="https://localhost:8002/oauth-api/"
+URL_API="https://localhost:8002/admin-api/"
 URL_INSTALL="https://localhost:8002/install-dev/"
 
 # BO account

index.php

@@ -2,7 +2,7 @@
 # URLs
 URL_FO="https://localhost/"
 URL_BO="https://localhost/admin-dev/"
-URL_API="https://localhost/oauth-api/"
+URL_API="https://localhost/admin-api/"
 URL_INSTALL="http://localhost/install-dev/"
 
 # BO account

src/Adapter/Cache/Clearer/SymfonyCacheClearer.php

@@ -15,7 +15,7 @@ describe('API : Basic Test', async () => {
   });
 
   describe('Basic Test', async () => {
-    it('should request the endpoint /oauth-api', async function () {
+    it('should request the endpoint /admin-api', async function () {
       await testContext.addContextItem(this, 'testIdentifier', 'requestNewApi', baseContext);
 
       const apiResponse = await apiContext.get('');

src/PrestaShopBundle/Console/PrestaShopApplication.php

@@ -21,7 +21,7 @@ global.BO = {
 };
 
 global.API = {
-  URL: process.env.URL_API || `${global.FO.URL}oauth-api/`,
+  URL: process.env.URL_API || `${global.FO.URL}admin-api/`,
 };
 
 global.PSConfig = {