depcache spec and reference implementation proposal

guybedford · Feb 22, 2020 · 751ef09 · 751ef09
1 parent d9101de
commit 751ef09
Show file tree

Hide file tree

Showing 16 changed files with 245 additions and 10 deletions.
diff --git a/reference-implementation/__tests__/helpers/common-test-helper.js b/reference-implementation/__tests__/helpers/common-test-helper.js
@@ -3,6 +3,7 @@ const assert = require('assert');
 const { URL } = require('url');
 const { parseFromString } = require('../../lib/parser.js');
 const { resolve } = require('../../lib/resolver.js');
+const { traceDepcache } = require('../../lib/depcache.js');
 
 function assertNoExtraProperties(object, expectedProperties, description) {
   for (const actualProperty in object) {
@@ -59,7 +60,7 @@ function runTests(j) {
   assertNoExtraProperties(
     j,
     [
-      'expectedResults', 'expectedParsedImportMap',
+      'expectedResults', 'expectedParsedImportMap', 'expectedDepcache',
       'baseURL', 'name', 'parsedImportMap',
       'importMap', 'importMapBaseURL',
       'link', 'details'
@@ -85,8 +86,9 @@ function runTests(j) {
     }
     assert(
       'expectedResults' in j ||
-           'expectedParsedImportMap' in j,
-      'expectedResults or expectedParsedImportMap should exist'
+           'expectedParsedImportMap' in j ||
+           'expectedDepcache' in j,
+      'expectedResults, expectedParsedImportMap or expectedDepcache should exist'
     );
 
     // Resolution tests.
@@ -123,6 +125,25 @@ function runTests(j) {
         }
       });
     }
+
+    // Depcache tests
+    if ('expectedDepcache' in j) {
+      it(j.name, () => {
+        assertOwnProperty(j, 'baseURL');
+        describe(
+          'Import map registration should be successful for resolution tests',
+          () => {
+            expect(j.parsedImportMap).not.toBeInstanceOf(Error);
+          }
+        );
+
+        for (const specifier in j.expectedDepcache) {
+          const resolved = resolve(specifier, j.parsedImportMap, new URL(j.baseURL));
+          const traced = traceDepcache(resolved, j.parsedImportMap);
+          expect(traced).toEqual(j.expectedDepcache[specifier]);
+        }
+      });
+    }
   }
 }
 

