Merge pull request #425 from Esri/p/download-errors

Add errors array to hub api metadata and status to polling event metadata
Esri · Nov 16, 2020 · 7d5f9b6 · 7d5f9b6
2 parents 95e4a20 + a2128c1
commit 7d5f9b6
Show file tree

Hide file tree

Showing 9 changed files with 356 additions and 275 deletions.
diff --git a/packages/downloads/src/download-status.ts b/packages/downloads/src/download-status.ts
@@ -0,0 +1,10 @@
+export type DownloadStatus =
+  | "ready"
+  | "ready_unknown"
+  | "stale"
+  | "not_ready"
+  | "creating"
+  | "updating"
+  | "error_creating"
+  | "error_updating"
+  | "error";
diff --git a/packages/downloads/src/hub/hub-poll-download-metadata.ts b/packages/downloads/src/hub/hub-poll-download-metadata.ts
@@ -35,15 +35,18 @@ class HubPoller implements IPoller {
           }
 
           if (exportDatasetFailed(metadata)) {
+            const {
+              errors: [error]
+            } = metadata;
             eventEmitter.emit(`${downloadId}ExportError`, {
-              detail: { metadata }
+              detail: { error, metadata }
             });
             return this.disablePoll();
           }
         })
         .catch(error => {
           eventEmitter.emit(`${downloadId}PollingError`, {
-            detail: { error }
+            detail: { error, metadata: { status: "error" } }
           });
           return this.disablePoll();
         });

