scratch-storage 2.2.0 → 2.3.0

package/.circleci/config.yml

@@ -2,7 +2,7 @@
 version: 2.1
 orbs:
   commitlint: conventional-changelog/commitlint@1.0.0
-  node: circleci/node@5.1
+  node: circleci/node@5.1.0
 
 jobs:
   build-and-test:

package/dist/node/scratch-storage.js

@@ -462,39 +462,6 @@ module.exports = _unsupportedIterableToArray, module.exports.__esModule = true,
 
 /***/ }),
 
-/***/ "./node_modules/arraybuffer-loader/index.js!./src/builtins/defaultBitmap.png":
-/*!**************************************************************************!*\
-  !*** ./node_modules/arraybuffer-loader!./src/builtins/defaultBitmap.png ***!
-  \**************************************************************************/
-/*! no static exports found */
-/***/ (function(module, exports, __webpack_require__) {
-
-module.exports = __webpack_require__(/*! ../../node_modules/arraybuffer-loader/lib/to-array-buffer.js */ "./node_modules/arraybuffer-loader/lib/to-array-buffer.js")("iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAAAAADmVT4XAAADZElEQVR42u3a70vbQBgH8O/7vOibvsmbFUEEWUGGUhQ25nDuhSKIUFDxlYi0SAd94atRmFiHCH2x4W8iiNtwowXRgd1QipJYY3N/1F4kTQ6XLKS9yyHcvWyO8MnT5y53Tw5EcIMESIAESIAESIAESIAEPFVAq/6l8G4oAQCp4aniwbUVJ6BVzafwqKXy1VZMgNb+CHzbyK4ZB+Bi0nnk0VyhsDiSoAmvvnMHmGUVAF6UG+0ffsxRhsRHky/AyCsAUpumX0wAAIs6T4CxDADDtcdZsal6gjmdH8AsAEC6+s8Fa48SFExeAKusAEju+V367AmUCi9ANQ0AU3pwcOw2cMEH0FwAAKz5X228pRLR5AI4TgIAtIDL24oLUE94AB6W7LsH/cONN14Ilh44AOqD9s2LQR1KHiB9zgGgOSGeuA3ocPrME1Q4ANaceyePAzrcjHmAZYs9IBeW4/fzHiAwTCwAgTle9ACZK44ALDT9e6x7gL4aT0BQCHb4AqgA5/1TTOMLoJ7vZSMM0H/GHnCeDnu+CrU8vGYPcN5FADBYD0vCaYPDy+i0p337GSMsS1Z4vA3t9QgAZTt0IuIxFRPSKicAQHlvhk3FXF5GhBByMa8qo/sBO6BarwuYbYrYnFKDYEvE7phKgcxvEQBqnvhgiQCUOgoAO4C3JOS3L/hv23UXxVldBECfcueAqpAa0WGy/QeULREAY6aTXRFDgBuA13+ElOncAERMAGaA9hBQD4gQQHsIRE1AZoD2xrgQS5nOZyHgFKmWDSIG4GRAVidiAE4GRB6AzAB2AKIPQFaA5myHA5AV4ESNugZhC7BLR50lIBPAebrzBGQCKAFQNSIMcDvRTQIwAHxNApM3RBygGK0uyhxwOwGsPAgEnPWj5ycRCNiJtBHlAChGKQVwANzPY+CXSMDNWISiLA9AfRA5IhJQ68UnoQAt+AtOPIBKhJosF8B6UM0yLkAxQk2WCyDX9SiUh1gkQAIkoCuAvjGuquMbuijAtwG7MPL8yBICOHSPk3W8Ne8KcEUdmBi6FADYos+QleIH0N/ogOxd7AD6uAS6WRU8WcBdlgZMG/EnYUlwEpLLoQ4PjzGbiA5UsRMRsbQ+5ziDJmYqJuR6NaMomdXuFuZyPSABEiABEiABEiABEiAc8Bd6VyvCEKGqcQAAAABJRU5ErkJggg==")
-
-/***/ }),
-
-/***/ "./node_modules/arraybuffer-loader/index.js!./src/builtins/defaultSound.wav":
-/*!*************************************************************************!*\
-  !*** ./node_modules/arraybuffer-loader!./src/builtins/defaultSound.wav ***!
-  \*************************************************************************/
-/*! no static exports found */
-/***/ (function(module, exports, __webpack_require__) {
-
-module.exports = __webpack_require__(/*! ../../node_modules/arraybuffer-loader/lib/to-array-buffer.js */ "./node_modules/arraybuffer-loader/lib/to-array-buffer.js")("UklGRiYAAABXQVZFZm10IBAAAAABAAEAIlYAAESsAAACABAAZGF0YQIAAAAAAA==")
-
-/***/ }),
-
-/***/ "./node_modules/arraybuffer-loader/index.js!./src/builtins/defaultVector.svg":
-/*!**************************************************************************!*\
-  !*** ./node_modules/arraybuffer-loader!./src/builtins/defaultVector.svg ***!
-  \**************************************************************************/
-/*! no static exports found */
-/***/ (function(module, exports, __webpack_require__) {
-
-module.exports = __webpack_require__(/*! ../../node_modules/arraybuffer-loader/lib/to-array-buffer.js */ "./node_modules/arraybuffer-loader/lib/to-array-buffer.js")("PD94bWwgdmVyc2lvbj0iMS4wIj8+Cjxzdmcgd2lkdGg9IjEyOCIgaGVpZ2h0PSIxMjgiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6c3ZnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiA8Zz4KICA8cmVjdCBmaWxsPSIjQ0NDIiBoZWlnaHQ9IjEyOCIgd2lkdGg9IjEyOCIvPgogIDx0ZXh0IGZpbGw9ImJsYWNrIiB5PSIxMDciIHg9IjM1LjUiIGZvbnQtc2l6ZT0iMTI4Ij4/PC90ZXh0PgogPC9nPgo8L3N2Zz4K")
-
-/***/ }),
-
 /***/ "./node_modules/arraybuffer-loader/lib/to-array-buffer.js":
 /*!****************************************************************!*\
   !*** ./node_modules/arraybuffer-loader/lib/to-array-buffer.js ***!
@@ -5677,19 +5644,19 @@ var DefaultAssets = [{
   type: AssetType.ImageBitmap,
   format: DataFormat.PNG,
   id: null,
-  data: Buffer.from(__webpack_require__(/*! arraybuffer-loader!./builtins/defaultBitmap.png */ "./node_modules/arraybuffer-loader/index.js!./src/builtins/defaultBitmap.png") // eslint-disable-line global-require
+  data: Buffer.from(__webpack_require__(/*! ./builtins/defaultBitmap.png */ "./src/builtins/defaultBitmap.png") // eslint-disable-line global-require
   )
 }, {
   type: AssetType.Sound,
   format: DataFormat.WAV,
   id: null,
-  data: Buffer.from(__webpack_require__(/*! arraybuffer-loader!./builtins/defaultSound.wav */ "./node_modules/arraybuffer-loader/index.js!./src/builtins/defaultSound.wav") // eslint-disable-line global-require
+  data: Buffer.from(__webpack_require__(/*! ./builtins/defaultSound.wav */ "./src/builtins/defaultSound.wav") // eslint-disable-line global-require
   )
 }, {
   type: AssetType.ImageVector,
   format: DataFormat.SVG,
   id: null,
-  data: Buffer.from(__webpack_require__(/*! arraybuffer-loader!./builtins/defaultVector.svg */ "./node_modules/arraybuffer-loader/index.js!./src/builtins/defaultVector.svg") // eslint-disable-line global-require
+  data: Buffer.from(__webpack_require__(/*! ./builtins/defaultVector.svg */ "./src/builtins/defaultVector.svg") // eslint-disable-line global-require
   )
 }];
 /**
@@ -6001,6 +5968,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
 var _require = __webpack_require__(/*! ./scratchFetch */ "./src/scratchFetch.js"),
