update database:update to use apiv2 (with streaming request support) (#2803)

* update database:update to use new apiv2 module. add streaming body support

* update apiv2 to accept a body parameter

* better stream handling

* pass json stright through

* add one more undefined check

Author: bkendall

src/apiv2.ts

@@ -13,7 +13,7 @@ type HttpMethod = "GET" | "PUT" | "POST" | "DELETE" | "PATCH";
 interface RequestOptions<T> extends VerbOptions<T> {
   method: HttpMethod;
   path: string;
-  json?: T;
+  body?: T | string | NodeJS.ReadableStream;
   responseType?: "json" | "stream";
   signal?: AbortSignal;
 }
@@ -94,7 +94,7 @@ export class Client {
     const reqOptions: ClientRequestOptions<ReqT> = Object.assign(options, {
       method: "POST",
       path,
-      json,
+      body: json,
     });
     return this.request<ReqT, ResT>(reqOptions);
   }
@@ -107,7 +107,7 @@ export class Client {
     const reqOptions: ClientRequestOptions<ReqT> = Object.assign(options, {
       method: "PATCH",
       path,
-      json,
+      body: json,
     });
     return this.request<ReqT, ResT>(reqOptions);
   }
@@ -120,7 +120,7 @@ export class Client {
     const reqOptions: ClientRequestOptions<ReqT> = Object.assign(options, {
       method: "PUT",
       path,
-      json,
+      body: json,
     });
     return this.request<ReqT, ResT>(reqOptions);
   }
@@ -248,8 +248,10 @@ export class Client {
       signal: options.signal,
     };
 
-    if (options.json !== undefined) {
-      fetchOptions.body = JSON.stringify(options.json);
+    if (typeof options.body === "string" || isStream(options.body)) {
+      fetchOptions.body = options.body;
+    } else if (options.body !== undefined) {
+      fetchOptions.body = JSON.stringify(options.body);
     }
 
     this.logRequest(options);
@@ -296,10 +298,10 @@ export class Client {
     }
     const logURL = this.requestURL(options);
     logger.debug(`>>> [apiv2][query] ${options.method} ${logURL} ${queryParamsLog}`);
-    if (options.json) {
+    if (options.body !== undefined) {
       let logBody = "[omitted]";
       if (!options.skipLog?.body) {
-        logBody = JSON.stringify(options.json);
+        logBody = bodyToString(options.body);
       }
       logger.debug(`>>> [apiv2][body] ${options.method} ${logURL} ${logBody}`);
     }
@@ -310,17 +312,25 @@ export class Client {
     logger.debug(`<<< [apiv2][status] ${options.method} ${logURL} ${res.status}`);
     let logBody = "[omitted]";
     if (!options.skipLog?.resBody) {
-      if (body instanceof Readable) {
-        // Don't attempt to read any stream type, in case the caller needs it.
-        logBody = "[stream]";
-      } else {
-        try {
-          logBody = JSON.stringify(body);
-        } catch (_) {
-          logBody = `${body}`;
-        }
-      }
+      logBody = bodyToString(body);
     }
     logger.debug(`<<< [apiv2][body] ${options.method} ${logURL} ${logBody}`);
   }
 }
+
+function bodyToString(body: unknown): string {
+  if (isStream(body)) {
+    // Don't attempt to read any stream type, in case the caller needs it.
+    return "[stream]";
+  } else {
+    try {
+      return JSON.stringify(body);
+    } catch (_) {
+      return `${body}`;
+    }
+  }
+}
+
+function isStream(o: unknown): o is NodeJS.ReadableStream {
+  return o instanceof Readable;
+}

src/commands/database-update.js

@@ -0,0 +1,74 @@
+import * as clc from "cli-color";
+import * as fs from "fs";
+
+import { Client } from "../apiv2";
+import { Command } from "../command";
+import { Emulators } from "../emulator/types";
+import { FirebaseError } from "../error";
+import { populateInstanceDetails } from "../management/database";
+import { printNoticeIfEmulated } from "../emulator/commandUtils";
+import { promptOnce } from "../prompt";
+import { realtimeOriginOrEmulatorOrCustomUrl } from "../database/api";
+import { requirePermissions } from "../requirePermissions";
+import * as logger from "../logger";
+import * as requireInstance from "../requireInstance";
+import * as utils from "../utils";
+
+export default new Command("database:update <path> [infile]")
+  .description("update some of the keys for the defined path in your Firebase")
+  .option("-d, --data <data>", "specify escaped JSON directly")
+  .option("-y, --confirm", "pass this option to bypass confirmation prompt")
+  .option(
+    "--instance <instance>",
+    "use the database <instance>.firebaseio.com (if omitted, use default database instance)"
+  )
+  .before(requirePermissions, ["firebasedatabase.instances.update"])
+  .before(requireInstance)
+  .before(populateInstanceDetails)
+  .before(printNoticeIfEmulated, Emulators.DATABASE)
+  .action(async (path: string, infile: string | undefined, options) => {
+    if (!path.startsWith("/")) {
+      throw new FirebaseError("Path must begin with /");
+    }
+    const origin = realtimeOriginOrEmulatorOrCustomUrl(options);
+    const url = utils.getDatabaseUrl(origin, options.instance, path);
+    if (!options.confirm) {
+      const confirmed = await promptOnce({
+        type: "confirm",
+        name: "confirm",
+        default: false,
+        message: `You are about to modify data at ${clc.cyan(url)}. Are you sure?`,
+      });
+      if (!confirmed) {
+        throw new FirebaseError("Command aborted.");
+      }
+    }
+
+    const inStream =
+      utils.stringToStream(options.data) ||
+      (infile && fs.createReadStream(infile)) ||
+      process.stdin;
+    const jsonUrl = new URL(utils.getDatabaseUrl(origin, options.instance, path + ".json"));
+
+    if (!infile && !options.data) {
+      utils.explainStdin();
+    }
+
+    const c = new Client({ urlPrefix: jsonUrl.origin, auth: true });
+    try {
+      await c.request({
+        method: "PATCH",
+        path: jsonUrl.pathname,
+        body: inStream,
+      });
+    } catch (err) {
+      throw new FirebaseError("Unexpected error while setting data");
+    }
+
+    utils.logSuccess("Data updated successfully");
+    logger.info();
+    logger.info(
+      clc.bold("View data at:"),
+      utils.getDatabaseViewDataUrl(origin, options.project, options.instance, path)
+    );
+  });

src/commands/database-update.ts

@@ -3,12 +3,14 @@ import * as nock from "nock";
 
 import { Client } from "../apiv2";
 import { FirebaseError } from "../error";
-import { streamToString } from "../utils";
+import { streamToString, stringToStream } from "../utils";
 
 describe("apiv2", () => {
   beforeEach(() => {
     // The api module has package variables that we don't want sticking around.
     delete require.cache[require.resolve("../apiv2")];
+
+    nock.cleanAll();
   });
 
   after(() => {
@@ -207,7 +209,22 @@ describe("apiv2", () => {
       const r = await c.request({
         method: "POST",
         path: "/path/to/foo",
-        json: POST_DATA,
+        body: POST_DATA,
+      });
+      expect(r.body).to.deep.equal({ success: true });
+      expect(nock.isDone()).to.be.true;
+    });
+
+    it("should make a basic POST request with a stream", async () => {
+      nock("https://example.com")
+        .post("/path/to/foo", "hello world")
+        .reply(200, { success: true });
+
+      const c = new Client({ urlPrefix: "https://example.com" });
+      const r = await c.request({
+        method: "POST",
+        path: "/path/to/foo",
+        body: stringToStream("hello world"),
       });
       expect(r.body).to.deep.equal({ success: true });
       expect(nock.isDone()).to.be.true;