autnam 1.0.0

package/packages/arcgis-rest-feature-service/test/addToServiceDefinition.test.ts

@@ -0,0 +1,350 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import fetchMock from "fetch-mock";
+import { TOMORROW } from "../../../scripts/test-helpers.js";
+import {
+  encodeParam,
+  ErrorTypes,
+  ArcGISIdentityManager
+} from "@esri/arcgis-rest-request";
+import { ILayer, ITable } from "../src/helpers.js";
+import { addToServiceDefinition } from "../src/addToServiceDefinition.js";
+import {
+  AddToFeatureServiceSuccessResponseFredAndGinger,
+  AddToFeatureServiceSuccessResponseFayardAndHarold,
+  AddToFeatureServiceSuccessResponseCydAndGene,
+  AddToFeatureServiceError
+} from "./mocks/service.js";
+import { layerDefinitionSid } from "./mocks/layerDefinition.js";
+
+describe("add to feature service", () => {
+  afterEach(fetchMock.restore);
+
+  describe("Authenticated methods", () => {
+    // setup a ArcGISIdentityManager to use in all these tests
+    const MOCK_USER_SESSION = new ArcGISIdentityManager({
+      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-feature-service/test/attachments.test.ts

@@ -0,0 +1,188 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import fetchMock from "fetch-mock";
+import { attachmentFile } from "../../../scripts/test-helpers.js";
+import {
+  getAttachments,
+  IGetAttachmentsOptions,
+  addAttachment,
+  IAddAttachmentOptions,
+  updateAttachment,
+  IUpdateAttachmentOptions,
+  deleteAttachments,
+  IDeleteAttachmentsOptions
+} from "../src/index.js";
+
+import {
+  getAttachmentsResponse,
+  addAttachmentResponse,
+  updateAttachmentResponse,
+  deleteAttachmentsResponse,
+  genericInvalidResponse
+} from "./mocks/feature.js";
+import { FormData } from "@esri/arcgis-rest-form-data";
+const serviceUrl =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer/0";
+
+describe("attachment methods", () => {
+  afterEach(fetchMock.restore);
+
+  it("should return an array of attachmentInfos for a feature by id", (done) => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      params: {
+        gdbVersion: "SDE.DEFAULT"
+      }
+    } as IGetAttachmentsOptions;
+    fetchMock.once("*", getAttachmentsResponse);
+    getAttachments(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/attachments?f=json&gdbVersion=SDE.DEFAULT`
+        );
+        expect(options.method).toBe("GET");
+        expect(getAttachmentsResponse.attachmentInfos.length).toEqual(2);
+        expect(getAttachmentsResponse.attachmentInfos[0].id).toEqual(409);
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the added attachment and a truthy success", (done) => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IAddAttachmentOptions;
+    fetchMock.once("*", addAttachmentResponse);
+    addAttachment(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/addAttachment`
+        );
+        expect(options.method).toBe("POST");
+
+        const params = options.body as FormData;
+        expect(params instanceof FormData).toBeTruthy();
+        // we can introspect FormData in Chrome this way, but not Node.js
+        // more info: https://github.com/form-data/form-data/issues/124
+        if (params.get) {
+          expect(params.get("returnEditMoment")).toEqual("true");
+        }
+        expect(addAttachmentResponse.addAttachmentResult.objectId).toEqual(
+          1001
+        );
+        expect(addAttachmentResponse.addAttachmentResult.success).toEqual(true);
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should return an error for a service/feature which does not have attachments", (done) => {
+    const requestOptions = {
+      url: "https://services.arcgis.com/f8b/arcgis/rest/services/NoAttachments/FeatureServer/0",
+      featureId: 654,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IAddAttachmentOptions;
+    fetchMock.once("*", genericInvalidResponse);
+    addAttachment(requestOptions)
+      .then(() => {
+        // nothing to test here forcing error
+        fail();
+      })
+      .catch((error) => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/addAttachment`
+        );
+        expect(options.method).toBe("POST");
+        expect(error.response.error.code).toEqual(400);
+        expect(error.response.error.message).toEqual(
+          "Invalid or missing input parameters."
+        );
+        done();
+      });
+  });
+
+  it("should return objectId of the updated attachment and a truthy success", (done) => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachmentId: 1001,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IUpdateAttachmentOptions;
+    fetchMock.once("*", updateAttachmentResponse);
+    updateAttachment(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/updateAttachment`
+        );
+        expect(options.method).toBe("POST");
+        expect(
+          updateAttachmentResponse.updateAttachmentResult.objectId
+        ).toEqual(1001);
+        expect(updateAttachmentResponse.updateAttachmentResult.success).toEqual(
+          true
+        );
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the deleted attachment and a truthy success", (done) => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachmentIds: [1001],
+      params: {
+        returnEditMoment: true
+      }
+    } as IDeleteAttachmentsOptions;
+    fetchMock.once("*", deleteAttachmentsResponse);
+    deleteAttachments(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/deleteAttachments`
+        );
+        expect(options.body).toContain("attachmentIds=1001");
+        expect(options.body).toContain("returnEditMoment=true");
+        expect(options.method).toBe("POST");
+        expect(
+          deleteAttachmentsResponse.deleteAttachmentResults[0].objectId
+        ).toEqual(1001);
+        expect(
+          deleteAttachmentsResponse.deleteAttachmentResults[0].success
+        ).toEqual(true);
+        done();
+      })
+      .catch((e) => {
+        fail(e);
+      });
+  });
+});