Merge branch 'master' into rosalyntan.sdk

.eslintrc.js

@@ -122,6 +122,7 @@ module.exports = {
   // TODO(jamesdaniels): add this to overrides instead
   ignorePatterns: [
     "src/dynamicImport.js",
+    "src/emulator/dataconnect/pg-gateway",
     "scripts/webframeworks-deploy-tests/nextjs/**",
     "scripts/webframeworks-deploy-tests/angular/**",
     "scripts/frameworks-tests/vite-project/**",

firebase-vscode/common/messaging/broker.ts

@@ -9,13 +9,13 @@ export type Receiver = {} | Webview;
 export abstract class Broker<
   OutgoingMessages extends MessageParamsMap,
   IncomingMessages extends MessageParamsMap,
-  R extends Receiver
+  R extends Receiver,
 > {
   protected readonly listeners: MessageListeners<IncomingMessages> = {};
 
   abstract sendMessage<T extends keyof OutgoingMessages>(
     message: T,
-    data: OutgoingMessages[T]
+    data: OutgoingMessages[T],
   ): void;
   registerReceiver(receiver: R): void {}
 
@@ -58,42 +58,45 @@ export abstract class Broker<
 export interface BrokerImpl<
   OutgoingMessages,
   IncomingMessages,
-  R extends Receiver
+  R extends Receiver,
 > {
   send<E extends keyof OutgoingMessages>(
     message: E,
-    args?: OutgoingMessages[E]
+    args?: OutgoingMessages[E],
   ): void;
   registerReceiver(receiver: R): void;
   on<E extends keyof IncomingMessages>(
     message: Extract<E, string>,
-    listener: (params: IncomingMessages[E]) => void
+    listener: (params: IncomingMessages[E]) => void,
   ): () => void;
   delete(): void;
 }
 
 export function createBroker<
   OutgoingMessages extends MessageParamsMap,
   IncomingMessages extends MessageParamsMap,
-  R extends Receiver
+  R extends Receiver,
 >(
-  broker: Broker<OutgoingMessages, IncomingMessages, R>
+  broker: Broker<OutgoingMessages, IncomingMessages, R>,
 ): BrokerImpl<OutgoingMessages, IncomingMessages, Receiver> {
   return {
     send<E extends keyof OutgoingMessages>(
       message: Extract<E, string>,
-      args?: OutgoingMessages[E]
+      args: OutgoingMessages[E],
     ): void {
-      broker.sendMessage(message, args);
+      broker.sendMessage<E>(message, args);
     },
     registerReceiver(receiver: R): void {
       broker.registerReceiver(receiver);
     },
     on<E extends keyof IncomingMessages>(
       message: Extract<E, string>,
-      listener: (params: IncomingMessages[E]) => void
+      listener: (params: IncomingMessages[E]) => void,
     ): () => void {
-      return broker.addListener(message, listener);
+      return broker.addListener(
+        message,
+        listener as Listener<IncomingMessages>,
+      );
     },
     delete(): void {
       broker.delete();

firebase-vscode/common/messaging/protocol.ts

@@ -7,18 +7,10 @@ import { FirebaseConfig } from "../../../src/firebaseConfig";
 import { User } from "../../../src/types/auth";
 import { ServiceAccountUser } from "../types";
 import { RCData } from "../../../src/rc";
-import { EmulatorUiSelections, RunningEmulatorInfo } from "./types";
+import { EmulatorsStatus, RunningEmulatorInfo } from "./types";
 import { ExecutionResult } from "graphql";
 import { SerializedError } from "../error";
 
-export const DEFAULT_EMULATOR_UI_SELECTIONS: EmulatorUiSelections = {
-  projectId: "demo-something",
-  importStateFolderPath: "",
-  exportStateOnExit: false,
-  mode: "dataconnect",
-  debugLogging: false,
-};
-
 export enum UserMockKind {
   ADMIN = "admin",
   UNAUTHENTICATED = "unauthenticated",
@@ -44,7 +36,6 @@ export interface WebviewToExtensionParamsMap {
   /* Emulator panel requests */
   getEmulatorUiSelections: void;
   getEmulatorInfos: void;
-  updateEmulatorUiSelections: Partial<EmulatorUiSelections>;
 
   /** Notify extension that current user has been changed in UI. */
   requestChangeUser: { user: User | ServiceAccountUser };
@@ -60,6 +51,9 @@ export interface WebviewToExtensionParamsMap {
   /** Calls the `firebase init` CLI */
   runFirebaseInit: void;
 
+  /** Calls the `firebase init` CLI */
+  runStartEmulators: void;
+
   /**
    * Show a UI message using the vscode interface
    */
@@ -99,11 +93,16 @@ export interface WebviewToExtensionParamsMap {
   /** Configures generated SDK */
   "fdc.configure-sdk": void;
 
+  /** Opens generated docs */
+  "fdc.open-docs": void;
+
   // Initialize "result" tab.
   getDataConnectResults: void;
 
   // execute terminal tasks
   executeLogin: void;
+
+  getDocsLink: void;
 }
 
 export interface DataConnectResults {
@@ -119,16 +118,12 @@ export type ValueOrError<T> =
 
 export interface ExtensionToWebviewParamsMap {
   /** Triggered when the emulator UI/state changes */
-  notifyEmulatorUiSelectionsChanged: EmulatorUiSelections;
   notifyEmulatorStateChanged: {
-    status: "running" | "stopped" | "starting" | "stopping";
-    infos: RunningEmulatorInfo | undefined;
+    status: EmulatorsStatus;
+    infos?: RunningEmulatorInfo | undefined;
   };
-  notifyEmulatorImportFolder: { folder: string };
-
-  notifyIsConnectedToPostgres: boolean;
 
-  notifyPostgresStringChanged: string;
+  notifyEmulatorsHanging: boolean;
 
   /** Triggered when new environment variables values are found. */
   notifyEnv: { env: { isMonospace: boolean } };
@@ -142,15 +137,15 @@ export interface ExtensionToWebviewParamsMap {
   /**
    * This can potentially call multiple webviews to notify of user selection.
    */
-  notifyUserChanged: { user: User | ServiceAccountUser };
+  notifyUserChanged: { user: User | ServiceAccountUser | null };
 
   /**
    * Notify webview of initial discovery or change in firebase.json or
    * .firebaserc
    */
   notifyFirebaseConfig: {
-    firebaseJson: ValueOrError<FirebaseConfig> | undefined;
-    firebaseRC: ValueOrError<RCData> | undefined;
+    firebaseJson?: ValueOrError<FirebaseConfig | undefined>;
+    firebaseRC?: ValueOrError<RCData | undefined>;
   };
   /** Whether any dataconnect.yaml is present */
   notifyHasFdcConfigs: boolean;
@@ -165,6 +160,8 @@ export interface ExtensionToWebviewParamsMap {
   notifyDataConnectRequiredArgs: { args: string[] };
 
   notifyIsLoadingUser: boolean;
+
+  notifyDocksLink: string;
 }
 
 export type MessageParamsMap =

firebase-vscode/common/messaging/types.d.ts

@@ -1,5 +1,4 @@
 import { EmulatorInfo } from "../emulator/types";
-import { ExtensionToWebviewParamsMap, MessageParamsMap } from "./protocol";
 
 export interface Message<M> {
   command: string;
@@ -16,14 +15,8 @@ export interface MessageListeners<M> {
  * Info to display in the UI while the emulators are running
  */
 export interface RunningEmulatorInfo {
+  uiUrl: string;
   displayInfo: EmulatorInfo[];
 }
 
-export interface EmulatorUiSelections {
-  projectId: string;
-  firebaseJsonPath?: string;
-  importStateFolderPath?: string;
-  exportStateOnExit: boolean;
-  mode: "all" | "dataconnect";
-  debugLogging: boolean;
-}
+export type EmulatorsStatus = "running" | "stopped" | "starting" | "stopping";