Remove WeakRef usage (RooCodeInc#2811)

* Remove controllerRef

* Remove webviewProviderRef

* Remove controllerRef

* Fix test

* Create odd-jeans-wash.md

* Fix test

Author: saoudrizwan

.changeset/odd-jeans-wash.md

@@ -0,0 +1,5 @@
+---
+"claude-dev": patch
+---
+
+Remove WeakRef usage

src/core/context/context-tracking/ContextTrackerTypes.ts

@@ -21,8 +21,3 @@ export interface TaskMetadata {
 	files_in_context: FileMetadataEntry[]
 	model_usage: ModelMetadataEntry[]
 }
-
-// Interface for the controller to avoid direct dependency
-export interface ControllerLike {
-	context: vscode.ExtensionContext
-}

src/core/context/context-tracking/FileContextTracker.test.ts

@@ -5,11 +5,10 @@ import * as vscode from "vscode"
 import * as path from "path"
 import { FileContextTracker } from "./FileContextTracker"
 import * as diskModule from "../../storage/disk"
-import type { TaskMetadata, ControllerLike, FileMetadataEntry } from "./ContextTrackerTypes"
+import type { TaskMetadata, FileMetadataEntry } from "./ContextTrackerTypes"
 
 describe("FileContextTracker", () => {
 	let sandbox: sinon.SinonSandbox
-	let mockController: ControllerLike
 	let mockContext: vscode.ExtensionContext
 	let mockWorkspace: sinon.SinonStub
 	let mockFileSystemWatcher: any
@@ -48,18 +47,14 @@ describe("FileContextTracker", () => {
 			globalStorageUri: { fsPath: "/mock/storage" },
 		} as unknown as vscode.ExtensionContext
 
-		mockController = {
-			context: mockContext,
-		}
-
 		// Mock disk module functions
 		mockTaskMetadata = { files_in_context: [], model_usage: [] }
 		getTaskMetadataStub = sandbox.stub(diskModule, "getTaskMetadata").resolves(mockTaskMetadata)
 		saveTaskMetadataStub = sandbox.stub(diskModule, "saveTaskMetadata").resolves()
 
 		// Create tracker instance
 		taskId = "test-task-id"
-		tracker = new FileContextTracker(mockController, taskId)
+		tracker = new FileContextTracker(mockContext, taskId)
 	})
 
 	afterEach(() => {

src/core/context/context-tracking/FileContextTracker.ts

@@ -1,7 +1,7 @@
 import * as path from "path"
 import * as vscode from "vscode"
 import { getTaskMetadata, saveTaskMetadata } from "../../storage/disk"
-import type { FileMetadataEntry, ControllerLike } from "./ContextTrackerTypes"
+import type { FileMetadataEntry } from "./ContextTrackerTypes"
 
 // This class is responsible for tracking file operations that may result in stale context.
 // If a user modifies a file outside of Cline, the context may become stale and need to be updated.
@@ -16,29 +16,19 @@ import type { FileMetadataEntry, ControllerLike } from "./ContextTrackerTypes"
 // If the full contents of a file are pass to Cline via a tool, mention, or edit, the file is marked as active.
 // If a file is modified outside of Cline, we detect and track this change to prevent stale context.
 export class FileContextTracker {
+	private context: vscode.ExtensionContext
 	readonly taskId: string
-	private controllerRef: WeakRef<ControllerLike>
 
 	// File tracking and watching
 	private fileWatchers = new Map<string, vscode.FileSystemWatcher>()
 	private recentlyModifiedFiles = new Set<string>()
 	private recentlyEditedByCline = new Set<string>()
 
-	constructor(controller: ControllerLike, taskId: string) {
-		this.controllerRef = new WeakRef(controller)
+	constructor(context: vscode.ExtensionContext, taskId: string) {
+		this.context = context
 		this.taskId = taskId
 	}
 
-	// While a task is ref'd by a controller, it will always have access to the extension context
-	// This error is thrown if the controller derefs the task after e.g., aborting the task
-	private context(): vscode.ExtensionContext {
-		const context = this.controllerRef.deref()?.context
-		if (!context) {
-			throw new Error("Unable to access extension context")
-		}
-		return context
-	}
-
 	// Gets the current working directory or returns undefined if it cannot be determined
 	private getCwd(): string | undefined {
 		const cwd = vscode.workspace.workspaceFolders?.map((folder) => folder.uri.fsPath).at(0)
@@ -89,9 +79,8 @@ export class FileContextTracker {
 				return
 			}
 
-			const context = this.context()
 			// Add file to metadata
-			await this.addFileToFileContextTracker(context, this.taskId, filePath, operation)
+			await this.addFileToFileContextTracker(this.context, this.taskId, filePath, operation)
 
 			// Set up file watcher for this file
 			await this.setupFileWatcher(filePath)

src/core/context/context-tracking/ModelContextTracker.test.ts

@@ -4,11 +4,10 @@ import * as sinon from "sinon"
 import * as vscode from "vscode"
 import { ModelContextTracker } from "./ModelContextTracker"
 import * as diskModule from "../../storage/disk"
-import type { TaskMetadata, ControllerLike } from "./ContextTrackerTypes"
+import type { TaskMetadata } from "./ContextTrackerTypes"
 
 describe("ModelContextTracker", () => {
 	let sandbox: sinon.SinonSandbox
-	let mockController: ControllerLike
 	let mockContext: vscode.ExtensionContext
 	let tracker: ModelContextTracker
 	let taskId: string
@@ -24,18 +23,14 @@ describe("ModelContextTracker", () => {
 			globalStorageUri: { fsPath: "/mock/storage" },
 		} as unknown as vscode.ExtensionContext
 
-		mockController = {
-			context: mockContext,
-		}
-
 		// Mock disk module functions
 		mockTaskMetadata = { files_in_context: [], model_usage: [] }
 		getTaskMetadataStub = sandbox.stub(diskModule, "getTaskMetadata").resolves(mockTaskMetadata)
 		saveTaskMetadataStub = sandbox.stub(diskModule, "saveTaskMetadata").resolves()
 
 		// Create tracker instance
 		taskId = "test-task-id"
-		tracker = new ModelContextTracker(mockController, taskId)
+		tracker = new ModelContextTracker(mockContext, taskId)
 	})
 
 	afterEach(() => {
@@ -83,8 +78,7 @@ describe("ModelContextTracker", () => {
 
 	it("should throw an error when controller is dereferenced", async () => {
 		// Create a new tracker with a controller that will be garbage collected
-		const weakMockController = { context: mockContext }
-		const weakTracker = new ModelContextTracker(weakMockController, taskId)
+		const weakTracker = new ModelContextTracker(mockContext, taskId)
 
 		// Force the WeakRef to return null by overriding the deref method
 		const weakRef = { deref: sandbox.stub().returns(null) }

src/core/context/context-tracking/ModelContextTracker.ts

@@ -1,29 +1,17 @@
 import * as vscode from "vscode"
 import { getTaskMetadata, saveTaskMetadata } from "../../storage/disk"
-import type { ControllerLike } from "./ContextTrackerTypes"
 
 export class ModelContextTracker {
 	readonly taskId: string
-	private controllerRef: WeakRef<ControllerLike>
+	private context: vscode.ExtensionContext
 
-	constructor(controller: ControllerLike, taskId: string) {
-		this.controllerRef = new WeakRef(controller)
+	constructor(context: vscode.ExtensionContext, taskId: string) {
+		this.context = context
 		this.taskId = taskId
 	}
 
-	// While a task is ref'd by a controller, it will always have access to the extension context
-	// This error is thrown if the controller derefs the task after e.g., aborting the task
-	private context(): vscode.ExtensionContext {
-		const context = this.controllerRef.deref()?.context
-		if (!context) {
-			throw new Error("Unable to access extension context")
-		}
-		return context
-	}
-
 	async recordModelUsage(apiProviderId: string, modelId: string, mode: string) {
-		const context = this.context()
-		const metadata = await getTaskMetadata(context, this.taskId)
+		const metadata = await getTaskMetadata(this.context, this.taskId)
 
 		if (!metadata.model_usage) {
 			metadata.model_usage = []
@@ -47,6 +35,6 @@ export class ModelContextTracker {
 			mode: mode,
 		})
 
-		await saveTaskMetadata(context, this.taskId, metadata)
+		await saveTaskMetadata(this.context, this.taskId, metadata)
 	}
 }

src/core/controller/index.ts

@@ -17,10 +17,12 @@ import { selectImages } from "../../integrations/misc/process-images"
 import { getTheme } from "../../integrations/theme/getTheme"
 import WorkspaceTracker from "../../integrations/workspace/WorkspaceTracker"
 import { ClineAccountService } from "../../services/account/ClineAccountService"
+import { discoverChromeInstances } from "../../services/browser/BrowserDiscovery"
+import { BrowserSession } from "../../services/browser/BrowserSession"
 import { McpHub } from "../../services/mcp/McpHub"
+import { searchWorkspaceFiles } from "../../services/search/file-search"
 import { telemetryService } from "../../services/telemetry/TelemetryService"
 import { ApiProvider, ModelInfo } from "../../shared/api"
-import { findLast } from "../../shared/array"
 import { ChatContent } from "../../shared/ChatContent"
 import { ChatSettings } from "../../shared/ChatSettings"
 import { ExtensionMessage, ExtensionState, Invoke, Platform } from "../../shared/ExtensionMessage"
@@ -30,9 +32,10 @@ import { TelemetrySetting } from "../../shared/TelemetrySetting"
 import { ClineCheckpointRestore, WebviewMessage } from "../../shared/WebviewMessage"
 import { fileExistsAtPath } from "../../utils/fs"
 import { searchCommits } from "../../utils/git"
+import { getWorkspacePath } from "../../utils/path"
 import { getTotalTasksSize } from "../../utils/storage"
-import { Task } from "../task"
 import { openMention } from "../mentions"
+import { GlobalFileNames } from "../storage/disk"
 import {
 	getAllExtensionState,
 	getGlobalState,
@@ -42,12 +45,7 @@ import {
 	updateApiConfiguration,
 	updateGlobalState,
 } from "../storage/state"
-import { WebviewProvider } from "../webview"
-import { BrowserSession } from "../../services/browser/BrowserSession"
-import { GlobalFileNames } from "../storage/disk"
-import { discoverChromeInstances } from "../../services/browser/BrowserDiscovery"
-import { searchWorkspaceFiles } from "../../services/search/file-search"
-import { getWorkspacePath } from "../../utils/path"
+import { Task } from "../task"
 
 /*
 https://github.com/microsoft/vscode-webview-ui-toolkit-samples/blob/main/default/weather-webview/src/providers/WeatherViewProvider.ts
@@ -56,25 +54,37 @@ https://github.com/KumarVariable/vscode-extension-sidebar-html/blob/master/src/c
 */
 
 export class Controller {
+	private postMessage: (message: any) => Thenable<boolean> | undefined
+
 	private disposables: vscode.Disposable[] = []
 	private task?: Task
-	workspaceTracker?: WorkspaceTracker
-	mcpHub?: McpHub
-	accountService?: ClineAccountService
+	workspaceTracker: WorkspaceTracker
+	mcpHub: McpHub
+	accountService: ClineAccountService
 	private latestAnnouncementId = "april-10-2025" // update to some unique identifier when we add a new announcement
-	private webviewProviderRef: WeakRef<WebviewProvider>
 
 	constructor(
 		readonly context: vscode.ExtensionContext,
 		private readonly outputChannel: vscode.OutputChannel,
-		webviewProvider: WebviewProvider,
+		postMessage: (message: any) => Thenable<boolean> | undefined,
 	) {
 		this.outputChannel.appendLine("ClineProvider instantiated")
-		this.webviewProviderRef = new WeakRef(webviewProvider)
-
-		this.workspaceTracker = new WorkspaceTracker(this)
-		this.mcpHub = new McpHub(this)
-		this.accountService = new ClineAccountService(this)
+		this.postMessage = postMessage
+
+		this.workspaceTracker = new WorkspaceTracker((msg) => this.postMessageToWebview(msg))
+		this.mcpHub = new McpHub(
+			() => this.ensureMcpServersDirectoryExists(),
+			() => this.ensureSettingsDirectoryExists(),
+			(msg) => this.postMessageToWebview(msg),
+			this.context.extension?.packageJSON?.version ?? "1.0.0",
+		)
+		this.accountService = new ClineAccountService(
+			(msg) => this.postMessageToWebview(msg),
+			async () => {
+				const { apiConfiguration } = await this.getStateToPostToWebview()
+				return apiConfiguration?.clineApiKey
+			},
+		)
 
 		// Clean up legacy checkpoints
 		cleanupLegacyCheckpoints(this.context.globalStorageUri.fsPath, this.outputChannel).catch((error) => {
@@ -97,11 +107,8 @@ export class Controller {
 				x.dispose()
 			}
 		}
-		this.workspaceTracker?.dispose()
-		this.workspaceTracker = undefined
-		this.mcpHub?.dispose()
-		this.mcpHub = undefined
-		this.accountService = undefined
+		this.workspaceTracker.dispose()
+		this.mcpHub.dispose()
 		this.outputChannel.appendLine("Disposed all disposables")
 
 		console.error("Controller disposed")
@@ -124,42 +131,40 @@ export class Controller {
 		await updateGlobalState(this.context, "userInfo", info)
 	}
 
-	async initClineWithTask(task?: string, images?: string[]) {
+	async initTask(task?: string, images?: string[], historyItem?: HistoryItem) {
 		await this.clearTask() // ensures that an existing task doesn't exist before starting a new one, although this shouldn't be possible since user must clear task before starting a new one
 		const { apiConfiguration, customInstructions, autoApprovalSettings, browserSettings, chatSettings } =
 			await getAllExtensionState(this.context)
 		this.task = new Task(
-			this,
+			this.context,
+			this.mcpHub,
+			this.workspaceTracker,
+			(historyItem) => this.updateTaskHistory(historyItem),
+			() => this.postStateToWebview(),
+			(message) => this.postMessageToWebview(message),
+			(taskId) => this.reinitExistingTaskFromId(taskId),
+			() => this.cancelTask(),
 			apiConfiguration,
 			autoApprovalSettings,
 			browserSettings,
 			chatSettings,
 			customInstructions,
 			task,
 			images,
+			historyItem,
 		)
 	}
 
-	async initClineWithHistoryItem(historyItem: HistoryItem) {
-		await this.clearTask()
-		const { apiConfiguration, customInstructions, autoApprovalSettings, browserSettings, chatSettings } =
-			await getAllExtensionState(this.context)
-		this.task = new Task(
-			this,
-			apiConfiguration,
-			autoApprovalSettings,
-			browserSettings,
-			chatSettings,
-			customInstructions,
-			undefined,
-			undefined,
-			historyItem,
-		)
+	async reinitExistingTaskFromId(taskId: string) {
+		const history = await this.getTaskWithId(taskId)
+		if (history) {
+			await this.initTask(undefined, undefined, history.historyItem)
+		}
 	}
 
 	// Send any JSON serializable data to the react app
 	async postMessageToWebview(message: ExtensionMessage) {
-		await this.webviewProviderRef.deref()?.view?.webview.postMessage(message)
+		await this.postMessage(message)
 	}
 
 	/**
@@ -259,7 +264,7 @@ export class Controller {
 				// Could also do this in extension .ts
 				//this.postMessageToWebview({ type: "text", text: `Extension: ${Date.now()}` })
 				// initializing new instance of Cline will make sure that any agentically running promises in old instance don't affect our new task. this essentially creates a fresh slate for the new task
-				await this.initClineWithTask(message.text, message.images)
+				await this.initTask(message.text, message.images)
 				break
 			case "apiConfiguration":
 				if (message.apiConfiguration) {
@@ -1083,7 +1088,7 @@ export class Controller {
 				// 'abandoned' will prevent this cline instance from affecting future cline instance gui. this may happen if its hanging on a streaming request
 				this.task.abandoned = true
 			}
-			await this.initClineWithHistoryItem(historyItem) // clears task again, so we need to abortTask manually above
+			await this.initTask(undefined, undefined, historyItem) // clears task again, so we need to abortTask manually above
 			// await this.postStateToWebview() // new Cline instance will post state when it's ready. having this here sent an empty messages array to webview leading to virtuoso having to reload the entire list
 		}
 	}
@@ -1401,7 +1406,7 @@ export class Controller {
 Here is the project's README to help you get started:\n\n${mcpDetails.readmeContent}\n${mcpDetails.llmsInstallationContent}`
 
 			// Initialize task and show chat view
-			await this.initClineWithTask(task)
+			await this.initTask(task)
 			await this.postMessageToWebview({
 				type: "action",
 				action: "chatButtonClicked",
@@ -1735,9 +1740,7 @@ Here is the project's README to help you get started:\n\n${mcpDetails.readmeCont
 
 		const fileMention = this.getFileMentionFromPath(filePath)
 		const problemsString = this.convertDiagnosticsToProblemsString(diagnostics)
-		await this.initClineWithTask(
-			`Fix the following code in ${fileMention}\n\`\`\`\n${code}\n\`\`\`\n\nProblems:\n${problemsString}`,
-		)
+		await this.initTask(`Fix the following code in ${fileMention}\n\`\`\`\n${code}\n\`\`\`\n\nProblems:\n${problemsString}`)
 
 		console.log("fixWithCline", code, filePath, languageId, diagnostics, problemsString)
 	}
@@ -1813,7 +1816,7 @@ Here is the project's README to help you get started:\n\n${mcpDetails.readmeCont
 		if (id !== this.task?.taskId) {
 			// non-current task
 			const { historyItem } = await this.getTaskWithId(id)
-			await this.initClineWithHistoryItem(historyItem) // clears existing task
+			await this.initTask(undefined, undefined, historyItem) // clears existing task
 		}
 		await this.postMessageToWebview({
 			type: "action",