Reduce number of calls to form templates API (cypress)

Author: Crabcyborg

.github/workflows/cypress.yml

@@ -66,6 +66,37 @@ jobs:
         if: steps.cache-npm.outputs.cache-hit != 'true'
         run: npm ci --legacy-peer-deps --include=dev
 
+      # Serve the form-templates API from a fixture instead of calling
+      # formidableforms.com on every run. The cache key is the UTC date, so
+      # the fixture is refreshed at most once a day and all four shards share
+      # the one copy - without this, each shard fetches it separately. If the
+      # fetch fails the committed fixture is used, so the suite still runs
+      # when the API is unreachable.
+      - name: Get current date
+        id: date
+        run: echo "date=$( date -u +%Y-%m-%d )" >> "$GITHUB_OUTPUT"
+
+      - name: Cache form templates API response
+        id: cache-templates
+        uses: actions/cache@v4
+        with:
+          path: tests/mu-plugins/form-templates-api.json
+          key: form-templates-${{ steps.date.outputs.date }}
+
+      - name: Refresh form templates fixture
+        if: steps.cache-templates.outputs.cache-hit != 'true'
+        run: |
+          # Write to a temp file first so a partial or failed response never
+          # clobbers the committed fallback.
+          if curl -fsS --max-time 40 -A 'formidable-e2e' \
+            'https://formidableforms.com/wp-json/form-templates/v1/list?l=RlJFRVRFTVBMQVRFUyEhIQ%3D%3D' \
+            -o /tmp/form-templates-api.json && [ -s /tmp/form-templates-api.json ]; then
+            mv /tmp/form-templates-api.json tests/mu-plugins/form-templates-api.json
+            echo "Refreshed the form templates fixture from the API."
+          else
+            echo "Could not reach the templates API; using the committed fixture."
+          fi
+
       - name: Set up WP environment
         run: npm run env start
 

.wp-env.json

@@ -4,11 +4,15 @@
   "plugins": [
     "."
   ],
+  "mappings": {
+    "wp-content/mu-plugins": "./tests/mu-plugins"
+  },
   "env": {
     "tests": {
       "mappings": {
+        "wp-content/mu-plugins": "./tests/mu-plugins",
         "wp-cli.yml": "./tests/bin/wp-cli.yml"
       }
     }
   }
-}
+}

tests/mu-plugins/form-templates-api.json

@@ -0,0 +1,29 @@
+<?php
+// Forces the welcome-tour checklist off in the e2e test environment.
+//
+// On a fresh install the checklist renders expanded on its 'create-form'
+// step and its header overlays the form builder, covering
+// #frm-save-form-name-button so `cy.click()` fails actionability.
+//
+// The suite used to get away with this by accident: Cypress runs root-level
+// specs first, so admin-a11y.cy.js was always spec 1 of 18 and clicked the
+// checklist away, and because FrmWelcomeTourController stores its state in
+// the site-wide `frm-welcome-tour` option, every later spec inherited a
+// dismissed tour. Sharding removes that guarantee - whichever spec runs
+// first on a given shard now meets a virgin site - so the state has to be
+// set deterministically instead of inherited from a neighbour.
+//
+// Filtering rather than seeding the option means save_checklist() can't
+// write over it mid-run. `active_step_key` is required alongside
+// `dismissed`: get_usage_data() reads it whenever `dismissed` is truthy and
+// would otherwise emit an undefined-index warning into debug.log.
+add_filter(
+	'pre_option_frm-welcome-tour',
+	function () {
+		return array(
+			'completed_steps' => array(),
+			'active_step_key' => 'create-form',
+			'dismissed'       => true,
+		);
+	}
+);

tests/mu-plugins/frm-dismiss-welcome-tour.php

@@ -0,0 +1,57 @@
+<?php
+// Serves the form-templates API from a local fixture in the e2e test
+// environment, so the suite never depends on a live call to
+// formidableforms.com.
+//
+// Two things go wrong without this. A fresh wp-env has an empty template
+// cache, and FrmFormApi::get_api_info() returns an empty array outright when
+// another request for the same data is already in flight (the is_running()
+// guard) rather than waiting for it - so the templates list renders empty and
+// assertions like [frm-search-text="user registration"] never match. The
+// `Get Instant Access` signup flow then calls reset_cached(), clearing the
+// cache mid-run and re-opening the same window for whatever runs next.
+//
+// Sharding sharpened this: every shard is its own wp-env with its own cold
+// cache, so one live fetch per run became one per shard.
+//
+// Filtering pre_http_request rather than seeding the cache option keeps this
+// independent of FrmFormApi's cache internals - the option key is derived
+// from the license, and reset_cached() deletes it - and it is the standard
+// WordPress way to stub an outbound request.
+//
+// The fixture sits beside this file on purpose. The whole mu-plugins
+// directory is mapped to a known path inside the container, whereas the
+// plugin directory is named `formidable` locally and `formidable-forms` in
+// CI, so a path built from the plugin folder would break in one of the two.
+// WordPress only auto-loads .php from the mu-plugins root, so the .json
+// sibling is inert.
+add_filter(
+	'pre_http_request',
+	function ( $preempt, $args, $url ) {
+		if ( false === strpos( $url, '/wp-json/form-templates/v1/list' ) ) {
+			return $preempt;
+		}
+
+		$fixture = __DIR__ . '/form-templates-api.json';
+
+		if ( ! is_readable( $fixture ) ) {
+			// Let the real request through rather than failing the run with an
+			// empty template list, which is the confusing symptom this exists
+			// to prevent.
+			return $preempt;
+		}
+
+		return array(
+			'headers'  => array(),
+			'body'     => file_get_contents( $fixture ),
+			'response' => array(
+				'code'    => 200,
+				'message' => 'OK',
+			),
+			'cookies'  => array(),
+			'filename' => null,
+		);
+	},
+	10,
+	3
+);