Merge pull request #886 from calibreapp/host-blocking

🚫 Single Page Test host blocking

Author: benschwarz

.github/workflows/test.yml

@@ -1,4 +1,6 @@
 name: Test Node.js
+permissions:
+  contents: read
 
 on: [push]
 
@@ -9,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [20.x, 22.x, 24.x]
+        node-version: [20.x, 22.x, 24.x, 25.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
     timeout-minutes: 5
     steps:

CHANGELOG.md

@@ -1,3 +1,19 @@
+# 6.3.0 (2025-12-10)
+
+## 🚩 Commands and flags
+
+- Added support for host blocking to `calibre test create` command via new `--blockedHosts` flag. Supports wildcard patterns (e.g., `*.google-analytics.com`), comma-separated lists, JSON arrays, or file paths.
+- Removed adblocking support from Single Page Tests, Test Profiles & Synthetic Test Results. Adblocking support was deprecated March 25' (https://calibreapp.com/changelog/archive/2025/03-host-blocking), and removed December 25'.
+- Removed `--adblocker` flag from `calibre test create`, `calibre site create-test-profile`, and `calibre site update-test-profile` commands.
+
+## 🛠 Core
+
+- Updated Node.js example (`examples/nodejs/create-test.js`) to demonstrate `blockedHosts` usage with wildcard patterns.
+
+## 🧹 Housekeeping
+
+- Update dependencies in response to latest dependabot updates and security patches.
+
 # 6.2.1 (2025-10-20)
 
 ## 🐛 Bug fixes

CLI_COMMANDS.md

@@ -202,7 +202,6 @@ Flags:
   * `--device`: Choose the emulated test device. (default: `Desktop`),
   * `--connection`: Choose the emulated network connection speed.,
   * `--javascript`: Turn JavaScript execution on or off. (default: `true`) (boolean),
-  * `--adblocker`: Turn adblocking on or off. (boolean),
   * `--cookie-jar`: Set cookies by specifying a path to a Netscape formatted cookie jar file.,
   * `--json`: Outputs the results of the command in JSON format.
 
@@ -219,7 +218,6 @@ Flags:
   * `--site`: A unique slug identifying each Site. You can find it in Site Settings → General or by using the calibre site list command. (string),
   * `--json`: Outputs the results of the command in JSON format.,
   * `--javascript`: Turn JavaScript execution on or off (default: `true`) (boolean),
-  * `--adblocker`: Turn adblocking on or off. (boolean),
   * `--cookie-jar`: Set cookies by specifying a path to a Netscape formatted cookie jar file.
 
 
@@ -294,11 +292,11 @@ Flags:
   * `--connection`: Choose the emulated network connection speed.,
   * `--webhookUrl`: Test result JSON will be sent to this URL using HTTP POST.,
   * `--webhookSecret`: Secret used to sign the webhook payload. Secret can be validated using `Calibre-HMAC-SHA256-Signature` HTTP header. See https://calibreapp.com/docs/integrations/webhooks#webhook-security-and-verification for more information.,
-  * `--adblocker`: Turn adblocking on or off. (boolean),
   * `--private`: Make the results of a test private (only accessible by members of your Calibre organisation). (boolean),
-  * `--expiresAt`: Set a future UTC date time string (ISO8601). After this date, the test will be automatically deleted. (Min=24 hrs, Max=2 years) e.g.: 2025-12-31T23:59:59Z (Default: Expires 1 year from creation date.: `2026-09-25T14:11:14.450Z`) (string),
+  * `--expiresAt`: Set a future UTC date time string (ISO8601). After this date, the test will be automatically deleted. (Min=24 hrs, Max=2 years) e.g.: 2025-12-31T23:59:59Z (Default: Expires 1 year from creation date.: `2026-12-10T09:21:50.354Z`) (string),
   * `--cookie-jar`: Set cookies by specifying a path to a Netscape formatted cookie jar file.,
   * `--headers`: Set HTTP headers by providing a path to a JSON file or a valid JSON key-value pairs.,
+  * `--blockedHosts`: Block hosts by providing a comma-separated list, a path to a JSON file, or a valid JSON array. Supports wildcards (e.g., "*.example.com").,
   * `--json`: Outputs the results of the command in JSON format.,
   * `--markdown`: Outputs the results of the command in Markdown format.,
   * `--waitForTest`: Wait for the test to complete before showing the results (default: test result link is shown immediately). (boolean)

__tests__/cli/test/__snapshots__/create.test.js.snap

@@ -0,0 +1,7 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`test create with blockedHosts should accept JSON array for blocked hosts 1`] = `""`;
+
+exports[`test create with blockedHosts should accept comma-separated blocked hosts 1`] = `""`;
+
+exports[`test create with blockedHosts should work without blocked hosts 1`] = `""`;

