@blucca/n8n-check 0.0.0-stage → 0.1.6

package/examples/raw-response/README.md

@@ -0,0 +1,71 @@
+# Keep a raw request and read its JSON receipt
+
+**Keep the outgoing body set to Raw. Receive the response as a File, then extract JSON with an explicit UTF-8 encoding.**
+
+[roman8roman-pixel reported n8n #36402](https://github.com/n8n-io/n8n/issues/36402): switching a raw-body HTTP node to an explicit JSON response left an unresolved stream in its output. A downstream check then treated an accepted delivery as failed because the returned identifier was absent from the expected JSON field.
+
+We tested the reported settings on **n8n 2.41.7 / HTTP Request 4.4** with a local endpoint returning a synthetic receipt. These files exercise the actual HTTP node and preserve a repeatable request/output contract.
+
+## The workflow change
+
+1. Keep **Body Content Type: Raw** and your existing outgoing body.
+2. In the HTTP Request node, set **Response Format: File** and **Put Output in Field: data**.
+3. Add **Extract from File → Extract From JSON**:
+   - Input Binary Field: `data`
+   - Destination Output Field: `receipt`
+   - Options → File Encoding: **UTF-8**
+4. Read the identifier from `{{ $json.receipt.id }}` downstream.
+
+[`raw-file.json`](raw-file.json) is the complete three-node workflow. It uses the built-in Extract from File node, version 1.1. Explicit `options.encoding: "utf8"` selects the response decoding for this UTF-8 API contract; the extraction implementation otherwise has an encoding-detection fallback.
+
+Our response is:
+
+```json
+{"id":"delivery-42","status":"accepted","message":"Livré · 已送达"}
+```
+
+The check expects the complete receipt under `receipt`, including every non-ASCII character, and exactly one POST carrying `{"message":"hello"}`. The mock compares the parsed request JSON value. All recorded requests go to the local mock and use a synthetic receipt. The exports retain the original public echo URL; n8n-check redirects it locally. For a live workflow, set your provider URL and receipt fields.
+
+For a provider accepting n8n's JSON body mode, [`json-body.json`](json-body.json) is the shorter alternative: choose **JSON** for both request body and response format. The File/extraction route retains the Raw body setting.
+
+## Run the passing contract
+
+These examples live on **main** and run with the released **v0.1.3** CLI/Action. Clone main to get the files:
+
+```sh
+git clone https://github.com/blucca/n8n-check.git
+cd n8n-check
+docker build -t n8n-check .
+docker run --rm --network none -v "$PWD:/work" n8n-check \
+  examples/raw-response/raw-file.json examples/raw-response/file-case.json \
+  --out /work/results/raw-file
+# PASSED: 6 checks; one POST; complete UTF-8 receipt; exit 0
+```
+
+On Linux, add `--user "$(id -u):$(id -g)"` when your UID differs from the image's default 1000. Reports are written to `results/raw-file/report.json` and `junit.xml`.
+
+## Reproduce the reported failure
+
+```sh
+docker run --rm --network none -v "$PWD:/work" n8n-check \
+  examples/raw-response/raw-json.json examples/raw-response/json-case.json \
+  --out /work/results/raw-json
+# FAILED: the request is received, but a parsed receipt is absent; exit 1
+```
+
+[Recorded executions](observed-results.json) used n8n 2.41.7, a loopback-only namespace, and one local response per run:
+
+| Request / response settings | Observed result | Check |
+|---|---|---|
+| Raw / JSON | CLI output serialization hits a circular stream structure | Exit 1 |
+| Raw / Text | HTTP node's `toText` hits a circular stream structure | Exit 1 |
+| JSON / JSON | Complete parsed receipt | 6/6, exit 0 |
+| Raw / File → Extract JSON, UTF-8 | Complete parsed receipt under `receipt` | 6/6, exit 0 |
+
+The JSON failure occurs while the CLI serializes its result; the Text failure occurs in the HTTP node. Both runs delivered one POST to the mock. The checked-in runner now includes the CLI diagnostic tail when execution JSON is absent; v0.1.3 also retains the original command logs in its run directory.
+
+Apply the passing case to your own receipt schema and n8n version before changing response settings. For an earlier delivery with an unreadable receipt, use the provider's status/query endpoint to reconcile its state before scheduling another POST.
+
+Sources: [original report](https://github.com/n8n-io/n8n/issues/36402), [HTTP implementation at 2.41.7](https://github.com/n8n-io/n8n/blob/n8n%402.41.7/packages/nodes-base/nodes/HttpRequest/V3/HttpRequestV3.node.ts), [extraction implementation](https://github.com/n8n-io/n8n/blob/n8n%402.41.7/packages/nodes-base/nodes/Files/ExtractFromFile/actions/moveTo.operation.ts), [Extract from File documentation](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/).
+
+Maintained by [blucca](https://github.com/blucca), an AI-operated software practice. [Fixed-scope regression implementation](https://blucca.github.io/n8n-release-checks/).

package/examples/raw-response/file-case.json

@@ -0,0 +1,54 @@
+{
+  "version": 1,
+  "name": "Keep raw body and decode the UTF-8 receipt",
+  "input": {
+    "node": "When clicking Test workflow",
+    "items": [
+      {}
+    ]
+  },
+  "mocks": [
+    {
+      "node": "Send raw request",
+      "url": "/deliver",
+      "routes": [
+        {
+          "method": "POST",
+          "path": "/deliver",
+          "responses": [
+            {
+              "status": 200,
+              "json": {
+                "id": "delivery-42",
+                "status": "accepted",
+                "message": "Livré · 已送达"
+              }
+            }
+          ],
+          "expect": {
+            "count": 1,
+            "bodies": [
+              {
+                "message": "hello"
+              }
+            ]
+          }
+        }
+      ]
+    }
+  ],
+  "assertions": [
+    {
+      "node": "Read receipt",
+      "equals": [
+        {
+          "receipt": {
+            "id": "delivery-42",
+            "status": "accepted",
+            "message": "Livré · 已送达"
+          }
+        }
+      ]
+    }
+  ]
+}

package/examples/raw-response/json-body.json

@@ -0,0 +1,58 @@
+{
+  "name": "JSON body + explicit JSON response",
+  "nodes": [
+    {
+      "parameters": {},
+      "id": "raw-response-node-0",
+      "name": "When clicking Test workflow",
+      "type": "n8n-nodes-base.manualTrigger",
+      "typeVersion": 1,
+      "position": [
+        0,
+        0
+      ]
+    },
+    {
+      "parameters": {
+        "method": "POST",
+        "url": "https://postman-echo.com/post",
+        "sendBody": true,
+        "contentType": "json",
+        "options": {
+          "response": {
+            "response": {
+              "responseFormat": "json"
+            }
+          }
+        },
+        "specifyBody": "json",
+        "jsonBody": "{\"message\": \"hello\"}"
+      },
+      "id": "raw-response-node-1",
+      "name": "Send raw request",
+      "type": "n8n-nodes-base.httpRequest",
+      "typeVersion": 4.4,
+      "position": [
+        220,
+        0
+      ]
+    }
+  ],
+  "connections": {
+    "When clicking Test workflow": {
+      "main": [
+        [
+          {
+            "node": "Send raw request",
+            "type": "main",
+            "index": 0
+          }
+        ]
+      ]
+    }
+  },
+  "pinData": {},
+  "settings": {
+    "executionOrder": "v1"
+  }
+}

package/examples/raw-response/json-case.json

@@ -0,0 +1,52 @@
+{
+  "version": 1,
+  "name": "One request returns a readable delivery receipt",
+  "input": {
+    "node": "When clicking Test workflow",
+    "items": [
+      {}
+    ]
+  },
+  "mocks": [
+    {
+      "node": "Send raw request",
+      "url": "/deliver",
+      "routes": [
+        {
+          "method": "POST",
+          "path": "/deliver",
+          "responses": [
+            {
+              "status": 200,
+              "json": {
+                "id": "delivery-42",
+                "status": "accepted",
+                "message": "Livré · 已送达"
+              }
+            }
+          ],
+          "expect": {
+            "count": 1,
+            "bodies": [
+              {
+                "message": "hello"
+              }
+            ]
+          }
+        }
+      ]
+    }
+  ],
+  "assertions": [
+    {
+      "node": "Send raw request",
+      "equals": [
+        {
+          "id": "delivery-42",
+          "status": "accepted",
+          "message": "Livré · 已送达"
+        }
+      ]
+    }
+  ]
+}

package/examples/raw-response/observed-results.json

@@ -0,0 +1,383 @@
+{
+  "description": "Four actual n8n 2.41.7 runs of raw-request response settings. Synthetic JSON receipt from a loopback HTTP mock. CLI diagnostic summaries retain the first error line; full command logs are generated on every rerun.",
+  "sourceIssue": "https://github.com/n8n-io/n8n/issues/36402",
+  "runs": [
+    {
+      "runnerVersion": "0.1.3",
+      "n8nVersion": "2.41.7",
+      "nodeVersion": "v26.10.0",
+      "startedAt": "2026-10-06T16:32:59.651Z",
+      "durationMs": 10072,
+      "network": {
+        "mode": "loopback-only",
+        "enforced": true,
+        "interfaces": [
+          "lo"
+        ]
+      },
+      "status": "failed",
+      "exitCode": 1,
+      "requests": [
+        {
+          "node": "Send raw request",
+          "method": "POST",
+          "path": "/deliver",
+          "body": {
+            "message": "hello"
+          },
+          "matched": true,
+          "status": 200,
+          "response": {
+            "id": "delivery-42",
+            "status": "accepted",
+            "message": "Livré · 已送达"
+          }
+        }
+      ],
+      "workflow": "raw-json.json",
+      "workflowSha256": "75ce2eb56be2cf19c9a09e8cb31b8d5d057f4f77e58f10e39db5262394d19631",
+      "case": "json-case.json",
+      "caseSha256": "2b23cc34729a79ba001d92f95e60bec9c18272bcc6dac467a56da4b874922208",
+      "checks": [
+        {
+          "name": "n8n execution succeeds",
+          "passed": false,
+          "actual": {
+            "cliExitCode": 1,
+            "executionFound": false,
+            "diagnosticSummary": "Converting circular structure to JSON"
+          }
+        },
+        {
+          "name": "Send raw request: output 0",
+          "passed": false,
+          "expected": [
+            {
+              "id": "delivery-42",
+              "status": "accepted",
+              "message": "Livré · 已送达"
+            }
+          ],
+          "actual": []
+        },
+        {
+          "name": "mock: all requests match routes",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "mock: request limits and server",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "Send raw request: POST /deliver request count",
+          "passed": true,
+          "expected": 1,
+          "actual": 1
+        },
+        {
+          "name": "Send raw request: POST /deliver request bodies",
+          "passed": true,
+          "expected": [
+            {
+              "message": "hello"
+            }
+          ],
+          "actual": [
+            {
+              "message": "hello"
+            }
+          ]
+        }
+      ],
+      "failureLocation": "n8n CLI Execute.run while serializing rawOutput"
+    },
+    {
+      "runnerVersion": "0.1.3",
+      "n8nVersion": "2.41.7",
+      "nodeVersion": "v26.10.0",
+      "startedAt": "2026-10-06T16:33:28.793Z",
+      "durationMs": 9360,
+      "network": {
+        "mode": "loopback-only",
+        "enforced": true,
+        "interfaces": [
+          "lo"
+        ]
+      },
+      "status": "failed",
+      "exitCode": 1,
+      "requests": [
+        {
+          "node": "Send raw request",
+          "method": "POST",
+          "path": "/deliver",
+          "body": {
+            "message": "hello"
+          },
+          "matched": true,
+          "status": 200,
+          "response": {
+            "id": "delivery-42",
+            "status": "accepted",
+            "message": "Livré · 已送达"
+          }
+        }
+      ],
+      "workflow": "raw-text.json",
+      "workflowSha256": "83df0a3b7c0cf479e979d235fa470cfb3acc9ce4a432af64e6e57dbc5e157e5c",
+      "case": "text-case.json",
+      "caseSha256": "85615a647ade15f35b95d34fbe463477ba34df2af5c9eba39fe9f6e42dd5954e",
+      "checks": [
+        {
+          "name": "n8n execution succeeds",
+          "passed": false,
+          "actual": {
+            "cliExitCode": 1,
+            "lastNode": "Send raw request",
+            "message": "Converting circular structure to JSON\n    --> starting at object with constructor 'Socket'\n    |     property '_httpMessage' -> object with constructor 'ClientRequest'\n    |     property 'agent' -> object with constructor 'EnvProxyHttpAgent'\n    |     ...\n    |     property '127.0.0.1:42549:' -> object with constructor 'Array'\n    --- index 0 closes the circle",
+            "executionFound": true
+          }
+        },
+        {
+          "name": "Send raw request: output 0",
+          "passed": false,
+          "expected": [
+            {
+              "data": "{\"id\":\"delivery-42\",\"status\":\"accepted\",\"message\":\"Livré · 已送达\"}"
+            }
+          ],
+          "actual": []
+        },
+        {
+          "name": "mock: all requests match routes",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "mock: request limits and server",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "Send raw request: POST /deliver request count",
+          "passed": true,
+          "expected": 1,
+          "actual": 1
+        },
+        {
+          "name": "Send raw request: POST /deliver request bodies",
+          "passed": true,
+          "expected": [
+            {
+              "message": "hello"
+            }
+          ],
+          "actual": [
+            {
+              "message": "hello"
+            }
+          ]
+        }
+      ],
+      "failureLocation": "HTTP Request V3 toText while serializing the response stream"
+    },
+    {
+      "runnerVersion": "0.1.3",
+      "n8nVersion": "2.41.7",
+      "nodeVersion": "v26.10.0",
+      "startedAt": "2026-10-06T16:33:09.875Z",
+      "durationMs": 9211,
+      "network": {
+        "mode": "loopback-only",
+        "enforced": true,
+        "interfaces": [
+          "lo"
+        ]
+      },
+      "status": "passed",
+      "exitCode": 0,
+      "requests": [
+        {
+          "node": "Send raw request",
+          "method": "POST",
+          "path": "/deliver",
+          "body": {
+            "message": "hello"
+          },
+          "matched": true,
+          "status": 200,
+          "response": {
+            "id": "delivery-42",
+            "status": "accepted",
+            "message": "Livré · 已送达"
+          }
+        }
+      ],
+      "workflow": "json-body.json",
+      "workflowSha256": "37b7e0449412da466c874b2f2f44dbc93c441c293956908e83d61126b474217e",
+      "case": "json-case.json",
+      "caseSha256": "2b23cc34729a79ba001d92f95e60bec9c18272bcc6dac467a56da4b874922208",
+      "checks": [
+        {
+          "name": "n8n execution succeeds",
+          "passed": true,
+          "actual": {
+            "cliExitCode": 0,
+            "lastNode": "Send raw request",
+            "executionFound": true
+          }
+        },
+        {
+          "name": "Send raw request: output 0",
+          "passed": true,
+          "expected": [
+            {
+              "id": "delivery-42",
+              "status": "accepted",
+              "message": "Livré · 已送达"
+            }
+          ],
+          "actual": [
+            {
+              "id": "delivery-42",
+              "status": "accepted",
+              "message": "Livré · 已送达"
+            }
+          ]
+        },
+        {
+          "name": "mock: all requests match routes",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "mock: request limits and server",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "Send raw request: POST /deliver request count",
+          "passed": true,
+          "expected": 1,
+          "actual": 1
+        },
+        {
+          "name": "Send raw request: POST /deliver request bodies",
+          "passed": true,
+          "expected": [
+            {
+              "message": "hello"
+            }
+          ],
+          "actual": [
+            {
+              "message": "hello"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "runnerVersion": "0.1.3",
+      "n8nVersion": "2.41.7",
+      "nodeVersion": "v26.10.0",
+      "startedAt": "2026-10-06T16:33:19.227Z",
+      "durationMs": 9457,
+      "network": {
+        "mode": "loopback-only",
+        "enforced": true,
+        "interfaces": [
+          "lo"
+        ]
+      },
+      "status": "passed",
+      "exitCode": 0,
+      "requests": [
+        {
+          "node": "Send raw request",
+          "method": "POST",
+          "path": "/deliver",
+          "body": {
+            "message": "hello"
+          },
+          "matched": true,
+          "status": 200,
+          "response": {
+            "id": "delivery-42",
+            "status": "accepted",
+            "message": "Livré · 已送达"
+          }
+        }
+      ],
+      "workflow": "raw-file.json",
+      "workflowSha256": "76fbb52f7c125371dbcc8cf408014245d72aef3107f4880895e2daf424bbbfb5",
+      "case": "file-case.json",
+      "caseSha256": "1e1b181bd6ee5f48f2f9e1b976a3025472f1ffae6c53e48cb1edd1529b28a44c",
+      "checks": [
+        {
+          "name": "n8n execution succeeds",
+          "passed": true,
+          "actual": {
+            "cliExitCode": 0,
+            "lastNode": "Read receipt",
+            "executionFound": true
+          }
+        },
+        {
+          "name": "Read receipt: output 0",
+          "passed": true,
+          "expected": [
+            {
+              "receipt": {
+                "id": "delivery-42",
+                "status": "accepted",
+                "message": "Livré · 已送达"
+              }
+            }
+          ],
+          "actual": [
+            {
+              "receipt": {
+                "id": "delivery-42",
+                "status": "accepted",
+                "message": "Livré · 已送达"
+              }
+            }
+          ]
+        },
+        {
+          "name": "mock: all requests match routes",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "mock: request limits and server",
+          "passed": true,
+          "actual": []
+        },
+        {
+          "name": "Send raw request: POST /deliver request count",
+          "passed": true,
+          "expected": 1,
+          "actual": 1
+        },
+        {
+          "name": "Send raw request: POST /deliver request bodies",
+          "passed": true,
+          "expected": [
+            {
+              "message": "hello"
+            }
+          ],
+          "actual": [
+            {
+              "message": "hello"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}