sintfacilis 1.0.0

package/packages/arcgis-rest-service-admin/test/addTo.test.ts

@@ -0,0 +1,350 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { TOMORROW } from "@esri/arcgis-rest-auth/test/utils";
+import { encodeParam, ErrorTypes } from "@esri/arcgis-rest-request";
+import { ILayer, ITable } from "@esri/arcgis-rest-types";
+import { addToServiceDefinition } from "../src/addTo";
+import {
+  AddToFeatureServiceSuccessResponseFredAndGinger,
+  AddToFeatureServiceSuccessResponseFayardAndHarold,
+  AddToFeatureServiceSuccessResponseCydAndGene,
+  AddToFeatureServiceError,
+} from "./mocks/service";
+import { layerDefinitionSid } from "./mocks/layerDefinition";
+
+describe("add to feature service", () => {
+  afterEach(fetchMock.restore);
+
+  describe("Authenticated methods", () => {
+    // setup a UserSession to use in all these tests
+    const MOCK_USER_SESSION = new UserSession({
+      clientId: "clientId",
+      redirectUri: "https://example-app.com/redirect-uri",
+      token: "fake-token",
+      tokenExpires: TOMORROW,
+      refreshToken: "refreshToken",
+      refreshTokenExpires: TOMORROW,
+      refreshTokenTTL: 1440,
+      username: "casey",
+      password: "123456",
+      portal: "https://myorg.maps.arcgis.com/sharing/rest",
+    });
+
+    const MOCK_USER_REQOPTS = {
+      authentication: MOCK_USER_SESSION,
+    };
+
+    const layerDescriptionFred: ILayer = {
+      name: "Fred",
+      id: "1899",
+      layerType: "Feature Layer",
+    };
+
+    const layerDescriptionGinger: ILayer = {
+      name: "Ginger",
+      id: "1911",
+      layerType: "Feature Layer",
+    };
+
+    const layerDescriptionCyd: ILayer = {
+      name: "Cyd",
+      id: "1922",
+      layerType: "Feature Layer",
+    };
+
+    const layerDescriptionFail: ILayer = {
+      name: "",
+      id: "",
+      layerType: "Feature Layer",
+    };
+
+    const tableDescriptionFayard: ITable = {
+      name: "Fayard",
+      id: 1914,
+    };
+
+    const tableDescriptionHarold: ITable = {
+      name: "Harold",
+      id: 1921,
+    };
+
+    const tableDescriptionGene: ITable = {
+      name: "Gene",
+      id: 1912,
+    };
+
+    const tableDescriptionFail: ITable = {
+      name: "",
+      id: 0,
+    };
+
+    it("should add a pair of layers", (done) => {
+      fetchMock.once("*", AddToFeatureServiceSuccessResponseFredAndGinger);
+
+      addToServiceDefinition(
+        "https://services1.arcgis.com/ORG/arcgis/rest/services/FEATURE_SERVICE/FeatureServer",
+        {
+          layers: [layerDescriptionFred, layerDescriptionGinger],
+          ...MOCK_USER_REQOPTS,
+        }
+      )
+        .then(
+          (response) => {
+            // Check service call
+            expect(fetchMock.called()).toEqual(true);
+            const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+              "*"
+            );
+
+            expect(url).toEqual(
+              "https://services1.arcgis.com/ORG/arcgis/rest/admin/services/FEATURE_SERVICE/FeatureServer/addToDefinition"
+            );
+            expect(options.method).toBe("POST");
+            expect(options.body).toContain("f=json");
+            expect(options.body).toContain(encodeParam("token", "fake-token"));
+            expect(options.body).toContain(
+              encodeParam(
+                "addToDefinition",
+                JSON.stringify({
+                  layers: [layerDescriptionFred, layerDescriptionGinger],
+                })
+              )
+            );
+
+            // Check response
+            expect(response).toEqual(
+              AddToFeatureServiceSuccessResponseFredAndGinger
+            );
+
+            done();
+          },
+          () => {
+            fail(); // call is supposed to succeed
+          }
+        )
+        .catch((e) => {
+          fail(e);
+        });
+    });
+
+    it("should add a pair of tables", (done) => {
+      fetchMock.once("*", AddToFeatureServiceSuccessResponseFayardAndHarold);
+
+      addToServiceDefinition(
+        "https://services1.arcgis.com/ORG/arcgis/rest/services/FEATURE_SERVICE/FeatureServer",
+        {
+          tables: [tableDescriptionFayard, tableDescriptionHarold],
+          ...MOCK_USER_REQOPTS,
+        }
+      )
+        .then(
+          (response) => {
+            // Check service call
+            expect(fetchMock.called()).toEqual(true);
+            const [url, options]: [string, RequestInit] = fetchMock.lastCall(
+              "*"
+            );
+
+            expect(url).toEqual(
+              "https://services1.arcgis.com/ORG/arcgis/rest/admin/services/FEATURE_SERVICE/FeatureServer/addToDefinition"
+            );
+            expect(options.method).toBe("POST");
+            expect(options.body).toContain("f=json");
+            expect(options.body).toContain(encodeParam("token", "fake-token"));
+            expect(options.body).toContain(
+              encodeParam(
+                "addToDefinition",
+                JSON.stringify({
+                  tables: [tableDescriptionFayard, tableDescriptionHarold],
+                })
+              )
+            );
+
+            // Check response
+            expect(response).toEqual(
+              AddToFeatureServiceSuccessResponseFayardAndHarold
+            );
+
+            done();
+          },
+          () => {
+            fail(); // call is supposed to succeed
+          }
+        )
+        .catch((e) => {
+          fail(e);
+        });
+    });
+
+    it("should add a layer and a table", (done) => {
+      fetchMock.once("*", AddToFeatureServiceSuccessResponseCydAndGene);
+
+      addToServiceDefinition(
+        "https://services1.arcgis.com/ORG/arcgis/rest/services/FEATURE_SERVICE/FeatureServer",
+        {
+          layers: [layerDescriptionCyd],
+          tables: [tableDescriptionGene],
+          ...MOCK_USER_REQOPTS,
+        }
+      )
+        .then((response) => {
+          // Check service call
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+
+          expect(url).toEqual(
+            "https://services1.arcgis.com/ORG/arcgis/rest/admin/services/FEATURE_SERVICE/FeatureServer/addToDefinition"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body).toContain("f=json");
+          expect(options.body).toContain(encodeParam("token", "fake-token"));
+          expect(options.body).toContain(
+            encodeParam(
+              "addToDefinition",
+              JSON.stringify({
+                layers: [layerDescriptionCyd],
+                tables: [tableDescriptionGene],
+              })
+            )
+          );
+
+          // Check response
+          expect(response).toEqual(
+            AddToFeatureServiceSuccessResponseCydAndGene
+          );
+          done();
+        })
+        .catch((e) => {
+          fail(e);
+        });
+    });
+
+    it("should add a layer definition", (done) => {
+      fetchMock.once("*", AddToFeatureServiceSuccessResponseCydAndGene);
+
+      addToServiceDefinition(
+        "https://services1.arcgis.com/ORG/arcgis/rest/services/FEATURE_SERVICE/FeatureServer",
+        {
+          layers: [layerDefinitionSid],
+          ...MOCK_USER_REQOPTS,
+        }
+      )
+        .then((response) => {
+          // Check service call
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+
+          expect(url).toEqual(
+            "https://services1.arcgis.com/ORG/arcgis/rest/admin/services/FEATURE_SERVICE/FeatureServer/addToDefinition"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body).toContain("f=json");
+          expect(options.body).toContain(encodeParam("token", "fake-token"));
+          expect(options.body).toContain(
+            encodeParam(
+              "addToDefinition",
+              JSON.stringify({
+                layers: [layerDefinitionSid],
+              })
+            )
+          );
+
+          // Check response
+          expect(response).toEqual(
+            AddToFeatureServiceSuccessResponseCydAndGene
+          );
+          done();
+        })
+        .catch((e) => {
+          fail(e);
+        });
+    });
+
+    it("should fail to add a bad layer", (done) => {
+      fetchMock.once("*", AddToFeatureServiceError);
+
+      addToServiceDefinition(
+        "https://services1.arcgis.com/ORG/arcgis/rest/services/FEATURE_SERVICE/FeatureServer",
+        {
+          layers: [layerDescriptionFail],
+          ...MOCK_USER_REQOPTS,
+        }
+      ).catch((error) => {
+        expect(error.name).toBe(ErrorTypes.ArcGISRequestError);
+        expect(error.message).toBe(
+          "400: Unable to add feature service definition."
+        );
+        expect(error instanceof Error).toBeTruthy();
+        expect(error.url).toBe(
+          "https://services1.arcgis.com/ORG/arcgis/rest/admin/services/FEATURE_SERVICE/FeatureServer/addToDefinition"
+        );
+        // params added internally aren't surfaced in the error
+        expect(error.options.params.addToDefinition).toEqual({
+          layers: [layerDescriptionFail],
+        });
+        expect(error.options.httpMethod).toEqual("POST");
+        done();
+      });
+    });
+
+    it("should fail to add a bad table", (done) => {
+      fetchMock.once("*", AddToFeatureServiceError);
+
+      addToServiceDefinition(
+        "https://services1.arcgis.com/ORG/arcgis/rest/services/FEATURE_SERVICE/FeatureServer",
+        {
+          tables: [tableDescriptionFail],
+          ...MOCK_USER_REQOPTS,
+        }
+      ).catch((error) => {
+        expect(error.name).toBe(ErrorTypes.ArcGISRequestError);
+        expect(error.message).toBe(
+          "400: Unable to add feature service definition."
+        );
+        expect(error instanceof Error).toBeTruthy();
+        expect(error.url).toBe(
+          "https://services1.arcgis.com/ORG/arcgis/rest/admin/services/FEATURE_SERVICE/FeatureServer/addToDefinition"
+        );
+        // params added internally aren't surfaced in the error
+        expect(error.options.params.addToDefinition).toEqual({
+          tables: [tableDescriptionFail],
+        });
+        expect(error.options.httpMethod).toEqual("POST");
+        done();
+      });
+    });
+
+    it("should fail to add a bad layer and a bad table", (done) => {
+      fetchMock.once("*", AddToFeatureServiceError);
+
+      addToServiceDefinition(
+        "https://services1.arcgis.com/ORG/arcgis/rest/services/FEATURE_SERVICE/FeatureServer",
+        {
+          layers: [layerDescriptionFail],
+          tables: [tableDescriptionFail],
+          ...MOCK_USER_REQOPTS,
+        }
+      ).catch((error) => {
+        expect(error.name).toBe(ErrorTypes.ArcGISRequestError);
+        expect(error.message).toBe(
+          "400: Unable to add feature service definition."
+        );
+        expect(error instanceof Error).toBeTruthy();
+        expect(error.url).toBe(
+          "https://services1.arcgis.com/ORG/arcgis/rest/admin/services/FEATURE_SERVICE/FeatureServer/addToDefinition"
+        );
+        // params added internally aren't surfaced in the error
+        expect(error.options.params.addToDefinition).toEqual({
+          tables: [tableDescriptionFail],
+          layers: [layerDescriptionFail],
+        });
+        expect(error.options.httpMethod).toEqual("POST");
+        done();
+      });
+    });
+  }); // auth requests
+});

