feat(debug): add action to download logs (#288)

.env.local.template → .env.template

@@ -7,3 +7,8 @@
 API_KEY_MYPARCEL=
 API_KEY_BELGIE=
 API_KEY_FLESPAKKET=
+
+###
+# Docker image
+###
+IMAGE_NAME=ghcr.io/myparcelnl/pdk

.github/actions/setup/action.yml

@@ -2,13 +2,22 @@ name: 'Setup'
 description: ''
 
 inputs:
+  token:
+    description: 'GitHub token'
+    required: true
+
   php-version:
     description: 'PHP version'
     required: true
 
 runs:
   using: composite
   steps:
+    - uses: myparcelnl/actions/build-docker-image-reg@v4
+      id: build
+      with:
+        registry-password: ${{ inputs.token }}
+
     - name: 'Handle composer cache'
       uses: actions/cache@v4
       with:
@@ -22,22 +31,21 @@ runs:
           composer-${{ hashFiles('**/composer.json') }}-
           composer-
 
-    - uses: myparcelnl/actions/pull-docker-image@v4
-      with:
-        image: 'ghcr.io/myparcelnl/php-xd:${{ inputs.php-version }}-cli-alpine'
-
     - name: 'Prepare environment'
       shell: bash
       #language=bash
       run: |
-        touch .env.local
+        touch .env
+        echo "COMPOSER_HOME=/root/.composer" >> .env
+        echo "COMPOSER_MEMORY_LIMIT=-1" >> .env
 
     - name: 'Install composer dependencies'
       shell: bash
+      env:
+        IMAGE_NAME: ${{ steps.build.outputs.tagged-image }}
       #language=bash
       run: |
         docker compose run \
           --volume $HOME/.composer:/root/.composer \
-          --env COMPOSER_CACHE_DIR=/root/.composer \
           php \
           composer update --no-progress --no-scripts --no-plugins

.github/workflows/--analyse.yml

@@ -31,6 +31,7 @@ jobs:
       - uses: ./.github/actions/setup
         if: steps.phpstan-cache.outputs.cache-hit != 'true'
         with:
+          token: ${{ secrets.GITHUB_TOKEN }}
           php-version: ${{ vars.PHP_VERSION }}
 
       - name: 'Run PHPStan analysis'

.github/workflows/--quality.yml

@@ -37,6 +37,7 @@ jobs:
       - uses: ./.github/actions/setup
         if: steps.rector-cache.outputs.cache-hit != 'true'
         with:
+          token: ${{ secrets.GITHUB_TOKEN }}
           php-version: ${{ vars.PHP_VERSION }}
 
       - name: 'Run quality checks in dry-run mode'

.github/workflows/--setup.yml

@@ -10,4 +10,5 @@ jobs:
 
       - uses: ./.github/actions/setup
         with:
+          token: ${{ secrets.GITHUB_TOKEN }}
           php-version: ${{ vars.PHP_VERSION }}

.github/workflows/--test-integration.yml

@@ -11,6 +11,7 @@ jobs:
 
       - uses: ./.github/actions/setup
         with:
+          token: ${{ secrets.GITHUB_TOKEN }}
           php-version: ${{ vars.PHP_VERSION }}
 
       - name: 'Run integration tests'

.github/workflows/--test-unit.yml

@@ -19,6 +19,7 @@ jobs:
       - uses: ./.github/actions/setup
         if: steps.coverage-cache.outputs.cache-hit != 'true'
         with:
+          token: ${{ secrets.GITHUB_TOKEN }}
           php-version: ${{ vars.PHP_VERSION }}
 
       - name: 'Run unit tests'

.gitignore

@@ -6,7 +6,7 @@ composer.lock
 clover.xml
 
 docker-compose.override.yml
-.env.local
+.env
 
 /.cache/
 /.nx/

Dockerfile

@@ -0,0 +1,7 @@
+FROM ghcr.io/myparcelnl/php-xd:7.4-fpm-alpine
+
+# install php zip extension
+RUN apk add --no-cache libzip-dev \
+    && docker-php-ext-configure zip \
+    && docker-php-ext-install zip \
+    && docker-php-ext-enable zip

README.md

@@ -35,10 +35,10 @@ View our [contribution guidelines] for information on how to contribute to the P
 
 ### Installation
 
-Create `.env.local`:
+Create `.env`:
 
 ```shell
-cp .env.local.template .env.local
+cp .env.template .env
 ```
 
 Install Yarn dependencies:

composer.json

@@ -6,6 +6,7 @@
     "homepage": "https://myparcel.nl",
     "license": "MIT",
     "require": {
+        "ext-zip": "*",
         "justinrainbow/json-schema": "^5.2",
         "myparcelnl/sdk": ">= 7",
         "php": ">=7.1.0",
@@ -71,4 +72,4 @@
             "pestphp/pest-plugin": true
         }
     }
-}
+}

config/actions.php

@@ -5,6 +5,7 @@
 use MyParcelNL\Pdk\App\Action\Backend\Account\DeleteAccountAction;
 use MyParcelNL\Pdk\App\Action\Backend\Account\UpdateAccountAction;
 use MyParcelNL\Pdk\App\Action\Backend\Account\UpdateSubscriptionFeaturesAction;
