Url proxy endpoint featuring OpenAPI

.github/workflows/ci-tests.yml

@@ -175,3 +175,23 @@ jobs:
         run: npm install
       - name: Run ESLint
         run: npx eslint .
+
+  CheckOpenApiSpec:
+    name: Check OpenAPI specification
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          # Our Taskfile requires a proper checkout to function because of
+          # certain vars.
+          fetch-depth: 0
+      - name: Install go-task
+        uses: arduino/setup-task@v1
+      - name: Setup site
+        run: task ci:reset
+      - name: Validate specification
+        run: task ci:openapi:validate
+      - name: Download current specification
+        run: task ci:openapi:download
+      - name: Ensure specification has not drifted
+        run: git diff --exit-code openapi.json

.lighthouserc.js

@@ -1,33 +1,42 @@
 module.exports = {
-  "ci": {
-    "collect": {
-      "url": [
-        'http://varnish:8080/',
-      ],
+  ci: {
+    collect: {
+      url: ["http://varnish:8080/"],
       // Use 3 runs to test both cold and warm caches.
-      "numberOfRuns": 3,
-      "settings": {
-        "chromeFlags": "--no-sandbox",
+      numberOfRuns: 3,
+      settings: {
+        chromeFlags: "--no-sandbox",
         // Lighthouse best practices require HTTPS but we do not this available
         // on our CI environments so disable that check. It should not keep our
         // score down.
-        "skipAudits": ["is-on-https"]
-      }
+        skipAudits: ["is-on-https"],
+        throttling: {
+          // Lighthouse will throttle CPU by 4x by default to mimick the
+          // performance of a midrange smartphone instead of a desktop
+          // workstation. Experience shows that Docker containers and GitHub
+          // Actions runners have significantly fewer resources than a desktop and
+          // thus should be throttled less. This value is based on a benchmark
+          // index of 1000. The actual benchmark in a run can be seen under
+          // CPU/Memory Power in the generated report.
+          // https://lighthouse-cpu-throttling-calculator.vercel.app/
+          cpuSlowdownMultiplier: 2.9,
+        },
+      },
     },
-    "assert": {
-      "assertions": {
+    assert: {
+      assertions: {
         // Our quality standard requires all categories to be green. Green
         // translates to a score between 90 and 100 - or 0.9-1.
-        "categories:performance": ["error", {"minScore": 0.9}],
-        "categories:accessibility": ["error", {"minScore": 0.9}],
-        "categories:best-practices": ["error", {"minScore": 0.9}],
-        "categories:seo": ["error", {"minScore": 0.9}]
-      }
+        "categories:performance": ["error", { minScore: 0.9 }],
+        "categories:accessibility": ["error", { minScore: 0.9 }],
+        "categories:best-practices": ["error", { minScore: 0.9 }],
+        "categories:seo": ["error", { minScore: 0.9 }],
+      },
     },
-    "upload": {
+    upload: {
       // Update to Googles public storage to make reports easily accessible.
       // The fact that the storage is public is fine. The project is open.
-      "target": "temporary-public-storage"
-    }
-  }
+      target: "temporary-public-storage",
+    },
+  },
 };

Taskfile.yml

@@ -93,7 +93,7 @@ tasks:
   dev:phpunit:
     desc: Run PHPUnit tests with code coverage
     cmds:
-      - docker compose run -e XDEBUG_ENABLE=true cli vendor/bin/phpunit --coverage-text
+      - docker compose run -e XDEBUG_ENABLE=true -e XDEBUG_MODE=coverage,debug cli vendor/bin/phpunit --coverage-text
 
   dev:restore:database:
     desc: 'Restore database from db dump file. Only one sql should be present the "{{ .DIR_RESTORE_DATABASE }}" directory.'
@@ -177,6 +177,18 @@ tasks:
       - docker compose {{ .DOCKER_COMPOSE_FILES_CI }} run node-chrome npm ci
       - docker compose {{ .DOCKER_COMPOSE_FILES_CI }} run node-chrome npx lhci autorun
 
+  ci:openapi:validate:
+    desc: Validate the Drupal OpenAPI specification
+    cmds:
+      - docker compose {{ .DOCKER_COMPOSE_FILES_CI }} run node-chrome npm ci
+      - docker compose {{ .DOCKER_COMPOSE_FILES_CI }} run node-chrome npx swagger-cli validate http://varnish:8080/openapi/rest?_format=json
+
+  ci:openapi:download:
+    desc: Download the Drupal OpenAPI specification from the running local site to the local filesystem
+    cmds:
+      - docker compose {{ .DOCKER_COMPOSE_FILES_CI }} run node-chrome npm ci
+      - docker compose {{ .DOCKER_COMPOSE_FILES_CI }} run node-chrome curl http://varnish:8080/openapi/rest?_format=json | npx jsome -r > openapi.json
+
   source:build:
     summary: Build core source image.
     cmds:

composer.json

@@ -59,9 +59,12 @@
         "drupal/devel": "^4.1",
         "drupal/jsonlog": "^3.0",
         "drupal/libraries": "^3.0@beta",
+        "drupal/openapi": "^2.0",
+        "drupal/openapi_rest": "^2.0@RC",
         "drupal/openid_connect": "^1.1",
         "drupal/purge": "^3.2",
         "drupal/redis": "^1.5",
+        "drupal/restui": "^1.21",
         "drupal/varnish_purge": "^2.1",
         "drush/drush": "10.4.3",
         "thecodingmachine/safe": "^1.3",
@@ -96,7 +99,8 @@
             "dealerdirect/phpcodesniffer-composer-installer": true,
             "drupal/core-project-message": true,
             "phpstan/extension-installer": true,
-            "zaporylie/composer-drupal-optimizations": true
+            "zaporylie/composer-drupal-optimizations": true,
+            "drupal/console-extend-plugin": true
         }
     },
     "autoload-dev": {
@@ -142,11 +146,17 @@
                 "2936067: CSS aggregation fails on many variations of @import": "https://git.drupalcode.org/project/drupal/-/commit/5aa154d.patch",
                 "Configure core to not check permissions before accepting an updated module": "patches/disable-core-upload-permission-check.diff"
             },
+            "drupal/jsonlog": {
+                "3251587: Change logging from stdout to stderr": "https://www.drupal.org/files/issues/2021-11-29/jsonlog-change-stdout-to-stderr-3251587-3.patch"
+            },
             "drupal/redis": {
                 "3207574: Patch against redis being include too late": "https://www.drupal.org/files/issues/2021-04-07/redis-report_warnings-3207574-2.patch"
             },
-            "drupal/jsonlog": {
-                "3251587: Change logging from stdout to stderr": "https://www.drupal.org/files/issues/2021-11-29/jsonlog-change-stdout-to-stderr-3251587-3.patch"
+            "drupal/openapi": {
+                "3313521: OpenAPI security field does not validate": "https://git.drupalcode.org/project/openapi/-/merge_requests/6.patch"
+            },
+            "drupal/openapi_rest": {
+                "3171530 + 3116760: Add support for parameter and response descriptions": "patches/openapi-parameter-response-descriptions.patch"
             }
         }
     }