Add support for PrestaShop 1.6.1.24

.github/workflows/quality-check.yml

@@ -52,7 +52,8 @@ jobs:
     timeout-minutes: 15
     strategy:
       matrix:
-        presta_version: ["1.7.8.7"]
+        ps_version: ["1.7.8.10", "8.1.1"]
+        # @TODO: "1.6.1.24" is temporarily disabled here
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -61,8 +62,8 @@ jobs:
         with:
           path: vendor
           key: php-${{ hashFiles('composer.lock') }}
-      - name: PHPStan PrestaShop 1.7.8.7
-        run: PS_VERSION="1.7.8.7" make phpstan
+      - name: PHPStan PrestaShop ${{ matrix.ps_version }}
+        run: PS_VERSION="${{ matrix.ps_version }}" make phpstan
 
   phpunit:
     name: PHP Unit

Makefile

@@ -7,7 +7,7 @@ BUILDPLATFORM ?= linux/amd64
 TESTING_DOCKER_IMAGE ?= ps-eventbus-testing:latest
 TESTING_DOCKER_BASE_IMAGE ?= phpdockerio/php80-cli
 PHP_VERSION ?= 8.2
-PS_VERSION ?= 1.7.8.7
+PS_VERSION ?= 8.1.1
 PS_ROOT_DIR ?= $(shell pwd)/prestashop/prestashop-${PS_VERSION}
 
 # target: default                                - Calling build by default
@@ -70,7 +70,7 @@ zip-prod: vendor dist .config.prod.yml
 	@$(call zip_it,.config.prod.yml,${PACKAGE}.zip)
 
 # target: build                                  - Setup PHP & Node.js locally
-build: vendor
+build: vendor tools-vendor
 
 composer.phar:
 	@php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');";
@@ -80,22 +80,30 @@ composer.phar:
 vendor: composer.phar
 	./composer.phar install --no-dev -o;
 
-vendor/bin/php-cs-fixer: composer.phar
+tools-vendor: composer.phar
+	./composer.phar install --working-dir tools -o;
+
+tools/vendor/bin/php-cs-fixer: composer.phar
 	./composer.phar install --ignore-platform-reqs
+	./composer.phar install --working-dir tools --ignore-platform-reqs
 
-vendor/bin/phpunit: composer.phar
+tools/vendor/bin/phpunit: composer.phar
 	./composer.phar install --ignore-platform-reqs
+	./composer.phar install --working-dir tools --ignore-platform-reqs
 
-vendor/bin/phpstan: composer.phar
+tools/vendor/bin/phpstan: composer.phar
 	./composer.phar install --ignore-platform-reqs
+	./composer.phar install --working-dir tools --ignore-platform-reqs
 
 prestashop:
 	@mkdir -p ./prestashop
 
 prestashop/prestashop-${PS_VERSION}: prestashop composer.phar
 	@if [ ! -d "prestashop/prestashop-${PS_VERSION}" ]; then \
-		git clone --depth 1 --branch ${PS_VERSION} https://github.com/PrestaShop/PrestaShop.git prestashop/prestashop-${PS_VERSION}; \
-		./composer.phar -d ./prestashop/prestashop-${PS_VERSION} install; \
+		git clone --depth 1 --branch ${PS_VERSION} https://github.com/PrestaShop/PrestaShop.git prestashop/prestashop-${PS_VERSION} > /dev/null; \
+		if [ "${PS_VERSION}" != "1.6.1.24" ]; then \
+			./composer.phar -d ./prestashop/prestashop-${PS_VERSION} install; \
+    fi \
 	fi;
 
 # target: test                                   - Static and unit testing
@@ -110,33 +118,35 @@ translation-validate:
 	php tests/translation.test.php
 
 # target: lint                                   - Lint the code and expose errors
-lint: vendor/bin/php-cs-fixer
-	@PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --dry-run --diff --using-cache=no;
+lint: tools/vendor/bin/php-cs-fixer
+	@PHP_CS_FIXER_IGNORE_ENV=1 tools/vendor/bin/php-cs-fixer fix --dry-run --diff --using-cache=no;
 
 # target: lint-fix                               - Lint the code and fix it
-lint-fix: vendor/bin/php-cs-fixer
-	@PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --using-cache=no;
+lint-fix: tools/vendor/bin/php-cs-fixer
+	@PHP_CS_FIXER_IGNORE_ENV=1 tools/vendor/bin/php-cs-fixer fix --using-cache=no;
 
 # target: php-lint                               - Use php linter to check the code
 php-lint:
 	@git ls-files | grep -E '.*\.(php)' | xargs -n1 php -l -n | (! grep -v "No syntax errors" );
 	@echo "php $(shell php -r 'echo PHP_VERSION;') lint passed";
 
 # target: phpunit                                - Run phpunit tests
-phpunit: vendor/bin/phpunit
-	vendor/bin/phpunit --configuration=./tests/phpunit.xml;
+phpunit: tools/vendor/bin/phpunit
+	tools/vendor/bin/phpunit --configuration=./tests/phpunit.xml;
 
 # target: phpunit-coverage                       - Run phpunit with coverage and allure
-phpunit-coverage: vendor/bin/phpunit
-	php -dxdebug.mode=coverage vendor/bin/phpunit --coverage-html ./coverage-reports/coverage-html --configuration=./tests/phpunit-coverage.xml;
+phpunit-coverage: tools/vendor/bin/phpunit
+	php -dxdebug.mode=coverage tools/vendor/bin/phpunit --coverage-html ./coverage-reports/coverage-html --configuration=./tests/phpunit-coverage.xml;
 
 # target: phpstan                                - Run phpstan
