Merge pull request #1521 from Esri/web-tool-enterprise

Web tool enterprise

Author: jmhauck

packages/web-tool/src/web-tool-processor.ts

@@ -205,51 +205,108 @@ export function createWebTool(
   destinationAuthentication: common.UserSession,
 ): Promise<any> {
   return new Promise<any>((resolve, reject) => {
-    if (templateDictionary?.portalUrls?.notebooks.https.length > 0) {
-      const notebookUrl = templateDictionary.portalUrls.notebooks.https[0];
-      const url = `https://${notebookUrl}/admin/services/createService?f=json&request.preventCache=${Date.now()}`;
-
-      const params = {
-        serviceProperties: {
-          description: template.item.description,
-          provider: "notebooks",
-          type: "GPServer",
-          jsonProperties: {
-            timeoutInMinutes: template.data.timeoutInMinutes,
-            title: template.item.title,
-            notebookId: template.data.notebookId,
-            tasks: [
-              {
-                type: "notebook",
-                name: template.data.name,
+    getNotebookServerCreateServiceURL(
+      templateDictionary.portalBaseUrl,
+      destinationAuthentication,
+      templateDictionary,
+    ).then(
+      (url) => {
+        if (url) {
+          const params = {
+            serviceProperties: {
+              description: template.item.description,
+              provider: "notebooks",
+              type: "GPServer",
+              jsonProperties: {
+                timeoutInMinutes: template.data.timeoutInMinutes,
+                title: template.item.title,
+                notebookId: template.data.notebookId,
+                tasks: [
+                  {
+                    type: "notebook",
+                    name: template.data.name,
+                  },
+                ],
               },
-            ],
-          },
-        },
-      };
-
-      const requestOptions = {
-        httpMethod: "POST",
-        authentication: destinationAuthentication,
-        params,
-        headers: {
-          "Accept": "application/json",
-          "Authorization": `Bearer ${destinationAuthentication.token}`,
-          "Content-Type": "application/json",
-          "X-Esri-Authorization": `Bearer ${destinationAuthentication.token}`,
-        },
-      } as common.IRequestOptions;
+            },
+          };
 
-      common.request(url, requestOptions).then(
-        (response) => {
-          resolve(response);
-        },
-        (e) => {
-          reject(e);
-        },
-      );
-    } else {
-      reject();
-    }
+          const requestOptions = {
+            httpMethod: "POST",
+            authentication: destinationAuthentication,
+            params,
+            headers: {
+              "Accept": "application/json",
+              "Authorization": `Bearer ${destinationAuthentication.token}`,
+              "Content-Type": "application/json",
+              "X-Esri-Authorization": `Bearer ${destinationAuthentication.token}`,
+            },
+          } as common.IRequestOptions;
+
+          common.request(url, requestOptions).then(
+            (response) => {
+              resolve(response);
+            },
+            (e) => {
+              reject(e);
+            },
+          );
+        } else {
+          reject();
+        }
+      },
+      (e) => {
+        reject(e);
+      },
+    );
   });
 }
+
+/**
+ * Get the URL for the Notebook server in Enterprise.
+ *
+ * @param portalBaseUrl URL of the portal endpoint, e.g., "https://gisserver.domain.com/server"
+ * @param authentication Credentials for the request to AGO
+ * @returns URL for the Notebook server Enterprise application (e.g., "https://abc123.esri.com:6443/gis"),
+ * or an empty string if Notebook server is not installed
+ */
+export async function getNotebookServerCreateServiceURL(
+  portalBaseUrl: string,
+  authentication: common.UserSession,
+  templateDictionary: any,
+): Promise<string> {
+  const notebookUrl = templateDictionary.isPortal
+    ? await getNotebookEnterpriseServerRootURL(portalBaseUrl, authentication)
+    : templateDictionary.portalUrls?.notebooks.https.length > 0
+      ? templateDictionary.portalUrls.notebooks.https[0]
+      : "";
+
+  return notebookUrl && templateDictionary.isPortal
+    ? `${notebookUrl}/admin/services/createService?f=json&request.preventCache=${Date.now()}`
+    : notebookUrl
+      ? `https://${notebookUrl}/admin/services/createService?f=json&request.preventCache=${Date.now()}`
+      : "";
+}
+
+/**
+ * Get the URL for the Notebook server in Enterprise.
+ *
+ * @param portalBaseUrl URL of the portal endpoint, e.g., "https://gisserver.domain.com/server"
+ * @param authentication Credentials for the request to AGO
+ * @returns URL for the Notebook server Enterprise application (e.g., "https://abc123.esri.com:6443/gis"),
+ * or an empty string if Notebook server is not installed
+ */
+export async function getNotebookEnterpriseServerRootURL(
+  portalBaseUrl: string,
+  authentication: common.UserSession,
+): Promise<string> {
+  // Get the servers
+  const servers = await common.getEnterpriseServers(`${portalBaseUrl}/sharing/rest`, authentication);
+
+  // Find the Notebook server
+  const notebookServer = servers.find((s: any) => s.serverFunction.indexOf("NotebookServer") > -1);
+  if (!notebookServer) {
+    return "";
+  }
+  return notebookServer.url as string;
+}

packages/web-tool/test/web-tool-processor.test.ts

@@ -153,6 +153,33 @@ describe("Module `web-tool-processor`: ", () => {
       expect(blobToJsonSpy.calls.count()).toBe(1);
     });
 
+    it("can handle error on getEnterpriseServers", async () => {
+      const getEnterpriseServersSpy = spyOn(common, "getEnterpriseServers").and.throwError("error")
+
+      await WebToolProcessor.createItemFromTemplate(
+        {
+          id: "bc3",
+          type: "Geoprocessing Service",
+          item: {
+            typeKeywords: ["Web Tool"],
+            thumbnail: "thumb",
+          },
+          data: {
+            notebookId: "123",
+            name: "NotebookName",
+          },
+        } as any,
+        {
+          isPortal: true
+        },
+        MOCK_USER_SESSION,
+        cb,
+      );
+
+      expect(getEnterpriseServersSpy.calls.count()).toBe(1);
+      expect(getEnterpriseServersSpy).toThrowError();
+    });
+
     it("Web Tool Geoprocessing Service handles cancel with item removal", async () => {
       const createCb2 = () => {
         let calls = 0;
@@ -638,12 +665,100 @@ describe("Module `web-tool-processor`: ", () => {
           type: "Geoprocessing Service",
           item: { typeKeywords: ["Web Tool"] },
         } as any,
-        undefined,
+        {},
         MOCK_USER_SESSION,
       ).then(
         () => fail(),
         (e) => expect(e).toBeUndefined(),
       );
     });
   });
