[PS-1884] [TDL-189] [TDL-203] Move libs/node files to CLI and rename per ADR12 (#4069)

* Extract files only used in cli out of libs/node

Move commands from libs/node to cli
Move program from libs/node to cli
Move services from libs/node to cli
Move specs from libs/node to cli

Naming changes based on ADR 12
Rename commands
Rename models/request
Rename models/response
Remove entries from whitelist-capital-letters.txt

* Merge lowDbStorageService into base class

Move logic from extended lowdbStorage.service.ts into base-lowdb-storage.service.ts
Delete lowdb-storage.service.ts
Rename base-lowdb-storage.service.ts to lowdb-storage.service.ts

* Merge login.command with base class

program.ts - changed import temporarily to make it easier to review
Remove passing in clientId, set "cli" when constructing ssoRedirectUri call
Remove setting callbacks, use private methods instead
Remove i18nService from constructor params
Add syncService, keyConnectorService and logoutCallback to constructor
Merge successCallback with handleSuccessResponse
Remove validatedParams callback and added private method
Move options(program.OptionValues) and set in run()
Delete login.command.ts

* Rename base-login.command.ts to login.command.ts

* Merge base.program.ts with program.ts

apps/cli/src/services/cli-platform-utils.service.ts

@@ -0,0 +1,149 @@
+import * as child_process from "child_process";
+
+import { PlatformUtilsService } from "@bitwarden/common/abstractions/platformUtils.service";
+import { ClientType } from "@bitwarden/common/enums/clientType";
+import { DeviceType } from "@bitwarden/common/enums/deviceType";
+
+// eslint-disable-next-line
+const open = require("open");
+
+export class CliPlatformUtilsService implements PlatformUtilsService {
+  clientType: ClientType;
+
+  private deviceCache: DeviceType = null;
+
+  constructor(clientType: ClientType, private packageJson: any) {
+    this.clientType = clientType;
+  }
+
+  getDevice(): DeviceType {
+    if (!this.deviceCache) {
+      switch (process.platform) {
+        case "win32":
+          this.deviceCache = DeviceType.WindowsDesktop;
+          break;
+        case "darwin":
+          this.deviceCache = DeviceType.MacOsDesktop;
+          break;
+        case "linux":
+        default:
+          this.deviceCache = DeviceType.LinuxDesktop;
+          break;
+      }
+    }
+
+    return this.deviceCache;
+  }
+
+  getDeviceString(): string {
+    const device = DeviceType[this.getDevice()].toLowerCase();
+    return device.replace("desktop", "");
+  }
+
+  getClientType() {
+    return this.clientType;
+  }
+
+  isFirefox() {
+    return false;
+  }
+
+  isChrome() {
+    return false;
+  }
+
+  isEdge() {
+    return false;
+  }
+
+  isOpera() {
+    return false;
+  }
+
+  isVivaldi() {
+    return false;
+  }
+
+  isSafari() {
+    return false;
+  }
+
+  isMacAppStore() {
+    return false;
+  }
+
+  isViewOpen() {
+    return Promise.resolve(false);
+  }
+
+  launchUri(uri: string, options?: any): void {
+    if (process.platform === "linux") {
+      child_process.spawnSync("xdg-open", [uri]);
+    } else {
+      open(uri);
+    }
+  }
+
+  getApplicationVersion(): Promise<string> {
+    return Promise.resolve(this.packageJson.version);
+  }
+
+  getApplicationVersionSync(): string {
+    return this.packageJson.version;
+  }
+
+  supportsWebAuthn(win: Window) {
+    return false;
+  }
+
+  supportsDuo(): boolean {
+    return false;
+  }
+
+  showToast(
+    type: "error" | "success" | "warning" | "info",
+    title: string,
+    text: string | string[],
+    options?: any
+  ): void {
+    throw new Error("Not implemented.");
+  }
+
+  showDialog(
+    text: string,
+    title?: string,
+    confirmText?: string,
+    cancelText?: string,
+    type?: string
+  ): Promise<boolean> {
+    throw new Error("Not implemented.");
+  }
+
+  isDev(): boolean {
+    return process.env.BWCLI_ENV === "development";
+  }
+
+  isSelfHost(): boolean {
+    return false;
+  }
+
+  copyToClipboard(text: string, options?: any): void {
+    throw new Error("Not implemented.");
+  }
+
+  readFromClipboard(options?: any): Promise<string> {
+    throw new Error("Not implemented.");
+  }
+
+  supportsBiometric(): Promise<boolean> {
+    return Promise.resolve(false);
+  }
+
+  authenticateBiometric(): Promise<boolean> {
+    return Promise.resolve(false);
+  }
+
+  supportsSecureStorage(): boolean {
+    return false;
+  }
+}

apps/cli/src/services/console-log.service.spec.ts

@@ -0,0 +1,42 @@
+import { interceptConsole, restoreConsole } from "@bitwarden/common/spec/shared/interceptConsole";
+
+import { ConsoleLogService } from "./console-log.service";
+
+let caughtMessage: any = {};
+
+describe("CLI Console log service", () => {
+  let logService: ConsoleLogService;
+  beforeEach(() => {
+    caughtMessage = {};
+    interceptConsole(caughtMessage);
+    logService = new ConsoleLogService(true);
+  });
+
+  afterAll(() => {
+    restoreConsole();
+  });
+
+  it("should redirect all console to error if BW_RESPONSE env is true", () => {
+    process.env.BW_RESPONSE = "true";
+
+    logService.debug("this is a debug message");
+    expect(caughtMessage).toMatchObject({
+      error: { 0: "this is a debug message" },
+    });
+  });
+
+  it("should not redirect console to error if BW_RESPONSE != true", () => {
+    process.env.BW_RESPONSE = "false";
+
+    logService.debug("debug");
+    logService.info("info");
+    logService.warning("warning");
+    logService.error("error");
+
+    expect(caughtMessage).toMatchObject({
+      log: { 0: "info" },
+      warn: { 0: "warning" },
+      error: { 0: "error" },
+    });
+  });
+});

apps/cli/src/services/console-log.service.ts

@@ -0,0 +1,22 @@
+import { LogLevelType } from "@bitwarden/common/enums/logLevelType";
+import { ConsoleLogService as BaseConsoleLogService } from "@bitwarden/common/services/consoleLog.service";
+
+export class ConsoleLogService extends BaseConsoleLogService {
+  constructor(isDev: boolean, filter: (level: LogLevelType) => boolean = null) {
+    super(isDev, filter);
+  }
+
+  write(level: LogLevelType, message: string) {
+    if (this.filter != null && this.filter(level)) {
+      return;
+    }
+
+    if (process.env.BW_RESPONSE === "true") {
+      // eslint-disable-next-line
+      console.error(message);
+      return;
+    }
+
+    super.write(level, message);
+  }
+}

apps/cli/src/services/lowdb-storage.service.ts

@@ -0,0 +1,168 @@
+import * as fs from "fs";
+import * as path from "path";
+
+import * as lowdb from "lowdb";
+import * as FileSync from "lowdb/adapters/FileSync";
+import * as lock from "proper-lockfile";
+import { OperationOptions } from "retry";
+
+import { LogService } from "@bitwarden/common/abstractions/log.service";
+import { AbstractStorageService } from "@bitwarden/common/abstractions/storage.service";
+import { NodeUtils } from "@bitwarden/common/misc/nodeUtils";
+import { sequentialize } from "@bitwarden/common/misc/sequentialize";
+import { Utils } from "@bitwarden/common/misc/utils";
+
+const retries: OperationOptions = {
+  retries: 50,
+  minTimeout: 100,
+  maxTimeout: 250,
+  factor: 2,
+};
+
+export class LowdbStorageService implements AbstractStorageService {
+  protected dataFilePath: string;
+  private db: lowdb.LowdbSync<any>;
+  private defaults: any;
+  private ready = false;
+
+  constructor(
+    protected logService: LogService,
+    defaults?: any,
+    private dir?: string,
+    private allowCache = false,
+    private requireLock = false
+  ) {
+    this.defaults = defaults;
+  }
+
+  @sequentialize(() => "lowdbStorageInit")
+  async init() {
+    if (this.ready) {
+      return;
+    }
+
+    this.logService.info("Initializing lowdb storage service.");
+    let adapter: lowdb.AdapterSync<any>;
+    if (Utils.isNode && this.dir != null) {
+      if (!fs.existsSync(this.dir)) {
+        this.logService.warning(`Could not find dir, "${this.dir}"; creating it instead.`);
+        NodeUtils.mkdirpSync(this.dir, "700");
+        this.logService.info(`Created dir "${this.dir}".`);
+      }
+      this.dataFilePath = path.join(this.dir, "data.json");
+      if (!fs.existsSync(this.dataFilePath)) {
+        this.logService.warning(
+          `Could not find data file, "${this.dataFilePath}"; creating it instead.`
+        );
+        fs.writeFileSync(this.dataFilePath, "", { mode: 0o600 });
+        fs.chmodSync(this.dataFilePath, 0o600);
+        this.logService.info(`Created data file "${this.dataFilePath}" with chmod 600.`);
+      } else {
+        this.logService.info(`db file "${this.dataFilePath} already exists"; using existing db`);
+      }
+      await this.lockDbFile(() => {
+        adapter = new FileSync(this.dataFilePath);
+      });
+    }
+    try {
+      this.logService.info("Attempting to create lowdb storage adapter.");
+      this.db = lowdb(adapter);
+      this.logService.info("Successfully created lowdb storage adapter.");
+    } catch (e) {
+      if (e instanceof SyntaxError) {
+        this.logService.warning(
+          `Error creating lowdb storage adapter, "${e.message}"; emptying data file.`
+        );
+        if (fs.existsSync(this.dataFilePath)) {
+          const backupPath = this.dataFilePath + ".bak";
+          this.logService.warning(`Writing backup of data file to ${backupPath}`);
+          await fs.copyFile(this.dataFilePath, backupPath, () => {
+            this.logService.warning(
+              `Error while creating data file backup, "${e.message}". No backup may have been created.`
+            );
+          });
+        }
+        adapter.write({});
+        this.db = lowdb(adapter);
+      } else {
+        this.logService.error(`Error creating lowdb storage adapter, "${e.message}".`);
+        throw e;
+      }
+    }
+
+    if (this.defaults != null) {
+      this.lockDbFile(() => {
+        this.logService.info("Writing defaults.");
+        this.readForNoCache();
+        this.db.defaults(this.defaults).write();
+        this.logService.info("Successfully wrote defaults to db.");
+      });
+    }
+
+    this.ready = true;
+  }
+
+  async get<T>(key: string): Promise<T> {
+    await this.waitForReady();
+    return this.lockDbFile(() => {
+      this.readForNoCache();
+      const val = this.db.get(key).value();
+      this.logService.debug(`Successfully read ${key} from db`);
+      if (val == null) {
+        return null;
+      }
+      return val as T;
+    });
+  }
+
+  has(key: string): Promise<boolean> {
+    return this.get(key).then((v) => v != null);
+  }
+
+  async save(key: string, obj: any): Promise<any> {
+    await this.waitForReady();
+    return this.lockDbFile(() => {
+      this.readForNoCache();
+      this.db.set(key, obj).write();
+      this.logService.debug(`Successfully wrote ${key} to db`);
+      return;
+    });
+  }
+
+  async remove(key: string): Promise<any> {
+    await this.waitForReady();
+    return this.lockDbFile(() => {
+      this.readForNoCache();
+      this.db.unset(key).write();
+      this.logService.debug(`Successfully removed ${key} from db`);
+      return;
+    });
+  }
+
+  protected async lockDbFile<T>(action: () => T): Promise<T> {
+    if (this.requireLock && !Utils.isNullOrWhitespace(this.dataFilePath)) {
+      this.logService.info("acquiring db file lock");
+      return await lock.lock(this.dataFilePath, { retries: retries }).then((release) => {
+        try {
+          return action();
+        } finally {
+          release();
+        }
+      });
+    } else {
+      return action();
+    }
+  }
+
+  private readForNoCache() {
+    if (!this.allowCache) {
+      this.db.read();
+    }
+  }
+
+  private async waitForReady() {
+    if (!this.ready) {
+      await this.init();
+    }
+  }
+}

apps/cli/src/services/lowdbStorage.service.ts

@@ -1,40 +0,0 @@
-import * as lock from "proper-lockfile";
-import { OperationOptions } from "retry";
-
-import { LogService } from "@bitwarden/common/abstractions/log.service";
-import { Utils } from "@bitwarden/common/misc/utils";
-import { LowdbStorageService as LowdbStorageServiceBase } from "@bitwarden/node/services/lowdbStorage.service";
-
-const retries: OperationOptions = {
-  retries: 50,
-  minTimeout: 100,
-  maxTimeout: 250,
-  factor: 2,
-};
-
-export class LowdbStorageService extends LowdbStorageServiceBase {
-  constructor(
-    logService: LogService,
-    defaults?: any,
-    dir?: string,
-    allowCache = false,
-    private requireLock = false
-  ) {
-    super(logService, defaults, dir, allowCache);
-  }
-
-  protected async lockDbFile<T>(action: () => T): Promise<T> {
-    if (this.requireLock && !Utils.isNullOrWhitespace(this.dataFilePath)) {
-      this.logService.info("acquiring db file lock");
-      return await lock.lock(this.dataFilePath, { retries: retries }).then((release) => {
-        try {
-          return action();
-        } finally {
-          release();
-        }
-      });
-    } else {
-      return action();
-    }
-  }
-}

apps/cli/src/services/node-api.service.ts

@@ -0,0 +1,43 @@
+import * as FormData from "form-data";
+import { HttpsProxyAgent } from "https-proxy-agent";
+import * as fe from "node-fetch";
+
+import { AppIdService } from "@bitwarden/common/abstractions/appId.service";
+import { EnvironmentService } from "@bitwarden/common/abstractions/environment.service";
+import { PlatformUtilsService } from "@bitwarden/common/abstractions/platformUtils.service";
+import { TokenService } from "@bitwarden/common/abstractions/token.service";
+import { ApiService } from "@bitwarden/common/services/api.service";
+
+(global as any).fetch = fe.default;
+(global as any).Request = fe.Request;
+(global as any).Response = fe.Response;
+(global as any).Headers = fe.Headers;
+(global as any).FormData = FormData;
+
+export class NodeApiService extends ApiService {
+  constructor(
+    tokenService: TokenService,
+    platformUtilsService: PlatformUtilsService,
+    environmentService: EnvironmentService,
+    appIdService: AppIdService,
+    logoutCallback: (expired: boolean) => Promise<void>,
+    customUserAgent: string = null
+  ) {
+    super(
+      tokenService,
+      platformUtilsService,
+      environmentService,
+      appIdService,
+      logoutCallback,
+      customUserAgent
+    );
+  }
+
+  nativeFetch(request: Request): Promise<Response> {
+    const proxy = process.env.http_proxy || process.env.https_proxy;
+    if (proxy) {
+      (request as any).agent = new HttpsProxyAgent(proxy);
+    }
+    return fetch(request);
+  }
+}