diff --git a/packages/downloads/src/hub/hub-request-download-metadata.ts b/packages/downloads/src/hub/hub-request-download-metadata.ts
@@ -82,6 +82,7 @@ function formatApiResponse(json: any, downloadId: string) {
       contentLastModified,
       lastModified,
       status,
+      errors,
       contentLength,
       cacheTime,
       source: { lastEditDate }
@@ -95,6 +96,7 @@ function formatApiResponse(json: any, downloadId: string) {
     lastEditDate,
     lastModified,
     status,
+    errors: errors || [],
     downloadUrl,
     contentLength,
     cacheTime

diff --git a/packages/downloads/src/portal/portal-poll-export-job-status.ts b/packages/downloads/src/portal/portal-poll-export-job-status.ts
@@ -15,6 +15,11 @@ import { urlBuilder } from "../utils";
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { IPoller } from "../poller";
 
+enum DownloadStatus {
+  READY = "ready",
+  ERROR = "error"
+}
+
 class ExportCompletionError extends Error {
   constructor(message: string) {
     /* istanbul ignore next */
@@ -87,7 +92,9 @@ class PortalPoller implements IPoller {
           if (metadata.status === "failed") {
             eventEmitter.emit(`${downloadId}ExportError`, {
               detail: {
+                error: new Error(metadata.statusMessage),
                 metadata: {
+                  status: DownloadStatus.ERROR,
                   errors: [new Error(metadata.statusMessage)]
                 }
               }
@@ -98,11 +105,14 @@ class PortalPoller implements IPoller {
         .catch((error: any) => {
           if (error instanceof ExportCompletionError) {
             eventEmitter.emit(`${downloadId}ExportError`, {
-              detail: { metadata: { errors: [error] } }
+              detail: {
+                error,
+                metadata: { status: DownloadStatus.ERROR, errors: [error] }
+              }
             });
           } else {
             eventEmitter.emit(`${downloadId}PollingError`, {
-              detail: { error }
+              detail: { error, metadata: { status: DownloadStatus.ERROR } }
             });
           }
           return this.disablePoll();
@@ -173,7 +183,7 @@ function completedHandler(params: any): Promise<any> {
         detail: {
           metadata: {
             downloadId,
-            status: "ready",
+            status: DownloadStatus.READY,
             lastModified: new Date().toISOString(),
             downloadUrl: urlBuilder({
               host: authentication.portal,

diff --git a/packages/downloads/src/request-download-metadata.ts b/packages/downloads/src/request-download-metadata.ts
@@ -1,7 +1,8 @@
 import { portalRequestDownloadMetadata } from "./portal/portal-request-download-metadata";
-import { hubRequestDownloadMetadata } from "./hub/hub-request-download-metadata"
+import { hubRequestDownloadMetadata } from "./hub/hub-request-download-metadata";
 import { DownloadFormat } from "./download-format";
-import { UserSession } from '@esri/arcgis-rest-auth';
+import { DownloadStatus } from "./download-status";
+import { UserSession } from "@esri/arcgis-rest-auth";
 
 export interface IDownloadMetadataRequestParams {
   /* API target for downloads: 'hub' (default) or 'portal' */
@@ -24,28 +25,31 @@ export interface IDownloadMetadataRequestParams {
 
 export interface IDownloadMetadataResults {
   /* Identifier for the download */
-  downloadId: string,
+  downloadId: string;
 
-  /* ready, not_ready, creating, updating, failed*/
-  status: string,
+  /* ready, not_ready, creating, updating, failed */
+  status: DownloadStatus;
+
+  /* array of any errors related to exporting*/
+  errors?: Error[];
 
   /* ISO date of the service's last edit date */
-  lastEditDate?:string,
+  lastEditDate?: string;
 
   /* ISO date of the download file's data - the last edit date of the service when the download export started */
-  contentLastModified?: string,
+  contentLastModified?: string;
 
   /* File timestamp */
-  lastModified?: string,
+  lastModified?: string;
 
   /* URL for downloading the file */
-  downloadUrl?: string,
+  downloadUrl?: string;
 
   /* File size */
-  contentLength?: number,
+  contentLength?: number;
 
   /* Time (milliseconds) it took to export and cache the download file */
-  cacheTime?: number
+  cacheTime?: number;
 }
 
 /**
@@ -89,7 +93,7 @@ export function requestDownloadMetadata(
     authentication
   } = params;
 
-  if (target === 'portal') {
+  if (target === "portal") {
     return portalRequestDownloadMetadata({
       datasetId,
       format,

diff --git a/packages/downloads/test/hub/hub-poll-download-metadata.test.ts b/packages/downloads/test/hub/hub-poll-download-metadata.test.ts
@@ -17,6 +17,7 @@ const fixtures = {
           format: "CSV",
           status: "error_creating",
           featureSet: "full",
+          errors: [{ message: "Some error" }],
           source: {
             type: "Feature Service",
             url:
@@ -77,20 +78,26 @@ describe("hubPollDownloadMetadata", () => {
         }
       );
       const mockEventEmitter = new EventEmitter();
-      spyOn(mockEventEmitter, 'emit');
+      spyOn(mockEventEmitter, "emit");
       const poller = hubPollDownloadMetadata({
-        host: 'http://hub.com',
-        datasetId: 'abcdef0123456789abcdef0123456789_0',
-        downloadId: 'test-id',
-        spatialRefId: '4326',
-        format: 'CSV',
+        host: "http://hub.com",
+        datasetId: "abcdef0123456789abcdef0123456789_0",
+        downloadId: "test-id",
+        spatialRefId: "4326",
+        format: "CSV",
         eventEmitter: mockEventEmitter,
         pollingInterval: 10
       });
       await delay(100);
       expect(mockEventEmitter.emit as any).toHaveBeenCalledTimes(1);
       expect((mockEventEmitter.emit as any).calls.first().args).toEqual([
-        'test-idPollingError', { detail: { error: new Error('Bad Gateway') } }
+        "test-idPollingError",
+        {
+          detail: {
+            error: new Error("Bad Gateway"),
+            metadata: { status: "error" }
+          }
+        }
       ]);
       expect(poller.pollTimer).toEqual(null);
     } catch (err) {
@@ -110,13 +117,13 @@ describe("hubPollDownloadMetadata", () => {
         }
       );
       const mockEventEmitter = new EventEmitter();
-      spyOn(mockEventEmitter, 'emit');
+      spyOn(mockEventEmitter, "emit");
       const poller = hubPollDownloadMetadata({
-        host: 'http://hub.com',
-        datasetId: 'abcdef0123456789abcdef0123456789_0',
-        downloadId: 'test-id',
-        spatialRefId: '4326',
-        format: 'CSV',
+        host: "http://hub.com",
+        datasetId: "abcdef0123456789abcdef0123456789_0",
+        downloadId: "test-id",
+        spatialRefId: "4326",
+        format: "CSV",
         eventEmitter: mockEventEmitter,
         pollingInterval: 10
       });
@@ -133,6 +140,7 @@ describe("hubPollDownloadMetadata", () => {
         contentLastModified: undefined,
         lastEditDate: "2020-06-18T01:17:31.492Z",
         lastModified: undefined,
+        errors: [{ message: "Some error" }],
         status: "error_creating",
         downloadUrl:
           "https://dev-hub-indexer.s3.amazonaws.com/files/dd4580c810204019a7b8eb3e0b329dd6/0/full/4326/dd4580c810204019a7b8eb3e0b329dd6_0_full_4326.csv",
@@ -157,13 +165,13 @@ describe("hubPollDownloadMetadata", () => {
         }
       );
       const mockEventEmitter = new EventEmitter();
-      spyOn(mockEventEmitter, 'emit');
+      spyOn(mockEventEmitter, "emit");
       const poller = hubPollDownloadMetadata({
-        host: 'http://hub.com',
-        datasetId: 'abcdef0123456789abcdef0123456789_0',
-        downloadId: 'test-id',
-        spatialRefId: '4326',
-        format: 'CSV',
+        host: "http://hub.com",
+        datasetId: "abcdef0123456789abcdef0123456789_0",
+        downloadId: "test-id",
+        spatialRefId: "4326",
+        format: "CSV",
         eventEmitter: mockEventEmitter,
         pollingInterval: 10
       });
@@ -181,6 +189,7 @@ describe("hubPollDownloadMetadata", () => {
         lastEditDate: "2020-06-18T01:15:31.492Z",
         lastModified: "2020-06-17T13:04:28.000Z",
         status: "ready",
+        errors: [],
         downloadUrl:
           "https://dev-hub-indexer.s3.amazonaws.com/files/dd4580c810204019a7b8eb3e0b329dd6/0/full/4326/dd4580c810204019a7b8eb3e0b329dd6_0_full_4326.csv",
         contentLength: 1391454,
@@ -233,13 +242,13 @@ describe("hubPollDownloadMetadata", () => {
         }
       );
       const mockEventEmitter = new EventEmitter();
-      spyOn(mockEventEmitter, 'emit');
+      spyOn(mockEventEmitter, "emit");
       const poller = hubPollDownloadMetadata({
-        host: 'http://hub.com',
-        datasetId: 'abcdef0123456789abcdef0123456789_0',
-        downloadId: 'test-id',
-        spatialRefId: '4326',
-        format: 'CSV',
+        host: "http://hub.com",
+        datasetId: "abcdef0123456789abcdef0123456789_0",
+        downloadId: "test-id",
+        spatialRefId: "4326",
+        format: "CSV",
         eventEmitter: mockEventEmitter,
         pollingInterval: 10
       });

diff --git a/packages/downloads/test/hub/hub-request-download-metadata.test.ts b/packages/downloads/test/hub/hub-request-download-metadata.test.ts
@@ -195,6 +195,7 @@ describe("hubRequestDownloadMetadata", () => {
         lastEditDate: "2020-06-18T01:17:31.492Z",
         lastModified: "2020-06-17T13:04:28.000Z",
         status: "stale",
+        errors: [],
         downloadUrl:
           "https://dev-hub-indexer.s3.amazonaws.com/files/dd4580c810204019a7b8eb3e0b329dd6/0/full/4326/dd4580c810204019a7b8eb3e0b329dd6_0_full_4326.csv",
         contentLength: 1391454,
@@ -231,6 +232,7 @@ describe("hubRequestDownloadMetadata", () => {
         lastEditDate: "2020-06-18T01:17:31.492Z",
         lastModified: "2020-06-17T13:04:28.000Z",
         status: "stale",
+        errors: [],
         downloadUrl:
           "https://dev-hub-indexer.s3.amazonaws.com/files/dd4580c810204019a7b8eb3e0b329dd6/0/full/4326/dd4580c810204019a7b8eb3e0b329dd6_0_full_4326.csv",
         contentLength: 1391454,
@@ -276,6 +278,7 @@ describe("hubRequestDownloadMetadata", () => {
         lastEditDate: "2020-06-18T01:17:31.492Z",
         lastModified: "2020-06-17T13:04:28.000Z",
         status: "stale",
+        errors: [],
         downloadUrl:
           "https://dev-hub-indexer.s3.amazonaws.com/files/dd4580c810204019a7b8eb3e0b329dd6/0/full/4326/dd4580c810204019a7b8eb3e0b329dd6_0_full_4326.csv",
         contentLength: 1391454,