diff --git a/reference-implementation/__tests__/helpers/matchers.js b/reference-implementation/__tests__/helpers/matchers.js
@@ -15,7 +15,7 @@ expect.extend({
     }
 
     received = received.href;
-    expected = (new URL(expected)).href;
+    expected = new URL(expected).href;
 
     const pass = received === expected;
 

diff --git a/reference-implementation/__tests__/json/depcache.json b/reference-implementation/__tests__/json/depcache.json
@@ -0,0 +1,42 @@
+{
+  "importMapBaseURL": "https://example.com/app/index.html",
+  "tests": {
+    "Depcache resolution": {
+      "importMap": {
+        "imports": {
+          "a": "/a-1.mjs",
+          "b": "/scope/b-1.mjs"
+        },
+        "scopes": {
+          "/a-1.mjs": {
+            "a": "/a-2.mjs"
+          },
+          "/scope/": {
+            "a": "/scope/a-3.mjs",
+            "b": "./b-2.mjs"
+          }
+        },
+        "depcache": {
+          "/a-1.mjs": ["a"],
+          "/a-2.mjs": ["b"],
+          "/scope/b-1.mjs": ["./b-2.mjs"],
+          "/scope/b-2.mjs": ["a"]
+        }
+      },
+      "tests": {
+        "should trace full depcache": {
+          "baseURL": "https://example.com/scope2/foo.mjs",
+          "expectedDepcache": {
+            "a": [
+              "https://example.com/a-1.mjs",
+              "https://example.com/a-2.mjs",
+              "https://example.com/scope/b-1.mjs",
+              "https://example.com/scope/b-2.mjs",
+              "https://example.com/scope/a-3.mjs"
+            ]
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/reference-implementation/__tests__/json/parsing-addresses-absolute.json b/reference-implementation/__tests__/json/parsing-addresses-absolute.json
@@ -20,6 +20,7 @@
       },
       "importMapBaseURL": "https://base.example/path1/path2/path3",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "about": "about:good",
           "blob": "blob:good",
@@ -50,6 +51,7 @@
       },
       "importMapBaseURL": "https://base.example/path1/path2/path3",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "unparseable2": null,
           "unparseable3": null,

diff --git a/reference-implementation/__tests__/json/parsing-addresses-invalid.json b/reference-implementation/__tests__/json/parsing-addresses-invalid.json
@@ -13,6 +13,7 @@
       },
       "importMapBaseURL": "https://base.example/path1/path2/path3",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "foo1": null,
           "foo2": null,

diff --git a/reference-implementation/__tests__/json/parsing-addresses.json b/reference-implementation/__tests__/json/parsing-addresses.json
@@ -3,6 +3,7 @@
   "tests": {
     "should accept strings prefixed with ./, ../, or /": {
       "importMap": {
+        "depcache": {},
         "imports": {
           "dotSlash": "./foo",
           "dotDotSlash": "../foo",
@@ -11,6 +12,7 @@
       },
       "importMapBaseURL": "https://base.example/path1/path2/path3",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "dotSlash": "https://base.example/path1/path2/foo",
           "dotDotSlash": "https://base.example/path1/foo",
@@ -21,6 +23,7 @@
     },
     "should not accept strings prefixed with ./, ../, or / for data: base URLs": {
       "importMap": {
+        "depcache": {},
         "imports": {
           "dotSlash": "./foo",
           "dotDotSlash": "../foo",
@@ -29,6 +32,7 @@
       },
       "importMapBaseURL": "data:text/html,test",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "dotSlash": null,
           "dotDotSlash": null,
@@ -39,6 +43,7 @@
     },
     "should accept the literal strings ./, ../, or / with no suffix": {
       "importMap": {
+        "depcache": {},
         "imports": {
           "dotSlash": "./",
           "dotDotSlash": "../",
@@ -47,6 +52,7 @@
       },
       "importMapBaseURL": "https://base.example/path1/path2/path3",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "dotSlash": "https://base.example/path1/path2/",
           "dotDotSlash": "https://base.example/path1/",
@@ -57,6 +63,7 @@
     },
     "should ignore percent-encoded variants of ./, ../, or /": {
       "importMap": {
+        "depcache": {},
         "imports": {
           "dotSlash1": "%2E/",
           "dotDotSlash1": "%2E%2E/",
@@ -69,6 +76,7 @@
       },
       "importMapBaseURL": "https://base.example/path1/path2/path3",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "dotSlash1": null,
           "dotDotSlash1": null,

diff --git a/reference-implementation/__tests__/json/parsing-schema-normalization.json b/reference-implementation/__tests__/json/parsing-schema-normalization.json
@@ -5,6 +5,7 @@
     "should normalize empty import maps to have imports and scopes keys": {
       "importMap": {},
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {}
       }
@@ -14,6 +15,7 @@
         "scopes": {}
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {}
       }
@@ -23,6 +25,7 @@
         "imports": {}
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {}
       }

diff --git a/reference-implementation/__tests__/json/parsing-schema-specifier-map.json b/reference-implementation/__tests__/json/parsing-schema-specifier-map.json
@@ -17,6 +17,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {
           "null": null,
           "boolean": null,
@@ -36,6 +37,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {}
       }

diff --git a/reference-implementation/__tests__/json/parsing-schema-toplevel.json b/reference-implementation/__tests__/json/parsing-schema-toplevel.json
@@ -89,6 +89,7 @@
         "scops": {}
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {}
       }

diff --git a/reference-implementation/__tests__/json/parsing-scope-keys.json b/reference-implementation/__tests__/json/parsing-scope-keys.json
@@ -8,6 +8,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/foo": {}
@@ -23,6 +24,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/foo": {},
@@ -41,6 +43,7 @@
       },
       "importMapBaseURL": "data:text/html,test",
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {}
       }
@@ -54,6 +57,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/": {},
@@ -69,6 +73,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/foo/bar?baz#qux": {}
@@ -82,6 +87,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/path3": {}
@@ -99,6 +105,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/foo/": {},
@@ -123,6 +130,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/foo//": {
@@ -149,6 +157,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "about:good": {},
@@ -178,6 +187,7 @@
         }
       },
       "expectedParsedImportMap": {
+        "depcache": {},
         "imports": {},
         "scopes": {
           "https://base.example/path1/path2/example.org": {},