refactor: pseventbus v4

README.md

@@ -12,6 +12,11 @@
 | 1.7.3-1.7.8         | 7.1+ | From 2.x    |
 | 1.6.1.11 - 1.7.2.5  | 7.1  | From 3.1    |
 
+## BREAKING CHANGES
+
+### Front controllers and API endpoints
+Depuis la version 4.0, tout les endpoints API sont regroupé sous un seul controller "apiFront.php". La route a appeller est donc maintenant unique, et le shopContent n'est plus un endpoint en particulier, mais un paramètre query de la requête (ex: "http://localhost:8000/index.php?fc=module&module=ps_eventbus&controller=apiFront&shop_content=healtcheck")
+
 PS Accounts compatibility matrix [can be viewed here](https://github.com/PrestaShopCorp/ps_accounts#compatibility-matrix).
 
 ### Product Images Issue in PHP 8.1
@@ -51,7 +56,7 @@ To check the module healthiness (authenticated route):
 
 ```sh
 BASE_URL="http://localhost:8000"
-curl -s -L "$BASE_URL/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=1&shop_content=healthcheck&job_id=valid-job-stuff" | jq .
+curl -s -L "$BASE_URL/index.php?fc=module&module=ps_eventbus&controller=apiFront&shop_content=healthcheck&job_id=valid-job-stuff" | jq .
 {
   "prestashop_version": "1.6.1.24",
   "ps_eventbus_version": "0.0.0",
@@ -72,7 +77,7 @@ To check the fallback route (unauthenticated):
 
 ```sh
 BASE_URL="http://localhost:8000"
-curl -s -L "$BASE_URL/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=1&shop_content=healthcheck" | jq .
+curl -s -L "$BASE_URL/index.php?fc=module&module=ps_eventbus&controller=apiFront=1&shop_content=healthcheck" | jq .
 {
   "ps_account": true,
   "is_valid_jwt": true,
@@ -119,3 +124,28 @@ Or an up-to-date [Docker engine](https://docs.docker.com/engine/install).
 
 ¹ Feature enabled only with PsWishlist module</br>
 ² Feature enabled only with PsFacebook module
+
+## How to add new shop content
+Prenons pour exemple l'ajout d'un shopContent nommé "plane".
+
+- Ajoutez le shop content dans le fichier [Config.php](src/Config/Config.php) (créez une constante, et ajoutez là au tableau SHOP_CONTENTS).
+```PHP
+const COLLECTION_PLANES = 'planes';
+
+const SHOP_CONTENTS = [
+  ...
+  self::COLLECTION_PLANES
+  ...
+];
+```
+- Créez un service "monShopContentsService.php" dans le [dossier des service shop content](src/Service/ShopContent/) qui implémente l'interface [ShopContentServiceInterface.php](src/Service/ShopContent/ShopContentServiceInterface.php). Pour la structure des méthodes, reprenez la base existante sur tout les autres service de shop content pour garder une cohérence.
+- Créez un repository pour votre shop content (ex: monShopContentRepository.php) dans le dossier [Repository](src/Repository/) qui etends la classe [AbstractRepository.php](src/Repository/AbstractRepository.php) et implemente l'interface [RepositoryInterface.php](src/Repository/RepositoryInterface.php). De la même manière, gardez une cohérence avec les autres repository de shop content.
+- Ajoutez dans le fichier de [config e2e](e2e/src/helpers/shop-contents.ts) votre shop content, puis lancez les tests une fois pour générer les dumps nécessaire (seront présent dans le dossier [dump](e2e/dumps/)). Une fois le test réalisé (et échoué), copier le fichier json correspondant à votre shop content, et collez le dans le dossier fixture, pour votre version donné. Faites la même chose pour chaque version (si les versions retournent des résultats différent). 
+
+## Debugging
+There are 3 variables that are passed "magically" from the apiFront file to the end of the chain (repositories and errorHandler):
+- PS_EVENTBUS_EXPLAIN_SQL_ENABLED
+- PS_EVENTBUS_VERBOSE_ENABLED
+- PS_EVENTBUS_LOGS_ENABLED
+
+These variables are defined via the PHP function define() and reused in the files mentioned above. The reason for this usage is to avoid having to pass these variables through the entire execution chain to retrieve them at the end of the chain (e.g., apiFront => frontService => shopContentService => shopContentRepository).

e2e-env/README.md

@@ -54,13 +54,13 @@ Simple!
 Is the module healthy?
 
 ```sh
-curl -s "http://localhost:8000/index.php?fc=module&module=ps_eventbus&controller=apiHealthCheck&job_id=valid-job-1" | jq .
+curl -s "http://localhost:8000/index.php?fc=module&module=ps_eventbus&controller=apiFront&shop_content=healthcheck&job_id=valid-job-1" | jq .
 ```
 
 Capture orders:
 
 ```sh
-curl -s "http://localhost:8000/index.php?fc=module&module=ps_eventbus&controller=apiOrders&job_id=valid-job-1" | jq .
+curl -s "http://localhost:8000/index.php?fc=module&module=ps_eventbus&controller=apiFront&shop_content=orders&job_id=valid-job-1" | jq .
 ```
 
 ## Make changes to the mock

e2e-env/docker-compose.yml

@@ -12,7 +12,7 @@ services:
           "-sI",
           "-H",
           "Host: localhost:8000",
-          "http://localhost:80/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=1&shop_content=healthcheck",
+          "http://localhost:80/index.php?fc=module&module=ps_eventbus&controller=apiFront=1&shop_content=healthcheck",
         ]
       interval: 30s
     volumes:

e2e/README.md

@@ -18,12 +18,12 @@ import testConfig from './helpers/test.config';
 import request from 'supertest';
 
 const controller = 'categories';
-const endpoint = `/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=1&shop_content=${shopContent}&limit=5`;
+const endpoint = `/index.php?fc=module&module=ps_eventbus&controller=apiFront=1&shop_content=${shopContent}&limit=5`;
 
 describe('CategoriesShopContent', () => {
   it(`${shopContent} should upload to collector`, async () => {
     // arrange
-    const url = `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=1&shop_content=${shopContent}&limit=5&full=1&job_id=${jobId}`;
+    const url = `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront=1&shop_content=${shopContent}&limit=5&full=1&job_id=${jobId}`;
     // jobId starting with "valid-job-" will be considered valid by the mock sync-api and will always return 201;
     // other values will be rejected by the mock
     const jobId = 'valid-job-1'

e2e/src/full-sync.spec.ts

@@ -51,7 +51,7 @@ describe("Full Sync", () => {
   describe.each(shopContentList)("%s", (shopContent) => {
     it(`${shopContent} should accept full sync`, async () => {
       // arrange
-      const url = `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=0&shop_content=${shopContent}&limit=5&full=1&job_id=${jobId}`;
+      const url = `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront=0&shop_content=${shopContent}&limit=5&full=1&job_id=${jobId}`;
 
       const callId = { call_id: Math.random().toString(36).substring(2, 11) };
 

e2e/src/helpers/data-helper.ts

@@ -59,7 +59,7 @@ export async function getShopHealthCheck(options?: {
     healthCheck = cachedHealthCheck;
   } else {
     const res = await axios.get<HealthCheck>(
-      `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=0&shop_content=healthcheck&job_id=valid-job-healthcheck`,
+      `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront=0&shop_content=healthcheck&job_id=valid-job-healthcheck`,
     );
     healthCheck = res.data;
     cachedHealthCheck = healthCheck;

e2e/src/helpers/mock-probe.ts

@@ -96,7 +96,7 @@ export function doFullSync(
 
   const requestNext = (full: number) => {
     return axios.post<PsEventbusSyncResponse>(
-      `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=0&shop_content=${shopContent}&limit=5&full=${full}&job_id=${jobId}`,
+      `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront=0&shop_content=${shopContent}&limit=5&full=${full}&job_id=${jobId}`,
       callId,
       {
         headers: {

e2e/src/job-id-validation.spec.ts

@@ -22,7 +22,7 @@ describe("Reject invalid job-id", () => {
     async (shopContent) => {
       expect.assertions(6);
       // arrange
-      const url = `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront&is_e2e=0&shop_content=${shopContent}&limit=5&job_id=${jobId}`;
+      const url = `${testConfig.prestashopUrl}/index.php?fc=module&module=ps_eventbus&controller=apiFront=0&shop_content=${shopContent}&limit=5&job_id=${jobId}`;
       const message$ = probe({ params: { id: jobId } });
 
       //act

src/Api/LiveSyncApiClient.php

@@ -109,8 +109,8 @@ public function liveSync($shopContent, $action)
                     'Authorization' => 'Bearer ' . $this->jwt,
                     'User-Agent' => 'ps-eventbus/' . $this->module->version,
                     'Content-Type' => 'application/json',
-                ], // FIXME: Pass real array of shop contents. at the moment, only one shop content is sent for match CS rate limiter
-                '{"shopContents": ["' . $kebabCasedShopContent . '"], "shopContentId": ' . $uselessParameter . ', "action": "' . $action . '"}'
+                ], // FIXME: Pass real array of shop contents. at the moment, only one shop content is sent to match CS rate limiter
+                '{"shopContents": ["' . $kebabCasedShopContent . '"], "action": "' . $action . '"}'
             )
         );
 

src/Config/Config.php

@@ -29,7 +29,7 @@ class Config
     const MYSQL_DATE_FORMAT = 'Y-m-d H:i:s';
 
     const RANDOM_SYNC_CHECK_MAX = 20;
-    const INCREMENTAL_SYNC_MAX_ITEMS_PER_SHOP_CONTENT = 100000;
+    const INCREMENTAL_SYNC_MAX_PAGE_SIZE = 10000;
 
     const SYNC_API_MAX_TIMEOUT = 5;
     const COLLECTOR_MAX_TIMEOUT = 30;

src/Service/CommonService.php

@@ -56,14 +56,19 @@ public static function exitWithExceptionMessage(\Exception $exception)
     {
         $code = $exception->getCode() == 0 ? 500 : $exception->getCode();
 
-        if ($exception instanceof \PrestaShopDatabaseException) {
-            $code = Config::DATABASE_QUERY_ERROR_CODE;
-        } elseif ($exception instanceof EnvVarException) {
-            $code = Config::ENV_MISCONFIGURED_ERROR_CODE;
-        } elseif ($exception instanceof FirebaseException) {
-            $code = Config::REFRESH_TOKEN_ERROR_CODE;
-        } elseif ($exception instanceof QueryParamsException) {
-            $code = Config::INVALID_URL_QUERY;
+        switch ($exception) {
+            case $exception instanceof \PrestaShopDatabaseException:
+                $code = Config::DATABASE_QUERY_ERROR_CODE;
+                break;
+            case $exception instanceof EnvVarException:
+                $code = Config::ENV_MISCONFIGURED_ERROR_CODE;
+                break;
+            case $exception instanceof FirebaseException:
+                $code = Config::REFRESH_TOKEN_ERROR_CODE;
+                break;
+            case $exception instanceof QueryParamsException:
+                $code = Config::INVALID_URL_QUERY;
+                break;
         }
 
         $response = [

src/Service/FrontApiService.php

@@ -227,12 +227,12 @@ private function authorize($jobId, $isHealthCheck)
                 return false;
             }
 
-            if ($exception instanceof \PrestaShopDatabaseException) {
-                $this->errorHandler->handle($exception);
-            } elseif ($exception instanceof EnvVarException) {
-                $this->errorHandler->handle($exception);
-            } elseif ($exception instanceof FirebaseException) {
-                $this->errorHandler->handle($exception);
+            switch ($exception) {
+                case $exception instanceof \PrestaShopDatabaseException:
+                case $exception instanceof EnvVarException:
+                case $exception instanceof FirebaseException:
+                    $this->errorHandler->handle($exception);
+                    break;
             }
 
             return false;

src/Service/SynchronizationService.php

@@ -263,7 +263,7 @@ public function insertContentIntoIncremental($contentTypesWithIds, $actionType,
             foreach ($contentTypesWithIds as $contentType => $contentIds) {
                 $count = $this->incrementalSyncRepository->getIncrementalSyncObjectCountByType($contentType);
 
-                if ($count > Config::INCREMENTAL_SYNC_MAX_ITEMS_PER_SHOP_CONTENT) {
+                if ($count > Config::INCREMENTAL_SYNC_MAX_PAGE_SIZE) {
                     $hasDeleted = $this->incrementalSyncRepository->removeIncrementaSyncObjectByType($contentType);
 
                     if ($hasDeleted) {