Initial work for adding host bridge client for external hosts (RooCodeInc#4144)

* Add a host bridge client that uses the appropriate underlying client (vscode or external grpc service)

Add placeholders for the external clients.

Move the hosts directory under src, add an alias in tsconfig.json for @hosts

* Update package.json

Author: sjf

.gitignore

@@ -32,8 +32,8 @@ src/shared/proto/host/*.ts
 webview-ui/src/services/grpc-client.ts
 # Standalone
 src/standalone/server-setup.ts
-src/standalone/services/host-grpc-client.ts
 # Host bridge
-hosts/vscode/*/methods.ts
-hosts/vscode/*/index.ts
-hosts/vscode/host-grpc-service-config.ts
+src/hosts/vscode/*/methods.ts
+src/hosts/vscode/*/index.ts
+src/hosts/vscode/client/host-grpc-client.ts
+src/hosts/vscode/host-grpc-service-config.ts

package.json

@@ -331,7 +331,7 @@
 		"watch:tsc": "tsc --noEmit --watch --project tsconfig.json",
 		"package": "npm run check-types && npm run build:webview && npm run lint && node esbuild.js --production",
 		"protos": "node proto/build-proto.js && node scripts/generate-server-setup.mjs",
-		"postprotos": "prettier src/shared/proto src/core/controller webview-ui/src/services src/standalone/server-setup.ts --write --log-level silent",
+		"postprotos": "prettier src/shared/proto src/core/controller src/hosts/ webview-ui/src/services src/standalone/server-setup.ts --write --log-level silent",
 		"compile-tests": "node ./scripts/build-tests.js",
 		"watch-tests": "tsc -p . -w --outDir out",
 		"pretest": "npm run compile-tests && npm run compile && npm run compile-standalone && npm run lint",

proto/build-proto.js

@@ -21,6 +21,17 @@ const tsProtoPlugin = isWindows
 	? path.join(ROOT_DIR, "node_modules", ".bin", "protoc-gen-ts_proto.cmd") // Use the .bin directory path for Windows
 	: require.resolve("ts-proto/protoc-gen-ts_proto")
 
+const TS_PROTO_OPTIONS = [
+	"env=node",
+	"esModuleInterop=true",
+
+	"outputIndex=true", // output an index file for each package which exports all protos in the package.
+	"outputServices=generic-definitions",
+
+	"useOptionals=messages", // Message fields are optional, scalars are not.
+	"useDate=false", // Timestamp fields will not be automatically converted to Date.
+]
+
 // List of gRPC services
 // To add a new service, simply add it to this map and run this script
 // The service handler will be automatically discovered and used by grpc-handler.ts
@@ -47,7 +58,9 @@ const hostServiceNameMap = {
 	watch: "host.WatchService",
 	// Add new host services here
 }
-const hostServiceDirs = Object.keys(hostServiceNameMap).map((serviceKey) => path.join(ROOT_DIR, "hosts", "vscode", serviceKey))
+const hostServiceDirs = Object.keys(hostServiceNameMap).map((serviceKey) =>
+	path.join(ROOT_DIR, "src", "hosts", "vscode", serviceKey),
+)
 
 async function main() {
 	console.log(chalk.bold.blue("Starting Protocol Buffer code generation..."))
@@ -81,9 +94,7 @@ async function main() {
 		`--proto_path="${SCRIPT_DIR}"`,
 		`--plugin=protoc-gen-ts_proto="${tsProtoPlugin}"`,
 		`--ts_proto_out="${TS_OUT_DIR}"`,
-		"--ts_proto_opt=exportCommonSymbols=false",
-		"--ts_proto_opt=outputIndex=true",
-		"--ts_proto_opt=outputServices=generic-definitions,env=node,esModuleInterop=true,useDate=false,useOptionals=messages",
+		`--ts_proto_opt=${TS_PROTO_OPTIONS.join(",")} `,
 		...protoFiles,
 	].join(" ")
 	try {
@@ -592,7 +603,7 @@ export interface HostServiceHandlerConfig {
 export const hostServiceHandlers: Record<string, HostServiceHandlerConfig> = {${serviceConfigs.join(",")}
 };`
 
-	const configPath = path.join(ROOT_DIR, "hosts", "vscode", "host-grpc-service-config.ts")
+	const configPath = path.join(ROOT_DIR, "src", "hosts", "vscode", "host-grpc-service-config.ts")
 	await fs.mkdir(path.dirname(configPath), { recursive: true })
 	await fs.writeFile(configPath, content)
 	console.log(chalk.green(`Generated host service configuration at ${configPath}`))
@@ -637,7 +648,7 @@ export {
 	${serviceExports.join(",\n\t")}
 }`
 
-	const configPath = path.join(ROOT_DIR, "src", "standalone", "services", "host-grpc-client.ts")
+	const configPath = path.join(ROOT_DIR, "src", "hosts", "vscode", "client", "host-grpc-client.ts")
 	await fs.mkdir(path.dirname(configPath), { recursive: true })
 	await fs.writeFile(configPath, content)
 	console.log(chalk.green(`Generated host gRPC client at ${configPath}`))

src/core/controller/file/getRelativePaths.ts

@@ -3,7 +3,7 @@ import { RelativePathsRequest, RelativePaths } from "@shared/proto/file"
 import { FileMethodHandler } from "./index"
 import * as vscode from "vscode"
 import * as path from "path"
-import { UriServiceClient } from "../../../standalone/services/host-grpc-client"
+import { UriServiceClient } from "@hosts/host-bridge-client"
 import { Metadata, StringRequest } from "@shared/proto/common"
 
 /**

src/hosts/external/client/host-bridge-client.ts

@@ -0,0 +1,23 @@
+import { StringRequest } from "@/shared/proto/common"
+import { Uri } from "@/shared/proto/host/uri"
+import { FileChangeEvent_ChangeType, SubscribeToFileRequest } from "@/shared/proto/host/watch"
+
+const UriServiceClient = {
+	parse: function (_: StringRequest): Uri {
+		throw Error("Unimplemented")
+	},
+}
+const WatchServiceClient = {
+	subscribeToFile: function (
+		_r: SubscribeToFileRequest,
+		_h: {
+			onResponse?: (response: { type: FileChangeEvent_ChangeType }) => void | Promise<void>
+			onError?: (error: any) => void
+			onComplete?: () => void
+		},
+	) {
+		throw Error("Unimplemented")
+	},
+}
+
+export { UriServiceClient, WatchServiceClient }

src/hosts/host-bridge-client.ts

@@ -0,0 +1,8 @@
+import * as VscodeClient from "./vscode/client/host-grpc-client"
+import * as ExternalClient from "./external/client/host-bridge-client"
+
+const isHostBridgeExternal = process.env.HOST_BRIDGE_ADDRESS !== undefined && process.env.HOST_BRIDGE_ADDRESS !== "vscode"
+const Client = isHostBridgeExternal ? ExternalClient : VscodeClient
+
+export const UriServiceClient = Client.UriServiceClient
+export const WatchServiceClient = Client.WatchServiceClient

src/standalone/services/host-grpc-client-base.ts renamed to src/hosts/vscode/client/host-grpc-client-base.ts

@@ -1,5 +1,5 @@
 import { v4 as uuidv4 } from "uuid"
-import { GrpcHandler, StreamingCallbacks } from "../../../hosts/vscode/host-grpc-handler"
+import { GrpcHandler, StreamingCallbacks } from "../host-grpc-handler"
 
 // Generic type for any protobuf service definition
 export type ProtoService = {

hosts/vscode/host-grpc-handler.ts renamed to src/hosts/vscode/host-grpc-handler.ts

@@ -1,6 +1,6 @@
 import { v4 as uuidv4 } from "uuid"
 import { hostServiceHandlers } from "./host-grpc-service-config"
-import { GrpcRequestRegistry } from "../../src/core/controller/grpc-request-registry"
+import { GrpcRequestRegistry } from "@core/controller/grpc-request-registry"
 
 /**
  * Type definition for a streaming response handler

hosts/vscode/host-grpc-service.ts renamed to src/hosts/vscode/host-grpc-service.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode"
-import { Uri } from "../../../src/shared/proto/host/uri"
-import { StringRequest } from "../../../src/shared/proto/common"
+import { Uri } from "@shared/proto/host/uri"
+import { StringRequest } from "@shared/proto/common"
 
 /**
  * Creates a file URI from a file path