test: test with properly-formatted URLs

Author: cwillisf

test/fixtures/known-assets.js

@@ -3,6 +3,16 @@ const path = require('path');
 
 const md5 = require('js-md5');
 
+/**
+ * @typedef {object} KnownAsset
+ * @property {Buffer} content - The content of the asset.
+ * @property {string} hash - The MD5 hash of the asset content.
+ */
+
+/**
+ * @typedef {{[id: string]: KnownAsset}} KnownAssetCollection
+ */
+
 const projects = [
     '117504922'
 ];
@@ -15,6 +25,11 @@ const assets = [
     'fe5e3566965f9de793beeffce377d054.jpg'
 ];
 
+/**
+ * Load a file from disk, then return its content and hash.
+ * @param {string} filename - The file to load
+ * @returns {KnownAsset} The loaded asset
+ */
 const loadSomething = filename => {
     const fullPath = path.join(__dirname, 'assets', filename);
     const content = fs.readFileSync(fullPath);
@@ -25,6 +40,11 @@ const loadSomething = filename => {
     };
 };
 
+/**
+ * Load a project from disk, ensure it's valid JSON, then return its content and hash.
+ * @param {string} id - The project ID
+ * @returns {KnownAsset} The loaded project asset
+ */
 const loadProject = id => {
     const filename = `${id}.json`;
     const result = loadSomething(filename);
@@ -35,6 +55,11 @@ const loadProject = id => {
     return result;
 };
 
+/**
+ * Load an asset from disk, ensuring its hash matches its filename.
+ * @param {string} filename - The file to load
+ * @returns {KnownAsset} The loaded asset
+ */
 const loadAsset = filename => {
     const result = loadSomething(filename);
 
@@ -46,15 +71,18 @@ const loadAsset = filename => {
     return result;
 };
 
+/**
+ * @type {KnownAssetCollection}
+ */
 const knownAssets = Object.assign({},
     projects.reduce((bag, id) => {
         bag[id] = loadProject(id);
         return bag;
-    }, {}),
+    }, /** @type {KnownAssetCollection} */ ({})),
     assets.reduce((bag, filename) => {
         bag[filename] = loadAsset(filename);
         return bag;
-    }, {})
+    }, /** @type {KnownAssetCollection} */ ({}))
 );
 
 module.exports = knownAssets;

test/fixtures/mockFetch.js