__tests__/cli/test/create.test.js

@@ -0,0 +1,42 @@
+import {
+  runCLI,
+  setupIntegrationServer,
+  teardownIntegrationServer
+} from '../../utils'
+
+const mockResponse = {
+  data: {
+    createTest: {
+      uuid: 'test-uuid-123',
+      formattedTestUrl: 'https://calibreapp.com/test/test-uuid-123'
+    }
+  }
+}
+
+describe('test create with blockedHosts', () => {
+  beforeAll(async () => await setupIntegrationServer(mockResponse))
+  afterAll(async () => await teardownIntegrationServer())
+
+  test('should accept comma-separated blocked hosts', async () => {
+    const out = await runCLI({
+      args:
+        'test create https://example.com --location=Sydney --blockedHosts="*.google-analytics.com,*.facebook.com"'
+    })
+    expect(out).toMatchSnapshot()
+  })
+
+  test('should accept JSON array for blocked hosts', async () => {
+    const out = await runCLI({
+      args:
+        'test create https://example.com --location=Sydney --blockedHosts=\'["*.google-analytics.com","*.facebook.com"]\''
+    })
+    expect(out).toMatchSnapshot()
+  })
+
+  test('should work without blocked hosts', async () => {
+    const out = await runCLI({
+      args: 'test create https://example.com --location=Sydney'
+    })
+    expect(out).toMatchSnapshot()
+  })
+})

__tests__/fixtures/completedTest.json

@@ -4,7 +4,6 @@
   "formattedTestUrl": "https://calibreapp.com/tests/b3baaa1/1fe9862",
   "status": "completed",
   "updatedAt": "2019-04-26T05:09:26Z",
-  "adBlockerIsEnabled": false,
   "runtimeError": {
     "code": "NO_ERROR",
     "message": ""

__tests__/fixtures/erroredTest.json

@@ -4,7 +4,6 @@
   "formattedTestUrl": "https://calibreapp.com/tests/b3baaa1/1fe9862",
   "status": "errored",
   "updatedAt": "2019-04-26T05:09:26Z",
-  "adBlockerIsEnabled": false,
   "runtimeError": {
     "code": "INTERSTITIAL_ERROR",
     "message": "Calibre was unable to load the page. Please make sure the page URL and site authentication settings are correct."

__tests__/fixtures/incompleteTest.json

@@ -4,7 +4,6 @@
   "formattedTestUrl": "https://calibreapp.com/tests/b3baaa1/1fe9862",
   "status": "completed",
   "updatedAt": "2019-04-26T05:09:26Z",
-  "adBlockerIsEnabled": false,
   "runtimeError": {
     "code": "NO_ERROR",
     "message": ""

__tests__/fixtures/timeoutTest.json

@@ -4,7 +4,6 @@
   "formattedTestUrl": "https://calibreapp.com/tests/b3baaa1/1fe9862",
   "status": "timeout",
   "updatedAt": "2019-04-26T05:09:26Z",
-  "adBlockerIsEnabled": false,
   "runtimeError": {
     "code": "INTERSTITIAL_ERROR",
     "message": "Calibre was unable to load the page. Please make sure the page URL and site authentication settings are correct."

examples/nodejs/create-test.js

@@ -27,15 +27,21 @@ const createTest = async () => {
       value: 'My Custom User Agent'
     }
   ]
+  const blockedHosts = [
+    '*.google-analytics.com',
+    '*.facebook.com',
+    'ads.example.com'
+  ]
 
   // Create the test
-  const { formattedTestUrl } = await Test.create({
+  const { formattedTestUrl, uuid } = await Test.create({
     url,
     location,
     device,
     connection,
     cookies,
     headers,
+    blockedHosts,
     isPrivate
   })