Merge branch 'master' into graph-traversal

* master:
  Update changelog
  Introduce `@siteimprove/alfa-url` package (#421)
  Mark `Property` as internal
  Default `Import` condition to `None`

CHANGELOG.md

@@ -21,8 +21,20 @@ Items that are related, such as breaking changes, new features, or changes to ex
 
 ## [Unreleased]
 
+### Breaking
+
+- [@siteimprove/alfa-predicate](packages/alfa-predicate): The `Predicate<T>` type now no longer duals as a refinement type. This behavior has instead been split out into the new `Refinement<T, U extends T>` type. This also means that none of the functions on the `Predicate` namespace will perform type narrowing. Instead, an equivalent function on the `Refinement` namespace should be used if type narrowing is desired. ([#415](../../pull/415))
+
+- [@siteimprove/alfa-http](packages/alfa-http): `Request#url` and `Response#url` now return `URL` instances rather than strings. ([#421](../../pull/421))
+
+- [@siteimprove/alfa-frontier](packages/alfa-frontier), [@siteimprove/alfa-scraper](packages/alfa-scraper): `Frontier` and `Scraper` now work on `URL` instances from the @siteimprove/alfa-url package rather than WHATWG URL instances. ([#421](../../pull/421))
+
 ### Added
 
+- [@siteimprove/alfa-refinement](packages/alfa-refinement): A new package has been added with functionality for working with refinement types, also known as type guards in TypeScript. ([#415](../../pull/415))
+
+- [@siteimprove/alfa-url](packages/alfa-url): A new package has been added with an implementation of an immutable URL representation. ([#421](../../pull/421))
+
 - [@siteimprove/alfa-result](packages/alfa-result): `Result` now provides an implementation of `Hashable`.
 
 - [@siteimprove/alfa-iterable](packages/alfa-iterable): `Iterable#takeLastWhile()`, `Iterable#takeLastUntil()`, `Iterable#skipLastWhile()`, `Iterable#skipLastUntil()`, `Iterable#trimLeading()`, `Iterable#trimTrailing()`, `Iterable#trim()`, and `Iterable#hash()` are now available.
@@ -33,10 +45,14 @@ Items that are related, such as breaking changes, new features, or changes to ex
 
 - [@siteimprove/alfa-sequence](packages/alfa-sequence): `Nil#hash()` now writes a size of 0 to prevent some avoidable collisions.
 
+- [@siteimprove/alfa-rules](packages/alfa-rules): SIA-R57 now only applies when at least one landmark is found one the page. ([#414](../../pull/414))
+
 ### Fixed
 
 - [@siteimprove/alfa-rules](packages/alfa-rules): SIA-R14 now only applies to focusable widgets with either an `aria-label` or `aria-labelledby` attribute, as intended. ([#409](../../pull/409))
 
+- [@siteimprove/alfa-rules](packages/alfa-rules): SIA-R68 now correctly excludes descendants of containers with an `aria-busy=true` attribute. ([#418](../../pull/418))
+
 - [@siteimprove/alfa-thunk](packages/alfa-thunk): `Thunk.flatMap()` now correctly defers evaluation of the passed thunk.
 
 ## [0.5.0](../../compare/v0.4.1...v0.5.0) (2020-09-22)

docs/examples/custom-testing/crawling/test.ts

@@ -25,18 +25,18 @@ Crawler.with(async (crawler) => {
 
       const earl = outcomes.map((outcome) => outcome.toEARL());
 
-      const url = new URL(input.response.url);
+      const { url } = input.response;
 
-      console.group(url.href);
+      console.group(url.toString());
       logStats(outcomes);
       console.groupEnd();
 
       const file =
         path.join(
           __dirname,
           "outcomes",
-          url.host,
-          url.pathname.replace(/\/$/, "")
+          url.host.get(),
+          ...url.path.filter((segment) => segment !== "")
         ) + ".json";
 
       fs.mkdirSync(path.dirname(file), { recursive: true });

docs/examples/custom-testing/scraping/test.ts

@@ -21,18 +21,18 @@ Scraper.with(async (scraper) => {
 
     const earl = outcomes.map((outcome) => outcome.toEARL());
 
-    const url = new URL(input.response.url);
+    const { url } = input.response;
 
-    console.group(url.href);
+    console.group(url.toString());
     logStats(outcomes);
     console.groupEnd();
 
     const file =
       path.join(
         __dirname,
         "outcomes",
-        url.host,
-        url.pathname.replace(/\/$/, "")
+        url.host.get(),
+        ...url.path.filter((segment) => segment !== "")
       ) + ".json";
 
     fs.mkdirSync(path.dirname(file), { recursive: true });

packages/alfa-cli/bin/alfa/command/scrape/run.ts

@@ -15,6 +15,7 @@ import {
   Screenshot,
 } from "@siteimprove/alfa-scraper";
 import { Timeout } from "@siteimprove/alfa-time";
+import { URL } from "@siteimprove/alfa-url";
 
 import type { Arguments } from "./arguments";
 import type { Flags } from "./flags";
@@ -139,7 +140,7 @@ export const run: Command.Runner<typeof Flags, typeof Arguments> = async ({
   const timeout = Timeout.of(flags.timeout);
 
   const result = await scraper.scrape(
-    new URL(target, url.pathToFileURL(process.cwd() + path.sep)),
+    URL.parse(target, url.pathToFileURL(process.cwd() + path.sep).href).get(),
     {
       timeout,
       awaiter,

packages/alfa-cli/package.json

@@ -35,6 +35,7 @@
     "@siteimprove/alfa-rules": "^0.5.0",
     "@siteimprove/alfa-scraper": "^0.5.0",
     "@siteimprove/alfa-time": "^0.5.0",
+    "@siteimprove/alfa-url": "^0.5.0",
     "@siteimprove/alfa-web": "^0.5.0",
     "@siteimprove/alfa-xpath": "^0.5.0",
     "@types/node": "^14.0.12",

packages/alfa-cli/tsconfig.json

@@ -90,6 +90,9 @@
     {
       "path": "../alfa-time"
     },
+    {
+      "path": "../alfa-url"
+    },
     {
       "path": "../alfa-web"
     },

packages/alfa-crawler/package.json

@@ -23,6 +23,7 @@
     "@siteimprove/alfa-mapper": "^0.5.0",
     "@siteimprove/alfa-result": "^0.5.0",
     "@siteimprove/alfa-scraper": "^0.5.0",
+    "@siteimprove/alfa-url": "^0.5.0",
     "@siteimprove/alfa-web": "^0.5.0"
   },
   "devDependencies": {

packages/alfa-crawler/src/crawler.ts

@@ -3,6 +3,7 @@ import { Frontier } from "@siteimprove/alfa-frontier";
 import { Mapper } from "@siteimprove/alfa-mapper";
 import { Result } from "@siteimprove/alfa-result";
 import { Scraper, Screenshot } from "@siteimprove/alfa-scraper";
+import { URL } from "@siteimprove/alfa-url";
 import { Page } from "@siteimprove/alfa-web";
 
 const { isElement } = Element;
@@ -19,10 +20,12 @@ export class Crawler {
     scraper?: Promise<Scraper>
   ): Promise<T> {
     const crawler = await this.of(scraper);
-    const result = await mapper(crawler);
 
-    await crawler.close();
-    return result;
+    try {
+      return await mapper(crawler);
+    } finally {
+      await crawler.close();
+    }
   }
 
   private readonly _scraper: Scraper;
@@ -53,8 +56,8 @@ export class Crawler {
         frontier.complete(url);
 
         for (const page of result) {
-          if (page.response.url !== url.href) {
-            frontier.redirect(url.href, page.response.url);
+          if (!page.response.url.equals(url)) {
+            frontier.redirect(url, page.response.url);
           }
 
           for (const url of urls(page)) {
@@ -94,7 +97,7 @@ function* urls(page: Page): Iterable<URL> {
     if (isElement(node) && node.name === "a") {
       yield* node
         .attribute("href")
-        .map((href) => new URL(href.value, page.response.url));
+        .map((href) => URL.parse(href.value, page.response.url).get());
     }
   }
 }

packages/alfa-crawler/test/crawler.spec.ts

@@ -15,7 +15,7 @@ test("#crawl() crawls a frontier", async (t) =>
     for await (const result of crawler.crawl(frontier)) {
       t.equal(result.isOk(), true);
 
-      pages.push(result.get().response.url);
+      pages.push(result.get().response.url.toString());
     }
 
     t.deepEqual(pages, [

packages/alfa-crawler/tsconfig.json

@@ -21,6 +21,9 @@
     {
       "path": "../alfa-test"
     },
+    {
+      "path": "../alfa-url"
+    },
     {
       "path": "../alfa-web"
     }

packages/alfa-dom/src/style/rule/import.ts

@@ -1,4 +1,4 @@
-import { Option } from "@siteimprove/alfa-option";
+import { Option, None } from "@siteimprove/alfa-option";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Rule } from "../rule";
@@ -9,7 +9,7 @@ export class Import extends Condition {
   public static of(
     href: string,
     sheet: Sheet,
-    condition: Option<string>
+    condition: Option<string> = None
   ): Import {
     return new Import(href, sheet, condition);
   }

packages/alfa-frontier/package.json

@@ -21,7 +21,8 @@
     "@siteimprove/alfa-equatable": "^0.5.0",
     "@siteimprove/alfa-json": "^0.5.0",
     "@siteimprove/alfa-option": "^0.5.0",
-    "@siteimprove/alfa-predicate": "^0.5.0"
+    "@siteimprove/alfa-predicate": "^0.5.0",
+    "@siteimprove/alfa-url": "^0.5.0"
   },
   "devDependencies": {
     "@siteimprove/alfa-test": "^0.5.0"

packages/alfa-frontier/src/frontier.ts

@@ -2,6 +2,7 @@ import { Equatable } from "@siteimprove/alfa-equatable";
 import { Serializable } from "@siteimprove/alfa-json";
 import { Option, None } from "@siteimprove/alfa-option";
 import { Predicate } from "@siteimprove/alfa-predicate";
+import { URL } from "@siteimprove/alfa-url";
 
 import * as json from "@siteimprove/alfa-json";
 
@@ -35,7 +36,7 @@ export class Frontier implements Equatable, Serializable {
   }
 
   public isInScope(url: string | URL): boolean {
-    return toURL(url).href.startsWith(this._scope.href);
+    return toURL(url).toString().startsWith(this._scope.toString());
   }
 
   public hasWaiting(): boolean {
@@ -186,15 +187,15 @@ export class Frontier implements Equatable, Serializable {
   public equals(value: unknown): value is this {
     return (
       value instanceof Frontier &&
-      value._scope.href === this._scope.href &&
+      value._scope.equals(this._scope) &&
       value._items.length === this._items.length &&
       value._items.every((item, i) => item.equals(this._items[i]))
     );
   }
 
   public toJSON(): Frontier.JSON {
     return {
-      scope: this._scope.href,
+      scope: this._scope.toString(),
       items: this._items.map((item) => item.toJSON()),
     };
   }
@@ -269,10 +270,7 @@ class Item implements Equatable, Serializable {
   public matches(url: string | URL): boolean {
     url = toURL(url);
 
-    return (
-      this._url.href === url.href ||
-      this._aliases.some(property("href", equals(url.href)))
-    );
+    return this._url.equals(url) || this._aliases.some(equals(url));
   }
 
   public transition(state: State): boolean {
@@ -304,10 +302,7 @@ class Item implements Equatable, Serializable {
   public alias(url: string | URL): boolean {
     url = toURL(url);
 
-    if (
-      this._url.href === url.href ||
-      this._aliases.some(property("href", equals(url.href)))
-    ) {
+    if (this._url.equals(url) || this._aliases.some(equals(url))) {
       return false;
     }
 
@@ -319,7 +314,7 @@ class Item implements Equatable, Serializable {
   public redirect(target: string | URL): boolean {
     target = toURL(target);
 
-    if (this._url.href === target.href) {
+    if (this._url.equals(target)) {
       return false;
     }
 
@@ -332,19 +327,17 @@ class Item implements Equatable, Serializable {
   public equals(value: unknown): value is this {
     return (
       value instanceof Item &&
-      value._url.href === this._url.href &&
+      value._url.equals(this._url) &&
       value._aliases.length === this._aliases.length &&
-      value._aliases.every(
-        (alias, i) => alias.href === this._aliases[i].href
-      ) &&
+      value._aliases.every((alias, i) => alias.equals(this._aliases[i])) &&
       value._state === this._state
     );
   }
 
   public toJSON(): Item.JSON {
     return {
-      url: this._url.href,
-      aliases: this._aliases.map((url) => url.href),
+      url: this._url.toString(),
+      aliases: this._aliases.map((url) => url.toString()),
       state: this._state,
     };
   }
@@ -360,11 +353,10 @@ namespace Item {
 }
 
 function toURL(url: string | URL): URL {
-  url = typeof url === "string" ? new URL(url) : url;
-  url.hash = "";
-  return url;
+  url = typeof url === "string" ? URL.parse(url).get() : url;
+  return url.withoutFragment();
 }
 
 function isInScope(scope: string | URL, url: string | URL): boolean {
-  return toURL(url).href.startsWith(toURL(scope).href);
+  return toURL(url).toString().startsWith(toURL(scope).toString());
 }

packages/alfa-frontier/test/frontier.spec.ts

@@ -106,7 +106,7 @@ test("#enqueue() doesn't change the state of an already seen URL", (t) => {
 test("#dequeue() gets the next waiting URL in queue and moves it to in progress", (t) => {
   const frontier = Frontier.of("https://example.com/");
 
-  t.deepEqual(frontier.dequeue().get(), new URL("https://example.com"));
+  t.deepEqual(frontier.dequeue().get().toString(), "https://example.com/");
 
   t.deepEqual(frontier.toJSON(), {
     scope: "https://example.com/",

packages/alfa-frontier/tsconfig.json

@@ -17,6 +17,9 @@
     },
     {
       "path": "../alfa-test"
+    },
+    {
+      "path": "../alfa-url"
     }
   ]
 }

packages/alfa-http/package.json

@@ -25,7 +25,8 @@
     "@siteimprove/alfa-json": "^0.5.0",
     "@siteimprove/alfa-map": "^0.5.0",
     "@siteimprove/alfa-option": "^0.5.0",
-    "@siteimprove/alfa-refinement": "^0.5.0"
+    "@siteimprove/alfa-refinement": "^0.5.0",
+    "@siteimprove/alfa-url": "^0.5.0"
   },
   "devDependencies": {
     "@siteimprove/alfa-test": "^0.5.0"