Merge pull request #426 from Esri/p/downloads-collection-search

Specify "Collection" when searching for multilayer KML or CSV exports
Esri · Nov 18, 2020 · 6a247ff · 6a247ff
2 parents 7d5f9b6 + a3a57df
commit 6a247ff
Show file tree

Hide file tree

Showing 6 changed files with 651 additions and 130 deletions.
diff --git a/demos/oauth2-browser/package-lock.json b/demos/oauth2-browser/package-lock.json
diff --git a/packages/downloads/package.json b/packages/downloads/package.json
@@ -16,6 +16,11 @@
     "eventemitter3": "^4.0.4",
     "tslib": "^1.13.0"
   },
+  "peerDependencies": {
+    "@esri/arcgis-rest-feature-layer": "^2.21.0",
+    "@esri/arcgis-rest-portal": "^2.21.0",
+    "@esri/arcgis-rest-request": "^2.21.0"
+  },
   "devDependencies": {
     "@esri/arcgis-rest-auth": "^2.21.0",
     "@rollup/plugin-commonjs": "^15.0.0",

diff --git a/packages/downloads/src/download-format.ts b/packages/downloads/src/download-format.ts
@@ -1,8 +1,12 @@
-export type DownloadFormat = 'Shapefile' |
-'CSV' |
-'File Geodatabase' |
-'Feature Collection' |
-'GeoJson' |
-'Scene Package' |
-'KML' |
-'Excel';
+export enum DownloadFormats {
+  Shapefile = "Shapefile",
+  CSV = "CSV",
+  KML = "KML",
+  GeoJson = "GeoJson",
+  Excel = "Excel",
+  "File Geodatabase" = "File Geodatabase",
+  "Feature Collection" = "Feature Collection",
+  "Scene Package" = "Scene Package"
+}
+
+export type DownloadFormat = keyof typeof DownloadFormats;
diff --git a/packages/downloads/src/portal/portal-request-download-metadata.ts b/packages/downloads/src/portal/portal-request-download-metadata.ts
@@ -1,9 +1,21 @@
 import { getItem, IItem, searchItems } from "@esri/arcgis-rest-portal";
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { getLayer } from "@esri/arcgis-rest-feature-layer";
-import { DownloadFormat } from "../download-format";
+import {
+  getService,
+  IFeatureServiceDefinition,
+  ILayerDefinition
+} from "@esri/arcgis-rest-feature-layer";
+import { DownloadFormat, DownloadFormats } from "../download-format";
 import { urlBuilder, composeDownloadId } from "../utils";
 
+enum ItemTypes {
+  FeatureService = "Feature Service",
+  MapService = "Map Service"
+}
+
+const isCollectionType = (format: DownloadFormat) =>
+  format === DownloadFormats.CSV || format === DownloadFormats.KML;
+
 /**
  * @private
  */
@@ -14,6 +26,14 @@ export interface IPortalDownloadMetadataRequestParams {
   spatialRefId?: string;
 }
 
+/**
+ * @private
+ */
+export interface ICacheSearchMetadata {
+  modified: number;
+  format: string;
+}
+
 /**
  * @private
  */
@@ -32,18 +52,19 @@ export function portalRequestDownloadMetadata(
       const { type, modified, url } = item;
       itemModifiedDate = modified;
       itemType = type;
-      return fetchLastEditDate({
-        datasetId,
+      return fetchCacheSearchMetadata({
         url,
         authentication,
         type,
-        modified
+        modified,
+        format
       });
     })
-    .then((result: number) => {
-      serviceLastEditDate = result;
+    .then((metadata: ICacheSearchMetadata) => {
+      const { modified, format: searchFormat } = metadata;
+      serviceLastEditDate = modified;
       return searchItems({
-        q: `type:"${format}" AND typekeywords:"export:${datasetId},spatialRefId:${spatialRefId}"`,
+        q: `type:"${searchFormat}" AND typekeywords:"export:${datasetId},spatialRefId:${spatialRefId}"`,
         num: 1,
         sortField: "modified",
         sortOrder: "DESC",
@@ -67,30 +88,57 @@ export function portalRequestDownloadMetadata(
     });
 }
 
-function fetchLastEditDate(params: any): Promise<number | undefined> {
-  const { datasetId, url, type, modified, authentication } = params;
+function fetchCacheSearchMetadata(params: any): Promise<ICacheSearchMetadata> {
+  const { format, layerId, url, type, modified, authentication } = params;
 
-  const layerId = datasetId.split("_")[1] || 0;
-
-  if (type !== "Feature Service" && type !== "Map Service") {
-    return Promise.resolve(modified);
+  if (type !== ItemTypes.FeatureService && type !== ItemTypes.MapService) {
+    return Promise.resolve({
+      modified,
+      format
+    });
   }
 
-  return getLayer({
-    url: `${url}/${layerId}`,
-    authentication
-  }).then((layer: any) => {
-    const editingInfo: any | null = layer.editingInfo;
-    return editingInfo ? editingInfo.lastEditDate : undefined;
-  });
+  return getService({ url, authentication }).then(
+    (response: IFeatureServiceDefinition) => {
+      const layers: ILayerDefinition[] = response.layers || [];
+      const multilayer = isMultilayerRequest(layerId, layers);
+      return {
+        format:
+          multilayer && isCollectionType(format)
+            ? `${format} Collection`
+            : format,
+        modified: extractLastEditDate(layers)
+      };
+    }
+  );
+}
+
+function isMultilayerRequest(layerId: string, layers: ILayerDefinition[]) {
+  return layerId === undefined && layers.length > 1;
+}
+
+function extractLastEditDate(layers: ILayerDefinition[]) {
+  const result = layers
+    .map((layer: ILayerDefinition) => {
+      const { editingInfo: { lastEditDate } = {} } = layer;
+      return lastEditDate;
+    })
+    .filter(timestamp => {
+      return timestamp !== undefined;
+    })
+    .sort((a, b) => {
+      return b - a;
+    });
+  return result[0];
 }
 
 function formatDownloadMetadata(params: any) {
   const { cachedDownload, serviceLastEditDate, authentication } = params;
 
-  const lastEditDate = serviceLastEditDate
-    ? new Date(serviceLastEditDate).toISOString()
-    : undefined;
+  const lastEditDate =
+    serviceLastEditDate !== undefined
+      ? new Date(serviceLastEditDate).toISOString()
+      : undefined;
 
   if (!cachedDownload) {
     return {