+    Headers = _require.Headers,
     applyMetadata = _require.applyMetadata;
 /**
  * Get and send assets with a worker that uses fetch.
@@ -6119,7 +6087,14 @@ var PrivateFetchWorkerTool = /*#__PURE__*/function () {
         var id = Math.random().toString(16).substring(2);
         var augmentedOptions = applyMetadata(Object.assign({
           method: 'GET'
-        }, options));
+        }, 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());
+        }
 
         _this2.worker.postMessage({
           id: id,
@@ -6473,6 +6448,8 @@ var _AssetType = __webpack_require__(/*! ./AssetType */ "./src/AssetType.js");
 
 var _DataFormat = __webpack_require__(/*! ./DataFormat */ "./src/DataFormat.js");
 
+var _scratchFetch = __webpack_require__(/*! ./scratchFetch */ "./src/scratchFetch.js");
+
 var ScratchStorage = /*#__PURE__*/function () {
   "use strict";
 
@@ -6522,6 +6499,16 @@ var ScratchStorage = /*#__PURE__*/function () {
     get: function get() {
       return _DataFormat;
     }
+    /**
+     * Access the `scratchFetch` module within this library.
+     * @return {module} the scratchFetch module, with properties for `scratchFetch`, `setMetadata`, etc.
+     */
+
+  }, {
+    key: "scratchFetch",
+    get: function get() {
+      return _scratchFetch;
+    }
     /**
      * @deprecated Please use the `Asset` member of a storage instance instead.
      * @return {Asset} - the `Asset` class constructor.
@@ -6995,6 +6982,39 @@ module.exports = WebHelper;
 
 /***/ }),
 
+/***/ "./src/builtins/defaultBitmap.png":
+/*!****************************************!*\
+  !*** ./src/builtins/defaultBitmap.png ***!
+  \****************************************/
+/*! no static exports found */
+/***/ (function(module, exports, __webpack_require__) {
+
+module.exports = __webpack_require__(/*! ../../node_modules/arraybuffer-loader/lib/to-array-buffer.js */ "./node_modules/arraybuffer-loader/lib/to-array-buffer.js")("iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAAAAADmVT4XAAADZElEQVR42u3a70vbQBgH8O/7vOibvsmbFUEEWUGGUhQ25nDuhSKIUFDxlYi0SAd94atRmFiHCH2x4W8iiNtwowXRgd1QipJYY3N/1F4kTQ6XLKS9yyHcvWyO8MnT5y53Tw5EcIMESIAESIAESIAESIAEPFVAq/6l8G4oAQCp4aniwbUVJ6BVzafwqKXy1VZMgNb+CHzbyK4ZB+Bi0nnk0VyhsDiSoAmvvnMHmGUVAF6UG+0ffsxRhsRHky/AyCsAUpumX0wAAIs6T4CxDADDtcdZsal6gjmdH8AsAEC6+s8Fa48SFExeAKusAEju+V367AmUCi9ANQ0AU3pwcOw2cMEH0FwAAKz5X228pRLR5AI4TgIAtIDL24oLUE94AB6W7LsH/cONN14Ilh44AOqD9s2LQR1KHiB9zgGgOSGeuA3ocPrME1Q4ANaceyePAzrcjHmAZYs9IBeW4/fzHiAwTCwAgTle9ACZK44ALDT9e6x7gL4aT0BQCHb4AqgA5/1TTOMLoJ7vZSMM0H/GHnCeDnu+CrU8vGYPcN5FADBYD0vCaYPDy+i0p337GSMsS1Z4vA3t9QgAZTt0IuIxFRPSKicAQHlvhk3FXF5GhBByMa8qo/sBO6BarwuYbYrYnFKDYEvE7phKgcxvEQBqnvhgiQCUOgoAO4C3JOS3L/hv23UXxVldBECfcueAqpAa0WGy/QeULREAY6aTXRFDgBuA13+ElOncAERMAGaA9hBQD4gQQHsIRE1AZoD2xrgQS5nOZyHgFKmWDSIG4GRAVidiAE4GRB6AzAB2AKIPQFaA5myHA5AV4ESNugZhC7BLR50lIBPAebrzBGQCKAFQNSIMcDvRTQIwAHxNApM3RBygGK0uyhxwOwGsPAgEnPWj5ycRCNiJtBHlAChGKQVwANzPY+CXSMDNWISiLA9AfRA5IhJQ68UnoQAt+AtOPIBKhJosF8B6UM0yLkAxQk2WCyDX9SiUh1gkQAIkoCuAvjGuquMbuijAtwG7MPL8yBICOHSPk3W8Ne8KcEUdmBi6FADYos+QleIH0N/ogOxd7AD6uAS6WRU8WcBdlgZMG/EnYUlwEpLLoQ4PjzGbiA5UsRMRsbQ+5ziDJmYqJuR6NaMomdXuFuZyPSABEiABEiABEiABEiAc8Bd6VyvCEKGqcQAAAABJRU5ErkJggg==")
+
+/***/ }),
+
+/***/ "./src/builtins/defaultSound.wav":
+/*!***************************************!*\
+  !*** ./src/builtins/defaultSound.wav ***!
+  \***************************************/
+/*! no static exports found */
+/***/ (function(module, exports, __webpack_require__) {
+
+module.exports = __webpack_require__(/*! ../../node_modules/arraybuffer-loader/lib/to-array-buffer.js */ "./node_modules/arraybuffer-loader/lib/to-array-buffer.js")("UklGRiYAAABXQVZFZm10IBAAAAABAAEAIlYAAESsAAACABAAZGF0YQIAAAAAAA==")
+
+/***/ }),
+
+/***/ "./src/builtins/defaultVector.svg":
+/*!****************************************!*\
+  !*** ./src/builtins/defaultVector.svg ***!
+  \****************************************/
+/*! no static exports found */
+/***/ (function(module, exports, __webpack_require__) {
+
+module.exports = __webpack_require__(/*! ../../node_modules/arraybuffer-loader/lib/to-array-buffer.js */ "./node_modules/arraybuffer-loader/lib/to-array-buffer.js")("PD94bWwgdmVyc2lvbj0iMS4wIj8+Cjxzdmcgd2lkdGg9IjEyOCIgaGVpZ2h0PSIxMjgiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6c3ZnPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiA8Zz4KICA8cmVjdCBmaWxsPSIjQ0NDIiBoZWlnaHQ9IjEyOCIgd2lkdGg9IjEyOCIvPgogIDx0ZXh0IGZpbGw9ImJsYWNrIiB5PSIxMDciIHg9IjM1LjUiIGZvbnQtc2l6ZT0iMTI4Ij4/PC90ZXh0PgogPC9nPgo8L3N2Zz4K")
+
+/***/ }),
+
 /***/ "./src/index.js":
 /*!**********************!*\
   !*** ./src/index.js ***!
@@ -7042,9 +7062,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
-var _require = __webpack_require__(/*! cross-fetch */ "./node_modules/cross-fetch/dist/node-ponyfill.js"),
-    fetch = _require.fetch,
-    Headers = _require.Headers;
+var crossFetch = __webpack_require__(/*! cross-fetch */ "./node_modules/cross-fetch/dist/node-ponyfill.js");
 /**
  * Metadata header names
  * @enum {string} The enum value is the name of the associated header.
@@ -7054,17 +7072,48 @@ var _require = __webpack_require__(/*! cross-fetch */ "./node_modules/cross-fetc
 
 var 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}
