scratch-storage 2.0.2 → 2.2.0

package/test/unit/metadata.js

@@ -0,0 +1,136 @@
+const tap = require('tap');
+
+const crossFetch = require('cross-fetch');
+
+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!
+const setupModules = () => {
+    /**
+     * This instance of scratchFetch will be shared between this file and FetchTool.
+     * By sharing the same instance, the test can affect the metadata that FetchTool will use.
+     */
+    const scratchFetchModule = tap.mock('../../src/scratchFetch', {
+        'cross-fetch': mockFetchModule
+    });
+
+    /**
+     * 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': mockFetchModule,
+        // Make sure FetchTool uses the same scratchFetch instance
+        '../../src/scratchFetch': scratchFetchModule
+    });
+
+    return {scratchFetchModule, FetchTool};
+};
+
+tap.test('get without metadata', async t => {
+    const {FetchTool} = setupModules();
+
+    const tool = new FetchTool();
+
+    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    const mockFetchTestData = {};
+    const result = await tool.get({url: '200', mockFetchTestData});
+
+    t.type(result, Uint8Array);
+    t.ok(mockFetchTestData.headers, 'mockFetch did not report headers');
+    t.equal(mockFetchTestData.headersCount, 0);
+});
+
+tap.test('get with metadata', async t => {
+    const {scratchFetchModule, FetchTool} = setupModules();
+    const {RequestMetadata, setMetadata} = scratchFetchModule;
+
+    const tool = new FetchTool();
+
+    setMetadata(RequestMetadata.ProjectId, 1234);
+    setMetadata(RequestMetadata.RunId, 5678);
+
+    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    const mockFetchTestData = {};
+    const result = await tool.get({url: '200', mockFetchTestData});
+
+    t.type(result, Uint8Array);
+    t.ok(mockFetchTestData.headers, 'mockFetch did not report headers');
+    t.equal(mockFetchTestData.headersCount, 2);
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.ProjectId), '1234');
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.RunId), '5678');
+});
+
+tap.test('send without metadata', async t => {
+    const {FetchTool} = setupModules();
+
+    const tool = new FetchTool();
+
+    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    const mockFetchTestData = {};
+    const result = await tool.send({url: '200', mockFetchTestData});
+
+    t.type(result, 'string');
+    t.ok(mockFetchTestData.headers, 'mockFetch did not report headers');
+    t.equal(mockFetchTestData.headersCount, 0);
+});
+
+tap.test('send with metadata', async t => {
+    const {scratchFetchModule, FetchTool} = setupModules();
+    const {RequestMetadata, setMetadata} = scratchFetchModule;
+
+    const tool = new FetchTool();
+
+    setMetadata(RequestMetadata.ProjectId, 4321);
+    setMetadata(RequestMetadata.RunId, 8765);
+
+    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    const mockFetchTestData = {};
+    const result = await tool.send({url: '200', mockFetchTestData});
+
+    t.type(result, 'string');
+    t.ok(mockFetchTestData.headers, 'mockFetch did not report headers');
+    t.equal(mockFetchTestData.headersCount, 2);
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.ProjectId), '4321');
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.RunId), '8765');
+});
+
+tap.test('selectively delete metadata', async t => {
+    const {scratchFetchModule, FetchTool} = setupModules();
+    const {RequestMetadata, setMetadata, unsetMetadata} = scratchFetchModule;
+
+    // verify that these special values are preserved and not interpreted as "delete"
+    setMetadata(RequestMetadata.ProjectId, null);
+    setMetadata(RequestMetadata.RunId, void 0); // void 0 = undefined
+
+    const tool = new FetchTool();
+
+    /** @type import('../mocks/mockFetch.js').MockFetchTestData */
+    const mockFetchTestData = {};
+
+    const result1 = await tool.send({url: '200', mockFetchTestData});
+    t.type(result1, 'string');
+    t.ok(mockFetchTestData.headers, 'mockFetch did not report headers');
+
+    t.equal(mockFetchTestData.headersCount, 2);
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.ProjectId), 'null'); // string "null" means it's present
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.RunId), 'undefined');
+
+    // remove the Project ID from metadata
+    unsetMetadata(RequestMetadata.ProjectId);
+
+    const result2 = await tool.send({url: '200', mockFetchTestData});
+    t.type(result2, 'string');
+    t.ok(mockFetchTestData.headers, 'mockFetch did not report headers');
+
+    t.equal(mockFetchTestData.headersCount, 1);
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.ProjectId), null); // value `null` means it's missing
+    t.equal(mockFetchTestData.headers?.get(RequestMetadata.RunId), 'undefined');
+});

package/webpack.config.js

@@ -1,5 +1,4 @@
 const path = require('path');
-const {ProvidePlugin} = require('webpack');
 const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
 
 const base = {
@@ -14,9 +13,16 @@ const base = {
                 test: /\.js$/,
                 loader: 'babel-loader',
                 options: {
+                    plugins: [
+                        '@babel/plugin-transform-runtime'
+                    ],
                     presets: [
                         ['@babel/preset-env', {targets: {browsers: ['last 3 versions', 'Safari >= 8', 'iOS >= 8']}}]
-                    ]
+                    ],
+                    // Consider a file a "module" if import/export statements are present, or else consider it a
+                    // "script". Fixes "Cannot assign to read only property 'exports'" when using
+                    // @babel/plugin-transform-runtime with CommonJS files.
+                    sourceType: 'unambiguous'
                 }
             }
         ]
@@ -65,11 +71,6 @@ module.exports = [
             'js-md5': true,
             'localforage': true,
             'text-encoding': true
-        },
-        plugins: [
-            new ProvidePlugin({
-                fetch: ['node-fetch', 'default']
-            })
-        ]
+        }
     })
 ];

package/.travis.yml

@@ -1,24 +0,0 @@
-sudo: false
-language: node_js
-cache:
-  directories:
-    - node_modules
-node_js:
-  - "10"
-install:
-  - npm install
-  - npm update
-  - npm prune
-script:
-  - commitlint-travis
-  - npm run lint
-  - npm run build
-  - npm run tap
-deploy:
-- provider: script
-  on:
-    branch:
-    - master
-    - develop
-  skip_cleanup: true
-  script: npm run semantic-release