@@ -37,7 +37,7 @@ const successText = 'successful response';
  * @returns {Promise<MockFetchResponse>} A promise for a Response-like object. Does not fully implement Response.
  */
 const mockFetch = (resource, options) => {
-    /** @type MockFetchResponse */
+    /** @type {MockFetchResponse} */
     const results = {
         ok: false,
         status: 0
@@ -46,13 +46,15 @@ const mockFetch = (resource, options) => {
         options.mockFetchTestData.headers = new Headers(options.headers);
         options.mockFetchTestData.headersCount = Array.from(options.mockFetchTestData.headers).length;
     }
-    const assetInfo = knownAssets[resource];
+    const request = new Request(resource, options);
+    const path = new URL(request.url).pathname.slice(1); // remove leading '/'
+    const assetInfo = knownAssets[path];
     if (assetInfo) {
         results.ok = true;
         results.status = 200;
         results.arrayBuffer = () => Promise.resolve(assetInfo.content);
     } else {
-        switch (resource) {
+        switch (path) {
         case '200':
             results.ok = true;
             results.status = 200;

test/integration/download-known-assets.test.js

@@ -75,11 +75,11 @@ const addWebStores = storage => {
     // in the real world they would generate proper URIs
     storage.addWebStore(
         [storage.AssetType.Project],
-        asset => asset.assetId,
+        asset => `http://example.com/${asset.assetId}`,
         null, null);
     storage.addWebStore(
         [storage.AssetType.ImageVector, storage.AssetType.ImageBitmap, storage.AssetType.Sound],
-        asset => `${asset.assetId}.${asset.dataFormat}`,
+        asset => `http://example.com/${asset.assetId}.${asset.dataFormat}`,
         null, null
     );
 };

test/unit/fetch-tool.test.js

@@ -8,7 +8,7 @@ const {FetchTool} = require('../../src/FetchTool');
 test('send success returns response.text()', async () => {
     const tool = new FetchTool();
 
-    const result = await tool.send({url: '200'});
+    const result = await tool.send({url: 'http://example.com/200'});
     expect(result).toBe(mockFetch.successText);
 });
 
@@ -18,7 +18,7 @@ test('send failure returns response.status', async () => {
     const catcher = jest.fn();
 
     try {
-        await tool.send({url: '500'});
+        await tool.send({url: 'http://example.com/500'});
     } catch (e) {
         catcher(e);
     }
@@ -32,14 +32,14 @@ test('get success returns Uint8Array.body(response.arrayBuffer())', async () =>
 
     const tool = new FetchTool();
 
-    const result = await tool.get({url: '200'});
+    const result = await tool.get({url: 'http://example.com/200'});
     expect(decoder.decode(result)).toBe(mockFetch.successText);
 });
 
 test('get with 404 response returns null data', async () => {
     const tool = new FetchTool();
 
-    const result = await tool.get({url: '404'});
+    const result = await tool.get({url: 'http://example.com/404'});
     expect(result).toBeNull();
 });
 
@@ -48,7 +48,7 @@ test('get failure returns response.status', async () => {
     const catcher = jest.fn();
 
     try {
-        await tool.get({url: '500'});
+        await tool.get({url: 'http://example.com/500'});
     } catch (e) {
         catcher(e);
     }

test/unit/metadata.test.js

@@ -18,7 +18,7 @@ test('get without metadata', async () => {
     const tool = new FetchTool();
 
     const mockFetchTestData = {};
-    const result = await tool.get({url: '200', mockFetchTestData});
+    const result = await tool.get({url: 'http://example.com/200', mockFetchTestData});
 
     expect(result).toBeInstanceOf(Uint8Array);
     expect(mockFetchTestData.headers).toBeTruthy();
@@ -36,7 +36,7 @@ test('get with metadata', async () => {
     setMetadata(RequestMetadata.RunId, 5678);
 
     const mockFetchTestData = {};
-    const result = await tool.get({url: '200', mockFetchTestData});
+    const result = await tool.get({url: 'http://example.com/200', mockFetchTestData});
 
     expect(result).toBeInstanceOf(Uint8Array);
     expect(mockFetchTestData.headers).toBeTruthy();
@@ -50,7 +50,7 @@ test('send without metadata', async () => {
     const tool = new FetchTool();
 
     const mockFetchTestData = {};
-    const result = await tool.send({url: '200', mockFetchTestData});
+    const result = await tool.send({url: 'http://example.com/200', mockFetchTestData});
 
     expect(typeof result).toBe('string');
     expect(mockFetchTestData.headers).toBeTruthy();
@@ -68,7 +68,7 @@ test('send with metadata', async () => {
     setMetadata(RequestMetadata.RunId, 8765);
 
     const mockFetchTestData = {};
-    const result = await tool.send({url: '200', mockFetchTestData});
+    const result = await tool.send({url: 'http://example.com/200', mockFetchTestData});
 
     expect(typeof result).toBe('string');
     expect(mockFetchTestData.headers).toBeTruthy();
@@ -90,7 +90,7 @@ test('selectively delete metadata', async () => {
 
     const mockFetchTestData = {};
 
-    const result1 = await tool.send({url: '200', mockFetchTestData});
+    const result1 = await tool.send({url: 'http://example.com/200', mockFetchTestData});
     expect(typeof result1).toBe('string');
     expect(mockFetchTestData.headers).toBeTruthy();
 
@@ -101,7 +101,7 @@ test('selectively delete metadata', async () => {
     // remove the Project ID from metadata
     unsetMetadata(RequestMetadata.ProjectId);
 
-    const result2 = await tool.send({url: '200', mockFetchTestData});
+    const result2 = await tool.send({url: 'http://example.com/200', mockFetchTestData});
     expect(typeof result2).toBe('string');
     expect(mockFetchTestData.headers).toBeTruthy();
 
@@ -121,7 +121,7 @@ test('metadata has case-insensitive keys', async () => {
     const tool = new FetchTool();
 
     const mockFetchTestData = {};
-    await tool.get({url: '200', mockFetchTestData});
+    await tool.get({url: 'http://example.com/200', mockFetchTestData});
 
     expect(mockFetchTestData.headers).toBeTruthy();
     expect(mockFetchTestData.headersCount).toBe(1);