+
+  describe("getNotebookServerCreateServiceURL", () => {
+    it("should fetch servers for Enterprise", async () => {
+      const notebookBaseUrl = "https://RQALnxBI01NB.esri.com/gis";
+      const getEnterpriseServersSpy = spyOn(common, "getEnterpriseServers").and.resolveTo([
+        {
+          "id": "e0d0rP32Fai4ToC3",
+          "name": "RQALnxBI01Sv.esri.com:6443",
+          "adminUrl": "https://RQALnxBI01Sv.esri.com:6443/arcgis",
+          "url": "https://RQALnxBI01Sv.esri.com/gis",
+          "isHosted": true,
+          "serverType": "ArcGIS",
+          "serverRole": "HOSTING_SERVER",
+          "serverFunction": "KnowledgeServer,WorkflowManager"
+        },
+        {
+          "id": "U5yshUHhJkWINozX",
+          "name": "RQALnxBI01NB.esri.com:11443",
+          "adminUrl": "https://RQALnxBI01NB.esri.com:11443/arcgis",
+          "url": notebookBaseUrl,
+          "isHosted": false,
+          "serverType": "ARCGIS_NOTEBOOK_SERVER",
+          "serverRole": "FEDERATED_SERVER",
+          "serverFunction": "NotebookServer"
+        }
+      ]);
+
+      return WebToolProcessor.getNotebookServerCreateServiceURL(
+        "https://gisserver.domain.com/server",
+        MOCK_USER_SESSION,
+        {
+          isPortal: true
+        }
+      ).then(
+        (url) => {
+          expect(getEnterpriseServersSpy.calls.count()).toBe(1);
+          expect(url.startsWith(
+            `${notebookBaseUrl}/admin/services/createService?f=json&request.preventCache=`
+          )).toBe(true);
+        },
+        () => fail(),
+      );
+    });
+
+
+    it("should handle missing Enterprise server", async () => {
+      const getEnterpriseServersSpy = spyOn(common, "getEnterpriseServers").and.resolveTo([
+        {
+          "id": "e0d0rP32Fai4ToC3",
+          "name": "RQALnxBI01Sv.esri.com:6443",
+          "adminUrl": "https://RQALnxBI01Sv.esri.com:6443/arcgis",
+          "url": "https://RQALnxBI01Sv.esri.com/gis",
+          "isHosted": true,
+          "serverType": "ArcGIS",
+          "serverRole": "HOSTING_SERVER",
+          "serverFunction": "KnowledgeServer,WorkflowManager"
+        }
+      ]);
+
+      return WebToolProcessor.getNotebookServerCreateServiceURL(
+        "https://gisserver.domain.com/server",
+        MOCK_USER_SESSION,
+        {
+          isPortal: true
+        }
+      ).then(
+        (url) => {
+          expect(getEnterpriseServersSpy.calls.count()).toBe(1);
+          expect(url).toBe("");
+        },
+        () => fail(),
+      );
+    });
+
+    it("should handle missing portalUrls", async () => {
+      return WebToolProcessor.getNotebookServerCreateServiceURL(
+        "https://gisserver.domain.com/server",
+        MOCK_USER_SESSION,
+        {}
+      ).then(
+        (url) => {
+          expect(url).toBe("");
+        },
+        () => fail(),
+      );
+    });
+
+  });
 });