v0.6.59 — backend test coverage, dead-code cleanup and defect fixes

.github/workflows/server.yml

@@ -46,9 +46,24 @@ jobs:
     - name: Generate Coverage Baseline
       run: XDEBUG_MODE=coverage composer coverage:baseline
 
+    # Asserts the gate against the report the step above just wrote.
+    # `composer coverage:check` would regenerate it first, which means running
+    # the whole suite under coverage a second time.
+    - name: Enforce Coverage Gate
+      run: php scripts/coverage-summary.php coverage/clover.xml --fail-under=100
+
     - name: Upload Coverage Baseline
       uses: actions/upload-artifact@v4
       with:
         name: fleetops-coverage-clover
         path: coverage/clover.xml
         if-no-files-found: error
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: coverage/clover.xml
+        disable_search: true
+        flags: backend
+        fail_ci_if_error: false

README.md

@@ -13,6 +13,9 @@
     <a href="https://github.com/fleetbase/fleetops/blob/master/LICENSE.md">
         <img src="https://img.shields.io/badge/license-AGPL--3.0--or--later-blue?style=flat-square" alt="License: AGPL-3.0-or-later">
     </a>
+    <a href="https://codecov.io/gh/fleetbase/fleetops">
+        <img src="https://codecov.io/gh/fleetbase/fleetops/branch/main/graph/badge.svg" alt="Coverage">
+    </a>
     <a href="https://www.npmjs.com/package/@fleetbase/fleetops-engine">
         <img src="https://img.shields.io/badge/npm-%40fleetbase%2Ffleetops--engine-CB3837?style=flat-square" alt="NPM package">
     </a>

addon/components/entity/card.hbs

@@ -15,6 +15,7 @@
     <Card.footer class={{@footerClass}}>
         <div class="flex flex-row items-center space-x-1">
             <Button @icon="pencil" @size="xs" @onClick={{fn this.entityActions.modal.edit @resource}} />
+            <Button @icon="barcode" @size="xs" @onClick={{fn this.entityActions.viewLabel @resource}} @permission="fleet-ops view entity" />
             <Button @icon="trash" @size="xs" @type="danger" @onClick={{fn this.entityActions.delete @resource}} />
         </div>
         {{#if (has-block "footer")}}

addon/components/modals/order-label.hbs

@@ -1,6 +1,6 @@
 <Modal::Default @modalIsOpened={{@modalIsOpened}} @options={{@options}} @confirm={{@onConfirm}} @decline={{@onDecline}}>
     <div class="modal-body-container">
-        <object id="pdf" class="border-0 w-full shadow-sm h-40rem" data={{@options.data}} type="application/pdf" alt={{@options.order.public_id}}>
+        <object id="pdf" class="border-0 w-full shadow-sm h-40rem" data={{@options.data}} type="application/pdf" alt={{or @options.order.public_id @options.subject.public_id}}>
             <div class="text-center font-semibold dark:text-gray-100 p-6 flex items-center justify-center">{{t "modals.order-label.loading"}}</div>
         </object>
     </div>

addon/components/place/form.hbs

@@ -37,7 +37,7 @@
                 <ModelCoordinatesInput @model={{@resource}} @disabled={{cannot-write @resource}} @autocomplete="all" @onInputReady={{fn (mut this.coordinatesInput)}} />
             </InputGroup>
             <InputGroup @name={{t "place.fields.phone"}} @wrapperClass="col-span-2">
-                <PhoneInput @value={{@resource.phone}} @autocomplete="nope" @onInput={{this.phone}} disabled={{cannot-write @resource}} class="form-input w-full" />
+                <PhoneInput @value={{@resource.phone}} @autocomplete="nope" @onInput={{fn (mut @resource.phone)}} disabled={{cannot-write @resource}} class="form-input w-full" />
             </InputGroup>
         </div>
     </ContentPanel>

addon/services/entity-actions.js

@@ -1,4 +1,6 @@
 import ResourceActionService from '@fleetbase/ember-core/services/resource-action';
+import { action } from '@ember/object';
+import { debug } from '@ember/debug';
 
 export default class EntityActionsService extends ResourceActionService {
     constructor() {
@@ -38,4 +40,34 @@ export default class EntityActionsService extends ResourceActionService {
             });
         },
     };
+
+    @action async viewLabel(entity) {
+        // render dialog to display label within
+        this.modalsManager.show(`modals/order-label`, {
+            title: this.intl.t('order.fields.entity-label'),
+            modalClass: 'modal-xl',
+            acceptButtonText: this.intl.t('common.done'),
+            hideDeclineButton: true,
+            subject: entity,
+        });
+
+        try {
+            // load the pdf label from base64
+            // eslint-disable-next-line no-undef
+            const fileReader = new FileReader();
+            const { data: pdfStream } = await this.fetch.get(`orders/label/${entity.public_id}?format=base64`);
+            // eslint-disable-next-line no-undef
+            const base64 = await fetch(`data:application/pdf;base64,${pdfStream}`);
+            const blob = await base64.blob();
+            // load into file reader
+            fileReader.onload = (event) => {
+                const data = event.target.result;
+                this.modalsManager.setOption('data', data);
+            };
+            fileReader.readAsDataURL(blob);
+        } catch (err) {
+            this.notifications.error(this.intl.t('order.prompts.failed-to-load-entity-label'));
+            debug('Error loading entity label data: ' + err.message);
+        }
+    }
 }

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "fleetbase/fleetops-api",
-    "version": "0.6.58",
+    "version": "0.6.59",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "keywords": [
         "fleetbase-extension",
@@ -22,7 +22,7 @@
     ],
     "require": {
         "php": "^8.0",
-        "barryvdh/laravel-dompdf": "^2.0",
+        "barryvdh/laravel-dompdf": "^3.1",
         "brick/geo": "0.7.2",
         "cknow/laravel-money": "^7.1",
         "fleetbase/core-api": "*",
@@ -90,11 +90,15 @@
             "@test:coverage:clover",
             "@coverage:summary"
         ],
