Roo-Code/packages/cloud/src/bridge/BaseChannel.ts

import type { Socket } from "socket.io-client"
import * as vscode from "vscode"

import type { StaticAppProperties, GitProperties } from "@roo-code/types"

export interface BaseChannelOptions {
	instanceId: string
	appProperties: StaticAppProperties
	gitProperties?: GitProperties
}

/**
 * Abstract base class for communication channels in the bridge system.
 * Provides common functionality for bidirectional communication between
 * the VSCode extension and web application.
 *
 * @template TCommand - Type of commands this channel can receive.
 * @template TEvent - Type of events this channel can publish.
 */
export abstract class BaseChannel<TCommand = unknown, TEventName extends string = string, TEventData = unknown> {
	protected socket: Socket | null = null
	protected readonly instanceId: string
	protected readonly appProperties: StaticAppProperties
	protected readonly gitProperties?: GitProperties

	constructor(options: BaseChannelOptions) {
		this.instanceId = options.instanceId
		this.appProperties = options.appProperties
		this.gitProperties = options.gitProperties
	}

	/**
	 * Called when socket connects.
	 */
	public async onConnect(socket: Socket): Promise<void> {
		this.socket = socket
		await this.handleConnect(socket)
	}

	/**
	 * Called when socket disconnects.
	 */
	public onDisconnect(): void {
		this.socket = null
		this.handleDisconnect()
	}

	/**
	 * Called when socket reconnects.
	 */
	public async onReconnect(socket: Socket): Promise<void> {
		this.socket = socket
		await this.handleReconnect(socket)
	}

	/**
	 * Cleanup resources.
	 */
	public async cleanup(socket: Socket | null): Promise<void> {
		if (socket) {
			await this.handleCleanup(socket)
		}

		this.socket = null
	}

	/**
	 * Emit a socket event with error handling.
	 */
	protected publish<Params extends object>(
		eventName: TEventName,
		data: TEventData,
		callback?: (params: Params) => void,
	): boolean {
		if (!this.socket) {
			console.error(`[${this.constructor.name}#emit] socket not available for ${eventName}`)
			return false
		}

		try {
			// console.log(`[${this.constructor.name}#emit] emit() -> ${eventName}`, data)
			this.socket.emit(eventName, data, callback)

			return true
		} catch (error) {
			console.error(
				`[${this.constructor.name}#emit] emit() failed -> ${eventName}: ${
					error instanceof Error ? error.message : String(error)
				}`,
			)

			return false
		}
	}

	/**
	 * Handle incoming commands - template method that ensures common functionality
	 * is executed before subclass-specific logic.
	 *
	 * This method should be called by subclasses to handle commands.
	 * It will execute common functionality and then delegate to the abstract
	 * handleCommandImplementation method.
	 */
	public async handleCommand(command: TCommand): Promise<void> {
		// Common functionality: focus the sidebar.
		await vscode.commands.executeCommand(`${this.appProperties.appName}.SidebarProvider.focus`)

		// Delegate to subclass-specific implementation.
		await this.handleCommandImplementation(command)
	}

	/**
	 * Handle command-specific logic - must be implemented by subclasses.
	 * This method is called after common functionality has been executed.
	 */
	protected abstract handleCommandImplementation(command: TCommand): Promise<void>

	/**
	 * Handle connection-specific logic.
	 */
	protected abstract handleConnect(socket: Socket): Promise<void>

	/**
	 * Handle disconnection-specific logic.
	 */
	protected handleDisconnect(): void {
		// Default implementation - can be overridden.
	}

	/**
	 * Handle reconnection-specific logic.
	 */
	protected abstract handleReconnect(socket: Socket): Promise<void>

	/**
	 * Handle cleanup-specific logic.
	 */
	protected abstract handleCleanup(socket: Socket): Promise<void>
}