FE-6300 Accept s3 URI as input for export and show s3 URI in output.

cleve-fauna · cleve-fauna · commit 6c009f82ef12 · 2025-01-24T15:33:36.000-05:00
diff --git a/src/commands/export/create.mjs b/src/commands/export/create.mjs
@@ -19,19 +19,24 @@ async function createS3Export(argv) {
     wait,
     maxWait,
     quiet,
+    destination,
   } = argv;
   const logger = container.resolve("logger");
   const { createExport } = container.resolve("accountAPI");
-
-  let createdExport = await createExport({
-    database,
-    collections,
-    destination: {
+  let destinationInput = destination;
+  if (!destinationInput) {
+    destinationInput = {
       s3: {
         bucket,
         path,
       },
-    },
+    };
+  }
+
+  let createdExport = await createExport({
+    database,
+    collections,
+    destination: destinationInput,
     format,
   });
 
@@ -44,7 +49,6 @@ async function createS3Export(argv) {
       },
     });
   }
-
   if (json) {
     logger.stdout(colorize(createdExport, { color, format: Format.JSON }));
   } else {
@@ -54,39 +58,52 @@ async function createS3Export(argv) {
 
 const sharedExamples = [
   [
-    "$0 export create s3 --database us/my_db --bucket doc-example-bucket --path exports/my_db",
-    "Export the 'us-std/my_db' database to the 'exports/my_db' path of the 'doc-example-bucket' S3 bucket. Outputs the export ID.",
+    "$0 export create s3 --destination s3://doc-example-bucket/exports/my_db",
+    "Export the 'us-std/my_db' database to the S3 URI 's3://doc-example-bucket/exports/my_db'.",
   ],
   [
-    "$0 export create s3 --database us/my_db --bucket doc-example-bucket --path my-prefix --json",
+    "$0 export create s3 --bucket doc-example-bucket --path exports/my_db",
+    "You can also specify the S3 location using --bucket and --path options rather than --destination.",
+  ],
+  [
+    "$0 export create s3 --destination s3://doc-example-bucket/my-prefix --json",
     "Output the full JSON of the export request.",
   ],
   [
-    "$0 export create s3 --database us/my_db --bucket doc-example-bucket --path my-prefix --collection my-collection",
+    "$0 export create s3 --destination s3://doc-example-bucket/my-prefix --collection my-collection",
     "Export the 'my-collection' collection only.",
   ],
   [
-    "$0 export create s3 --database us/my_db --bucket doc-example-bucket --path my-prefix --format tagged",
+    "$0 export create s3 --destination s3://doc-example-bucket/my-prefix --format tagged",
     "Encode the export's document data using the 'tagged' format.",
   ],
   [
-    "$0 export create s3 --database us/my_db --bucket doc-example-bucket --path my-prefix --wait --max-wait 180",
+    "$0 export create s3 --destination s3://doc-example-bucket/my-prefix --wait --max-wait 180",
     "Wait for the export to complete or fail before exiting. Waits up to 180 minutes.",
   ],
 ];
 
+const S3_URI_REGEX = /^s3:\/\/[^/]+\/.+$/;
+
 function buildCreateS3ExportCommand(yargs) {
   return yargs
     .options({
+      destination: {
+        alias: ["uri", "destination-uri"],
+        type: "string",
+        required: false,
+        description: "S3 URI in the format s3://bucket/path.",
+        group: "API:",
+      },
       bucket: {
         type: "string",
-        required: true,
+        required: false,
         description: "Name of the S3 bucket where the export will be stored.",
         group: "API:",
       },
       path: {
         type: "string",
-        required: true,
+        required: false,
         description:
           "Path prefix for the S3 bucket. Separate subfolders using a slash (`/`).",
         group: "API:",
@@ -108,7 +125,22 @@ function buildCreateS3ExportCommand(yargs) {
           "--database is required to create an export.",
         );
       }
-
+      if (argv.destination) {
+        if (argv.bucket || argv.path) {
+          throw new ValidationError(
+            "Cannot specify --destination with --bucket or --path. Use either --destination or both --bucket and --path.",
+          );
+        }
+        if (!S3_URI_REGEX.test(argv.destination)) {
+          throw new ValidationError(
+            "Invalid S3 URI format. Expected format: s3://bucket/path",
+          );
+        }
+      } else if (!argv.bucket || !argv.path) {
+        throw new ValidationError(
+          "Either --destination or both --bucket and --path are required to create an export.",
+        );
+      }
       return true;
     })
     .example(sharedExamples);
diff --git a/src/lib/account-api.mjs b/src/lib/account-api.mjs
@@ -450,7 +450,7 @@ async function createExport({
   });
 
   const data = await responseHandler(response);
-  return { ...data.response, destination_uri: getExportUri(data.response) }; // eslint-disable-line camelcase
+  return { ...data.response, destination: data.response.destination.uri };
 }
 
 /**
diff --git a/test/commands/export/create.mjs b/test/commands/export/create.mjs
@@ -20,7 +20,6 @@ const createExportStub = (opts) => ({
   },
   created_at: "2025-01-02T22:59:51",
   updated_at: "2025-01-02T22:59:51",
-  destination_uri: "",
   ...opts,
 });
 
@@ -34,113 +33,109 @@ describe("export create s3", () => {
     ({ createExport } = container.resolve("accountAPI"));
   });
 
-  it("creates an export", async () => {
-    const database = "us-std/example";
-    const bucket = "test-bucket";
-    const path = "/test/key";
-    const stubbedResponse = createExportStub({
-      database,
-      destination: {
-        s3: {
-          path,
-          bucket,
-        },
-      },
-      format: "simple",
-    });
-    createExport.resolves(stubbedResponse);
-
-    await run(
-      `export create s3 --database '${database}' --bucket '${bucket}' --path '${path}'`,
-      container,
-    );
-    await stdout.waitForWritten();
+  const scenarios = [
+    {
+      description: "using --destination",
+      args: "--destination 's3://test-bucket/test/key'",
+      expectedDestination: "s3://test-bucket/test/key",
+      expectedDestArgs: "s3://test-bucket/test/key",
+    },
+    {
+      description: "using --bucket and --path",
+      args: "--bucket 'test-bucket' --path '/test/key'",
+      expectedDestination: "s3://test-bucket/test/key",
+      expectedDestArgs: { s3: { bucket: "test-bucket", path: "/test/key" } },
+    },
+  ];
+
+  scenarios.forEach(
+    ({ description, args, expectedDestination, expectedDestArgs }) => {
+      it(`creates an export ${description}`, async () => {
+        const database = "us-std/example";
+        const stubbedResponse = createExportStub({
+          database,
+          destination: expectedDestination,
+          format: "simple",
+        });
+        createExport.resolves(stubbedResponse);
+
+        await run(
+          `export create s3 --database '${database}' ${args}`,
+          container,
+        );
+        await stdout.waitForWritten();
 
-    expect(stdout.getWritten()).to.equal(`id: test-export-id
+        expect(stdout.getWritten()).to.equal(`id: test-export-id
 state: Pending
 database: us-std/example
 format: simple
-destination:
-  s3:
-    path: /test/key
-    bucket: test-bucket
+destination: s3://test-bucket/test/key
 created_at: 2025-01-02T22:59:51
 updated_at: 2025-01-02T22:59:51
-destination_uri: ""
 `);
-    expect(createExport).to.have.been.calledWith({
-      database,
-      collections: [],
-      destination: {
-        s3: {
-          bucket,
-          path,
-        },
-      },
-      format: "simple",
-    });
-  });
+        expect(createExport).to.have.been.calledWith({
+          database,
+          collections: [],
+          destination: expectedDestArgs,
+          format: "simple",
+        });
+      });
 
-  it("outputs the full response with --json", async () => {
-    const database = "us-std/example";
-    const bucket = "test-bucket";
-    const path = "/test/key";
-    const stubbedResponse = createExportStub({
-      database,
-      destination: {
-        s3: {
-          path,
-          bucket,
-        },
-      },
-      format: "simple",
-    });
-    createExport.resolves(stubbedResponse);
-
-    await run(
-      `export create s3 --database '${database}' --bucket '${bucket}' --path '${path}' --json`,
-      container,
-    );
-    await stdout.waitForWritten();
+      it(`outputs the full response with --json ${description}`, async () => {
+        const database = "us-std/example";
+        const stubbedResponse = createExportStub({
+          database,
+          destination: expectedDestination,
+          format: "simple",
+        });
+        createExport.resolves(stubbedResponse);
 
-    expect(stdout.getWritten()).to.equal(
-      `${colorize(stubbedResponse, { format: Format.JSON })}\n`,
-    );
-  });
+        await run(
+          `export create s3 --database '${database}' ${args} --json`,
+          container,
+        );
+        await stdout.waitForWritten();
 
-  it("passes the format to the account api", async () => {
-    createExport.resolves(createExportStub({ format: "tagged" }));
-    await run(
-      `export create s3 --database 'us-std/example' --bucket 'test-bucket' --path 'test/key' --format 'tagged'`,
-      container,
-    );
-    expect(createExport).to.have.been.calledWith(
-      sinon.match({
-        format: "tagged",
-      }),
-    );
-  });
+        expect(stdout.getWritten()).to.equal(
+          `${colorize(stubbedResponse, { format: Format.JSON })}\n`,
+        );
+      });
 
-  it("should allow providing multiple collections", async () => {
-    createExport.resolves(createExportStub({ collections: ["foo", "bar"] }));
-    await run(
-      `export create s3 --database 'us-std/example' --bucket 'test-bucket' --path 'test/key' --collection foo --collection bar`,
-      container,
-    );
-    expect(createExport).to.have.been.calledWith(
-      sinon.match({
-        database: "us-std/example",
-        collections: ["foo", "bar"],
-      }),
-    );
-  });
+      it(`passes the format to the account api ${description}`, async () => {
+        createExport.resolves(createExportStub({ format: "tagged" }));
+        await run(
+          `export create s3 --database 'us-std/example' ${args} --format 'tagged'`,
+          container,
+        );
+        expect(createExport).to.have.been.calledWith(
+          sinon.match({
+            format: "tagged",
+          }),
+        );
+      });
+
+      it(`should allow providing multiple collections ${description}`, async () => {
+        createExport.resolves(
+          createExportStub({ collections: ["foo", "bar"] }),
+        );
+        await run(
+          `export create s3 --database 'us-std/example' ${args} --collection foo --collection bar`,
+          container,
+        );
+        expect(createExport).to.have.been.calledWith(
+          sinon.match({
+            database: "us-std/example",
+            collections: ["foo", "bar"],
+          }),
+        );
+      });
+    },
+  );
 
   it("should output an error if --database is not provided", async () => {
+    const destination = "s3://test-bucket/test/key";
     try {
-      await run(
-        "export create s3 --bucket test-bucket --path test/key",
-        container,
-      );
+      await run(`export create s3 --destination '${destination}'`, container);
     } catch {}
 
     await stderr.waitForWritten();
diff --git a/test/lib/account-api/account-api.mjs b/test/lib/account-api/account-api.mjs

Original file line number	Diff line number	Diff line change
`@@ -450,7 +450,7 @@ async function createExport({`
`450`	`450`	`});`
`451`	`451`
`452`	`452`	`const data = await responseHandler(response);`
`453`		`- return { ...data.response, destination_uri: getExportUri(data.response) }; // eslint-disable-line camelcase`
	`453`	`+ return { ...data.response, destination: data.response.destination.uri };`
`454`	`454`	`}`
`455`	`455`
`456`	`456`	`/**`