package/packages/arcgis-rest-service-admin/test/create.test.ts

@@ -0,0 +1,294 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+
+import { createFeatureService } from "../src/create";
+
+import { FeatureServiceResponse } from "./mocks/service";
+
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { TOMORROW } from "@esri/arcgis-rest-auth/test/utils";
+import { encodeParam } from "@esri/arcgis-rest-request";
+
+describe("create feature service", () => {
+  afterEach(fetchMock.restore);
+
+  describe("Authenticated methods", () => {
+    // setup a UserSession to use in all these tests
+    const MOCK_USER_SESSION = new UserSession({
+      clientId: "clientId",
+      redirectUri: "https://example-app.com/redirect-uri",
+      token: "fake-token",
+      tokenExpires: TOMORROW,
+      refreshToken: "refreshToken",
+      refreshTokenExpires: TOMORROW,
+      refreshTokenTTL: 1440,
+      username: "casey",
+      password: "123456",
+      portal: "https://myorg.maps.arcgis.com/sharing/rest"
+    });
+
+    const MOCK_USER_REQOPTS = {
+      authentication: MOCK_USER_SESSION
+    };
+
+    const serviceDescription = {
+      name: "EmptyServiceName",
+      serviceDescription: "",
+      hasStaticData: false,
+      maxRecordCount: 1000,
+      supportedQueryFormats: "JSON",
+      capabilities: "Create,Delete,Query,Update,Editing",
+      description: "",
+      copyrightText: "",
+      spatialReference: {
+        wkid: 102100
+      },
+      initialExtent: {
+        xmin: -20037507.0671618,
+        ymin: -30240971.9583862,
+        xmax: 20037507.0671618,
+        ymax: 18398924.324645,
+        spatialReference: {
+          wkid: 102100,
+          latestWkid: 3857
+        }
+      },
+      allowGeometryUpdates: true,
+      units: "esriMeters",
+      xssPreventionInfo: {
+        xssPreventionEnabled: true,
+        xssPreventionRule: "InputOnly",
+        xssInputRule: "rejectInvalid"
+      }
+    };
+
+    it("should create a feature service defaulting to the root folder", done => {
+      fetchMock.mock("end:createService", FeatureServiceResponse, {});
+
+      createFeatureService({
+        item: serviceDescription,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(
+          response => {
+            expect(fetchMock.called("end:createService")).toEqual(true);
+
+            // Check create service call
+            const [urlCreate, optionsCreate]: [
+              string,
+              RequestInit
+            ] = fetchMock.lastCall("end:createService");
+            expect(urlCreate).toEqual(
+              "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/createService"
+            );
+            expect(optionsCreate.method).toBe("POST");
+            expect(optionsCreate.body).toContain("f=json");
+            expect(optionsCreate.body).toContain(
+              encodeParam(
+                "createParameters",
+                JSON.stringify(serviceDescription)
+              )
+            );
+            expect(optionsCreate.body).toContain("outputType=featureService");
+            expect(optionsCreate.body).toContain(
+              encodeParam("token", "fake-token")
+            );
+
+            // Check response
+            expect(response).toEqual(FeatureServiceResponse);
+
+            done();
+          },
+          () => {
+            fail(); // call is supposed to succeed
+          }
+        )
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should create a feature service specified for the root folder 1", done => {
+      fetchMock.mock("end:createService", FeatureServiceResponse, {});
+      const folderId = "";
+
+      createFeatureService({
+        item: serviceDescription,
+        folderId,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(
+          response => {
+            expect(fetchMock.called("end:createService")).toEqual(true);
+
+            // Check create service call
+            const [urlCreate, optionsCreate]: [
+              string,
+              RequestInit
+            ] = fetchMock.lastCall("end:createService");
+            expect(urlCreate).toEqual(
+              "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/createService"
+            );
+            expect(optionsCreate.method).toBe("POST");
+            expect(optionsCreate.body).toContain("f=json");
+            expect(optionsCreate.body).toContain(
+              encodeParam(
+                "createParameters",
+                JSON.stringify(serviceDescription)
+              )
+            );
+            expect(optionsCreate.body).toContain("outputType=featureService");
+            expect(optionsCreate.body).toContain(
+              encodeParam("token", "fake-token")
+            );
+
+            // Check response
+            expect(response).toEqual(FeatureServiceResponse);
+
+            done();
+          },
+          () => {
+            fail(); // call is supposed to succeed
+          }
+        )
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should create a feature service specified for the root folder 2", done => {
+      fetchMock.mock("end:createService", FeatureServiceResponse, {});
+      const folderId = "/";
+
+      createFeatureService({
+        item: serviceDescription,
+        folderId,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(
+          response => {
+            expect(fetchMock.called("end:createService")).toEqual(true);
+
+            // Check create service call
+            const [urlCreate, optionsCreate]: [
+              string,
+              RequestInit
+            ] = fetchMock.lastCall("end:createService");
+            expect(urlCreate).toEqual(
+              "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/createService"
+            );
+            expect(optionsCreate.method).toBe("POST");
+            expect(optionsCreate.body).toContain("f=json");
+            expect(optionsCreate.body).toContain(
+              encodeParam(
+                "createParameters",
+                JSON.stringify(serviceDescription)
+              )
+            );
+            expect(optionsCreate.body).toContain("outputType=featureService");
+            expect(optionsCreate.body).toContain(
+              encodeParam("token", "fake-token")
+            );
+
+            // Check response
+            expect(response).toEqual(FeatureServiceResponse);
+
+            done();
+          },
+          () => {
+            fail(); // call is supposed to succeed
+          }
+        )
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should create a feature service in a particular folder", done => {
+      fetchMock
+        .mock("end:createService", FeatureServiceResponse, {});
+      const folderId = "83216cba44bf4357bf06687ec88a847b";
+
+      createFeatureService({
+        item: serviceDescription,
+        folderId,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(
+          response => {
+            expect(fetchMock.called("end:createService")).toEqual(true);
+
+            // Check create service call
+            const [urlCreate, optionsCreate]: [
+              string,
+              RequestInit
+            ] = fetchMock.lastCall("end:createService");
+            expect(urlCreate).toEqual(
+              "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/83216cba44bf4357bf06687ec88a847b/createService"
+            );
+            expect(optionsCreate.method).toBe("POST");
+            expect(optionsCreate.body).toContain("f=json");
+            expect(optionsCreate.body).toContain(
+              encodeParam(
+                "createParameters",
+                JSON.stringify(serviceDescription)
+              )
+            );
+            expect(optionsCreate.body).toContain("outputType=featureService");
+            expect(optionsCreate.body).toContain(
+              encodeParam("token", "fake-token")
+            );
+
+            // Check response
+            expect(response).toEqual(FeatureServiceResponse);
+
+            done();
+          },
+          () => {
+            fail(); // call is supposed to succeed
+          }
+        )
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should fail to create a feature service destined for a particular folder with success=false", done => {
+      fetchMock.mock("end:createService", { success: false });
+
+      const folderId = "83216cba44bf4357bf06687ec88a847b";
+
+      createFeatureService({
+        item: serviceDescription,
+        folderId,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(e => {
+          expect(fetchMock.called("end:createService")).toEqual(true);
+
+          // Check create service call
+          const [urlCreate, optionsCreate]: [
+            string,
+            RequestInit
+          ] = fetchMock.lastCall("end:createService");
+          expect(urlCreate).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/83216cba44bf4357bf06687ec88a847b/createService"
+          );
+          expect(optionsCreate.method).toBe("POST");
+          expect(optionsCreate.body).toContain("f=json");
+          expect(optionsCreate.body).toContain(
+            encodeParam("createParameters", JSON.stringify(serviceDescription))
+          );
+          expect(optionsCreate.body).toContain("outputType=featureService");
+          expect(optionsCreate.body).toContain(
+            encodeParam("token", "fake-token")
+          );
+          expect(e.success).toBeFalsy();
+          done();
+        })
+      .catch(() => fail());
+    });
+  });
+});

package/packages/arcgis-rest-service-admin/test/get-service-admin-info.test.ts

@@ -0,0 +1,37 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as requestModule from "@esri/arcgis-rest-request";
+import { getServiceAdminInfo } from "../src/get-service-admin-info";
+import { TOMORROW } from "@esri/arcgis-rest-auth/test/utils";
+import { UserSession } from "@esri/arcgis-rest-auth";
+
+describe("get-service-admin-info: ", () => {
+  const MOCK_USER_SESSION = new UserSession({
+    clientId: "clientId",
+    redirectUri: "https://example-app.com/redirect-uri",
+    token: "fake-token",
+    tokenExpires: TOMORROW,
+    refreshToken: "refreshToken",
+    refreshTokenExpires: TOMORROW,
+    refreshTokenTTL: 1440,
+    username: "casey",
+    password: "123456",
+    portal: "https://myorg.maps.arcgis.com/sharing/rest",
+  });
+  it("makes request to the admin url", () => {
+    const spy = spyOn(requestModule, "request").and.callFake(() =>
+      Promise.resolve({ foo: "bar" })
+    );
+    return getServiceAdminInfo(
+      "https://servicesqa.arcgis.com/orgid/arcgis/rest/services/mysevice/FeatureServer",
+      MOCK_USER_SESSION
+    ).then((result) => {
+      expect(result.foo).toBe("bar", "should return the api response");
+      expect(spy.calls.count()).toBe(1, "should make one request");
+      expect(spy.calls.argsFor(0)[0]).toBe(
+        "https://servicesqa.arcgis.com/orgid/arcgis/rest/admin/services/mysevice/FeatureServer"
+      );
+    });
+  });
+});