@siteimprove/alfa-cypress 0.76.0 → 0.76.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @siteimprove/alfa-cypress
 
+## 0.76.1
+
+### Patch Changes
+
+- **Added:** The page URL is now correctly filled when grabbing the page. ([#116](https://github.com/Siteimprove/alfa-integrations/pull/116))
+
+  A full `Request` and `Response` are build, with sensible values:
+
+  - The request is assumed to be a GET.
+  - The response is assumed to be a 200 OK with HTMl content.
+
+  These values are not always correct, but should be in most cases. It is not really possible to build better values because the actual request and response may be long lost by the time one decides to call `.toPage`.
+
 ## 0.76.0
 
 ## 0.75.0

package/dist/cypress.js

@@ -3,7 +3,8 @@
 import { Asserter } from "@siteimprove/alfa-assert";
 import { Device } from "@siteimprove/alfa-device";
 import { Document, Node } from "@siteimprove/alfa-dom";
-import { Request, Response } from "@siteimprove/alfa-http";
+import { Header, Headers, Request, Response } from "@siteimprove/alfa-http";
+import { URL } from "@siteimprove/alfa-url";
 import { Page } from "@siteimprove/alfa-web";
 import * as device from "@siteimprove/alfa-device/native";
 import * as dom from "@siteimprove/alfa-dom/native";
@@ -51,7 +52,25 @@ export var Cypress;
             : undefined) ?? window;
         const deviceJSON = device.Native.fromWindow(view);
         const pageDevice = Device.from(deviceJSON);
-        return Page.of(Request.empty(), Response.empty(), nodeJSON.type === "document"
+        /*
+         * We cannot really grab the request and response as they may have been
+         * long-lost when .toPage is called. We can at least grab the current URL
+         * and fill the rest with reasonable defaults values. Given that we do not
+         * really use these in the audit, this is mostly OK.
+         *
+         * Known caveats:
+         * * We assume that the request was a GET and the response a 200 OK. This is
+         *   probably not too wrong in most cases, but can easily be completely off.
+         * * We assume that the response was HTML. This is probably mostly correct.
+         * * We always return an empty Headers list; this is most likely wrong since
+         *   at least a Content-Type header should be present on the response.
+         */
+        // WARNING: This will throw an exception in the unlikely case that
+        // window.location.href is not a valid URL (which should never happen)
+        const url = URL.parse(view.location.href).getUnsafe();
+        const request = Request.of("GET", url);
+        const response = Response.of(url, 200, Headers.of([Header.of("Content-Type", "text/html")]));
+        return Page.of(request, response, nodeJSON.type === "document"
             ? Document.from(nodeJSON, pageDevice)
             : Document.of([Node.from(nodeJSON, pageDevice)]), pageDevice);
     }

package/package.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/package",
   "name": "@siteimprove/alfa-cypress",
   "homepage": "https://alfa.siteimprove.com",
-  "version": "0.76.0",
+  "version": "0.76.1",
   "license": "MIT",
   "description": "Integrations and utilities for the Cypress testing framework",
   "repository": {
@@ -26,14 +26,15 @@
   },
   "dependencies": {
     "@siteimprove/alfa-act": "^0.96.0",
-    "@siteimprove/alfa-assert": "^0.76.0",
+    "@siteimprove/alfa-assert": "^0.76.1",
     "@siteimprove/alfa-device": "^0.96.0",
     "@siteimprove/alfa-dom": "^0.96.0",
-    "@siteimprove/alfa-formatter": "^0.76.0",
-    "@siteimprove/alfa-formatter-earl": "^0.76.0",
+    "@siteimprove/alfa-formatter": "^0.76.1",
+    "@siteimprove/alfa-formatter-earl": "^0.76.1",
     "@siteimprove/alfa-hash": "^0.96.0",
     "@siteimprove/alfa-http": "^0.96.0",
     "@siteimprove/alfa-mapper": "^0.96.0",
+    "@siteimprove/alfa-url": "^0.96.0",
     "@siteimprove/alfa-web": "^0.96.0",
     "cypress": "^13.14.2"
   },
@@ -44,6 +45,7 @@
     "@siteimprove/alfa-hash": "^0.96.0",
     "@siteimprove/alfa-http": "^0.96.0",
     "@siteimprove/alfa-mapper": "^0.96.0",
+    "@siteimprove/alfa-url": "^0.96.0",
     "@siteimprove/alfa-web": "^0.96.0",
     "cypress": "^13.14.2"
   },