Convert FirebaseError to TypeScript (#1521)

* Convert FirebaseError to TypeScript * Use named export of FirebaseError * Assign properties in FirebaseError constructor in alphabetical order * Remove newlines between class properties * Avoid destruction of properties * Add basic tests for FirestoreError * Rename a test file * Don't enforce all options to exist in FirebaseError class definition * Describe complex typings so it is more understandable
firebase · Jul 23, 2019 · 15a582c · 15a582c
1 parent 7c67993
commit 15a582c
Show file tree

Hide file tree

Showing 78 changed files with 150 additions and 92 deletions.
diff --git a/src/RulesDeploy.ts b/src/RulesDeploy.ts
@@ -4,7 +4,7 @@ import fs = require("fs");
 
 import gcp = require("./gcp");
 import logger = require("./logger");
-import FirebaseError = require("./error");
+import { FirebaseError } from "./error";
 import utils = require("./utils");
 
 import { prompt } from "./prompt";

diff --git a/src/api.js b/src/api.js
@@ -4,7 +4,7 @@ var _ = require("lodash");
 var querystring = require("querystring");
 var request = require("request");
 
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var logger = require("./logger");
 var responseToError = require("./responseToError");
 var scopes = require("./scopes");

diff --git a/src/auth.js b/src/auth.js
@@ -12,7 +12,7 @@ var url = require("url");
 
 var api = require("./api");
 var configstore = require("./configstore");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var logger = require("./logger");
 var { prompt } = require("./prompt");
 var scopes = require("./scopes");

diff --git a/src/checkDupHostingKeys.js b/src/checkDupHostingKeys.js
@@ -5,7 +5,7 @@ var _ = require("lodash");
 var utils = require("./utils");
 var clc = require("cli-color");
 var Config = require("./config");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var logger = require("./logger");
 
 module.exports = function(options) {

diff --git a/src/checkValidTargetFilters.js b/src/checkValidTargetFilters.js
@@ -2,7 +2,7 @@
 
 var _ = require("lodash");
 
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 
 module.exports = function(options) {
   function numFilters(targetTypes) {

diff --git a/src/command.js b/src/command.js
@@ -4,7 +4,7 @@ var _ = require("lodash");
 var track = require("./track");
 var logger = require("./logger");
 var utils = require("./utils");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var clc = require("cli-color");
 var RC = require("./rc");
 var Config = require("./config");

diff --git a/src/commands/database-get.js b/src/commands/database-get.js
@@ -6,7 +6,7 @@ var requirePermissions = require("../requirePermissions");
 var request = require("request");
 var api = require("../api");
 var responseToError = require("../responseToError");
-var FirebaseError = require("../error");
+var { FirebaseError } = require("../error");
 
 var utils = require("../utils");
 var querystring = require("querystring");

diff --git a/src/commands/database-push.js b/src/commands/database-push.js
@@ -6,7 +6,7 @@ var requirePermissions = require("../requirePermissions");
 var request = require("request");
 var api = require("../api");
 var responseToError = require("../responseToError");
-var FirebaseError = require("../error");
+var { FirebaseError } = require("../error");
 
 var utils = require("../utils");
 var clc = require("cli-color");

diff --git a/src/commands/database-set.js b/src/commands/database-set.js
@@ -6,7 +6,7 @@ var requirePermissions = require("../requirePermissions");
 var request = require("request");
 var api = require("../api");
 var responseToError = require("../responseToError");
-var FirebaseError = require("../error");
+var { FirebaseError } = require("../error");
 
 var utils = require("../utils");
 var clc = require("cli-color");

diff --git a/src/commands/database-settings-get.ts b/src/commands/database-settings-get.ts
@@ -5,7 +5,7 @@ import * as request from "request";
 import * as responseToError from "../responseToError";
 import * as Command from "../command";
 import * as logger from "../logger";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as requirePermissions from "../requirePermissions";
 import * as utils from "../utils";
 import * as api from "../api";

diff --git a/src/commands/database-settings-set.ts b/src/commands/database-settings-set.ts
@@ -5,7 +5,7 @@ import * as request from "request";
 import * as responseToError from "../responseToError";
 import * as Command from "../command";
 import * as logger from "../logger";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as requirePermissions from "../requirePermissions";
 import * as utils from "../utils";
 import * as api from "../api";

diff --git a/src/commands/database-update.js b/src/commands/database-update.js
@@ -6,7 +6,7 @@ var requirePermissions = require("../requirePermissions");
 var request = require("request");
 var api = require("../api");
 var responseToError = require("../responseToError");
-var FirebaseError = require("../error");
+var { FirebaseError } = require("../error");
 
 var utils = require("../utils");
 var clc = require("cli-color");

diff --git a/src/commands/emulators-exec.ts b/src/commands/emulators-exec.ts
@@ -4,7 +4,7 @@ import * as clc from "cli-color";
 
 import * as Command from "../command";
 import { Emulators } from "../emulator/types";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as utils from "../utils";
 import * as logger from "../logger";
 import * as controller from "../emulator/controller";

diff --git a/src/commands/functions-log.ts b/src/commands/functions-log.ts
@@ -3,7 +3,7 @@ import * as opn from "open";
 import * as qs from "querystring";
 
 import * as Command from "../command";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as gcp from "../gcp";
 import * as getProjectId from "../getProjectId";
 import * as logger from "../logger";

diff --git a/src/commands/open.ts b/src/commands/open.ts
@@ -2,7 +2,7 @@ import * as _ from "lodash";
 import * as clc from "cli-color";
 import * as open from "open";
 
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as api from "../api";
 import * as Command from "../command";
 import * as logger from "../logger";

diff --git a/src/config.js b/src/config.js
@@ -7,7 +7,7 @@ var fs = require("fs-extra");
 var path = require("path");
 
 var detectProjectRoot = require("./detectProjectRoot");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var fsutils = require("./fsutils");
 var loadCJSON = require("./loadCJSON");
 var parseBoltRules = require("./parseBoltRules");

diff --git a/src/database/listRemote.ts b/src/database/listRemote.ts
@@ -2,7 +2,7 @@ import * as request from "request";
 import { Response } from "request";
 import * as responseToError from "../responseToError";
 import * as utils from "../utils";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as logger from "../logger";
 import * as api from "../api";
 

diff --git a/src/database/removeRemote.ts b/src/database/removeRemote.ts
@@ -2,7 +2,7 @@ import * as request from "request";
 import { Response } from "request";
 import * as responseToError from "../responseToError";
 import * as utils from "../utils";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as logger from "../logger";
 import * as api from "../api";
 

diff --git a/src/deploy/database/prepare.js b/src/deploy/database/prepare.js
@@ -4,7 +4,7 @@ var _ = require("lodash");
 var clc = require("cli-color");
 var path = require("path");
 
-var FirebaseError = require("../../error");
+var { FirebaseError } = require("../../error");
 var parseBoltRules = require("../../parseBoltRules");
 var rtdb = require("../../rtdb");
 var utils = require("../../utils");

diff --git a/src/deploy/functions/release.js b/src/deploy/functions/release.js
@@ -7,7 +7,7 @@
 var clc = require("cli-color");
 var _ = require("lodash");
 
-var FirebaseError = require("../../error");
+var { FirebaseError } = require("../../error");
 var gcp = require("../../gcp");
 var logger = require("../../logger");
 var track = require("../../track");

diff --git a/src/deploy/functions/validate.ts b/src/deploy/functions/validate.ts
@@ -1,4 +1,4 @@
-import * as FirebaseError from "../../error";
+import { FirebaseError } from "../../error";
 import * as _ from "lodash";
 import * as path from "path";
 import * as clc from "cli-color";

diff --git a/src/deploy/hosting/prepare.js b/src/deploy/hosting/prepare.js
@@ -6,7 +6,7 @@ const clc = require("cli-color");
 const api = require("../../api");
 const convertConfig = require("./convertConfig");
 const deploymentTool = require("../../deploymentTool");
-const FirebaseError = require("../../error");
+const { FirebaseError } = require("../../error");
 const fsutils = require("../../fsutils");
 const normalizedHostingConfigs = require("../../hosting/normalizedHostingConfigs");
 const { resolveProjectPath } = require("../../projectPath");

diff --git a/src/deploy/index.js b/src/deploy/index.js
@@ -6,7 +6,7 @@ var clc = require("cli-color");
 var _ = require("lodash");
 var getProjectId = require("../getProjectId");
 var utils = require("../utils");
-var FirebaseError = require("../error");
+var { FirebaseError } = require("../error");
 var track = require("../track");
 var lifecycleHooks = require("./lifecycleHooks");
 

diff --git a/src/deploy/lifecycleHooks.js b/src/deploy/lifecycleHooks.js
@@ -5,7 +5,7 @@ const _ = require("lodash");
 const utils = require("../utils");
 const clc = require("cli-color");
 const childProcess = require("child_process");
-const FirebaseError = require("../error");
+const { FirebaseError } = require("../error");
 const getProjectId = require("../getProjectId");
 const logger = require("../logger");
 const path = require("path");

diff --git a/src/emulator/controller.ts b/src/emulator/controller.ts
@@ -14,7 +14,7 @@ import { FunctionsEmulator } from "../emulator/functionsEmulator";
 import { DatabaseEmulator, DatabaseEmulatorArgs } from "../emulator/databaseEmulator";
 import { FirestoreEmulator, FirestoreEmulatorArgs } from "../emulator/firestoreEmulator";
 import { HostingEmulator } from "../emulator/hostingEmulator";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as getProjectId from "../getProjectId";
 
 export const VALID_EMULATOR_STRINGS: string[] = ALL_EMULATORS;

diff --git a/src/emulator/download.ts b/src/emulator/download.ts
@@ -2,7 +2,7 @@ import * as crypto from "crypto";
 import * as request from "request";
 import * as ProgressBar from "progress";
 
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as utils from "../utils";
 import { Emulators, JavaEmulatorDetails } from "./types";
 import * as javaEmulators from "../serve/javaEmulators";

diff --git a/src/emulator/emulatorServer.ts b/src/emulator/emulatorServer.ts
@@ -1,7 +1,7 @@
 import { EmulatorInstance } from "./types";
 import { EmulatorRegistry } from "./registry";
 import * as controller from "./controller";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 
 /**
  * Wrapper object to expose an EmulatorInstance for "firebase serve" that

diff --git a/src/emulator/functionsEmulatorShell.ts b/src/emulator/functionsEmulatorShell.ts
@@ -4,7 +4,7 @@ import { FunctionsEmulator } from "./functionsEmulator";
 import { EmulatedTriggerDefinition, getFunctionRegion } from "./functionsEmulatorShared";
 import * as utils from "../utils";
 import * as logger from "../logger";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import { LegacyEvent } from "./events/types";
 
 interface FunctionsShellController {

diff --git a/src/emulator/registry.ts b/src/emulator/registry.ts
@@ -1,7 +1,7 @@
 import * as clc from "cli-color";
 
 import { ALL_EMULATORS, EmulatorInstance, Emulators } from "./types";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 import * as utils from "../utils";
 import * as controller from "./controller";
 

diff --git a/src/ensureCloudResourceLocation.ts b/src/ensureCloudResourceLocation.ts
@@ -1,4 +1,4 @@
-import * as FirebaseError from "./error";
+import { FirebaseError } from "./error";
 
 /**
  * Simple helper function that returns an error with a helpful

diff --git a/src/error.js b/src/error.js
diff --git a/src/error.ts b/src/error.ts
@@ -0,0 +1,34 @@
+import { defaultTo } from "lodash";
+
+interface FirebaseErrorOptions {
+  children?: unknown[];
+  context?: unknown;
+  exit?: number;
+  original?: Error;
+  status?: number;
+}
+
+const DEFAULT_CHILDREN: NonNullable<FirebaseErrorOptions["children"]> = [];
+const DEFAULT_EXIT: NonNullable<FirebaseErrorOptions["exit"]> = 1;
+const DEFAULT_STATUS: NonNullable<FirebaseErrorOptions["status"]> = 500;
+
+export class FirebaseError extends Error {
+  readonly children: unknown[];
+  readonly context: unknown | undefined;
+  readonly exit: number;
+  readonly message: string;
+  readonly name = "FirebaseError";
+  readonly original: Error | undefined;
+  readonly status: number;
+
+  constructor(message: string, options: FirebaseErrorOptions = {}) {
+    super();
+
+    this.children = defaultTo(options.children, DEFAULT_CHILDREN);
+    this.context = options.context;
+    this.exit = defaultTo(options.exit, DEFAULT_EXIT);
+    this.message = message;
+    this.original = options.original;
+    this.status = defaultTo(options.status, DEFAULT_STATUS);
+  }
+}
diff --git a/src/errorOut.js b/src/errorOut.js
@@ -1,7 +1,7 @@
 "use strict";
 
 var logError = require("./logError");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 
 module.exports = function(client, error) {
   if (error.name !== "FirebaseError") {

diff --git a/src/filterTargets.js b/src/filterTargets.js
@@ -1,7 +1,7 @@
 "use strict";
 
 var _ = require("lodash");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 
 module.exports = function(options, validTargets) {
   var targets = validTargets.filter(function(t) {

diff --git a/src/firestore/delete.js b/src/firestore/delete.js
@@ -5,7 +5,7 @@ var ProgressBar = require("progress");
 
 var api = require("../api");
 var firestore = require("../gcp/firestore");
-var FirebaseError = require("../error");
+var { FirebaseError } = require("../error");
 var logger = require("../logger");
 var utils = require("../utils");
 

diff --git a/src/firestore/encodeFirestoreValue.ts b/src/firestore/encodeFirestoreValue.ts
@@ -1,6 +1,6 @@
 import * as _ from "lodash";
 
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 
 function isPlainObject(input: any): boolean {
   return (

diff --git a/src/firestore/util.ts b/src/firestore/util.ts
@@ -1,4 +1,4 @@
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 
 interface IndexName {
   projectId: string;

diff --git a/src/firestore/validator.ts b/src/firestore/validator.ts
@@ -1,5 +1,5 @@
 import * as clc from "cli-color";
-import * as FirebaseError from "../error";
+import { FirebaseError } from "../error";
 
 /**
  * Throw an error if 'obj' does not have a value for the property 'prop'.

diff --git a/src/functionsConfig.js b/src/functionsConfig.js
@@ -4,7 +4,7 @@ var _ = require("lodash");
 
 var clc = require("cli-color");
 var api = require("./api");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var runtimeconfig = require("./gcp/runtimeconfig");
 var getProjectId = require("./getProjectId");
 var ensureApiEnabled = require("./ensureApiEnabled").ensure;

diff --git a/src/functionsConfigClone.js b/src/functionsConfigClone.js
@@ -3,7 +3,7 @@
 var _ = require("lodash");
 
 var clc = require("cli-color");
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var functionsConfig = require("./functionsConfig");
 var runtimeconfig = require("./gcp/runtimeconfig");
 

diff --git a/src/functionsDeployHelper.js b/src/functionsDeployHelper.js
@@ -3,7 +3,7 @@
 var _ = require("lodash");
 var clc = require("cli-color");
 
-var FirebaseError = require("./error");
+var { FirebaseError } = require("./error");
 var logger = require("./logger");
 var track = require("./track");
 var utils = require("./utils");