KV Storage: update to match IDL

Along with https://chromium-review.googlesource.com/c/chromium/src/+/1670572, this aligns the KV Storage implementation with WICG/kv-storage#68, which uses Web IDL to define the API. The observable changes are to: * Enumerability of methods * Adding @@toStringTag (affecting Object.prototype.toString.call) This includes web platform tests that abuse the current idlharness.js infrastructure, plus some ad-hoc hand-written tests that we expect to be generated by future versions of idlharness.js once the relevant Web IDL pull requests are merged. It removes the existing API surface tests and helpers in favor of idlharness.js. Bug: 931263 Change-Id: I9205d1a8b3040617cbb6200f825ba9ad250e61c5
web-platform-tests · Jun 24, 2019 · f353e91 · f353e91
1 parent ec977de
commit f353e91
Show file tree

Hide file tree

Showing 9 changed files with 236 additions and 239 deletions.
diff --git a/kv-storage/api-surface.https.html b/kv-storage/api-surface.https.html
diff --git a/kv-storage/entries.https.html b/kv-storage/entries.https.html
@@ -7,7 +7,7 @@
 
 <script type="module">
 import { testWithArea } from "./helpers/kvs-tests.js";
-import * as classAssert from "./helpers/class-assert.js";
+import * as iterAssert from "./helpers/iter-assert.js";
 import {
   assertAsyncIteratorEquals,
   assertAsyncIteratorCustomEquals,
@@ -76,7 +76,7 @@
     await iter.next()
   ];
 
-  classAssert.iterResultsCustom(
+  iterAssert.iterResultsCustom(
     iterResults,
     [
       [[1, "value 1"], false],
@@ -106,7 +106,7 @@
   ];
   const iterResults = await Promise.all(promises);
 
-  classAssert.iterResultsCustom(
+  iterAssert.iterResultsCustom(
     iterResults,
     [
       [[1, "value 1"], false],

diff --git a/kv-storage/helpers/class-assert.js b/kv-storage/helpers/class-assert.js
diff --git a/kv-storage/helpers/expose-as-global.html b/kv-storage/helpers/expose-as-global.html
@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<title>Helper file to be loaded in an iframe that exposes a copy of StorageArea as a global</title>
+
+<script type="module">
+import { StorageArea } from "std:kv-storage";
+window.StorageArea = StorageArea;
+</script>
diff --git a/kv-storage/helpers/iter-assert.js b/kv-storage/helpers/iter-assert.js
@@ -0,0 +1,42 @@
+export function iterResultCustom(o, expectedValue, expectedDone, valueAsserter, label) {
+  label = formatLabel(label);
+
+  assert_equals(typeof expectedDone, "boolean",
+    `${label} iterResult assert usage check: expectedDone must be a boolean`);
+
+  propertyKeys(o, ["value", "done"], [], label);
+  assert_equals(Object.getPrototypeOf(o), Object.prototype, `${label}prototype must be Object.prototype`);
+  valueAsserter(o.value, expectedValue, `${label}value`);
+  assert_equals(o.done, expectedDone, `${label}done`);
+}
+
+export function iterResult(o, expectedValue, expectedDone, label) {
+  return iterResultCustom(o, expectedValue, expectedDone, assert_equals, label);
+}
+
+export function iterResultsCustom(actualArray, expectedArrayOfArrays, valueAsserter, label) {
+  label = formatLabel(label);
+
+  assert_equals(actualArray.length, expectedArrayOfArrays.length,
+    `${label} iterResults assert usage check: actual and expected must have the same length`);
+
+  for (let i = 0; i < actualArray.length; ++i) {
+    const [expectedValue, expectedDone] = expectedArrayOfArrays[i];
+    iterResultCustom(actualArray[i], expectedValue, expectedDone, valueAsserter, `${label}iter result ${i}`);
+  }
+}
+
+export function iterResults(actualArray, expectedArrayOfArrays, label) {
+  return iterResultsCustom(actualArray, expectedArrayOfArrays, assert_equals, label);
+}
+
+function propertyKeys(o, expectedNames, expectedSymbols, label) {
+  label = formatLabel(label);
+  assert_array_equals(Object.getOwnPropertyNames(o), expectedNames, `${label}property names`);
+  assert_array_equals(Object.getOwnPropertySymbols(o), expectedSymbols,
+    `${label}property symbols`);
+}
+
+function formatLabel(label) {
+  return label !== undefined ? `${label} ` : "";
+}