Feat #1130 [WIP] Adding support for downloading and zipping files (#1501)

* Feat #1130 Adding support for downloading and zipping files

@ This is a combination of 12 commits.
 - Feat #1130 Initial Commit
 - Feat #1130 Adding support for hierachical lists
 - Feat #1130 [WIP] Adding support for downloading and zipping files
 - Feat #1130 Adding support for hierarchical folder structure study, series, instances on generated zip file
 - Feat #1130 Adding unit tests and addressing code review feedbacks
 - Feat #1130 POC (adding module to support on progress handling)
 - Feat #1130 Improving logic from progress tracking utils
 - Feat #1130 Renaming module with progress tracking utils
 - Feat #1130 Beta version of Progress Tracking utils
 - Feat #1130 Adding unit tests for Progress Tracking Utils
 - Feat #1130 Documenting public methods from progress tracking utils module
 - Feat #1130 Adding support for download and zip progress reporting

* Feat #1130 Addressing code review feedback

* Feat #1130 Preventing multiple downloads from executing at once

* Feat #1130 Improving error message for concurrent downloads

* Remove downloadAndZipSeriesOnViewports

Co-authored-by: James Petts <jamesapetts@gmail.com>

platform/core/src/utils/Queue.test.js

@@ -0,0 +1,66 @@
+import makeDeferred from './makeDeferred';
+import Queue from './Queue';
+
+/**
+ * Utils
+ */
+
+function timeout(delay) {
+  const { resolve, promise } = makeDeferred();
+  setTimeout(() => void resolve(Date.now()), delay);
+  return promise;
+}
+
+/**
+ * Tests
+ */
+
+describe('Queue', () => {
+  it('should bind functions to the queue', async () => {
+    const queue = new Queue(2);
+    const mockedTimeout = jest.fn(timeout);
+    const timer = queue.bind(mockedTimeout);
+    const start = Date.now();
+    timer(120).then(now => {
+      const elapsed = now - start;
+      expect(elapsed >= 120 && elapsed < 240).toBe(true);
+    });
+    const end = await timer(120);
+    expect(end - start > 240).toBe(true);
+    expect(mockedTimeout).toBeCalledTimes(2);
+  });
+  it('should prevent task execution when queue limit is reached', async () => {
+    const queue = new Queue(1);
+    const mockedTimeout = jest.fn(timeout);
+    const timer = queue.bind(mockedTimeout);
+    const start = Date.now();
+    const promise = timer(120).then(time => time - start);
+    try {
+      await timer(120);
+    } catch (e) {
+      expect(Date.now() - start < 120).toBe(true);
+      expect(e.message).toBe('Queue limit reached');
+    }
+    const elapsed = await promise;
+    expect(elapsed >= 120 && elapsed < 240).toBe(true);
+    expect(mockedTimeout).toBeCalledTimes(1);
+  });
+  it('should safely bind tasks to the queue', async () => {
+    const queue = new Queue(1);
+    const mockedErrorHandler = jest.fn();
+    const mockedTimeout = jest.fn(timeout);
+    const timer = queue.bindSafe(mockedTimeout, mockedErrorHandler);
+    const start = Date.now();
+    const promise = timer(120).then(time => time - start);
+    await timer(120);
+    expect(Date.now() - start < 120).toBe(true);
+    expect(mockedErrorHandler).toBeCalledTimes(1);
+    expect(mockedErrorHandler).nthCalledWith(
+      1,
+      expect.objectContaining({ message: 'Queue limit reached' })
+    );
+    const elapsed = await promise;
+    expect(elapsed >= 120 && elapsed < 240).toBe(true);
+    expect(mockedTimeout).toBeCalledTimes(1);
+  });
+});