Migrate didBecomeVisible protobus (#3996)

* migrate chatButtonClicked

* changeset

* send targeted event to the controller

* prettier

* migrate didBecomeVisible

* changeset

* fix proto linter issue

* add back event listener

---------

Co-authored-by: Elephant Lumps <celestial_vault@Elephants-MacBook-Pro.local>

src/core/controller/ui/subscribeToDidBecomeVisible.ts

@@ -0,0 +1,63 @@
+import { Controller } from "../index"
+import { Empty } from "@shared/proto/common"
+import { EmptyRequest } from "@shared/proto/common"
+import { StreamingResponseHandler, getRequestRegistry } from "../grpc-handler"
+
+// Keep track of active didBecomeVisible subscriptions by controller ID
+const activeDidBecomeVisibleSubscriptions = new Map<string, StreamingResponseHandler>()
+
+/**
+ * Subscribe to didBecomeVisible events
+ * @param controller The controller instance
+ * @param request The empty request
+ * @param responseStream The streaming response handler
+ * @param requestId The ID of the request (passed by the gRPC handler)
+ */
+export async function subscribeToDidBecomeVisible(
+	controller: Controller,
+	request: EmptyRequest,
+	responseStream: StreamingResponseHandler,
+	requestId?: string,
+): Promise<void> {
+	const controllerId = controller.id
+	console.log(`[DEBUG] set up didBecomeVisible subscription for controller ${controllerId}`)
+
+	// Add this subscription to the active subscriptions with the controller ID
+	activeDidBecomeVisibleSubscriptions.set(controllerId, responseStream)
+
+	// Register cleanup when the connection is closed
+	const cleanup = () => {
+		activeDidBecomeVisibleSubscriptions.delete(controllerId)
+	}
+
+	// Register the cleanup function with the request registry if we have a requestId
+	if (requestId) {
+		getRequestRegistry().registerRequest(requestId, cleanup, { type: "didBecomeVisible_subscription" }, responseStream)
+	}
+}
+
+/**
+ * Send a didBecomeVisible event to a specific controller's subscription
+ * @param controllerId The ID of the controller to send the event to
+ */
+export async function sendDidBecomeVisibleEvent(controllerId: string): Promise<void> {
+	// Get the subscription for this specific controller
+	const responseStream = activeDidBecomeVisibleSubscriptions.get(controllerId)
+
+	if (!responseStream) {
+		console.log(`[DEBUG] No active subscription for controller ${controllerId}`)
+		return
+	}
+
+	try {
+		const event: Empty = Empty.create({})
+		await responseStream(
+			event,
+			false, // Not the last message
+		)
+	} catch (error) {
+		console.error(`Error sending didBecomeVisible event to controller ${controllerId}:`, error)
+		// Remove the subscription if there was an error
+		activeDidBecomeVisibleSubscriptions.delete(controllerId)
+	}
+}

src/core/webview/index.ts

@@ -10,6 +10,7 @@ import path from "node:path"
 import { WebviewProviderType } from "@/shared/webview/types"
 import { sendThemeEvent } from "@core/controller/ui/subscribeToTheme"
 import { v4 as uuidv4 } from "uuid"
+import { sendDidBecomeVisibleEvent } from "../controller/ui/subscribeToDidBecomeVisible"
 
 /*
 https://github.com/microsoft/vscode-webview-ui-toolkit-samples/blob/main/default/weather-webview/src/providers/WeatherViewProvider.ts
@@ -113,12 +114,9 @@ export class WebviewProvider implements vscode.WebviewViewProvider {
 			// WebviewView and WebviewPanel have all the same properties except for this visibility listener
 			// panel
 			webviewView.onDidChangeViewState(
-				() => {
+				async () => {
 					if (this.view?.visible) {
-						this.controller.postMessageToWebview({
-							type: "action",
-							action: "didBecomeVisible",
-						})
+						await sendDidBecomeVisibleEvent(this.controller.id)
 					}
 				},
 				null,
@@ -127,12 +125,9 @@ export class WebviewProvider implements vscode.WebviewViewProvider {
 		} else if ("onDidChangeVisibility" in webviewView) {
 			// sidebar
 			webviewView.onDidChangeVisibility(
-				() => {
+				async () => {
 					if (this.view?.visible) {
-						this.controller.postMessageToWebview({
-							type: "action",
-							action: "didBecomeVisible",
-						})
+						await sendDidBecomeVisibleEvent(this.controller.id)
 					}
 				},
 				null,

src/shared/ExtensionMessage.ts

@@ -25,7 +25,7 @@ export interface ExtensionMessage {
 		| "userCreditsPayments"
 		| "grpc_response" // New type for gRPC responses
 	text?: string
-	action?: "didBecomeVisible" | "accountLogoutClicked"
+	action?: "accountLogoutClicked"
 	state?: ExtensionState
 	images?: string[]
 	files?: string[]