+        "coverage:check": [
+            "@test:coverage:clover",
+            "php scripts/coverage-summary.php coverage/clover.xml --fail-under=100"
+        ],
         "coverage:summary": "php scripts/coverage-summary.php coverage/clover.xml",
         "lint": "php-cs-fixer fix -v",
         "test:lint": "php-cs-fixer fix -v --dry-run",
         "test:coverage": "php scripts/coverage-runner.php --coverage --coverage-text --colors=always",
-        "test:coverage:clover": "mkdir -p coverage && php scripts/coverage-runner.php --coverage-clover=coverage/clover.xml --colors=always",
+        "test:coverage:clover": "mkdir -p coverage && php scripts/coverage-file-runner.php --coverage-clover=coverage/clover.xml --colors=always",
         "test:types": "phpstan analyse --ansi --memory-limit=4G",
         "test:unit": "php scripts/pest-file-runner.php --colors=always",
         "test": [

extension.json

@@ -1,6 +1,6 @@
 {
     "name": "Fleet-Ops",
-    "version": "0.6.58",
+    "version": "0.6.59",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "repository": "https://github.com/fleetbase/fleetops",
     "license": "AGPL-3.0-or-later",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fleetbase/fleetops-engine",
-    "version": "0.6.58",
+    "version": "0.6.59",
     "description": "Fleet & Transport Management Extension for Fleetbase",
     "fleetbase": {
         "route": "fleet-ops"

scripts/coverage-file-runner.php

@@ -0,0 +1,240 @@
+<?php
+
+declare(strict_types=1);
+
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\Report\Clover;
+
+// Merging hundreds of per-file coverage snapshots into one clover report
+// needs more than the default 128M limit
+ini_set('memory_limit', '-1');
+
+$autoloadCandidates = [
+    getcwd() . '/server_vendor/autoload.php',
+    getcwd() . '/vendor/autoload.php',
+];
+
+$autoload = null;
+foreach ($autoloadCandidates as $candidate) {
+    if (is_file($candidate)) {
+        $autoload = $candidate;
+        break;
+    }
+}
+
+if ($autoload === null) {
+    fwrite(STDERR, "Unable to find Composer autoload. Run composer install first.\n");
+    exit(1);
+}
+
+require_once $autoload;
+
+$pestRunner = getcwd() . '/scripts/pest-runner.php';
+if (!is_file($pestRunner)) {
+    fwrite(STDERR, "Unable to find Pest runner at scripts/pest-runner.php.\n");
+    exit(1);
+}
+
+$hasCoverageExtension = extension_loaded('xdebug') || extension_loaded('pcov');
+if (!$hasCoverageExtension) {
+    fwrite(STDERR, "No PHP coverage driver is available.\n\n");
+    fwrite(STDERR, "Install or enable one of:\n");
+    fwrite(STDERR, "  - Xdebug with XDEBUG_MODE=coverage\n");
+    fwrite(STDERR, "  - PCOV\n");
+    fwrite(STDERR, "\n");
+    fwrite(STDERR, 'Current PHP binary: ' . PHP_BINARY . "\n");
+    exit(1);
+}
+
+putenv('XDEBUG_MODE=coverage');
+$_ENV['XDEBUG_MODE']    = 'coverage';
+$_SERVER['XDEBUG_MODE'] = 'coverage';
+
+$args       = array_slice($argv, 1);
+$cloverPath = getcwd() . '/coverage/clover.xml';
+$pestArgs   = [];
+$targets    = [];
+
+foreach ($args as $arg) {
+    if (str_starts_with($arg, '--coverage-clover=')) {
+        $path       = substr($arg, strlen('--coverage-clover='));
+        $cloverPath = str_starts_with($path, '/') ? $path : getcwd() . '/' . $path;
+        continue;
+    }
+
+    if ($arg === '--coverage-clover') {
+        fwrite(STDERR, "Use --coverage-clover=path with coverage-file-runner.php.\n");
+        exit(1);
+    }
+
+    if ($arg !== '' && $arg[0] !== '-') {
+        $targets[] = $arg;
+        continue;
+    }
+
+    if (!str_starts_with($arg, '--coverage-')) {
+        $pestArgs[] = $arg;
+    }
+}
+
+if ($targets === []) {
+    $targets[] = 'server/tests';
+}
+
+$files = [];
+foreach ($targets as $target) {
+    $path = getcwd() . '/' . ltrim($target, '/');
+    if (is_file($path)) {
+        $files[] = $path;
+        continue;
+    }
+
+    if (is_dir($path)) {
+        $iterator = new RecursiveIteratorIterator(
+            new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS)
+        );
+
+        foreach ($iterator as $fileInfo) {
+            if ($fileInfo->isFile() && $fileInfo->getExtension() === 'php') {
+                $files[] = $fileInfo->getPathname();
+            }
+        }
+    }
+}
+
+$files = array_values(array_unique($files));
+sort($files);
+
+if ($files === []) {
+    fwrite(STDERR, "Unable to find Pest test files for coverage.\n");
+    exit(1);
+}
+
+$coverageDir = dirname($cloverPath);
+if (!is_dir($coverageDir) && !mkdir($coverageDir, 0777, true) && !is_dir($coverageDir)) {
+    fwrite(STDERR, "Unable to create coverage directory: {$coverageDir}\n");
+    exit(1);
+}
+
+$tmpDir = $coverageDir . '/.coverage-file-runner';
+if (is_dir($tmpDir)) {
+    $iterator = new RecursiveIteratorIterator(
+        new RecursiveDirectoryIterator($tmpDir, FilesystemIterator::SKIP_DOTS),
+        RecursiveIteratorIterator::CHILD_FIRST
+    );
+
+    foreach ($iterator as $fileInfo) {
+        $fileInfo->isDir() ? rmdir($fileInfo->getPathname()) : unlink($fileInfo->getPathname());
+    }
+} elseif (!mkdir($tmpDir, 0777, true) && !is_dir($tmpDir)) {
+    fwrite(STDERR, "Unable to create temporary coverage directory: {$tmpDir}\n");
+    exit(1);
+}
+
+$timeout       = (float) (getenv('PEST_FILE_TIMEOUT') ?: 120);
+$timeoutBinary = trim((string) shell_exec('command -v timeout'));
+$memoryLimit   = getenv('FLEETOPS_COVERAGE_MEMORY_LIMIT') ?: '-1';
+$coverageFiles = [];
+
+// Opt-in: keep going after a file fails instead of aborting the whole run.
+//
+// By default a non-zero file exits immediately, which means every later file is
+// skipped, the merge below never runs, and no Clover report is written — the
+// previous report is silently left in place and reads as current. With this set,
+// failures are collected and reported, the report is still produced, and the
+// process still exits non-zero so a failure cannot be mistaken for success.
+$continueOnFailure = filter_var(getenv('FLEETOPS_COVERAGE_CONTINUE_ON_FAILURE') ?: '', FILTER_VALIDATE_BOOLEAN);
+$failedFiles       = [];
+
+foreach ($files as $index => $file) {
+    $relativeFile = str_replace(getcwd() . '/', '', $file);
+    $coverageFile = $tmpDir . '/' . str_pad((string) $index, 4, '0', STR_PAD_LEFT) . '.cov';
+
+    fwrite(STDOUT, "::group::{$relativeFile} coverage\n");
+
+    $command = array_merge([
+        PHP_BINARY,
+        '-d',
+        'memory_limit=' . $memoryLimit,
+        $pestRunner,
+    ], $pestArgs, [
+        '--coverage-php=' . $coverageFile,
+        $file,
+    ]);
+
+    if ($timeoutBinary !== '') {
+        $command = array_merge([$timeoutBinary, "{$timeout}s"], $command);
+    }
+
+    fwrite(STDOUT, '$ ' . implode(' ', array_map('escapeshellarg', $command)) . "\n");
+    passthru(implode(' ', array_map('escapeshellarg', $command)), $exitCode);
+    fwrite(STDOUT, "::endgroup::\n");
+
+    if ($exitCode === 124) {
+        fwrite(STDERR, "\nTimed out after {$timeout} seconds while running {$relativeFile}.\n");
+
+        if (!$continueOnFailure) {
+            exit(1);
+        }
+
+        $failedFiles[] = $relativeFile . ' (timed out)';
+
+        continue;
+    }
+
+    if ($exitCode !== 0) {
+        fwrite(STDERR, "\nPest coverage failed for {$relativeFile} with exit code {$exitCode}.\n");
+
+        if (!$continueOnFailure) {
+            exit($exitCode);
+        }
+
+        $failedFiles[] = $relativeFile;
+
+        // A failing file may still have written partial coverage before it died
+        if (is_file($coverageFile)) {
+            $coverageFiles[] = $coverageFile;
+        }
+
+        continue;
+    }
+
+    $coverageFiles[] = $coverageFile;
+}
+
+$merged = null;
+foreach ($coverageFiles as $coverageFile) {
+    $coverage = include $coverageFile;
+
+    if (!$coverage instanceof CodeCoverage) {
+        fwrite(STDERR, "Invalid coverage artifact: {$coverageFile}\n");
+        exit(1);
+    }
+
+    if ($merged === null) {
+        $merged = $coverage;
+        continue;
+    }
+
+    $merged->merge($coverage);
+}
+
+if (!$merged instanceof CodeCoverage) {
+    fwrite(STDERR, "No coverage data was produced.\n");
+    exit(1);
+}
+
+(new Clover())->process($merged, $cloverPath);
+fwrite(STDOUT, "Wrote Clover coverage to {$cloverPath}\n");
+
+if ($failedFiles !== []) {
+    fwrite(STDERR, "\n" . count($failedFiles) . " test file(s) failed:\n");
+
+    foreach ($failedFiles as $failedFile) {
+        fwrite(STDERR, "  - {$failedFile}\n");
+    }
+
+    fwrite(STDERR, "\nCoverage above excludes anything those files would have covered.\n");
+
+    exit(1);
+}