feat: force update tile select now reharvests

Esri · May 1, 2024 · 11c1228 · 11c1228
1 parent 42e0fcd
commit 11c1228
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 28 deletions.
diff --git a/packages/common/src/content/_internal/ContentBusinessRules.ts b/packages/common/src/content/_internal/ContentBusinessRules.ts
@@ -115,7 +115,7 @@ export const ContentPermissionPolicies: IPermissionPolicy[] = [
     // can view = (alpha org + devext environment) || (permission is passed via query param)
     permission: "hub:content:workspace:settings:schedule",
     availability: ["alpha"],
-    // environments: ["devext"],
+    environments: ["devext"],
   },
   {
     permission: "hub:content:workspace:collaborators",

diff --git a/packages/common/src/content/_internal/ContentUiSchemaSettings.ts b/packages/common/src/content/_internal/ContentUiSchemaSettings.ts
@@ -49,28 +49,16 @@ export const buildUiSchema = async (
             ],
           },
         },
+        // force update checkbox -- TODO: replace with button once available
         {
           type: "Control",
           scope: "/properties/schedule/properties/_forceUpdate",
-          rule: {
-            effect: UiSchemaRuleEffects.SHOW,
-            condition: {
-              scope: "/properties/schedule",
-              schema: {
-                enum: [
-                  { mode: "manual" },
-                  { mode: "manual", _forceUpdate: [] },
-                  { mode: "manual", _forceUpdate: [true] },
-                ],
-              },
-            },
-          },
           options: {
             control: "hub-field-input-tile-select",
             type: "checkbox",
             labels: ["Force Update"],
             descriptions: [
-              "Use this option to manually update the search index and cached download files for this item.",
+              'Select this option and then select "Save" to manually update the search index and cached download files for this item as applicable.',
             ],
           },
         },

diff --git a/packages/common/src/content/_internal/getSchedulerApiUrl.ts b/packages/common/src/content/_internal/getSchedulerApiUrl.ts
diff --git a/packages/common/src/content/_internal/internalContentUtils.ts b/packages/common/src/content/_internal/internalContentUtils.ts
@@ -41,6 +41,8 @@ import { _getHubUrlFromPortalHostname } from "../../urls/_get-hub-url-from-porta
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { geojsonToArcGIS } from "@terraformer/arcgis";
 import { Polygon } from "geojson";
+import { getHubApiUrl } from "../../api";
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 
 /**
  * Hashmap of Hub environment and application url surfix
@@ -965,3 +967,38 @@ const getUrbanModelEditUrl = (item: IItem, requestOptions: IRequestOptions) => {
 const isPortalFromUrl = (portalUrl: string): boolean => {
   return portalUrl.indexOf("arcgis.com") === -1;
 };
+
+export function getSchedulerApiUrl(
+  itemId: string,
+  requestOptions: IRequestOptions
+): string {
+  const hubApiUrlRoot = getHubApiUrlRoot(requestOptions);
+  return `${hubApiUrlRoot}/api/download/v1/items/${itemId}/schedule`;
+}
+
+export function getHubApiUrlRoot(requestOptions: IRequestOptions): string {
+  // sometimes the url has /api/v3 at the end, so we need to remove it
+  const hubApiUrlWithVersion = getHubApiUrl(requestOptions);
+  return hubApiUrlWithVersion.replace(/\/api\/v3$/, "");
+}
+
+export const forceUpdateContent = async (
+  itemId: string,
+  requestOptions: IUserRequestOptions
+) => {
+  // https://opendata{qa|dev}.arcgis.com/api/v3/jobs/item/${itemId}/harvest with a token in the header
+
+  const hubApiUrlRoot = getHubApiUrl(requestOptions);
+  const url = `${hubApiUrlRoot}/api/v3/jobs/item/${itemId}/harvest`;
+  const options = {
+    method: "POST",
+    headers: {
+      "content-type": "application/json",
+      // I see a number of ways to use getToken, but I'm not sure which one is correct
+      authorization: requestOptions.authentication.token,
+    },
+  };
+
+  const response = await fetch(url, options);
+  return response.json();
+};
diff --git a/packages/common/src/content/edit.ts b/packages/common/src/content/edit.ts
@@ -39,6 +39,8 @@ import {
   isDownloadSchedulingAvailable,
   maybeUpdateSchedule,
 } from "./manageSchedule";
+import { forceUpdateContent } from "./_internal/internalContentUtils";
+import { deepEqual } from "../objects";
 
 // TODO: move this to defaults?
 const DEFAULT_CONTENT_MODEL: IModel = {
@@ -174,6 +176,14 @@ export async function updateContent(
   }
 
   if (isDownloadSchedulingAvailable(requestOptions, content.access)) {
+    // if schedule has "Force Update" checked and clicked save, initiate an update
+    if (deepEqual((content.schedule as any)._forceUpdate, [true])) {
+      // [true]
+      await forceUpdateContent(item.id, requestOptions);
+    }
+
+    delete (content.schedule as any)._forceUpdate;
+
     await maybeUpdateSchedule(content, requestOptions);
   }
 

diff --git a/packages/common/src/content/manageSchedule.ts b/packages/common/src/content/manageSchedule.ts
@@ -3,7 +3,7 @@ import { IHubSchedule, IHubScheduleResponse } from "../core/types/IHubSchedule";
 import { cloneObject } from "../util";
 import { deepEqual } from "../objects/deepEqual";
 import { AccessLevel, IHubEditableContent } from "../core";
-import { getSchedulerApiUrl } from "./_internal/getSchedulerApiUrl";
+import { getSchedulerApiUrl } from "./_internal/internalContentUtils";
 
 // Any code referencing these functions must first pass isDownloadSchedulingAvailable
 
@@ -43,6 +43,14 @@ export const getSchedule = async (
         message: `Download schedule found for item ${itemId}`,
         statusCode: 200,
       } as IHubScheduleResponse;
+    case "manual":
+      return {
+        schedule: {
+          mode: "manual",
+        },
+        message: `Download schedule found for item ${itemId}`,
+        statusCode: 200,
+      } as IHubScheduleResponse;
   }
 };