-phpstan: vendor/bin/phpstan prestashop/prestashop-${PS_VERSION}
-	_PS_ROOT_DIR_=${PS_ROOT_DIR} vendor/bin/phpstan analyse --memory-limit=256M --configuration=./tests/phpstan/phpstan.neon;
+phpstan: tools/vendor/bin/phpstan prestashop/prestashop-${PS_VERSION}
+	sed -i -e 's|%currentWorkingDirectory%/vendor|%currentWorkingDirectory%/tools/vendor|g' ./tools/vendor/prestashop/php-dev-tools/phpstan/ps-module-extension.neon
+	_PS_ROOT_DIR_=${PS_ROOT_DIR} tools/vendor/bin/phpstan analyse --memory-limit=256M --configuration=./tests/phpstan/phpstan.neon;
 
 # target: phpstan-baseline                       - Generate a phpstan baseline to ignore all errors
-phpstan-baseline: prestashop/prestashop-${PS_VERSION} vendor/bin/phpstan
-	_PS_ROOT_DIR_=${PS_ROOT_DIR} vendor/bin/phpstan analyse --generate-baseline --memory-limit=256M --configuration=./tests/phpstan/phpstan.neon;
+phpstan-baseline: prestashop/prestashop-${PS_VERSION} tools/vendor/bin/phpstan
+	sed -i -e 's|%currentWorkingDirectory%/vendor|%currentWorkingDirectory%/tools/vendor|g' ./tools/vendor/prestashop/php-dev-tools/phpstan/ps-module-extension.neon
+	_PS_ROOT_DIR_=${PS_ROOT_DIR} tools/vendor/bin/phpstan analyse --generate-baseline --memory-limit=256M --configuration=./tests/phpstan/phpstan.neon;
 
 # target: docker-test                            - Static and unit testing in docker
 docker-test: docker-lint docker-phpstan docker-phpunit
@@ -186,7 +196,7 @@ run-docker-actions-177:
 all-tests-actions-177:
 	make rda177
 	make bps177
-	docker exec -i prestashop-177 sh -c "cd /var/www/html/modules/ps_eventbus && php vendor/bin/phpunit -c tests/phpunit.xml"
+	docker exec -i prestashop-177 sh -c "cd /var/www/html/modules/ps_eventbus && php tools/vendor/bin/phpunit -c tests/phpunit.xml"
 
 # Fixme: add "allure-framework/allure-phpunit" in composer.json to solve this.
 # Currently failing to resolve devDeps:

README.md

@@ -6,11 +6,11 @@
 
 ## Compatibility matrix
 
-| PrestaShop platform | PS EventBus    |
-|---------------------|----------------|
-| 8.0                 | 2.x - PHP 7.1+ |
-| 1.7.0-1.7.8         | 2.x - PHP 7.1+ |
-| 1.6.1.x             | No             |
+| PrestaShop platform | PHP  | PS EventBus |
+| ------------------- | ---- | ----------- |
+| 8.0                 | 7.1+ | From 2.x    |
+| 1.7.0-1.7.8         | 7.1+ | From 2.x    |
+| 1.6.1.24            | 7.1  | From 3.x    |
 
 PS Accounts compatibility matrix [can be viewed here](https://github.com/PrestaShopCorp/ps_accounts#compatibility-matrix).
 
@@ -39,3 +39,39 @@ make docker-<stuff>    # same as above, but within a docker container
 ```
 
 > Note: you will need [xdebug](https://xdebug.org/) if you want to generate the code-coverage of this project. You may install it with: `pecl install -f xdebug`.
+
+## Healthiness
+
+To check the module healthiness:
+
+```sh
+BASE_URL="http://localhost:8000"
+curl -s -L "$BASE_URL/index.php?fc=module&module=ps_eventbus&controller=apiHealthCheck" | jq .
+{
+  "prestashop_version": "1.6.1.24",
+  "ps_eventbus_version": "x.y.z",
+  "ps_accounts_version": "5.6.2",
+  "php_version": "7.1.33",
+  "ps_account": true,
+  "is_valid_jwt": true,
+  "ps_eventbus": true,
+  "env": {
+    "EVENT_BUS_PROXY_API_URL": "http://reverse-proxy/collector",
+    "EVENT_BUS_SYNC_API_URL": "http://reverse-proxy/sync-api"
+  },
+  "httpCode": 200
+}
+```
+
+## Contribute
+
+Dev requirements:
+
+- PHP 8.2.12
+- PHP Extensions
+  - [DOM](https://www.php.net/manual/en/book.dom.php)
+  - [SimpleXML](https://www.php.net/manual/en/book.simplexml.php)
+  - [gd](https://www.php.net/manual/en/book.image.php)
+  - [zip](https://www.php.net/manual/en/book.zip.php)
+
+Or an up to dat [Docker engine](https://docs.docker.com/engine/install).

composer.json

@@ -42,14 +42,9 @@
     "prestashop/prestashop-accounts-installer": "^1.0.0",
     "sentry/sentry": "^1.11.0",
     "php-http/message": "<1.15.0",
-    "psr/http-message": "<1.1"
-  },
-  "require-dev": {
-    "prestashop/php-dev-tools": "^4.3",
-    "phpunit/phpunit": "^10.1.3",
-    "phpunit/php-code-coverage": "^10.1.1",
-    "phpstan/phpstan": "^1.10.15",
-    "friendsofphp/php-cs-fixer": "^3.16.0",
-    "phpseclib/phpseclib": "^3.0.19"
+    "psr/http-message": "<1.1",
+    "symfony/config": "^3.4",
+    "symfony/dependency-injection": "^3.4",
+    "symfony/yaml": "^3.4"
   }
 }