chore(utils): add utils tests (#675)

knagaitsev · web-flow · commit 86c308c306a5 · 2020-07-14T12:00:38.000+09:00
diff --git a/src/middleware.js b/src/middleware.js
@@ -72,7 +72,7 @@ export default function wrapper(context) {
       }
 
       // Buffer
-      content = handleRangeHeaders(content, req, res);
+      content = handleRangeHeaders(context, content, req, res);
 
       // send Buffer
       res.send(content);
diff --git a/src/utils/handleRangeHeaders.js b/src/utils/handleRangeHeaders.js
@@ -1,6 +1,6 @@
 import parseRange from 'range-parser';
 
-export default function handleRangeHeaders(content, req, res) {
+export default function handleRangeHeaders(context, content, req, res) {
   // assumes express API. For other servers, need to add logic to access
   // alternative header APIs
   res.setHeader('Accept-Ranges', 'bytes');
@@ -13,11 +13,18 @@ export default function handleRangeHeaders(content, req, res) {
       res.setHeader('Content-Range', `bytes */${content.length}`);
       // eslint-disable-next-line no-param-reassign
       res.statusCode = 416;
-    }
-
-    // valid (syntactically invalid/multiple ranges are treated as a
-    // regular response)
-    if (ranges !== -2 && ranges.length === 1) {
+    } else if (ranges === -2) {
+      // malformed header treated as regular response
+      context.logger.error(
+        'A malformed Range header was provided. A regular response will be sent for this request.'
+      );
+    } else if (ranges.length !== 1) {
+      // multiple ranges treated as regular response
+      context.logger.error(
+        'A Range header with multiple ranges was provided. Multiple ranges are not supported, so a regular response will be sent for this request.'
+      );
+    } else {
+      // valid range header
       const { length } = content;
 
       // Content-Range
diff --git a/test/middleware.test.js b/test/middleware.test.js
@@ -229,6 +229,17 @@ describe('middleware', () => {
           .expect(206, done);
       });
 
+      it('should return the "200" code for the "GET" request with malformed range header which is ignored', (done) => {
+        request(app).get('/bundle.js').set('Range', 'abc').expect(200, done);
+      });
+
+      it('should return the "200" code for the "GET" request with multiple range header which is ignored', (done) => {
+        request(app)
+          .get('/bundle.js')
+          .set('Range', 'bytes=3000-3100,3200-3300')
+          .expect(200, done);
+      });
+
       it('should return the "404" code for the "GET" request with to the non-public path', (done) => {
         request(app)
           .get('/nonpublic/')
diff --git a/test/utils/__snapshots__/handleRangeHeaders.test.js.snap b/test/utils/__snapshots__/handleRangeHeaders.test.js.snap
@@ -0,0 +1,61 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`handleRangeHeaders should handle malformed range header 1`] = `
+Array [
+  Array [
+    "A malformed Range header was provided. A regular response will be sent for this request.",
+  ],
+]
+`;
+
+exports[`handleRangeHeaders should handle malformed range header 2`] = `
+Array [
+  Array [
+    "Accept-Ranges",
+    "bytes",
+  ],
+]
+`;
+
+exports[`handleRangeHeaders should handle multiple ranges 1`] = `
+Array [
+  Array [
+    "A Range header with multiple ranges was provided. Multiple ranges are not supported, so a regular response will be sent for this request.",
+  ],
+]
+`;
+
+exports[`handleRangeHeaders should handle multiple ranges 2`] = `
+Array [
+  Array [
+    "Accept-Ranges",
+    "bytes",
+  ],
+]
+`;
+
+exports[`handleRangeHeaders should handle unsatisfiable range 1`] = `
+Array [
+  Array [
+    "Accept-Ranges",
+    "bytes",
+  ],
+  Array [
+    "Content-Range",
+    "bytes */6",
+  ],
+]
+`;
+
+exports[`handleRangeHeaders should return content in range with valid range header 1`] = `
+Array [
+  Array [
+    "Accept-Ranges",
+    "bytes",
+  ],
+  Array [
+    "Content-Range",
+    "bytes 1-4/6",
+  ],
+]
+`;
diff --git a/test/utils/__snapshots__/setupHooks.test.js.snap b/test/utils/__snapshots__/setupHooks.test.js.snap
@@ -0,0 +1,39 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`setupHooks handles multi compiler 1`] = `
+Array [
+  Array [
+    "Child \\"comp1\\": Failed to compile.",
+  ],
+  Array [
+    "Child \\"comp2\\": Compiled with warnings.",
+  ],
+]
+`;
+
+exports[`setupHooks handles multi compiler 2`] = `
+Array [
+  Array [
+    "Child \\"comp1\\": statsString1",
+  ],
+]
+`;
+
+exports[`setupHooks handles multi compiler 3`] = `
+Array [
+  Array [
+    "Child \\"comp2\\": statsString2",
+  ],
+]
+`;
+
+exports[`setupHooks sets state, then logs stats and handles callbacks on nextTick from done hook 1`] = `
+Array [
+  Array [
+    "statsString",
+  ],
+  Array [
+    "Compiled successfully.",
+  ],
+]
+`;
diff --git a/test/utils/__snapshots__/setupWriteToDisk.test.js.snap b/test/utils/__snapshots__/setupWriteToDisk.test.js.snap
@@ -0,0 +1,55 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with mkdir error 1`] = `
+Array [
+  Array [
+    "Child \\"name\\": Unable to write \\"/target/path\\" directory to disk:
+error1",
+  ],
+]
+`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with mkdir error 2`] = `Array []`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with mkdir error 3`] = `
+Array [
+  Array [
+    "error1",
+  ],
+]
+`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with no write errors 1`] = `Array []`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with no write errors 2`] = `
+Array [
+  Array [
+    "Child \\"name\\": Asset written to disk: \\"/target/path/file\\"",
+  ],
+]
+`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with no write errors 3`] = `
+Array [
+  Array [],
+]
+`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with writeFile error 1`] = `
+Array [
+  Array [
+    "Child \\"name\\": Unable to write \\"/target/path/file\\" asset to disk:
+error2",
+  ],
+]
+`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with writeFile error 2`] = `Array []`;
+
+exports[`setupWriteToDisk tries to create directories and write file if not filtered out with writeFile error 3`] = `
+Array [
+  Array [
+    "error2",
+  ],
+]
+`;
diff --git a/test/utils/handleRangeHeaders.test.js b/test/utils/handleRangeHeaders.test.js
@@ -0,0 +1,87 @@
+import handleRangeHeaders from '../../src/utils/handleRangeHeaders';
+
+describe('handleRangeHeaders', () => {
+  let context;
+
+  beforeEach(() => {
+    context = {
+      logger: {
+        error: jest.fn(),
+      },
+    };
+  });
+
+  it('should return content in range with valid range header', () => {
+    const content = 'abcdef';
+    const req = {
+      headers: {
+        range: 'bytes=1-4',
+      },
+    };
+
+    const res = {
+      setHeader: jest.fn(),
+    };
+
+    const contentRes = handleRangeHeaders(context, content, req, res);
+    expect(contentRes).toEqual('bcde');
+    expect(res.statusCode).toEqual(206);
+    expect(res.setHeader.mock.calls).toMatchSnapshot();
+  });
+
+  it('should handle malformed range header', () => {
+    const content = 'abcdef';
+    const req = {
+      headers: {
+        range: 'abc',
+      },
+    };
+
+    const res = {
+      setHeader: jest.fn(),
+    };
+
+    const contentRes = handleRangeHeaders(context, content, req, res);
+    expect(contentRes).toEqual('abcdef');
+    expect(context.logger.error.mock.calls).toMatchSnapshot();
+    expect(res.statusCode).toBeUndefined();
+    expect(res.setHeader.mock.calls).toMatchSnapshot();
+  });
+
+  it('should handle unsatisfiable range', () => {
+    const content = 'abcdef';
+    const req = {
+      headers: {
+        range: 'bytes=10-20',
+      },
+    };
+
+    const res = {
+      setHeader: jest.fn(),
+    };
+
+    const contentRes = handleRangeHeaders(context, content, req, res);
+    expect(contentRes).toEqual('abcdef');
+    expect(res.statusCode).toEqual(416);
+    expect(res.setHeader.mock.calls).toMatchSnapshot();
+  });
+
+  it('should handle multiple ranges', () => {
+    const content = 'abcdef';
+    const req = {
+      headers: {
+        range: 'bytes=1-2,4-5',
+      },
+    };
+
+    const res = {
+      setHeader: jest.fn(),
+    };
+
+    const contentRes = handleRangeHeaders(context, content, req, res);
+    expect(contentRes).toEqual('abcdef');
+    expect(context.logger.error.mock.calls).toMatchSnapshot();
+    expect(res.statusCode).toBeUndefined();
+    expect(res.setHeader.mock.calls).toMatchSnapshot();
+  });
+});
diff --git a/test/utils/ready.test.js b/test/utils/ready.test.js
@@ -0,0 +1,59 @@
+import ready from '../../src/utils/ready';
+
+describe('ready', () => {
+  it('should call callback if state is true', () => {
+    const cb = jest.fn();
+    const context = {
+      state: true,
+      stats: 'stats',
+    };
+    ready(context, cb);
+
+    expect(cb.mock.calls.length).toEqual(1);
+    expect(cb.mock.calls[0]).toEqual(['stats']);
+  });
+
+  it('should save callback and log req.url if state is false with req.url set', () => {
+    const cb = jest.fn();
+    const context = {
+      state: false,
+      stats: 'stats',
+      logger: {
+        info: jest.fn(),
+      },
+      callbacks: [],
+    };
+    const req = {
+      url: 'url',
+    };
+    ready(context, cb, req);
+
+    expect(cb).not.toBeCalled();
+    expect(context.logger.info.mock.calls.length).toEqual(1);
+    expect(context.logger.info.mock.calls[0]).toEqual([
+      'wait until bundle finished: url',
+    ]);
+    expect(context.callbacks).toEqual([cb]);
+  });
+
+  it('should save callback and log callback.name if state is false with req.url not set', () => {
+    const cb = jest.fn();
+    const context = {
+      state: false,
+      stats: 'stats',
+      logger: {
+        info: jest.fn(),
+      },
+      callbacks: [],
+    };
+    ready(context, cb);
+
+    expect(cb).not.toBeCalled();
+    expect(context.logger.info.mock.calls.length).toEqual(1);
+    // mockConstructor is the name of the jest.fn() function
+    expect(context.logger.info.mock.calls[0]).toEqual([
+      'wait until bundle finished: mockConstructor',
+    ]);
+    expect(context.callbacks).toEqual([cb]);
+  });
+});
diff --git a/test/utils/setupHooks.test.js b/test/utils/setupHooks.test.js
diff --git a/test/utils/setupOutputFileSystem.test.js b/test/utils/setupOutputFileSystem.test.js
diff --git a/test/utils/setupWriteToDisk.test.js b/test/utils/setupWriteToDisk.test.js

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ export default function wrapper(context) {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`// Buffer`
`75`		`- content = handleRangeHeaders(content, req, res);`
	`75`	`+ content = handleRangeHeaders(context, content, req, res);`
`76`	`76`
`77`	`77`	`// send Buffer`
`78`	`78`	`res.send(content);`