scratch-storage 2.2.0 → 2.2.1

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "scratch-storage",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Load and store project and asset files for Scratch 3.0",
   "license": "BSD-3-Clause",
   "homepage": "https://github.com/LLK/scratch-storage#readme",
   "repository": {
     "type": "git",
     "url": "https://github.com/LLK/scratch-storage.git",
-    "sha": "5c6588073bb3c9ba4500403054d6409db2379286"
+    "sha": "4294057468737f2e179afe2cc963326d20942aed"
   },
   "main": "./dist/node/scratch-storage.js",
   "browser": "./src/index.js",

package/src/FetchWorkerTool.js

@@ -1,4 +1,4 @@
-const {applyMetadata} = require('./scratchFetch');
+const {Headers, applyMetadata} = require('./scratchFetch');
 
 /**
  * Get and send assets with a worker that uses fetch.
@@ -92,6 +92,13 @@ class PrivateFetchWorkerTool {
             const augmentedOptions = applyMetadata(
                 Object.assign({method: 'GET'}, options)
             );
+            // the Fetch spec says options.headers could be:
+            // "A Headers object, an object literal, or an array of two-item arrays to set request's headers."
+            // structured clone (postMessage) doesn't support Headers objects
+            // so turn it into an array of two-item arrays to make it to the worker intact
+            if (augmentedOptions && augmentedOptions.headers instanceof Headers) {
+                augmentedOptions.headers = Array.from(augmentedOptions.headers.entries());
+            }
             this.worker.postMessage({
                 id,
                 url,

package/src/ScratchStorage.js

@@ -6,6 +6,7 @@ const WebHelper = require('./WebHelper');
 const _Asset = require('./Asset');
 const _AssetType = require('./AssetType');
 const _DataFormat = require('./DataFormat');
+const _scratchFetch = require('./scratchFetch');
 
 class ScratchStorage {
     constructor () {
@@ -51,6 +52,14 @@ class ScratchStorage {
         return _DataFormat;
     }
 
+    /**
+     * Access the `scratchFetch` module within this library.
+     * @return {module} the scratchFetch module, with properties for `scratchFetch`, `setMetadata`, etc.
+     */
+    get scratchFetch () {
+        return _scratchFetch;
+    }
+
     /**
      * @deprecated Please use the `Asset` member of a storage instance instead.
      * @return {Asset} - the `Asset` class constructor.

package/src/scratchFetch.js

@@ -1,4 +1,4 @@
-const {fetch, Headers} = require('cross-fetch');
+const crossFetch = require('cross-fetch');
 
 /**
  * Metadata header names
@@ -7,16 +7,27 @@ const {fetch, Headers} = require('cross-fetch');
  */
 const RequestMetadata = {
     /** The ID of the project associated with this request */
-    ProjectId: 'X-ProjectId',
+    ProjectId: 'X-Project-ID',
     /** The ID of the project run associated with this request */
-    RunId: 'X-RunId'
+    RunId: 'X-Run-ID'
 };
 
 /**
- * Metadata for requests
- * @type {Map<string, string>}
+ * Metadata headers for requests
+ * @type {Headers}
  */