+use MyParcelNL\Pdk\App\Action\Backend\Debug\DownloadLogsAction;
 use MyParcelNL\Pdk\App\Action\Backend\Order\ExportOrderAction;
 use MyParcelNL\Pdk\App\Action\Backend\Order\FetchOrdersAction;
 use MyParcelNL\Pdk\App\Action\Backend\Order\PostOrderNotesAction;
@@ -31,6 +32,7 @@
 use MyParcelNL\Pdk\App\Request\Account\UpdateAccountEndpointRequest;
 use MyParcelNL\Pdk\App\Request\Account\UpdateSubscriptionFeaturesEndpointRequest;
 use MyParcelNL\Pdk\App\Request\Context\FetchContextEndpointRequest;
+use MyParcelNL\Pdk\App\Request\Debug\DownloadLogsEndpointRequest;
 use MyParcelNL\Pdk\App\Request\Orders\ExportOrdersEndpointRequest;
 use MyParcelNL\Pdk\App\Request\Orders\FetchOrdersEndpointRequest;
 use MyParcelNL\Pdk\App\Request\Orders\PostOrderNotesEndpointRequest;
@@ -215,5 +217,13 @@
             'request' => FetchWebhooksEndpointRequest::class,
             'action'  => FetchWebhooksAction::class,
         ],
+
+        /**
+         * Download logs
+         */
+        PdkBackendActions::DOWNLOAD_LOGS           => [
+            'request' => DownloadLogsEndpointRequest::class,
+            'action'  => DownloadLogsAction::class,
+        ],
     ],
 ];

config/pdk-services.php

@@ -32,12 +32,14 @@
 use MyParcelNL\Pdk\Base\Contract\CountryServiceInterface;
 use MyParcelNL\Pdk\Base\Contract\CurrencyServiceInterface;
 use MyParcelNL\Pdk\Base\Contract\WeightServiceInterface;
+use MyParcelNL\Pdk\Base\Contract\ZipServiceInterface;
 use MyParcelNL\Pdk\Base\FileSystem;
 use MyParcelNL\Pdk\Base\FileSystemInterface;
 use MyParcelNL\Pdk\Base\Pdk;
 use MyParcelNL\Pdk\Base\Service\CountryService;
 use MyParcelNL\Pdk\Base\Service\CurrencyService;
 use MyParcelNL\Pdk\Base\Service\WeightService;
+use MyParcelNL\Pdk\Base\Service\ZipService;
 use MyParcelNL\Pdk\Carrier\Contract\CarrierRepositoryInterface;
 use MyParcelNL\Pdk\Carrier\Repository\CarrierRepository;
 use MyParcelNL\Pdk\Context\Contract\ContextServiceInterface;
@@ -215,4 +217,9 @@
      * Handles executing webhooks.
      */
     PdkWebhookManagerInterface::class          => autowire(PdkWebhookManager::class),
+
+    /**
+     * Handles zipping files.
+     */
+    ZipServiceInterface::class                 => autowire(ZipService::class),
 ];

config/platform/belgie.php

@@ -11,6 +11,7 @@
     'name'             => 'belgie',
     'human'            => 'SendMyParcel',
     'backofficeUrl'    => 'https://backoffice.sendmyparcel.be',
+    'supportUrl'       => 'https://developer.myparcel.nl/contact',
     'localCountry'     => CountryCodes::CC_BE,
     'defaultCarrier'   => Carrier::CARRIER_BPOST_NAME,
     'defaultCarrierId' => Carrier::CARRIER_BPOST_ID,

config/platform/flespakket.php

@@ -12,6 +12,7 @@
     'name'             => 'flespakket',
     'human'            => 'Flespakket',
     'backofficeUrl'    => 'https://backoffice.flespakket.nl',
+    'supportUrl'       => 'https://developer.myparcel.nl/contact',
     'localCountry'     => CountryCodes::CC_NL,
     'defaultCarrier'   => Carrier::CARRIER_POSTNL_NAME,
     'defaultCarrierId' => Carrier::CARRIER_POSTNL_ID,

config/platform/myparcel.php

@@ -12,6 +12,7 @@
     'name'             => 'myparcel',
     'human'            => 'MyParcel',
     'backofficeUrl'    => 'https://backoffice.myparcel.nl',
+    'supportUrl'       => 'https://developer.myparcel.nl/contact',
     'localCountry'     => CountryCodes::CC_NL,
     'defaultCarrier'   => Carrier::CARRIER_POSTNL_NAME,
     'defaultCarrierId' => Carrier::CARRIER_POSTNL_ID,

docker-compose.yml

@@ -1,19 +1,24 @@
-x-image: &image ghcr.io/myparcelnl/php-xd:7.4-cli-alpine
+x-common: &common
+  build:
+    context: .
+    dockerfile: Dockerfile
+  # Set in .env
+  image: $IMAGE_NAME
 
 services:
   php:
-    image: *image
-    command: ['composer', 'install', '--no-interaction', '--no-progress', '--no-suggest']
+    <<: *common
     init: true
+    command: ['composer', 'install', '--no-interaction', '--no-progress']
     env_file:
-      - .env.local
+      - .env
     volumes:
       - ./:/app
 
   console:
-    image: *image
-    command: []
+    <<: *common
     init: true
+    command: []
     entrypoint: ['php', 'bin/console']
     volumes:
       - ./:/app