Add support for emulator import/export in VSCode (#8053)

* Added config

* Adding basic persistence support

* formats

* Starting on clearData

* Clear data now working!

* Added import/export support

* PR fixes + fidelity to approved API'

* Trying to fix vsce compile

* Progress on vsce import/export/clearData UI

* fixed build issue

* Adding config options for importPath/exportPath/exportOnExit

* More fixes

* add changelog

* Merge conflict

* Tweak the emulator action-buttons

* Startign on tests

* Adding basic tests for export and clear'

* format

* ajv upgrade

* Fix config issue

* Fix typo

* Santiy checking terminalView - does this even resolve?

* Does it work as a single test?

* PR fixes

---------

Co-authored-by: TJ Lavelle <[email protected]>

Author: joehan

firebase-vscode/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## NEXT
 
-- [Feature] Added `debug` setting to run commands with `--debug`
+- [Added] Added support for emulator import/export.
+- [Added] Added `debug` setting to run commands with `--debug`
 
 ## 0.12.0
 

firebase-vscode/common/messaging/protocol.ts

@@ -55,9 +55,12 @@ export interface WebviewToExtensionParamsMap {
   /** Calls the `firebase init` CLI */
   runFirebaseInit: void;
 
-  /** Calls the `firebase init` CLI */
+  /** Calls the `firebase emulators:start` CLI */
   runStartEmulators: void;
 
+  /** Calls the `firebase emulators:export` CLI */
+  runEmulatorsExport: void;
+
   /**
    * Show a UI message using the vscode interface
    */
@@ -100,6 +103,12 @@ export interface WebviewToExtensionParamsMap {
   /** Opens generated docs */
   "fdc.open-docs": void;
 
+  /** Opens settings page searching for Data Connect emualtor settings */
+  "fdc.open-emulator-settings": void;
+  
+    /** Clears data from a running data connect emulator */
+  "fdc.clear-emulator-data": void;
+
   // Initialize "result" tab.
   getDataConnectResults: void;
 

firebase-vscode/package.json

@@ -78,6 +78,20 @@
           "markdownDescription": "%ext.config.idx.viewMetricNotice%",
           "scope": "application"
         },
+        "firebase.emulators.importPath": {
+          "type": "string",
+          "markdownDescription": "%ext.config.emulators.importPath%"
+        },
+        "firebase.emulators.exportPath": {
+          "type": "string",
+          "default": "./exportedData",
+          "markdownDescription": "%ext.config.emulators.exportPath%"
+        },
+        "firebase.emulators.exportOnExit":{
+          "type": "boolean",
+          "default": false,
+          "markdownDescription": "%ext.config.emulators.exportOnExit%"
+        },
         "firebase.debug": {
           "type": "boolean",
           "default": false,

firebase-vscode/package.nls.json

@@ -4,7 +4,10 @@
   "ext.config.firebasePath": "Path to the `Firebase` module, e.g. `./node_modules/firebase`",
   "ext.config.hosting.useFrameworks": "Enable web frameworks",
   "ext.config.npmPath": "Path to NPM executable in local environment",
+  "ext.config.title": "Firebase Data Connect",
+  "ext.config.idx.viewMetricNotice": "Show data collection notice on next startup (IDX Only)",
+  "ext.config.emulators.importPath": "Path to import emulator data from",
+  "ext.config.emulators.exportPath": "Path to export emulator data to",
+  "ext.config.emulators.exportOnExit": "If true, data will be exported to exportPath when the emulator shuts down"
   "ext.config.debug": "When true, add the --debug flag to any commands run by the extension",
-  "ext.config.title": "Prettier",
-  "ext.config.idx.viewMetricNotice": "Show data collection notice on next startup (IDX Only)"
 }

firebase-vscode/src/analytics.ts

@@ -32,6 +32,7 @@ export enum DATA_CONNECT_EVENT_NAME {
   START_EMULATORS = "start_emulators",
   AUTO_COMPLETE = "auto_complete",
   SESSION_CHAR_COUNT = "session_char_count",
+  EMULATOR_EXPORT ="emulator_export",
   SETUP_FIREBASE_BINARY = "setup_firebase_binary",
 }
 

firebase-vscode/src/core/emulators.ts

@@ -6,6 +6,7 @@ import { EmulatorsStatus, RunningEmulatorInfo } from "../messaging/types";
 import { EmulatorHubClient } from "../../../src/emulator/hubClient";
 import { GetEmulatorsResponse } from "../../../src/emulator/hub";
 import { EmulatorInfo } from "../emulator/types";
+import { getSettings } from "../utils/settings";
 export class EmulatorsController implements Disposable {
   constructor(private broker: ExtensionBrokerImpl) {
     this.emulatorStatusItem.command = "firebase.openFirebaseRc";
@@ -21,6 +22,25 @@ export class EmulatorsController implements Disposable {
         this.setEmulatorsStarting();
       }),
     );
+
+    // Subscription to open up settings window
+    this.subscriptions.push(
+      broker.on("fdc.open-emulator-settings", () => {
+        vscode.commands.executeCommand( 'workbench.action.openSettings', 'firebase.emulators' );
+      })
+    );
+
+    // Subscription to trigger clear emulator data when button is clicked.
+    this.subscriptions.push(
+      broker.on("fdc.clear-emulator-data", () => {
+        vscode.commands.executeCommand("firebase.emulators.clearData");
+      }),
+    );
+
+    // Subscription to trigger emulator exports when button is clicked.
+    this.subscriptions.push(broker.on("runEmulatorsExport", () => {
+      vscode.commands.executeCommand("firebase.emulators.exportData")
+    }));
   }
 
   readonly emulatorStatusItem = vscode.window.createStatusBarItem("emulators");
@@ -39,6 +59,17 @@ export class EmulatorsController implements Disposable {
     this.setEmulatorsStopped.bind(this),
   );
 
+  private readonly clearEmulatorDataCommand = vscode.commands.registerCommand(
+    "firebase.emulators.clearData",
+    this.clearDataConnectData.bind(this),
+  );
+
+
+  private readonly exportEmulatorDataCommand = vscode.commands.registerCommand(
+    "firebase.emulators.exportData",
+    this.exportEmulatorData.bind(this),
+  );
+
   readonly emulators: { status: EmulatorsStatus; infos?: RunningEmulatorInfo } =
     {
       status: "stopped",
@@ -107,23 +138,47 @@ export class EmulatorsController implements Disposable {
   async findRunningCliEmulators(): Promise<
     { status: EmulatorsStatus; infos?: RunningEmulatorInfo } | undefined
   > {
-    const projectId = firebaseRC.value?.tryReadValue?.projects?.default;
-    // TODO: think about what to without projectID, in potentially a logged out mode
-    const hubClient = new EmulatorHubClient(projectId!);
-
-    if (hubClient.foundHub()) {
+    const hubClient = this.getHubClient();
+    if (hubClient) {
       const response: GetEmulatorsResponse = await hubClient.getEmulators();
 
       if (Object.values(response)) {
         this.setEmulatorsRunningInfo(Object.values(response));
       } else {
         this.setEmulatorsStopped();
       }
+    }
+    return this.emulators;
+  }
+
+  async clearDataConnectData(): Promise<void> {
+    const hubClient = this.getHubClient();
+    if (hubClient) {
+      await hubClient.clearDataConnectData();
+      vscode.window.showInformationMessage(`Data Connect emulator data has been cleared.`);
+    }
+  }
+
+  async exportEmulatorData(): Promise<void> {
+    const settings = getSettings();
+    const exportDir = settings.exportPath;
+    const hubClient = this.getHubClient();
+    if (hubClient) {
+      // TODO: Make exportDir configurable
+      await hubClient.postExport({path: exportDir, initiatedBy: "Data Connect VSCode extension"});
+      vscode.window.showInformationMessage(`Emulator Data exported to ${exportDir}`);
+    }
+  }
+
+  private getHubClient(): EmulatorHubClient | undefined {
+    const projectId = firebaseRC.value?.tryReadValue?.projects?.default;
+    // TODO: think about what to without projectID, in potentially a logged out mode
+    const hubClient = new EmulatorHubClient(projectId!);
+    if (hubClient.foundHub()) {
+      return hubClient;
     } else {
       this.setEmulatorsStopped();
     }
-
-    return this.emulators;
   }
 
   public areEmulatorsRunning() {
@@ -135,5 +190,7 @@ export class EmulatorsController implements Disposable {
     this.findRunningEmulatorsCommand.dispose();
     this.emulatorStatusItem.dispose();
     this.emulatorsStoppped.dispose();
+    this.clearEmulatorDataCommand.dispose();
+    this.exportEmulatorDataCommand.dispose();
   }
 }

firebase-vscode/src/data-connect/terminal.ts

@@ -90,12 +90,19 @@ export function registerTerminalTasks(
 
   const startEmulatorsTaskBroker = broker.on("runStartEmulators", () => {
     analyticsLogger.logger.logUsage(DATA_CONNECT_EVENT_NAME.START_EMULATORS);
-    // TODO: optional debug mode
+
+    let cmd = `${settings.firebasePath} emulators:start --project ${currentProjectId.value}`;
+
+    if (settings.importPath) {
+      cmd += ` --import ${settings.importPath}`;
+    }
+    if (settings.exportOnExit) {
+      cmd += ` --export-on-exit ${settings.exportPath}`;
+    }
     runTerminalTask(
       "firebase emulators",
-      `${settings.firebasePath} emulators:start --project ${currentProjectId.value}`,
-      // emulators:start almost never ask interactive questions.
-      { focus: false },
+      cmd,
+      { focus: true },
     );
   });
 

firebase-vscode/src/test/integration/fishfood/emulator.ts

@@ -1,6 +1,9 @@
 import { firebaseSuite, firebaseTest } from "../../utils/test_hooks";
 import { FirebaseCommands } from "../../utils/page_objects/commands";
 import { FirebaseSidebar } from "../../utils/page_objects/sidebar";
+
+import { TerminalView } from "../../utils/page_objects/terminal";
+import { Notifications } from "../../utils/page_objects/notifications";
 import { mockUser } from "../../utils/user";
 import { mockProject } from "../../utils/projects";
 
@@ -12,6 +15,8 @@ firebaseSuite("Emulators", async function () {
 
       const sidebar = new FirebaseSidebar(workbench);
       const commands = new FirebaseCommands();
+      const terminal = new TerminalView(workbench);
+      const notifications = new Notifications(workbench);
 
       await sidebar.openExtensionSidebar();
       await commands.waitForUser();
@@ -26,6 +31,15 @@ firebaseSuite("Emulators", async function () {
       const current = await sidebar.currentEmulators();
 
       expect(current).toContain("dataconnect :9399");
+
+      await sidebar.clearEmulatorData();
+      const text = await terminal.getTerminalText();
+      expect(text.includes("Clearing data from Data Connect data sources")).toBeTruthy();
+
+      await sidebar.exportEmulatorData();
+      const exportNotification = await notifications.getExportNotification();
+      expect(exportNotification).toExist();
+
     },
   );
 });

firebase-vscode/src/test/test_projects/fishfood/.firebaserc

@@ -1,6 +1,6 @@
 {
   "projects": {
-    "default": "dart-firebase-admin"
+    "default": "test-project"
   },
   "targets": {},
   "etags": {},

firebase-vscode/src/test/utils/page_objects/notifications.ts

@@ -0,0 +1,13 @@
+import { Workbench } from "wdio-vscode-service";
+
+export class Notifications {
+  constructor(readonly workbench: Workbench) {}
+
+  async getExportNotification() {
+    const notifications = await this.workbench.getNotifications();
+    return notifications.find(async n => { 
+      const message = await n.getMessage();
+      return message.includes("Emulator Data exported to");
+    });
+  }
+}