-const metadata = new Map();
+const metadata = new crossFetch.Headers();
+
+/**
+ * Check if there is any metadata to apply.
+ * @returns {boolean} true if `metadata` has contents, or false if it is empty.
+ */
+const hasMetadata = () => {
+    for (const _ of metadata) {
+        return true;
+    }
+    return false;
+};
 
 /**
  * Non-destructively merge any metadata state (if any) with the provided options object (if any).
@@ -28,12 +39,15 @@ const metadata = new Map();
  * @returns {RequestInit|undefined} the provided options parameter without modification, or a new options object.
  */
 const applyMetadata = options => {
-    if (metadata.size > 0) {
+    if (hasMetadata()) {
         const augmentedOptions = Object.assign({}, options);
-        augmentedOptions.headers = new Headers(Array.from(metadata));
+        augmentedOptions.headers = new crossFetch.Headers(metadata);
         if (options && options.headers) {
-            const overrideHeaders =
-                options.headers instanceof Headers ? options.headers : new Headers(options.headers);
+            // the Fetch spec says options.headers could be:
+            // "A Headers object, an object literal, or an array of two-item arrays to set request's headers."
+            // turn it into a Headers object to be sure of how to interact with it
+            const overrideHeaders = options.headers instanceof crossFetch.Headers ?
+                options.headers : new crossFetch.Headers(options.headers);
             for (const [name, value] of overrideHeaders.entries()) {
                 augmentedOptions.headers.set(name, value);
             }
@@ -53,7 +67,7 @@ const applyMetadata = options => {
  */
 const scratchFetch = (resource, options) => {
     const augmentedOptions = applyMetadata(options);
-    return fetch(resource, augmentedOptions);
+    return crossFetch.fetch(resource, augmentedOptions);
 };
 
 /**
@@ -78,9 +92,22 @@ const unsetMetadata = name => {
 module.exports = {
     default: scratchFetch,
 
+    Headers: crossFetch.Headers,
     RequestMetadata,
     applyMetadata,
     scratchFetch,
     setMetadata,
     unsetMetadata
 };
+
+if (process.env.NODE_ENV === 'development') {
+    /**
+     * Retrieve a named request metadata item.
+     * Only for use in tests.
+     * @param {RequestMetadata} name The name of the metadata item to retrieve.
+     * @returns {any} value The value of the metadata item, or `undefined` if it was not found.
+     */
+    const getMetadata = name => metadata.get(name);
+
+    module.exports.getMetadata = getMetadata;
+}

package/test/mocks/{mockFetch.js → mock-fetch.js}

@@ -1,6 +1,7 @@
 const TextEncoder = require('util').TextEncoder;
-const {Headers} = require('cross-fetch');
+const crossFetch = require('cross-fetch');
 
+const Headers = crossFetch.Headers;
 const successText = 'successful response';
 
 /**
@@ -58,7 +59,11 @@ const mockFetch = (resource, options) => {
     return Promise.resolve(results);
 };
 
+// Mimic the cross-fetch module, but replace its `fetch` with `mockFetch` and add a few extras
 module.exports = {
+    ...crossFetch, // Headers, Request, Response, etc.
+    default: mockFetch,
+    fetch: mockFetch,
     mockFetch,
     successText
 };

package/test/unit/fetch-tool.js

@@ -1,17 +1,14 @@
 const tap = require('tap');
 const TextDecoder = require('util').TextDecoder;
 
-const {mockFetch, successText} = require('../mocks/mockFetch.js');
+const mockFetch = require('../mocks/mock-fetch.js');
 
 /**
  * This is the real FetchTool, but the 'cross-fetch' module has been replaced with the mockFetch function.
  * @type {typeof import('../../src/FetchTool')}
  */
 const FetchTool = tap.mock('../../src/FetchTool', {
-    'cross-fetch': {
-        default: mockFetch,
-        fetch: mockFetch
-    }
+    'cross-fetch': mockFetch
 });
 
 tap.test('send success returns response.text()', t => {
@@ -19,7 +16,7 @@ tap.test('send success returns response.text()', t => {
 
     return t.resolves(
         tool.send({url: '200'}).then(result => {
-            t.equal(result, successText);
+            t.equal(result, mockFetch.successText);
         })
     );
 });
@@ -38,7 +35,7 @@ tap.test('get success returns Uint8Array.body(response.arrayBuffer())', t => {
 
     return t.resolves(
         tool.get({url: '200'}).then(result => {
-            t.equal(decoder.decode(result), successText);
+            t.equal(decoder.decode(result), mockFetch.successText);
         })
     );
 });

package/test/unit/metadata.js

@@ -1,14 +1,7 @@
 const tap = require('tap');
 
-const crossFetch = require('cross-fetch');
+const mockFetchModule = require('../mocks/mock-fetch.js');
 
-const {mockFetch} = require('../mocks/mockFetch.js');
-
-const mockFetchModule = {
-    ...crossFetch, // Headers, Request, Response, etc.
-    default: mockFetch,
-    fetch: mockFetch
-};
 
 // Call this separately from each test to ensure that metadata gets reset.
 // This is especially important when parallelizing tests!
@@ -39,7 +32,7 @@ tap.test('get without metadata', async t => {
 
     const tool = new FetchTool();
 
-    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    /** @type import('../mocks/mock-fetch.js').MockFetchTestData */
     const mockFetchTestData = {};
     const result = await tool.get({url: '200', mockFetchTestData});
 
@@ -57,7 +50,7 @@ tap.test('get with metadata', async t => {
     setMetadata(RequestMetadata.ProjectId, 1234);
     setMetadata(RequestMetadata.RunId, 5678);
 
-    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    /** @type import('../mocks/mock-fetch.js').MockFetchTestData */
     const mockFetchTestData = {};
     const result = await tool.get({url: '200', mockFetchTestData});
 
@@ -73,7 +66,7 @@ tap.test('send without metadata', async t => {
 
     const tool = new FetchTool();
 
-    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    /** @type import('../mocks/mock-fetch.js').MockFetchTestData */
     const mockFetchTestData = {};
     const result = await tool.send({url: '200', mockFetchTestData});
 
@@ -91,7 +84,7 @@ tap.test('send with metadata', async t => {
     setMetadata(RequestMetadata.ProjectId, 4321);
     setMetadata(RequestMetadata.RunId, 8765);
 
-    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    /** @type import('../mocks/mock-fetch.js').MockFetchTestData */
     const mockFetchTestData = {};
     const result = await tool.send({url: '200', mockFetchTestData});
 
@@ -112,7 +105,7 @@ tap.test('selectively delete metadata', async t => {
 
     const tool = new FetchTool();
 
-    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    /** @type import('../mocks/mock-fetch.js').MockFetchTestData */
     const mockFetchTestData = {};
 
     const result1 = await tool.send({url: '200', mockFetchTestData});
@@ -134,3 +127,21 @@ tap.test('selectively delete metadata', async t => {
     t.equal(mockFetchTestData.headers?.get(RequestMetadata.ProjectId), null); // value `null` means it's missing
     t.equal(mockFetchTestData.headers?.get(RequestMetadata.RunId), 'undefined');
 });
+
+tap.test('metadata has case-insensitive keys', async t => {
+    const {scratchFetchModule, FetchTool} = setupModules();
+    const {setMetadata} = scratchFetchModule;
+
+    setMetadata('foo', 1);
+    setMetadata('FOO', 2);
+
+    const tool = new FetchTool();
+
+    /** @type import('../mocks/mock-fetch.js').MockFetchTestData */
+    const mockFetchTestData = {};
+    await tool.get({url: '200', mockFetchTestData});
+
+    t.ok(mockFetchTestData.headers, 'mockFetch did not report headers');
+    t.equal(mockFetchTestData.headersCount, 1);
+    t.equal(mockFetchTestData.headers?.get('foo'), '2');
+});

package/.nyc_output/processinfo/c826ae6b-4ae2-4d8e-bdb2-162df5761fa7.json

@@ -1 +0,0 @@
-{"parent":null,"pid":263,"argv":["/usr/local/bin/node","/home/circleci/project/node_modules/.bin/tap","./test/integration/download-known-assets.js"],"execArgv":[],"cwd":"/home/circleci/project","time":1679325567414,"ppid":252,"coverageFilename":"/home/circleci/project/.nyc_output/c826ae6b-4ae2-4d8e-bdb2-162df5761fa7.json","externalId":"","uuid":"c826ae6b-4ae2-4d8e-bdb2-162df5761fa7","files":[]}

package/.nyc_output/processinfo/ec2d52a1-5131-4dd0-9c23-59106f297082.json

@@ -1 +0,0 @@
-{"parent":"c826ae6b-4ae2-4d8e-bdb2-162df5761fa7","pid":274,"argv":["/usr/local/bin/node","/home/circleci/project/test/integration/download-known-assets.js"],"execArgv":[],"cwd":"/home/circleci/project","time":1679325568227,"ppid":263,"coverageFilename":"/home/circleci/project/.nyc_output/ec2d52a1-5131-4dd0-9c23-59106f297082.json","externalId":"./test/integration/download-known-assets.js","uuid":"ec2d52a1-5131-4dd0-9c23-59106f297082","files":[]}