@quantcdn/edge-conformance 0.0.0-stage → 0.1.0

package/vectors/functions/filters.json

@@ -0,0 +1,238 @@
+{
+  "cases": [
+    {
+      "id": "functions-filter-transforms-html",
+      "description": "A content filter changes the body of a text/html response.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0003-4000-8000-000000000003",
+        "type": "filter",
+        "body": "class contentFilter extends TransformStream {\n  constructor(event, responseHeaders) {\n    super({\n      transform: (chunk, controller) => {\n        const text = this.textDecoder.decode(chunk);\n        controller.enqueue(this.textEncoder.encode(text.replace(/example/g, 'test')));\n      }\n    });\n    this.textEncoder = new TextEncoder();\n    this.textDecoder = new TextDecoder();\n  }\n}",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/page"
+        },
+        "response": {
+          "status": 200,
+          "headers": {
+            "content-type": "text/html; charset=utf-8"
+          },
+          "body": "<p>example page</p>"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "bodyText": "<p>test page</p>"
+      }
+    },
+    {
+      "id": "functions-filter-sets-a-response-header",
+      "description": "A content filter can set a response header on a text/html response.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0003-4000-8000-000000000003",
+        "type": "filter",
+        "body": "class contentFilter extends TransformStream {\n  constructor(event, responseHeaders) {\n    responseHeaders.set('x-filtered', 'yes');\n    super({ transform: (chunk, controller) => controller.enqueue(chunk) });\n  }\n}",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/page"
+        },
+        "response": {
+          "status": 200,
+          "headers": {
+            "content-type": "text/html; charset=utf-8"
+          },
+          "body": "<p>page</p>"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "headers": {
+          "x-filtered": "yes"
+        },
+        "bodyText": "<p>page</p>"
+      }
+    },
+    {
+      "id": "functions-filter-keeps-the-status",
+      "description": "A content filter keeps the status of the response.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0003-4000-8000-000000000003",
+        "type": "filter",
+        "body": "class contentFilter extends TransformStream {\n  constructor(event, responseHeaders) {\n    super({\n      transform: (chunk, controller) => {\n        const text = this.textDecoder.decode(chunk);\n        controller.enqueue(this.textEncoder.encode(text.replace(/example/g, 'test')));\n      }\n    });\n    this.textEncoder = new TextEncoder();\n    this.textDecoder = new TextDecoder();\n  }\n}",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/page"
+        },
+        "response": {
+          "status": 404,
+          "headers": {
+            "content-type": "text/html; charset=utf-8"
+          },
+          "body": "<p>example missing</p>"
+        }
+      },
+      "expect": {
+        "status": 404,
+        "bodyText": "<p>test missing</p>"
+      }
+    },
+    {
+      "id": "functions-filter-does-not-change-a-non-html-body",
+      "description": "A content filter does not change the body of a response that is not text/html.",
+      "tags": [
+        "functions",
+        "unverified"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0003-4000-8000-000000000003",
+        "type": "filter",
+        "body": "class contentFilter extends TransformStream {\n  constructor(event, responseHeaders) {\n    super({\n      transform: (chunk, controller) => {\n        const text = this.textDecoder.decode(chunk);\n        controller.enqueue(this.textEncoder.encode(text.replace(/example/g, 'test')));\n      }\n    });\n    this.textEncoder = new TextEncoder();\n    this.textDecoder = new TextDecoder();\n  }\n}",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/data"
+        },
+        "response": {
+          "status": 200,
+          "headers": {
+            "content-type": "application/json"
+          },
+          "body": "{\"word\":\"example\"}"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "bodyText": "{\"word\":\"example\"}"
+      }
+    },
+    {
+      "id": "functions-filter-needs-a-content-filter-class",
+      "description": "A filter body that does not define contentFilter gives a 500 response.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0003-4000-8000-000000000003",
+        "type": "filter",
+        "body": "const notAFilter = 1;",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/page"
+        },
+        "response": {
+          "status": 200,
+          "headers": {
+            "content-type": "text/html; charset=utf-8"
+          },
+          "body": "<p>page</p>"
+        }
+      },
+      "expect": {
+        "status": 500
+      }
+    },
+    {
+      "id": "functions-filter-applies-to-static-html",
+      "description": "A filter rule changes a static text/html page.",
+      "tags": [
+        "functions"
+      ],
+      "op": "serveSite",
+      "input": {
+        "files": {
+          "index.html": "<p>example home</p>"
+        },
+        "functions": [
+          {
+            "uuid": "b2c3d4e5-0003-4000-8000-000000000003",
+            "id": "rewrite",
+            "type": "filter",
+            "body": "class contentFilter extends TransformStream {\n  constructor(event, responseHeaders) {\n    super({\n      transform: (chunk, controller) => {\n        const text = this.textDecoder.decode(chunk);\n        controller.enqueue(this.textEncoder.encode(text.replace(/example/g, 'test')));\n      }\n    });\n    this.textEncoder = new TextEncoder();\n    this.textDecoder = new TextDecoder();\n  }\n}"
+          }
+        ],
+        "rules": {
+          "version": 1,
+          "namespace": "conformance",
+          "rules": [
+            {
+              "id": "rewrite",
+              "type": "filter",
+              "urls": [
+                "/",
+                "/*"
+              ],
+              "weight": 0,
+              "function_uuid": "b2c3d4e5-0003-4000-8000-000000000003"
+            }
+          ]
+        },
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "bodyText": "<p>test home</p>"
+      }
+    },
+    {
+      "id": "functions-filter-skips-static-css",
+      "description": "A filter rule does not change a static file that is not text/html.",
+      "tags": [
+        "functions"
+      ],
+      "op": "serveSite",
+      "input": {
+        "files": {
+          "index.html": "<p>example home</p>",
+          "site.css": ".example { color: red; }"
+        },
+        "functions": [
+          {
+            "uuid": "b2c3d4e5-0003-4000-8000-000000000003",
+            "id": "rewrite",
+            "type": "filter",
+            "body": "class contentFilter extends TransformStream {\n  constructor(event, responseHeaders) {\n    super({\n      transform: (chunk, controller) => {\n        const text = this.textDecoder.decode(chunk);\n        controller.enqueue(this.textEncoder.encode(text.replace(/example/g, 'test')));\n      }\n    });\n    this.textEncoder = new TextEncoder();\n    this.textDecoder = new TextDecoder();\n  }\n}"
+          }
+        ],
+        "rules": {
+          "version": 1,
+          "namespace": "conformance",
+          "rules": [
+            {
+              "id": "rewrite",
+              "type": "filter",
+              "urls": [
+                "/",
+                "/*"
+              ],
+              "weight": 0,
+              "function_uuid": "b2c3d4e5-0003-4000-8000-000000000003"
+            }
+          ]
+        },
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/site.css"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "bodyText": ".example { color: red; }"
+      }
+    }
+  ]
+}