+ */
+
+var 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.
  */
 
-var metadata = new Map();
+var hasMetadata = function hasMetadata() {
+  /* global self */
+  var searchParams = typeof self !== 'undefined' && self && self.location && self.location.search && self.location.search.split(/[?&]/) || [];
+
+  if (!searchParams.includes('scratchMetadata=1')) {
+    // for now, disable this feature unless scratchMetadata=1
+    // TODO: remove this check once we're sure the feature works correctly in production
+    return false;
+  }
+
+  var _iterator = _createForOfIteratorHelper(metadata),
+      _step;
+
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var _ = _step.value;
+      return true;
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+
+  return false;
+};
 /**
  * Non-destructively merge any metadata state (if any) with the provided options object (if any).
  * If there is metadata state but no options object is provided, make a new object.
@@ -7075,29 +7124,33 @@ var metadata = new Map();
  * @returns {RequestInit|undefined} the provided options parameter without modification, or a new options object.
  */
 
+
 var applyMetadata = function applyMetadata(options) {
-  if (metadata.size > 0) {
+  if (hasMetadata()) {
     var augmentedOptions = Object.assign({}, options);
-    augmentedOptions.headers = new Headers(Array.from(metadata));
+    augmentedOptions.headers = new crossFetch.Headers(metadata);
 
     if (options && options.headers) {
-      var 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
+      var overrideHeaders = options.headers instanceof crossFetch.Headers ? options.headers : new crossFetch.Headers(options.headers);
 
-      var _iterator = _createForOfIteratorHelper(overrideHeaders.entries()),
-          _step;
+      var _iterator2 = _createForOfIteratorHelper(overrideHeaders.entries()),
+          _step2;
 
       try {
-        for (_iterator.s(); !(_step = _iterator.n()).done;) {
-          var _step$value = _slicedToArray(_step.value, 2),
-              name = _step$value[0],
-              value = _step$value[1];
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var _step2$value = _slicedToArray(_step2.value, 2),
+              name = _step2$value[0],
+              value = _step2$value[1];
 
           augmentedOptions.headers.set(name, value);
         }
       } catch (err) {
-        _iterator.e(err);
+        _iterator2.e(err);
       } finally {
-        _iterator.f();
+        _iterator2.f();
       }
     }
 
@@ -7118,7 +7171,7 @@ var applyMetadata = function applyMetadata(options) {
 
 var scratchFetch = function scratchFetch(resource, options) {
   var augmentedOptions = applyMetadata(options);
-  return fetch(resource, augmentedOptions);
+  return crossFetch.fetch(resource, augmentedOptions);
 };
 /**
  * Set the value of a named request metadata item.
@@ -7144,6 +7197,7 @@ var unsetMetadata = function unsetMetadata(name) {
 
 module.exports = {
   default: scratchFetch,
+  Headers: crossFetch.Headers,
   RequestMetadata: RequestMetadata,
   applyMetadata: applyMetadata,
   scratchFetch: scratchFetch,
@@ -7151,6 +7205,20 @@ module.exports = {
   unsetMetadata: unsetMetadata
 };
 
+if (true) {
+  /**
+   * 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.
+   */
+  var getMetadata = function getMetadata(name) {
+    return metadata.get(name);
+  };
+
+  module.exports.getMetadata = getMetadata;
+}
+
 /***/ }),
 
 /***/ "base64-js":