package/vectors/functions/responses.json

@@ -0,0 +1,304 @@
+{
+  "cases": [
+    {
+      "id": "functions-response-status-headers-and-body",
+      "description": "The Response that a function returns gives the status, headers and body.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "return new Response('Hello World', { status: 200, headers: { 'content-type': 'text/html', 'x-powered-by': 'QuantCDN' } });",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/hello"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "headers": {
+          "content-type": {
+            "startsWith": "text/html"
+          },
+          "x-powered-by": "QuantCDN"
+        },
+        "bodyText": "Hello World"
+      }
+    },
+    {
+      "id": "functions-response-status",
+      "description": "A function can return any status.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "return new Response('Accepted', { status: 202 });",
+        "request": {
+          "method": "POST",
+          "url": "https://www.example.com/api",
+          "body": "x"
+        }
+      },
+      "expect": {
+        "status": 202,
+        "bodyText": "Accepted"
+      }
+    },
+    {
+      "id": "functions-await",
+      "description": "A function body can use await.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "const value = await new Promise((resolve) => setTimeout(() => resolve('later'), 5));\nreturn new Response(value);",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "bodyText": "later"
+      }
+    },
+    {
+      "id": "functions-json-response",
+      "description": "A function can return JSON with its content type.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "return new Response(JSON.stringify({ ok: true }), { headers: { 'content-type': 'application/json' } });",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "headers": {
+          "content-type": {
+            "startsWith": "application/json"
+          }
+        },
+        "bodyJson": {
+          "ok": true
+        }
+      }
+    },
+    {
+      "id": "functions-non-response-value",
+      "description": "A value that is not a Response becomes a 200 response with the value as the body.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "return 'plain value';",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "bodyText": "plain value"
+      }
+    },
+    {
+      "id": "functions-default-cache-control",
+      "description": "A function response without cache-control gets private, max-age=0.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "return new Response('ok');",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "headers": {
+          "cache-control": "private, max-age=0"
+        }
+      }
+    },
+    {
+      "id": "functions-keeps-its-cache-control",
+      "description": "A cache-control that the function sets is kept.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "return new Response('ok', { headers: { 'cache-control': 'public, max-age=60' } });",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "headers": {
+          "cache-control": "public, max-age=60"
+        }
+      }
+    },
+    {
+      "id": "functions-set-cookie-group",
+      "description": "Each set-cookie header that the function sets reaches the client.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "const headers = new Headers();\nheaders.append('set-cookie', 'a=1; Path=/');\nheaders.append('set-cookie', 'b=2; Path=/');\nreturn new Response('ok', { headers });",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 200,
+        "headers": {
+          "set-cookie": [
+            "a=1; Path=/",
+            "b=2; Path=/"
+          ]
+        }
+      }
+    },
+    {
+      "id": "functions-thrown-error-500",
+      "description": "A function that throws gives a 500 response without the error message.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "throw new Error('function broke');",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 500,
+        "bodyExcludes": [
+          "function broke"
+        ]
+      }
+    },
+    {
+      "id": "functions-thrown-error-empty-body",
+      "description": "The 500 response for a thrown error has an empty body.",
+      "tags": [
+        "functions",
+        "unverified"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "throw new Error('function broke');",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 500,
+        "bodyText": ""
+      }
+    },
+    {
+      "id": "functions-rejected-promise-500",
+      "description": "A function whose promise rejects gives a 500 response.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0001-4000-8000-000000000001",
+        "type": "function",
+        "body": "await Promise.reject(new Error('rejected'));",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/api"
+        }
+      },
+      "expect": {
+        "status": 500,
+        "bodyExcludes": [
+          "rejected"
+        ]
+      }
+    },
+    {
+      "id": "functions-auth-deny-response",
+      "description": "An auth function response that is not 201 is the response to the client.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0002-4000-8000-000000000002",
+        "type": "auth",
+        "body": "return new Response('Forbidden', { status: 403 });",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/members/area"
+        }
+      },
+      "expect": {
+        "status": 403,
+        "bodyText": "Forbidden"
+      }
+    },
+    {
+      "id": "functions-auth-needs-a-response",
+      "description": "An auth function that does not return a Response gives a 500 response.",
+      "tags": [
+        "functions"
+      ],
+      "op": "runFunction",
+      "input": {
+        "uuid": "b2c3d4e5-0002-4000-8000-000000000002",
+        "type": "auth",
+        "body": "return 'yes';",
+        "request": {
+          "method": "GET",
+          "url": "https://www.example.com/members/area"
+        }
+      },
+      "expect": {
+        "status": 500
+      }
+    }
+  ]
+}