| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586 |
- import { Anthropic } from "@anthropic-ai/sdk"
- import delay from "delay"
- import axios from "axios"
- import fs from "fs/promises"
- import os from "os"
- import pWaitFor from "p-wait-for"
- import * as path from "path"
- import * as vscode from "vscode"
- import simpleGit from "simple-git"
- import { setPanel } from "../../activate/registerCommands"
- import { ApiConfiguration, ApiProvider, ModelInfo, API_CONFIG_KEYS } from "../../shared/api"
- import { findLast } from "../../shared/array"
- import { supportPrompt } from "../../shared/support-prompt"
- import { GlobalFileNames } from "../../shared/globalFileNames"
- import { SecretKey, GlobalStateKey, SECRET_KEYS, GLOBAL_STATE_KEYS } from "../../shared/globalState"
- import { HistoryItem } from "../../shared/HistoryItem"
- import { CheckpointStorage } from "../../shared/checkpoints"
- import { ApiConfigMeta, ExtensionMessage } from "../../shared/ExtensionMessage"
- import { checkoutDiffPayloadSchema, checkoutRestorePayloadSchema, WebviewMessage } from "../../shared/WebviewMessage"
- import { Mode, PromptComponent, defaultModeSlug, ModeConfig } from "../../shared/modes"
- import { checkExistKey } from "../../shared/checkExistApiConfig"
- import { EXPERIMENT_IDS, experiments as Experiments, experimentDefault, ExperimentId } from "../../shared/experiments"
- import { TERMINAL_OUTPUT_LIMIT } from "../../shared/terminal"
- import { downloadTask } from "../../integrations/misc/export-markdown"
- import { openFile, openImage } from "../../integrations/misc/open-file"
- import { selectImages } from "../../integrations/misc/process-images"
- import { getTheme } from "../../integrations/theme/getTheme"
- import WorkspaceTracker from "../../integrations/workspace/WorkspaceTracker"
- import { McpHub } from "../../services/mcp/McpHub"
- import { McpServerManager } from "../../services/mcp/McpServerManager"
- import { ShadowCheckpointService } from "../../services/checkpoints/ShadowCheckpointService"
- import { fileExistsAtPath } from "../../utils/fs"
- import { playSound, setSoundEnabled, setSoundVolume } from "../../utils/sound"
- import { singleCompletionHandler } from "../../utils/single-completion-handler"
- import { searchCommits } from "../../utils/git"
- import { getDiffStrategy } from "../diff/DiffStrategy"
- import { SYSTEM_PROMPT } from "../prompts/system"
- import { ConfigManager } from "../config/ConfigManager"
- import { CustomModesManager } from "../config/CustomModesManager"
- import { ContextProxy } from "../contextProxy"
- import { buildApiHandler } from "../../api"
- import { getOpenRouterModels } from "../../api/providers/openrouter"
- import { getGlamaModels } from "../../api/providers/glama"
- import { getUnboundModels } from "../../api/providers/unbound"
- import { getRequestyModels } from "../../api/providers/requesty"
- import { getOpenAiModels } from "../../api/providers/openai"
- import { getOllamaModels } from "../../api/providers/ollama"
- import { getVsCodeLmModels } from "../../api/providers/vscode-lm"
- import { getLmStudioModels } from "../../api/providers/lmstudio"
- import { ACTION_NAMES } from "../CodeActionProvider"
- import { Cline, ClineOptions } from "../Cline"
- import { openMention } from "../mentions"
- import { getNonce } from "./getNonce"
- import { getUri } from "./getUri"
- import { telemetryService } from "../../services/telemetry/TelemetryService"
- import { TelemetrySetting } from "../../shared/TelemetrySetting"
- /**
- * https://github.com/microsoft/vscode-webview-ui-toolkit-samples/blob/main/default/weather-webview/src/providers/WeatherViewProvider.ts
- * https://github.com/KumarVariable/vscode-extension-sidebar-html/blob/master/src/customSidebarViewProvider.ts
- */
- export class ClineProvider implements vscode.WebviewViewProvider {
- public static readonly sideBarId = "roo-cline.SidebarProvider" // used in package.json as the view's id. This value cannot be changed due to how vscode caches views based on their id, and updating the id would break existing instances of the extension.
- public static readonly tabPanelId = "roo-cline.TabPanelProvider"
- private static activeInstances: Set<ClineProvider> = new Set()
- private disposables: vscode.Disposable[] = []
- private view?: vscode.WebviewView | vscode.WebviewPanel
- private isViewLaunched = false
- private clineStack: Cline[] = []
- private workspaceTracker?: WorkspaceTracker
- protected mcpHub?: McpHub // Change from private to protected
- private latestAnnouncementId = "mar-7-2025-3-8" // update to some unique identifier when we add a new announcement
- private contextProxy: ContextProxy
- configManager: ConfigManager
- customModesManager: CustomModesManager
- private lastTaskNumber = -1
- constructor(
- readonly context: vscode.ExtensionContext,
- private readonly outputChannel: vscode.OutputChannel,
- ) {
- this.outputChannel.appendLine("ClineProvider instantiated")
- this.contextProxy = new ContextProxy(context)
- ClineProvider.activeInstances.add(this)
- // Register this provider with the telemetry service to enable it to add properties like mode and provider
- telemetryService.setProvider(this)
- this.workspaceTracker = new WorkspaceTracker(this)
- this.configManager = new ConfigManager(this.context)
- this.customModesManager = new CustomModesManager(this.context, async () => {
- await this.postStateToWebview()
- })
- // Initialize MCP Hub through the singleton manager
- McpServerManager.getInstance(this.context, this)
- .then((hub) => {
- this.mcpHub = hub
- })
- .catch((error) => {
- this.outputChannel.appendLine(`Failed to initialize MCP Hub: ${error}`)
- })
- }
- // Adds a new Cline instance to clineStack, marking the start of a new task.
- // The instance is pushed to the top of the stack (LIFO order).
- // When the task is completed, the top instance is removed, reactivating the previous task.
- async addClineToStack(cline: Cline) {
- try {
- if (!cline) {
- throw new Error("Error invalid Cline instance provided.")
- }
- // Ensure lastTaskNumber is a valid number
- if (typeof this.lastTaskNumber !== "number") {
- this.lastTaskNumber = -1
- }
- const taskNumber = cline.getTaskNumber()
- if (taskNumber === -1) {
- this.lastTaskNumber += 1
- cline.setTaskNumber(this.lastTaskNumber)
- } else if (taskNumber > this.lastTaskNumber) {
- this.lastTaskNumber = taskNumber
- }
- // set this cline task parent cline (the task that launched it), and the root cline (the top most task that eventually launched it)
- if (this.clineStack.length >= 1) {
- cline.setParentTask(this.getCurrentCline())
- cline.setRootTask(this.clineStack[0])
- }
- // add this cline instance into the stack that represents the order of all the called tasks
- this.clineStack.push(cline)
- // Ensure getState() resolves correctly
- const state = await this.getState()
- if (!state || typeof state.mode !== "string") {
- throw new Error("Error failed to retrieve current mode from state.")
- }
- this.log(`[subtasks] Task: ${cline.getTaskNumber()} started at '${state.mode}' mode`)
- } catch (error) {
- this.log(`Error in addClineToStack: ${error.message}`)
- throw error
- }
- }
- // Removes and destroys the top Cline instance (the current finished task), activating the previous one (resuming the parent task).
- async removeClineFromStack() {
- try {
- if (!Array.isArray(this.clineStack)) {
- throw new Error("Error clineStack is not an array.")
- }
- if (this.clineStack.length === 0) {
- this.log("[subtasks] No active tasks to remove.")
- } else {
- // pop the top Cline instance from the stack
- var clineToBeRemoved = this.clineStack.pop()
- if (clineToBeRemoved) {
- const removedTaskNumber = clineToBeRemoved.getTaskNumber()
- try {
- // abort the running task and set isAbandoned to true so all running promises will exit as well
- await clineToBeRemoved.abortTask(true)
- } catch (abortError) {
- this.log(`Error failed aborting task ${removedTaskNumber}: ${abortError.message}`)
- }
- // make sure no reference kept, once promises end it will be garbage collected
- clineToBeRemoved = undefined
- this.log(`[subtasks] Task: ${removedTaskNumber} stopped`)
- }
- // if the stack is empty, reset the last task number
- if (this.clineStack.length === 0) {
- this.lastTaskNumber = -1
- }
- }
- } catch (error) {
- this.log(`Error in removeClineFromStack: ${error.message}`)
- throw error
- }
- }
- // remove the cline object with the received clineId, and all the cline objects bove it in the stack
- // for each cline object removed, pop it from the stack, abort the task and set it to undefined
- async removeClineWithIdFromStack(clineId: string) {
- try {
- if (typeof clineId !== "string" || !clineId.trim()) {
- throw new Error("Error Invalid clineId provided.")
- }
- const index = this.clineStack.findIndex((c) => c.taskId === clineId)
- if (index === -1) {
- this.log(`[subtasks] No task found with ID: ${clineId}`)
- return
- }
- for (let i = this.clineStack.length - 1; i >= index; i--) {
- try {
- await this.removeClineFromStack()
- } catch (removalError) {
- this.log(`Error removing task at stack index ${i}: ${removalError.message}`)
- }
- }
- } catch (error) {
- this.log(`Error in removeClineWithIdFromStack: ${error.message}`)
- throw error
- }
- }
- // returns the current cline object in the stack (the top one)
- // if the stack is empty, returns undefined
- getCurrentCline(): Cline | undefined {
- if (this.clineStack.length === 0) {
- return undefined
- }
- return this.clineStack[this.clineStack.length - 1]
- }
- // returns the current clineStack length (how many cline objects are in the stack)
- getClineStackSize(): number {
- return this.clineStack.length
- }
- // remove the current task/cline instance (at the top of the stack), ao this task is finished
- // and resume the previous task/cline instance (if it exists)
- // this is used when a sub task is finished and the parent task needs to be resumed
- async finishSubTask(lastMessage?: string) {
- try {
- // remove the last cline instance from the stack (this is the finished sub task)
- await this.removeClineFromStack()
- // resume the last cline instance in the stack (if it exists - this is the 'parnt' calling task)
- this.getCurrentCline()?.resumePausedTask(lastMessage)
- } catch (error) {
- this.log(`Error in finishSubTask: ${error.message}`)
- throw error
- }
- }
- /*
- VSCode extensions use the disposable pattern to clean up resources when the sidebar/editor tab is closed by the user or system. This applies to event listening, commands, interacting with the UI, etc.
- - https://vscode-docs.readthedocs.io/en/stable/extensions/patterns-and-principles/
- - https://github.com/microsoft/vscode-extension-samples/blob/main/webview-sample/src/extension.ts
- */
- async dispose() {
- this.outputChannel.appendLine("Disposing ClineProvider...")
- await this.removeClineFromStack()
- this.outputChannel.appendLine("Cleared task")
- if (this.view && "dispose" in this.view) {
- this.view.dispose()
- this.outputChannel.appendLine("Disposed webview")
- }
- while (this.disposables.length) {
- const x = this.disposables.pop()
- if (x) {
- x.dispose()
- }
- }
- this.workspaceTracker?.dispose()
- this.workspaceTracker = undefined
- this.mcpHub?.dispose()
- this.mcpHub = undefined
- this.customModesManager?.dispose()
- this.outputChannel.appendLine("Disposed all disposables")
- ClineProvider.activeInstances.delete(this)
- // Unregister from McpServerManager
- McpServerManager.unregisterProvider(this)
- }
- public static getVisibleInstance(): ClineProvider | undefined {
- return findLast(Array.from(this.activeInstances), (instance) => instance.view?.visible === true)
- }
- public static async getInstance(): Promise<ClineProvider | undefined> {
- let visibleProvider = ClineProvider.getVisibleInstance()
- // If no visible provider, try to show the sidebar view
- if (!visibleProvider) {
- await vscode.commands.executeCommand("roo-cline.SidebarProvider.focus")
- // Wait briefly for the view to become visible
- await delay(100)
- visibleProvider = ClineProvider.getVisibleInstance()
- }
- // If still no visible provider, return
- if (!visibleProvider) {
- return
- }
- return visibleProvider
- }
- public static async isActiveTask(): Promise<boolean> {
- const visibleProvider = await ClineProvider.getInstance()
- if (!visibleProvider) {
- return false
- }
- // check if there is a cline instance in the stack (if this provider has an active task)
- if (visibleProvider.getCurrentCline()) {
- return true
- }
- return false
- }
- public static async handleCodeAction(
- command: string,
- promptType: keyof typeof ACTION_NAMES,
- params: Record<string, string | any[]>,
- ): Promise<void> {
- const visibleProvider = await ClineProvider.getInstance()
- if (!visibleProvider) {
- return
- }
- const { customSupportPrompts } = await visibleProvider.getState()
- const prompt = supportPrompt.create(promptType, params, customSupportPrompts)
- if (command.endsWith("addToContext")) {
- await visibleProvider.postMessageToWebview({
- type: "invoke",
- invoke: "setChatBoxMessage",
- text: prompt,
- })
- return
- }
- if (visibleProvider.getCurrentCline() && command.endsWith("InCurrentTask")) {
- await visibleProvider.postMessageToWebview({
- type: "invoke",
- invoke: "sendMessage",
- text: prompt,
- })
- return
- }
- await visibleProvider.initClineWithTask(prompt)
- }
- public static async handleTerminalAction(
- command: string,
- promptType: "TERMINAL_ADD_TO_CONTEXT" | "TERMINAL_FIX" | "TERMINAL_EXPLAIN",
- params: Record<string, string | any[]>,
- ): Promise<void> {
- const visibleProvider = await ClineProvider.getInstance()
- if (!visibleProvider) {
- return
- }
- const { customSupportPrompts } = await visibleProvider.getState()
- const prompt = supportPrompt.create(promptType, params, customSupportPrompts)
- if (command.endsWith("AddToContext")) {
- await visibleProvider.postMessageToWebview({
- type: "invoke",
- invoke: "setChatBoxMessage",
- text: prompt,
- })
- return
- }
- if (visibleProvider.getCurrentCline() && command.endsWith("InCurrentTask")) {
- await visibleProvider.postMessageToWebview({
- type: "invoke",
- invoke: "sendMessage",
- text: prompt,
- })
- return
- }
- await visibleProvider.initClineWithTask(prompt)
- }
- async resolveWebviewView(webviewView: vscode.WebviewView | vscode.WebviewPanel) {
- this.outputChannel.appendLine("Resolving webview view")
- this.view = webviewView
- // Set panel reference according to webview type
- if ("onDidChangeViewState" in webviewView) {
- // Tag page type
- setPanel(webviewView, "tab")
- } else if ("onDidChangeVisibility" in webviewView) {
- // Sidebar Type
- setPanel(webviewView, "sidebar")
- }
- // Initialize sound enabled state
- this.getState().then(({ soundEnabled }) => {
- setSoundEnabled(soundEnabled ?? false)
- })
- webviewView.webview.options = {
- // Allow scripts in the webview
- enableScripts: true,
- localResourceRoots: [this.contextProxy.extensionUri],
- }
- webviewView.webview.html =
- this.contextProxy.extensionMode === vscode.ExtensionMode.Development
- ? await this.getHMRHtmlContent(webviewView.webview)
- : this.getHtmlContent(webviewView.webview)
- // Sets up an event listener to listen for messages passed from the webview view context
- // and executes code based on the message that is recieved
- this.setWebviewMessageListener(webviewView.webview)
- // Logs show up in bottom panel > Debug Console
- //console.log("registering listener")
- // Listen for when the panel becomes visible
- // https://github.com/microsoft/vscode-discussions/discussions/840
- if ("onDidChangeViewState" in webviewView) {
- // WebviewView and WebviewPanel have all the same properties except for this visibility listener
- // panel
- webviewView.onDidChangeViewState(
- () => {
- if (this.view?.visible) {
- this.postMessageToWebview({ type: "action", action: "didBecomeVisible" })
- }
- },
- null,
- this.disposables,
- )
- } else if ("onDidChangeVisibility" in webviewView) {
- // sidebar
- webviewView.onDidChangeVisibility(
- () => {
- if (this.view?.visible) {
- this.postMessageToWebview({ type: "action", action: "didBecomeVisible" })
- }
- },
- null,
- this.disposables,
- )
- }
- // Listen for when the view is disposed
- // This happens when the user closes the view or when the view is closed programmatically
- webviewView.onDidDispose(
- async () => {
- await this.dispose()
- },
- null,
- this.disposables,
- )
- // Listen for when color changes
- vscode.workspace.onDidChangeConfiguration(
- async (e) => {
- if (e && e.affectsConfiguration("workbench.colorTheme")) {
- // Sends latest theme name to webview
- await this.postMessageToWebview({ type: "theme", text: JSON.stringify(await getTheme()) })
- }
- },
- null,
- this.disposables,
- )
- // if the extension is starting a new session, clear previous task state
- await this.removeClineFromStack()
- this.outputChannel.appendLine("Webview view resolved")
- }
- // a wrapper that inits a new Cline instance (Task) ans setting it as a sub task of the current task
- public async initClineWithSubTask(task?: string, images?: string[]) {
- await this.initClineWithTask(task, images)
- this.getCurrentCline()?.setSubTask()
- }
- // when initializing a new task, (not from history but from a tool command new_task) there is no need to remove the previouse task
- // since the new task is a sub task of the previous one, and when it finishes it is removed from the stack and the caller is resumed
- // in this way we can have a chain of tasks, each one being a sub task of the previous one until the main task is finished
- public async initClineWithTask(task?: string, images?: string[]) {
- const {
- apiConfiguration,
- customModePrompts,
- diffEnabled: enableDiff,
- enableCheckpoints,
- checkpointStorage,
- fuzzyMatchThreshold,
- mode,
- customInstructions: globalInstructions,
- experiments,
- } = await this.getState()
- const modePrompt = customModePrompts?.[mode] as PromptComponent
- const effectiveInstructions = [globalInstructions, modePrompt?.customInstructions].filter(Boolean).join("\n\n")
- const newCline = new Cline({
- provider: this,
- apiConfiguration,
- customInstructions: effectiveInstructions,
- enableDiff,
- enableCheckpoints,
- checkpointStorage,
- fuzzyMatchThreshold,
- task,
- images,
- experiments,
- })
- await this.addClineToStack(newCline)
- }
- public async initClineWithHistoryItem(historyItem: HistoryItem) {
- await this.removeClineFromStack()
- const {
- apiConfiguration,
- customModePrompts,
- diffEnabled: enableDiff,
- enableCheckpoints,
- checkpointStorage,
- fuzzyMatchThreshold,
- mode,
- customInstructions: globalInstructions,
- experiments,
- } = await this.getState()
- const modePrompt = customModePrompts?.[mode] as PromptComponent
- const effectiveInstructions = [globalInstructions, modePrompt?.customInstructions].filter(Boolean).join("\n\n")
- const taskId = historyItem.id
- const globalStorageDir = this.contextProxy.globalStorageUri.fsPath
- const workspaceDir = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath ?? ""
- const checkpoints: Pick<ClineOptions, "enableCheckpoints" | "checkpointStorage"> = {
- enableCheckpoints,
- checkpointStorage,
- }
- if (enableCheckpoints) {
- try {
- checkpoints.checkpointStorage = await ShadowCheckpointService.getTaskStorage({
- taskId,
- globalStorageDir,
- workspaceDir,
- })
- this.log(
- `[ClineProvider#initClineWithHistoryItem] Using ${checkpoints.checkpointStorage} storage for ${taskId}`,
- )
- } catch (error) {
- checkpoints.enableCheckpoints = false
- this.log(`[ClineProvider#initClineWithHistoryItem] Error getting task storage: ${error.message}`)
- }
- }
- const newCline = new Cline({
- provider: this,
- apiConfiguration,
- customInstructions: effectiveInstructions,
- enableDiff,
- ...checkpoints,
- fuzzyMatchThreshold,
- historyItem,
- experiments,
- })
- newCline.setTaskNumber(historyItem.number)
- await this.addClineToStack(newCline)
- }
- public async postMessageToWebview(message: ExtensionMessage) {
- await this.view?.webview.postMessage(message)
- }
- private async getHMRHtmlContent(webview: vscode.Webview): Promise<string> {
- const localPort = "5173"
- const localServerUrl = `localhost:${localPort}`
- // Check if local dev server is running.
- try {
- await axios.get(`http://${localServerUrl}`)
- } catch (error) {
- vscode.window.showErrorMessage(
- "Local development server is not running, HMR will not work. Please run 'npm run dev' before launching the extension to enable HMR.",
- )
- return this.getHtmlContent(webview)
- }
- const nonce = getNonce()
- const stylesUri = getUri(webview, this.contextProxy.extensionUri, [
- "webview-ui",
- "build",
- "assets",
- "index.css",
- ])
- const codiconsUri = getUri(webview, this.contextProxy.extensionUri, [
- "node_modules",
- "@vscode",
- "codicons",
- "dist",
- "codicon.css",
- ])
- const file = "src/index.tsx"
- const scriptUri = `http://${localServerUrl}/${file}`
- const reactRefresh = /*html*/ `
- <script nonce="${nonce}" type="module">
- import RefreshRuntime from "http://localhost:${localPort}/@react-refresh"
- RefreshRuntime.injectIntoGlobalHook(window)
- window.$RefreshReg$ = () => {}
- window.$RefreshSig$ = () => (type) => type
- window.__vite_plugin_react_preamble_installed__ = true
- </script>
- `
- const csp = [
- "default-src 'none'",
- `font-src ${webview.cspSource}`,
- `style-src ${webview.cspSource} 'unsafe-inline' https://* http://${localServerUrl} http://0.0.0.0:${localPort}`,
- `img-src ${webview.cspSource} data:`,
- `script-src 'unsafe-eval' https://* https://*.posthog.com http://${localServerUrl} http://0.0.0.0:${localPort} 'nonce-${nonce}'`,
- `connect-src https://* https://*.posthog.com ws://${localServerUrl} ws://0.0.0.0:${localPort} http://${localServerUrl} http://0.0.0.0:${localPort}`,
- ]
- return /*html*/ `
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no">
- <meta http-equiv="Content-Security-Policy" content="${csp.join("; ")}">
- <link rel="stylesheet" type="text/css" href="${stylesUri}">
- <link href="${codiconsUri}" rel="stylesheet" />
- <title>Roo Code</title>
- </head>
- <body>
- <div id="root"></div>
- ${reactRefresh}
- <script type="module" src="${scriptUri}"></script>
- </body>
- </html>
- `
- }
- /**
- * Defines and returns the HTML that should be rendered within the webview panel.
- *
- * @remarks This is also the place where references to the React webview build files
- * are created and inserted into the webview HTML.
- *
- * @param webview A reference to the extension webview
- * @param extensionUri The URI of the directory containing the extension
- * @returns A template string literal containing the HTML that should be
- * rendered within the webview panel
- */
- private getHtmlContent(webview: vscode.Webview): string {
- // Get the local path to main script run in the webview,
- // then convert it to a uri we can use in the webview.
- // The CSS file from the React build output
- const stylesUri = getUri(webview, this.contextProxy.extensionUri, [
- "webview-ui",
- "build",
- "assets",
- "index.css",
- ])
- // The JS file from the React build output
- const scriptUri = getUri(webview, this.contextProxy.extensionUri, ["webview-ui", "build", "assets", "index.js"])
- // The codicon font from the React build output
- // https://github.com/microsoft/vscode-extension-samples/blob/main/webview-codicons-sample/src/extension.ts
- // we installed this package in the extension so that we can access it how its intended from the extension (the font file is likely bundled in vscode), and we just import the css fileinto our react app we don't have access to it
- // don't forget to add font-src ${webview.cspSource};
- const codiconsUri = getUri(webview, this.contextProxy.extensionUri, [
- "node_modules",
- "@vscode",
- "codicons",
- "dist",
- "codicon.css",
- ])
- // const scriptUri = webview.asWebviewUri(vscode.Uri.joinPath(this._extensionUri, "assets", "main.js"))
- // const styleResetUri = webview.asWebviewUri(vscode.Uri.joinPath(this._extensionUri, "assets", "reset.css"))
- // const styleVSCodeUri = webview.asWebviewUri(vscode.Uri.joinPath(this._extensionUri, "assets", "vscode.css"))
- // // Same for stylesheet
- // const stylesheetUri = webview.asWebviewUri(vscode.Uri.joinPath(this._extensionUri, "assets", "main.css"))
- // Use a nonce to only allow a specific script to be run.
- /*
- content security policy of your webview to only allow scripts that have a specific nonce
- create a content security policy meta tag so that only loading scripts with a nonce is allowed
- As your extension grows you will likely want to add custom styles, fonts, and/or images to your webview. If you do, you will need to update the content security policy meta tag to explicity allow for these resources. E.g.
- <meta http-equiv="Content-Security-Policy" content="default-src 'none'; style-src ${webview.cspSource}; font-src ${webview.cspSource}; img-src ${webview.cspSource} https:; script-src 'nonce-${nonce}';">
- - 'unsafe-inline' is required for styles due to vscode-webview-toolkit's dynamic style injection
- - since we pass base64 images to the webview, we need to specify img-src ${webview.cspSource} data:;
- in meta tag we add nonce attribute: A cryptographic nonce (only used once) to allow scripts. The server must generate a unique nonce value each time it transmits a policy. It is critical to provide a nonce that cannot be guessed as bypassing a resource's policy is otherwise trivial.
- */
- const nonce = getNonce()
- // Tip: Install the es6-string-html VS Code extension to enable code highlighting below
- return /*html*/ `
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no">
- <meta name="theme-color" content="#000000">
- <meta http-equiv="Content-Security-Policy" content="default-src 'none'; font-src ${webview.cspSource}; style-src ${webview.cspSource} 'unsafe-inline'; img-src ${webview.cspSource} data:; script-src 'nonce-${nonce}' https://us-assets.i.posthog.com; connect-src https://us.i.posthog.com https://us-assets.i.posthog.com;">
- <link rel="stylesheet" type="text/css" href="${stylesUri}">
- <link href="${codiconsUri}" rel="stylesheet" />
- <title>Roo Code</title>
- </head>
- <body>
- <noscript>You need to enable JavaScript to run this app.</noscript>
- <div id="root"></div>
- <script nonce="${nonce}" type="module" src="${scriptUri}"></script>
- </body>
- </html>
- `
- }
- /**
- * Sets up an event listener to listen for messages passed from the webview context and
- * executes code based on the message that is recieved.
- *
- * @param webview A reference to the extension webview
- */
- private setWebviewMessageListener(webview: vscode.Webview) {
- webview.onDidReceiveMessage(
- async (message: WebviewMessage) => {
- switch (message.type) {
- case "webviewDidLaunch":
- // Load custom modes first
- const customModes = await this.customModesManager.getCustomModes()
- await this.updateGlobalState("customModes", customModes)
- this.postStateToWebview()
- this.workspaceTracker?.initializeFilePaths() // don't await
- getTheme().then((theme) =>
- this.postMessageToWebview({ type: "theme", text: JSON.stringify(theme) }),
- )
- // If MCP Hub is already initialized, update the webview with current server list
- if (this.mcpHub) {
- this.postMessageToWebview({
- type: "mcpServers",
- mcpServers: this.mcpHub.getAllServers(),
- })
- }
- const cacheDir = await this.ensureCacheDirectoryExists()
- // Post last cached models in case the call to endpoint fails.
- this.readModelsFromCache(GlobalFileNames.openRouterModels).then((openRouterModels) => {
- if (openRouterModels) {
- this.postMessageToWebview({ type: "openRouterModels", openRouterModels })
- }
- })
- // GUI relies on model info to be up-to-date to provide
- // the most accurate pricing, so we need to fetch the
- // latest details on launch.
- // We do this for all users since many users switch
- // between api providers and if they were to switch back
- // to OpenRouter it would be showing outdated model info
- // if we hadn't retrieved the latest at this point
- // (see normalizeApiConfiguration > openrouter).
- getOpenRouterModels().then(async (openRouterModels) => {
- if (Object.keys(openRouterModels).length > 0) {
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.openRouterModels),
- JSON.stringify(openRouterModels),
- )
- await this.postMessageToWebview({ type: "openRouterModels", openRouterModels })
- // Update model info in state (this needs to be
- // done here since we don't want to update state
- // while settings is open, and we may refresh
- // models there).
- const { apiConfiguration } = await this.getState()
- if (apiConfiguration.openRouterModelId) {
- await this.updateGlobalState(
- "openRouterModelInfo",
- openRouterModels[apiConfiguration.openRouterModelId],
- )
- await this.postStateToWebview()
- }
- }
- })
- this.readModelsFromCache(GlobalFileNames.glamaModels).then((glamaModels) => {
- if (glamaModels) {
- this.postMessageToWebview({ type: "glamaModels", glamaModels })
- }
- })
- getGlamaModels().then(async (glamaModels) => {
- if (Object.keys(glamaModels).length > 0) {
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.glamaModels),
- JSON.stringify(glamaModels),
- )
- await this.postMessageToWebview({ type: "glamaModels", glamaModels })
- const { apiConfiguration } = await this.getState()
- if (apiConfiguration.glamaModelId) {
- await this.updateGlobalState(
- "glamaModelInfo",
- glamaModels[apiConfiguration.glamaModelId],
- )
- await this.postStateToWebview()
- }
- }
- })
- this.readModelsFromCache(GlobalFileNames.unboundModels).then((unboundModels) => {
- if (unboundModels) {
- this.postMessageToWebview({ type: "unboundModels", unboundModels })
- }
- })
- getUnboundModels().then(async (unboundModels) => {
- if (Object.keys(unboundModels).length > 0) {
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.unboundModels),
- JSON.stringify(unboundModels),
- )
- await this.postMessageToWebview({ type: "unboundModels", unboundModels })
- const { apiConfiguration } = await this.getState()
- if (apiConfiguration?.unboundModelId) {
- await this.updateGlobalState(
- "unboundModelInfo",
- unboundModels[apiConfiguration.unboundModelId],
- )
- await this.postStateToWebview()
- }
- }
- })
- this.readModelsFromCache(GlobalFileNames.requestyModels).then((requestyModels) => {
- if (requestyModels) {
- this.postMessageToWebview({ type: "requestyModels", requestyModels })
- }
- })
- getRequestyModels().then(async (requestyModels) => {
- if (Object.keys(requestyModels).length > 0) {
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.requestyModels),
- JSON.stringify(requestyModels),
- )
- await this.postMessageToWebview({ type: "requestyModels", requestyModels })
- const { apiConfiguration } = await this.getState()
- if (apiConfiguration.requestyModelId) {
- await this.updateGlobalState(
- "requestyModelInfo",
- requestyModels[apiConfiguration.requestyModelId],
- )
- await this.postStateToWebview()
- }
- }
- })
- this.configManager
- .listConfig()
- .then(async (listApiConfig) => {
- if (!listApiConfig) {
- return
- }
- if (listApiConfig.length === 1) {
- // check if first time init then sync with exist config
- if (!checkExistKey(listApiConfig[0])) {
- const { apiConfiguration } = await this.getState()
- await this.configManager.saveConfig(
- listApiConfig[0].name ?? "default",
- apiConfiguration,
- )
- listApiConfig[0].apiProvider = apiConfiguration.apiProvider
- }
- }
- const currentConfigName = (await this.getGlobalState("currentApiConfigName")) as string
- if (currentConfigName) {
- if (!(await this.configManager.hasConfig(currentConfigName))) {
- // current config name not valid, get first config in list
- await this.updateGlobalState("currentApiConfigName", listApiConfig?.[0]?.name)
- if (listApiConfig?.[0]?.name) {
- const apiConfig = await this.configManager.loadConfig(
- listApiConfig?.[0]?.name,
- )
- await Promise.all([
- this.updateGlobalState("listApiConfigMeta", listApiConfig),
- this.postMessageToWebview({ type: "listApiConfig", listApiConfig }),
- this.updateApiConfiguration(apiConfig),
- ])
- await this.postStateToWebview()
- return
- }
- }
- }
- await Promise.all([
- await this.updateGlobalState("listApiConfigMeta", listApiConfig),
- await this.postMessageToWebview({ type: "listApiConfig", listApiConfig }),
- ])
- })
- .catch((error) =>
- this.outputChannel.appendLine(
- `Error list api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- ),
- )
- // If user already opted in to telemetry, enable telemetry service
- this.getStateToPostToWebview().then((state) => {
- const { telemetrySetting } = state
- const isOptedIn = telemetrySetting === "enabled"
- telemetryService.updateTelemetryState(isOptedIn)
- })
- this.isViewLaunched = true
- break
- case "newTask":
- // Code that should run in response to the hello message command
- //vscode.window.showInformationMessage(message.text!)
- // Send a message to our webview.
- // You can send any JSON serializable data.
- // 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)
- break
- case "apiConfiguration":
- if (message.apiConfiguration) {
- await this.updateApiConfiguration(message.apiConfiguration)
- }
- await this.postStateToWebview()
- break
- case "customInstructions":
- await this.updateCustomInstructions(message.text)
- break
- case "alwaysAllowReadOnly":
- await this.updateGlobalState("alwaysAllowReadOnly", message.bool ?? undefined)
- await this.postStateToWebview()
- break
- case "alwaysAllowWrite":
- await this.updateGlobalState("alwaysAllowWrite", message.bool ?? undefined)
- await this.postStateToWebview()
- break
- case "alwaysAllowExecute":
- await this.updateGlobalState("alwaysAllowExecute", message.bool ?? undefined)
- await this.postStateToWebview()
- break
- case "alwaysAllowBrowser":
- await this.updateGlobalState("alwaysAllowBrowser", message.bool ?? undefined)
- await this.postStateToWebview()
- break
- case "alwaysAllowMcp":
- await this.updateGlobalState("alwaysAllowMcp", message.bool)
- await this.postStateToWebview()
- break
- case "alwaysAllowModeSwitch":
- await this.updateGlobalState("alwaysAllowModeSwitch", message.bool)
- await this.postStateToWebview()
- break
- case "alwaysAllowSubtasks":
- await this.updateGlobalState("alwaysAllowSubtasks", message.bool)
- await this.postStateToWebview()
- break
- case "askResponse":
- this.getCurrentCline()?.handleWebviewAskResponse(
- message.askResponse!,
- message.text,
- message.images,
- )
- break
- case "clearTask":
- // clear task resets the current session and allows for a new task to be started, if this session is a subtask - it allows the parent task to be resumed
- await this.finishSubTask(`Task error: It was stopped and canceled by the user.`)
- await this.postStateToWebview()
- break
- case "didShowAnnouncement":
- await this.updateGlobalState("lastShownAnnouncementId", this.latestAnnouncementId)
- await this.postStateToWebview()
- break
- case "selectImages":
- const images = await selectImages()
- await this.postMessageToWebview({ type: "selectedImages", images })
- break
- case "exportCurrentTask":
- const currentTaskId = this.getCurrentCline()?.taskId
- if (currentTaskId) {
- this.exportTaskWithId(currentTaskId)
- }
- break
- case "showTaskWithId":
- this.showTaskWithId(message.text!)
- break
- case "deleteTaskWithId":
- this.deleteTaskWithId(message.text!)
- break
- case "exportTaskWithId":
- this.exportTaskWithId(message.text!)
- break
- case "resetState":
- await this.resetState()
- break
- case "refreshOpenRouterModels":
- const openRouterModels = await getOpenRouterModels()
- if (Object.keys(openRouterModels).length > 0) {
- const cacheDir = await this.ensureCacheDirectoryExists()
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.openRouterModels),
- JSON.stringify(openRouterModels),
- )
- await this.postMessageToWebview({ type: "openRouterModels", openRouterModels })
- }
- break
- case "refreshGlamaModels":
- const glamaModels = await getGlamaModels()
- if (Object.keys(glamaModels).length > 0) {
- const cacheDir = await this.ensureCacheDirectoryExists()
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.glamaModels),
- JSON.stringify(glamaModels),
- )
- await this.postMessageToWebview({ type: "glamaModels", glamaModels })
- }
- break
- case "refreshUnboundModels":
- const unboundModels = await getUnboundModels()
- if (Object.keys(unboundModels).length > 0) {
- const cacheDir = await this.ensureCacheDirectoryExists()
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.unboundModels),
- JSON.stringify(unboundModels),
- )
- await this.postMessageToWebview({ type: "unboundModels", unboundModels })
- }
- break
- case "refreshRequestyModels":
- const requestyModels = await getRequestyModels()
- if (Object.keys(requestyModels).length > 0) {
- const cacheDir = await this.ensureCacheDirectoryExists()
- await fs.writeFile(
- path.join(cacheDir, GlobalFileNames.requestyModels),
- JSON.stringify(requestyModels),
- )
- await this.postMessageToWebview({ type: "requestyModels", requestyModels })
- }
- break
- case "refreshOpenAiModels":
- if (message?.values?.baseUrl && message?.values?.apiKey) {
- const openAiModels = await getOpenAiModels(
- message?.values?.baseUrl,
- message?.values?.apiKey,
- )
- this.postMessageToWebview({ type: "openAiModels", openAiModels })
- }
- break
- case "requestOllamaModels":
- const ollamaModels = await getOllamaModels(message.text)
- // TODO: Cache like we do for OpenRouter, etc?
- this.postMessageToWebview({ type: "ollamaModels", ollamaModels })
- break
- case "requestLmStudioModels":
- const lmStudioModels = await getLmStudioModels(message.text)
- // TODO: Cache like we do for OpenRouter, etc?
- this.postMessageToWebview({ type: "lmStudioModels", lmStudioModels })
- break
- case "requestVsCodeLmModels":
- const vsCodeLmModels = await getVsCodeLmModels()
- // TODO: Cache like we do for OpenRouter, etc?
- this.postMessageToWebview({ type: "vsCodeLmModels", vsCodeLmModels })
- break
- case "openImage":
- openImage(message.text!)
- break
- case "openFile":
- openFile(message.text!, message.values as { create?: boolean; content?: string })
- break
- case "openMention":
- openMention(message.text)
- break
- case "checkpointDiff":
- const result = checkoutDiffPayloadSchema.safeParse(message.payload)
- if (result.success) {
- await this.getCurrentCline()?.checkpointDiff(result.data)
- }
- break
- case "checkpointRestore": {
- const result = checkoutRestorePayloadSchema.safeParse(message.payload)
- if (result.success) {
- await this.cancelTask()
- try {
- await pWaitFor(() => this.getCurrentCline()?.isInitialized === true, { timeout: 3_000 })
- } catch (error) {
- vscode.window.showErrorMessage("Timed out when attempting to restore checkpoint.")
- }
- try {
- await this.getCurrentCline()?.checkpointRestore(result.data)
- } catch (error) {
- vscode.window.showErrorMessage("Failed to restore checkpoint.")
- }
- }
- break
- }
- case "cancelTask":
- await this.cancelTask()
- break
- case "allowedCommands":
- await this.context.globalState.update("allowedCommands", message.commands)
- // Also update workspace settings
- await vscode.workspace
- .getConfiguration("roo-cline")
- .update("allowedCommands", message.commands, vscode.ConfigurationTarget.Global)
- break
- case "openMcpSettings": {
- const mcpSettingsFilePath = await this.mcpHub?.getMcpSettingsFilePath()
- if (mcpSettingsFilePath) {
- openFile(mcpSettingsFilePath)
- }
- break
- }
- case "openCustomModesSettings": {
- const customModesFilePath = await this.customModesManager.getCustomModesFilePath()
- if (customModesFilePath) {
- openFile(customModesFilePath)
- }
- break
- }
- case "deleteMcpServer": {
- if (!message.serverName) {
- break
- }
- try {
- this.outputChannel.appendLine(`Attempting to delete MCP server: ${message.serverName}`)
- await this.mcpHub?.deleteServer(message.serverName)
- this.outputChannel.appendLine(`Successfully deleted MCP server: ${message.serverName}`)
- } catch (error) {
- const errorMessage = error instanceof Error ? error.message : String(error)
- this.outputChannel.appendLine(`Failed to delete MCP server: ${errorMessage}`)
- // Error messages are already handled by McpHub.deleteServer
- }
- break
- }
- case "restartMcpServer": {
- try {
- await this.mcpHub?.restartConnection(message.text!)
- } catch (error) {
- this.outputChannel.appendLine(
- `Failed to retry connection for ${message.text}: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- }
- break
- }
- case "toggleToolAlwaysAllow": {
- try {
- await this.mcpHub?.toggleToolAlwaysAllow(
- message.serverName!,
- message.toolName!,
- message.alwaysAllow!,
- )
- } catch (error) {
- this.outputChannel.appendLine(
- `Failed to toggle auto-approve for tool ${message.toolName}: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- }
- break
- }
- case "toggleMcpServer": {
- try {
- await this.mcpHub?.toggleServerDisabled(message.serverName!, message.disabled!)
- } catch (error) {
- this.outputChannel.appendLine(
- `Failed to toggle MCP server ${message.serverName}: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- }
- break
- }
- case "mcpEnabled":
- const mcpEnabled = message.bool ?? true
- await this.updateGlobalState("mcpEnabled", mcpEnabled)
- await this.postStateToWebview()
- break
- case "enableMcpServerCreation":
- await this.updateGlobalState("enableMcpServerCreation", message.bool ?? true)
- await this.postStateToWebview()
- break
- case "playSound":
- if (message.audioType) {
- const soundPath = path.join(this.context.extensionPath, "audio", `${message.audioType}.wav`)
- playSound(soundPath)
- }
- break
- case "soundEnabled":
- const soundEnabled = message.bool ?? true
- await this.updateGlobalState("soundEnabled", soundEnabled)
- setSoundEnabled(soundEnabled) // Add this line to update the sound utility
- await this.postStateToWebview()
- break
- case "soundVolume":
- const soundVolume = message.value ?? 0.5
- await this.updateGlobalState("soundVolume", soundVolume)
- setSoundVolume(soundVolume)
- await this.postStateToWebview()
- break
- case "diffEnabled":
- const diffEnabled = message.bool ?? true
- await this.updateGlobalState("diffEnabled", diffEnabled)
- await this.postStateToWebview()
- break
- case "enableCheckpoints":
- const enableCheckpoints = message.bool ?? true
- await this.updateGlobalState("enableCheckpoints", enableCheckpoints)
- await this.postStateToWebview()
- break
- case "checkpointStorage":
- const checkpointStorage = message.text ?? "task"
- await this.updateGlobalState("checkpointStorage", checkpointStorage)
- await this.postStateToWebview()
- break
- case "browserViewportSize":
- const browserViewportSize = message.text ?? "900x600"
- await this.updateGlobalState("browserViewportSize", browserViewportSize)
- await this.postStateToWebview()
- break
- case "fuzzyMatchThreshold":
- await this.updateGlobalState("fuzzyMatchThreshold", message.value)
- await this.postStateToWebview()
- break
- case "alwaysApproveResubmit":
- await this.updateGlobalState("alwaysApproveResubmit", message.bool ?? false)
- await this.postStateToWebview()
- break
- case "requestDelaySeconds":
- await this.updateGlobalState("requestDelaySeconds", message.value ?? 5)
- await this.postStateToWebview()
- break
- case "rateLimitSeconds":
- await this.updateGlobalState("rateLimitSeconds", message.value ?? 0)
- await this.postStateToWebview()
- break
- case "preferredLanguage":
- await this.updateGlobalState("preferredLanguage", message.text)
- await this.postStateToWebview()
- break
- case "writeDelayMs":
- await this.updateGlobalState("writeDelayMs", message.value)
- await this.postStateToWebview()
- break
- case "terminalOutputLimit":
- await this.updateGlobalState("terminalOutputLimit", message.value)
- await this.postStateToWebview()
- break
- case "mode":
- await this.handleModeSwitch(message.text as Mode)
- break
- case "updateSupportPrompt":
- try {
- if (Object.keys(message?.values ?? {}).length === 0) {
- return
- }
- const existingPrompts = (await this.getGlobalState("customSupportPrompts")) || {}
- const updatedPrompts = {
- ...existingPrompts,
- ...message.values,
- }
- await this.updateGlobalState("customSupportPrompts", updatedPrompts)
- await this.postStateToWebview()
- } catch (error) {
- this.outputChannel.appendLine(
- `Error update support prompt: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to update support prompt")
- }
- break
- case "resetSupportPrompt":
- try {
- if (!message?.text) {
- return
- }
- const existingPrompts = ((await this.getGlobalState("customSupportPrompts")) ||
- {}) as Record<string, any>
- const updatedPrompts = {
- ...existingPrompts,
- }
- updatedPrompts[message.text] = undefined
- await this.updateGlobalState("customSupportPrompts", updatedPrompts)
- await this.postStateToWebview()
- } catch (error) {
- this.outputChannel.appendLine(
- `Error reset support prompt: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to reset support prompt")
- }
- break
- case "updatePrompt":
- if (message.promptMode && message.customPrompt !== undefined) {
- const existingPrompts = (await this.getGlobalState("customModePrompts")) || {}
- const updatedPrompts = {
- ...existingPrompts,
- [message.promptMode]: message.customPrompt,
- }
- await this.updateGlobalState("customModePrompts", updatedPrompts)
- // Get current state and explicitly include customModePrompts
- const currentState = await this.getState()
- const stateWithPrompts = {
- ...currentState,
- customModePrompts: updatedPrompts,
- }
- // Post state with prompts
- this.view?.webview.postMessage({
- type: "state",
- state: stateWithPrompts,
- })
- }
- break
- case "deleteMessage": {
- const answer = await vscode.window.showInformationMessage(
- "What would you like to delete?",
- { modal: true },
- "Just this message",
- "This and all subsequent messages",
- )
- if (
- (answer === "Just this message" || answer === "This and all subsequent messages") &&
- this.getCurrentCline() &&
- typeof message.value === "number" &&
- message.value
- ) {
- const timeCutoff = message.value - 1000 // 1 second buffer before the message to delete
- const messageIndex = this.getCurrentCline()!.clineMessages.findIndex(
- (msg) => msg.ts && msg.ts >= timeCutoff,
- )
- const apiConversationHistoryIndex =
- this.getCurrentCline()?.apiConversationHistory.findIndex(
- (msg) => msg.ts && msg.ts >= timeCutoff,
- )
- if (messageIndex !== -1) {
- const { historyItem } = await this.getTaskWithId(this.getCurrentCline()!.taskId)
- if (answer === "Just this message") {
- // Find the next user message first
- const nextUserMessage = this.getCurrentCline()!
- .clineMessages.slice(messageIndex + 1)
- .find((msg) => msg.type === "say" && msg.say === "user_feedback")
- // Handle UI messages
- if (nextUserMessage) {
- // Find absolute index of next user message
- const nextUserMessageIndex = this.getCurrentCline()!.clineMessages.findIndex(
- (msg) => msg === nextUserMessage,
- )
- // Keep messages before current message and after next user message
- await this.getCurrentCline()!.overwriteClineMessages([
- ...this.getCurrentCline()!.clineMessages.slice(0, messageIndex),
- ...this.getCurrentCline()!.clineMessages.slice(nextUserMessageIndex),
- ])
- } else {
- // If no next user message, keep only messages before current message
- await this.getCurrentCline()!.overwriteClineMessages(
- this.getCurrentCline()!.clineMessages.slice(0, messageIndex),
- )
- }
- // Handle API messages
- if (apiConversationHistoryIndex !== -1) {
- if (nextUserMessage && nextUserMessage.ts) {
- // Keep messages before current API message and after next user message
- await this.getCurrentCline()!.overwriteApiConversationHistory([
- ...this.getCurrentCline()!.apiConversationHistory.slice(
- 0,
- apiConversationHistoryIndex,
- ),
- ...this.getCurrentCline()!.apiConversationHistory.filter(
- (msg) => msg.ts && msg.ts >= nextUserMessage.ts,
- ),
- ])
- } else {
- // If no next user message, keep only messages before current API message
- await this.getCurrentCline()!.overwriteApiConversationHistory(
- this.getCurrentCline()!.apiConversationHistory.slice(
- 0,
- apiConversationHistoryIndex,
- ),
- )
- }
- }
- } else if (answer === "This and all subsequent messages") {
- // Delete this message and all that follow
- await this.getCurrentCline()!.overwriteClineMessages(
- this.getCurrentCline()!.clineMessages.slice(0, messageIndex),
- )
- if (apiConversationHistoryIndex !== -1) {
- await this.getCurrentCline()!.overwriteApiConversationHistory(
- this.getCurrentCline()!.apiConversationHistory.slice(
- 0,
- apiConversationHistoryIndex,
- ),
- )
- }
- }
- await this.initClineWithHistoryItem(historyItem)
- }
- }
- break
- }
- case "screenshotQuality":
- await this.updateGlobalState("screenshotQuality", message.value)
- await this.postStateToWebview()
- break
- case "maxOpenTabsContext":
- const tabCount = Math.min(Math.max(0, message.value ?? 20), 500)
- await this.updateGlobalState("maxOpenTabsContext", tabCount)
- await this.postStateToWebview()
- break
- case "browserToolEnabled":
- await this.updateGlobalState("browserToolEnabled", message.bool ?? true)
- await this.postStateToWebview()
- break
- case "showRooIgnoredFiles":
- await this.updateGlobalState("showRooIgnoredFiles", message.bool ?? true)
- await this.postStateToWebview()
- break
- case "enhancementApiConfigId":
- await this.updateGlobalState("enhancementApiConfigId", message.text)
- await this.postStateToWebview()
- break
- case "enableCustomModeCreation":
- await this.updateGlobalState("enableCustomModeCreation", message.bool ?? true)
- await this.postStateToWebview()
- break
- case "autoApprovalEnabled":
- await this.updateGlobalState("autoApprovalEnabled", message.bool ?? false)
- await this.postStateToWebview()
- break
- case "enhancePrompt":
- if (message.text) {
- try {
- const {
- apiConfiguration,
- customSupportPrompts,
- listApiConfigMeta,
- enhancementApiConfigId,
- } = await this.getState()
- // Try to get enhancement config first, fall back to current config
- let configToUse: ApiConfiguration = apiConfiguration
- if (enhancementApiConfigId) {
- const config = listApiConfigMeta?.find(
- (c: ApiConfigMeta) => c.id === enhancementApiConfigId,
- )
- if (config?.name) {
- const loadedConfig = await this.configManager.loadConfig(config.name)
- if (loadedConfig.apiProvider) {
- configToUse = loadedConfig
- }
- }
- }
- const enhancedPrompt = await singleCompletionHandler(
- configToUse,
- supportPrompt.create(
- "ENHANCE",
- {
- userInput: message.text,
- },
- customSupportPrompts,
- ),
- )
- await this.postMessageToWebview({
- type: "enhancedPrompt",
- text: enhancedPrompt,
- })
- } catch (error) {
- this.outputChannel.appendLine(
- `Error enhancing prompt: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to enhance prompt")
- await this.postMessageToWebview({
- type: "enhancedPrompt",
- })
- }
- }
- break
- case "getSystemPrompt":
- try {
- const systemPrompt = await generateSystemPrompt(message)
- await this.postMessageToWebview({
- type: "systemPrompt",
- text: systemPrompt,
- mode: message.mode,
- })
- } catch (error) {
- this.outputChannel.appendLine(
- `Error getting system prompt: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to get system prompt")
- }
- break
- case "copySystemPrompt":
- try {
- const systemPrompt = await generateSystemPrompt(message)
- await vscode.env.clipboard.writeText(systemPrompt)
- await vscode.window.showInformationMessage("System prompt successfully copied to clipboard")
- } catch (error) {
- this.outputChannel.appendLine(
- `Error getting system prompt: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to get system prompt")
- }
- break
- case "searchCommits": {
- const cwd = vscode.workspace.workspaceFolders?.map((folder) => folder.uri.fsPath).at(0)
- if (cwd) {
- try {
- const commits = await searchCommits(message.query || "", cwd)
- await this.postMessageToWebview({
- type: "commitSearchResults",
- commits,
- })
- } catch (error) {
- this.outputChannel.appendLine(
- `Error searching commits: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to search commits")
- }
- }
- break
- }
- case "saveApiConfiguration":
- if (message.text && message.apiConfiguration) {
- try {
- await this.configManager.saveConfig(message.text, message.apiConfiguration)
- const listApiConfig = await this.configManager.listConfig()
- await this.updateGlobalState("listApiConfigMeta", listApiConfig)
- } catch (error) {
- this.outputChannel.appendLine(
- `Error save api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to save api configuration")
- }
- }
- break
- case "upsertApiConfiguration":
- if (message.text && message.apiConfiguration) {
- try {
- await this.configManager.saveConfig(message.text, message.apiConfiguration)
- const listApiConfig = await this.configManager.listConfig()
- await Promise.all([
- this.updateGlobalState("listApiConfigMeta", listApiConfig),
- this.updateApiConfiguration(message.apiConfiguration),
- this.updateGlobalState("currentApiConfigName", message.text),
- ])
- await this.postStateToWebview()
- } catch (error) {
- this.outputChannel.appendLine(
- `Error create new api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to create api configuration")
- }
- }
- break
- case "renameApiConfiguration":
- if (message.values && message.apiConfiguration) {
- try {
- const { oldName, newName } = message.values
- if (oldName === newName) {
- break
- }
- await this.configManager.saveConfig(newName, message.apiConfiguration)
- await this.configManager.deleteConfig(oldName)
- const listApiConfig = await this.configManager.listConfig()
- const config = listApiConfig?.find((c) => c.name === newName)
- // Update listApiConfigMeta first to ensure UI has latest data
- await this.updateGlobalState("listApiConfigMeta", listApiConfig)
- await Promise.all([this.updateGlobalState("currentApiConfigName", newName)])
- await this.postStateToWebview()
- } catch (error) {
- this.outputChannel.appendLine(
- `Error rename api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to rename api configuration")
- }
- }
- break
- case "loadApiConfiguration":
- if (message.text) {
- try {
- const apiConfig = await this.configManager.loadConfig(message.text)
- const listApiConfig = await this.configManager.listConfig()
- await Promise.all([
- this.updateGlobalState("listApiConfigMeta", listApiConfig),
- this.updateGlobalState("currentApiConfigName", message.text),
- this.updateApiConfiguration(apiConfig),
- ])
- await this.postStateToWebview()
- } catch (error) {
- this.outputChannel.appendLine(
- `Error load api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to load api configuration")
- }
- }
- break
- case "deleteApiConfiguration":
- if (message.text) {
- const answer = await vscode.window.showInformationMessage(
- "Are you sure you want to delete this configuration profile?",
- { modal: true },
- "Yes",
- )
- if (answer !== "Yes") {
- break
- }
- try {
- await this.configManager.deleteConfig(message.text)
- const listApiConfig = await this.configManager.listConfig()
- // Update listApiConfigMeta first to ensure UI has latest data
- await this.updateGlobalState("listApiConfigMeta", listApiConfig)
- // If this was the current config, switch to first available
- const currentApiConfigName = await this.getGlobalState("currentApiConfigName")
- if (message.text === currentApiConfigName && listApiConfig?.[0]?.name) {
- const apiConfig = await this.configManager.loadConfig(listApiConfig[0].name)
- await Promise.all([
- this.updateGlobalState("currentApiConfigName", listApiConfig[0].name),
- this.updateApiConfiguration(apiConfig),
- ])
- }
- await this.postStateToWebview()
- } catch (error) {
- this.outputChannel.appendLine(
- `Error delete api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to delete api configuration")
- }
- }
- break
- case "getListApiConfiguration":
- try {
- const listApiConfig = await this.configManager.listConfig()
- await this.updateGlobalState("listApiConfigMeta", listApiConfig)
- this.postMessageToWebview({ type: "listApiConfig", listApiConfig })
- } catch (error) {
- this.outputChannel.appendLine(
- `Error get list api configuration: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to get list api configuration")
- }
- break
- case "updateExperimental": {
- if (!message.values) {
- break
- }
- const updatedExperiments = {
- ...((await this.getGlobalState("experiments")) ?? experimentDefault),
- ...message.values,
- } as Record<ExperimentId, boolean>
- await this.updateGlobalState("experiments", updatedExperiments)
- // Update diffStrategy in current Cline instance if it exists
- if (message.values[EXPERIMENT_IDS.DIFF_STRATEGY] !== undefined && this.getCurrentCline()) {
- await this.getCurrentCline()!.updateDiffStrategy(
- Experiments.isEnabled(updatedExperiments, EXPERIMENT_IDS.DIFF_STRATEGY),
- Experiments.isEnabled(updatedExperiments, EXPERIMENT_IDS.MULTI_SEARCH_AND_REPLACE),
- )
- }
- await this.postStateToWebview()
- break
- }
- case "updateMcpTimeout":
- if (message.serverName && typeof message.timeout === "number") {
- try {
- await this.mcpHub?.updateServerTimeout(message.serverName, message.timeout)
- } catch (error) {
- this.outputChannel.appendLine(
- `Failed to update timeout for ${message.serverName}: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- vscode.window.showErrorMessage("Failed to update server timeout")
- }
- }
- break
- case "updateCustomMode":
- if (message.modeConfig) {
- await this.customModesManager.updateCustomMode(message.modeConfig.slug, message.modeConfig)
- // Update state after saving the mode
- const customModes = await this.customModesManager.getCustomModes()
- await this.updateGlobalState("customModes", customModes)
- await this.updateGlobalState("mode", message.modeConfig.slug)
- await this.postStateToWebview()
- }
- break
- case "deleteCustomMode":
- if (message.slug) {
- const answer = await vscode.window.showInformationMessage(
- "Are you sure you want to delete this custom mode?",
- { modal: true },
- "Yes",
- )
- if (answer !== "Yes") {
- break
- }
- await this.customModesManager.deleteCustomMode(message.slug)
- // Switch back to default mode after deletion
- await this.updateGlobalState("mode", defaultModeSlug)
- await this.postStateToWebview()
- }
- break
- case "humanRelayResponse":
- if (message.requestId && message.text) {
- vscode.commands.executeCommand("roo-cline.handleHumanRelayResponse", {
- requestId: message.requestId,
- text: message.text,
- cancelled: false,
- })
- }
- break
- case "humanRelayCancel":
- if (message.requestId) {
- vscode.commands.executeCommand("roo-cline.handleHumanRelayResponse", {
- requestId: message.requestId,
- cancelled: true,
- })
- }
- break
- case "telemetrySetting": {
- const telemetrySetting = message.text as TelemetrySetting
- await this.updateGlobalState("telemetrySetting", telemetrySetting)
- const isOptedIn = telemetrySetting === "enabled"
- telemetryService.updateTelemetryState(isOptedIn)
- await this.postStateToWebview()
- break
- }
- }
- },
- null,
- this.disposables,
- )
- const generateSystemPrompt = async (message: WebviewMessage) => {
- const {
- apiConfiguration,
- customModePrompts,
- customInstructions,
- preferredLanguage,
- browserViewportSize,
- diffEnabled,
- mcpEnabled,
- fuzzyMatchThreshold,
- experiments,
- enableMcpServerCreation,
- browserToolEnabled,
- } = await this.getState()
- // Create diffStrategy based on current model and settings
- const diffStrategy = getDiffStrategy(
- apiConfiguration.apiModelId || apiConfiguration.openRouterModelId || "",
- fuzzyMatchThreshold,
- Experiments.isEnabled(experiments, EXPERIMENT_IDS.DIFF_STRATEGY),
- )
- const cwd = vscode.workspace.workspaceFolders?.map((folder) => folder.uri.fsPath).at(0) || ""
- const mode = message.mode ?? defaultModeSlug
- const customModes = await this.customModesManager.getCustomModes()
- const rooIgnoreInstructions = this.getCurrentCline()?.rooIgnoreController?.getInstructions()
- // Determine if browser tools can be used based on model support and user settings
- const modelSupportsComputerUse = this.getCurrentCline()?.api.getModel().info.supportsComputerUse ?? false
- const canUseBrowserTool = modelSupportsComputerUse && (browserToolEnabled ?? true)
- const systemPrompt = await SYSTEM_PROMPT(
- this.context,
- cwd,
- canUseBrowserTool,
- mcpEnabled ? this.mcpHub : undefined,
- diffStrategy,
- browserViewportSize ?? "900x600",
- mode,
- customModePrompts,
- customModes,
- customInstructions,
- preferredLanguage,
- diffEnabled,
- experiments,
- enableMcpServerCreation,
- rooIgnoreInstructions,
- )
- return systemPrompt
- }
- }
- /**
- * Handle switching to a new mode, including updating the associated API configuration
- * @param newMode The mode to switch to
- */
- public async handleModeSwitch(newMode: Mode) {
- // Capture mode switch telemetry event
- const currentTaskId = this.getCurrentCline()?.taskId
- if (currentTaskId) {
- telemetryService.captureModeSwitch(currentTaskId, newMode)
- }
- await this.updateGlobalState("mode", newMode)
- // Load the saved API config for the new mode if it exists
- const savedConfigId = await this.configManager.getModeConfigId(newMode)
- const listApiConfig = await this.configManager.listConfig()
- // Update listApiConfigMeta first to ensure UI has latest data
- await this.updateGlobalState("listApiConfigMeta", listApiConfig)
- // If this mode has a saved config, use it
- if (savedConfigId) {
- const config = listApiConfig?.find((c) => c.id === savedConfigId)
- if (config?.name) {
- const apiConfig = await this.configManager.loadConfig(config.name)
- await Promise.all([
- this.updateGlobalState("currentApiConfigName", config.name),
- this.updateApiConfiguration(apiConfig),
- ])
- }
- } else {
- // If no saved config for this mode, save current config as default
- const currentApiConfigName = await this.getGlobalState("currentApiConfigName")
- if (currentApiConfigName) {
- const config = listApiConfig?.find((c) => c.name === currentApiConfigName)
- if (config?.id) {
- await this.configManager.setModeConfig(newMode, config.id)
- }
- }
- }
- await this.postStateToWebview()
- }
- private async updateApiConfiguration(apiConfiguration: ApiConfiguration) {
- // Update mode's default config
- const { mode } = await this.getState()
- if (mode) {
- const currentApiConfigName = await this.getGlobalState("currentApiConfigName")
- const listApiConfig = await this.configManager.listConfig()
- const config = listApiConfig?.find((c) => c.name === currentApiConfigName)
- if (config?.id) {
- await this.configManager.setModeConfig(mode, config.id)
- }
- }
- // Use the new setValues method to handle routing values to secrets or global state
- await this.contextProxy.setValues(apiConfiguration)
- if (this.getCurrentCline()) {
- this.getCurrentCline()!.api = buildApiHandler(apiConfiguration)
- }
- }
- async cancelTask() {
- if (this.getCurrentCline()) {
- const { historyItem } = await this.getTaskWithId(this.getCurrentCline()!.taskId)
- this.getCurrentCline()!.abortTask()
- await pWaitFor(
- () =>
- this.getCurrentCline()! === undefined ||
- this.getCurrentCline()!.isStreaming === false ||
- this.getCurrentCline()!.didFinishAbortingStream ||
- // If only the first chunk is processed, then there's no
- // need to wait for graceful abort (closes edits, browser,
- // etc).
- this.getCurrentCline()!.isWaitingForFirstChunk,
- {
- timeout: 3_000,
- },
- ).catch(() => {
- console.error("Failed to abort task")
- })
- if (this.getCurrentCline()) {
- // 'abandoned' will prevent this Cline instance from affecting
- // future Cline instances. This may happen if its hanging on a
- // streaming request.
- this.getCurrentCline()!.abandoned = true
- }
- // Clears task again, so we need to abortTask manually above.
- await this.initClineWithHistoryItem(historyItem)
- }
- }
- async updateCustomInstructions(instructions?: string) {
- // User may be clearing the field
- await this.updateGlobalState("customInstructions", instructions || undefined)
- if (this.getCurrentCline()) {
- this.getCurrentCline()!.customInstructions = instructions || undefined
- }
- await this.postStateToWebview()
- }
- // MCP
- async ensureMcpServersDirectoryExists(): Promise<string> {
- const mcpServersDir = path.join(os.homedir(), "Documents", "Cline", "MCP")
- try {
- await fs.mkdir(mcpServersDir, { recursive: true })
- } catch (error) {
- return "~/Documents/Cline/MCP" // in case creating a directory in documents fails for whatever reason (e.g. permissions) - this is fine since this path is only ever used in the system prompt
- }
- return mcpServersDir
- }
- async ensureSettingsDirectoryExists(): Promise<string> {
- const settingsDir = path.join(this.contextProxy.globalStorageUri.fsPath, "settings")
- await fs.mkdir(settingsDir, { recursive: true })
- return settingsDir
- }
- private async ensureCacheDirectoryExists() {
- const cacheDir = path.join(this.contextProxy.globalStorageUri.fsPath, "cache")
- await fs.mkdir(cacheDir, { recursive: true })
- return cacheDir
- }
- private async readModelsFromCache(filename: string): Promise<Record<string, ModelInfo> | undefined> {
- const filePath = path.join(await this.ensureCacheDirectoryExists(), filename)
- const fileExists = await fileExistsAtPath(filePath)
- if (fileExists) {
- const fileContents = await fs.readFile(filePath, "utf8")
- return JSON.parse(fileContents)
- }
- return undefined
- }
- // OpenRouter
- async handleOpenRouterCallback(code: string) {
- let apiKey: string
- try {
- const response = await axios.post("https://openrouter.ai/api/v1/auth/keys", { code })
- if (response.data && response.data.key) {
- apiKey = response.data.key
- } else {
- throw new Error("Invalid response from OpenRouter API")
- }
- } catch (error) {
- this.outputChannel.appendLine(
- `Error exchanging code for API key: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- throw error
- }
- const openrouter: ApiProvider = "openrouter"
- await this.contextProxy.setValues({
- apiProvider: openrouter,
- openRouterApiKey: apiKey,
- })
- await this.postStateToWebview()
- if (this.getCurrentCline()) {
- this.getCurrentCline()!.api = buildApiHandler({ apiProvider: openrouter, openRouterApiKey: apiKey })
- }
- // await this.postMessageToWebview({ type: "action", action: "settingsButtonClicked" }) // bad ux if user is on welcome
- }
- // Glama
- async handleGlamaCallback(code: string) {
- let apiKey: string
- try {
- const response = await axios.post("https://glama.ai/api/gateway/v1/auth/exchange-code", { code })
- if (response.data && response.data.apiKey) {
- apiKey = response.data.apiKey
- } else {
- throw new Error("Invalid response from Glama API")
- }
- } catch (error) {
- this.outputChannel.appendLine(
- `Error exchanging code for API key: ${JSON.stringify(error, Object.getOwnPropertyNames(error), 2)}`,
- )
- throw error
- }
- const glama: ApiProvider = "glama"
- await this.contextProxy.setValues({
- apiProvider: glama,
- glamaApiKey: apiKey,
- })
- await this.postStateToWebview()
- if (this.getCurrentCline()) {
- this.getCurrentCline()!.api = buildApiHandler({
- apiProvider: glama,
- glamaApiKey: apiKey,
- })
- }
- // await this.postMessageToWebview({ type: "action", action: "settingsButtonClicked" }) // bad ux if user is on welcome
- }
- // Task history
- async getTaskWithId(id: string): Promise<{
- historyItem: HistoryItem
- taskDirPath: string
- apiConversationHistoryFilePath: string
- uiMessagesFilePath: string
- apiConversationHistory: Anthropic.MessageParam[]
- }> {
- const history = ((await this.getGlobalState("taskHistory")) as HistoryItem[] | undefined) || []
- const historyItem = history.find((item) => item.id === id)
- if (historyItem) {
- const taskDirPath = path.join(this.contextProxy.globalStorageUri.fsPath, "tasks", id)
- const apiConversationHistoryFilePath = path.join(taskDirPath, GlobalFileNames.apiConversationHistory)
- const uiMessagesFilePath = path.join(taskDirPath, GlobalFileNames.uiMessages)
- const fileExists = await fileExistsAtPath(apiConversationHistoryFilePath)
- if (fileExists) {
- const apiConversationHistory = JSON.parse(await fs.readFile(apiConversationHistoryFilePath, "utf8"))
- return {
- historyItem,
- taskDirPath,
- apiConversationHistoryFilePath,
- uiMessagesFilePath,
- apiConversationHistory,
- }
- }
- }
- // if we tried to get a task that doesn't exist, remove it from state
- // FIXME: this seems to happen sometimes when the json file doesnt save to disk for some reason
- await this.deleteTaskFromState(id)
- throw new Error("Task not found")
- }
- async showTaskWithId(id: string) {
- if (id !== this.getCurrentCline()?.taskId) {
- // non-current task
- const { historyItem } = await this.getTaskWithId(id)
- await this.initClineWithHistoryItem(historyItem) // clears existing task
- }
- await this.postMessageToWebview({ type: "action", action: "chatButtonClicked" })
- }
- async exportTaskWithId(id: string) {
- const { historyItem, apiConversationHistory } = await this.getTaskWithId(id)
- await downloadTask(historyItem.ts, apiConversationHistory)
- }
- // this function deletes a task from task hidtory, and deletes it's checkpoints and delete the task folder
- async deleteTaskWithId(id: string) {
- // get the task directory full path
- const { taskDirPath } = await this.getTaskWithId(id)
- // remove task from stack if it's the current task
- if (id === this.getCurrentCline()?.taskId) {
- // if we found the taskid to delete - call finish to abort this task and allow a new task to be started,
- // if we are deleting a subtask and parent task is still waiting for subtask to finish - it allows the parent to resume (this case should neve exist)
- await this.finishSubTask(`Task failure: It was stopped and deleted by the user.`)
- }
- // delete task from the task history state
- await this.deleteTaskFromState(id)
- // get the base directory of the project
- const baseDir = vscode.workspace.workspaceFolders?.map((folder) => folder.uri.fsPath).at(0)
- // Delete associated shadow repository or branch.
- // TODO: Store `workspaceDir` in the `HistoryItem` object.
- const globalStorageDir = this.contextProxy.globalStorageUri.fsPath
- const workspaceDir = baseDir ?? ""
- try {
- await ShadowCheckpointService.deleteTask({ taskId: id, globalStorageDir, workspaceDir })
- } catch (error) {
- console.error(
- `[deleteTaskWithId${id}] failed to delete associated shadow repository or branch: ${error instanceof Error ? error.message : String(error)}`,
- )
- }
- // delete the entire task directory including checkpoints and all content
- try {
- await fs.rm(taskDirPath, { recursive: true, force: true })
- console.log(`[deleteTaskWithId${id}] removed task directory`)
- } catch (error) {
- console.error(
- `[deleteTaskWithId${id}] failed to remove task directory: ${error instanceof Error ? error.message : String(error)}`,
- )
- }
- }
- async deleteTaskFromState(id: string) {
- // Remove the task from history
- const taskHistory = ((await this.getGlobalState("taskHistory")) as HistoryItem[]) || []
- const updatedTaskHistory = taskHistory.filter((task) => task.id !== id)
- await this.updateGlobalState("taskHistory", updatedTaskHistory)
- // Notify the webview that the task has been deleted
- await this.postStateToWebview()
- }
- async postStateToWebview() {
- const state = await this.getStateToPostToWebview()
- this.postMessageToWebview({ type: "state", state })
- }
- async getStateToPostToWebview() {
- const {
- apiConfiguration,
- lastShownAnnouncementId,
- customInstructions,
- alwaysAllowReadOnly,
- alwaysAllowWrite,
- alwaysAllowExecute,
- alwaysAllowBrowser,
- alwaysAllowMcp,
- alwaysAllowModeSwitch,
- alwaysAllowSubtasks,
- soundEnabled,
- diffEnabled,
- enableCheckpoints,
- checkpointStorage,
- taskHistory,
- soundVolume,
- browserViewportSize,
- screenshotQuality,
- preferredLanguage,
- writeDelayMs,
- terminalOutputLimit,
- fuzzyMatchThreshold,
- mcpEnabled,
- enableMcpServerCreation,
- alwaysApproveResubmit,
- requestDelaySeconds,
- rateLimitSeconds,
- currentApiConfigName,
- listApiConfigMeta,
- mode,
- customModePrompts,
- customSupportPrompts,
- enhancementApiConfigId,
- autoApprovalEnabled,
- experiments,
- maxOpenTabsContext,
- browserToolEnabled,
- telemetrySetting,
- showRooIgnoredFiles,
- } = await this.getState()
- const telemetryKey = process.env.POSTHOG_API_KEY
- const machineId = vscode.env.machineId
- const allowedCommands = vscode.workspace.getConfiguration("roo-cline").get<string[]>("allowedCommands") || []
- const cwd = vscode.workspace.workspaceFolders?.map((folder) => folder.uri.fsPath).at(0) || ""
- return {
- version: this.context.extension?.packageJSON?.version ?? "",
- apiConfiguration,
- customInstructions,
- alwaysAllowReadOnly: alwaysAllowReadOnly ?? false,
- alwaysAllowWrite: alwaysAllowWrite ?? false,
- alwaysAllowExecute: alwaysAllowExecute ?? false,
- alwaysAllowBrowser: alwaysAllowBrowser ?? false,
- alwaysAllowMcp: alwaysAllowMcp ?? false,
- alwaysAllowModeSwitch: alwaysAllowModeSwitch ?? false,
- alwaysAllowSubtasks: alwaysAllowSubtasks ?? false,
- uriScheme: vscode.env.uriScheme,
- currentTaskItem: this.getCurrentCline()?.taskId
- ? (taskHistory || []).find((item: HistoryItem) => item.id === this.getCurrentCline()?.taskId)
- : undefined,
- clineMessages: this.getCurrentCline()?.clineMessages || [],
- taskHistory: (taskHistory || [])
- .filter((item: HistoryItem) => item.ts && item.task)
- .sort((a: HistoryItem, b: HistoryItem) => b.ts - a.ts),
- soundEnabled: soundEnabled ?? false,
- diffEnabled: diffEnabled ?? true,
- enableCheckpoints: enableCheckpoints ?? true,
- checkpointStorage: checkpointStorage ?? "task",
- shouldShowAnnouncement:
- telemetrySetting !== "unset" && lastShownAnnouncementId !== this.latestAnnouncementId,
- allowedCommands,
- soundVolume: soundVolume ?? 0.5,
- browserViewportSize: browserViewportSize ?? "900x600",
- screenshotQuality: screenshotQuality ?? 75,
- preferredLanguage: preferredLanguage ?? "English",
- writeDelayMs: writeDelayMs ?? 1000,
- terminalOutputLimit: terminalOutputLimit ?? TERMINAL_OUTPUT_LIMIT,
- fuzzyMatchThreshold: fuzzyMatchThreshold ?? 1.0,
- mcpEnabled: mcpEnabled ?? true,
- enableMcpServerCreation: enableMcpServerCreation ?? true,
- alwaysApproveResubmit: alwaysApproveResubmit ?? false,
- requestDelaySeconds: requestDelaySeconds ?? 10,
- rateLimitSeconds: rateLimitSeconds ?? 0,
- currentApiConfigName: currentApiConfigName ?? "default",
- listApiConfigMeta: listApiConfigMeta ?? [],
- mode: mode ?? defaultModeSlug,
- customModePrompts: customModePrompts ?? {},
- customSupportPrompts: customSupportPrompts ?? {},
- enhancementApiConfigId,
- autoApprovalEnabled: autoApprovalEnabled ?? false,
- customModes: await this.customModesManager.getCustomModes(),
- experiments: experiments ?? experimentDefault,
- mcpServers: this.mcpHub?.getAllServers() ?? [],
- maxOpenTabsContext: maxOpenTabsContext ?? 20,
- cwd,
- browserToolEnabled: browserToolEnabled ?? true,
- telemetrySetting,
- telemetryKey,
- machineId,
- showRooIgnoredFiles: showRooIgnoredFiles ?? true,
- }
- }
- // Caching mechanism to keep track of webview messages + API conversation history per provider instance
- /*
- Now that we use retainContextWhenHidden, we don't have to store a cache of cline messages in the user's state, but we could to reduce memory footprint in long conversations.
- - We have to be careful of what state is shared between ClineProvider instances since there could be multiple instances of the extension running at once. For example when we cached cline messages using the same key, two instances of the extension could end up using the same key and overwriting each other's messages.
- - Some state does need to be shared between the instances, i.e. the API key--however there doesn't seem to be a good way to notfy the other instances that the API key has changed.
- We need to use a unique identifier for each ClineProvider instance's message cache since we could be running several instances of the extension outside of just the sidebar i.e. in editor panels.
- // conversation history to send in API requests
- /*
- It seems that some API messages do not comply with vscode state requirements. Either the Anthropic library is manipulating these values somehow in the backend in a way thats creating cyclic references, or the API returns a function or a Symbol as part of the message content.
- VSCode docs about state: "The value must be JSON-stringifyable ... value — A value. MUST not contain cyclic references."
- For now we'll store the conversation history in memory, and if we need to store in state directly we'd need to do a manual conversion to ensure proper json stringification.
- */
- // getApiConversationHistory(): Anthropic.MessageParam[] {
- // // const history = (await this.getGlobalState(
- // // this.getApiConversationHistoryStateKey()
- // // )) as Anthropic.MessageParam[]
- // // return history || []
- // return this.apiConversationHistory
- // }
- // setApiConversationHistory(history: Anthropic.MessageParam[] | undefined) {
- // // await this.updateGlobalState(this.getApiConversationHistoryStateKey(), history)
- // this.apiConversationHistory = history || []
- // }
- // addMessageToApiConversationHistory(message: Anthropic.MessageParam): Anthropic.MessageParam[] {
- // // const history = await this.getApiConversationHistory()
- // // history.push(message)
- // // await this.setApiConversationHistory(history)
- // // return history
- // this.apiConversationHistory.push(message)
- // return this.apiConversationHistory
- // }
- /*
- Storage
- https://dev.to/kompotkot/how-to-use-secretstorage-in-your-vscode-extensions-2hco
- https://www.eliostruyf.com/devhack-code-extension-storage-options/
- */
- async getState() {
- // Create an object to store all fetched values
- const stateValues: Record<GlobalStateKey | SecretKey, any> = {} as Record<GlobalStateKey | SecretKey, any>
- const secretValues: Record<SecretKey, any> = {} as Record<SecretKey, any>
- // Create promise arrays for global state and secrets
- const statePromises = GLOBAL_STATE_KEYS.map((key) => this.getGlobalState(key))
- const secretPromises = SECRET_KEYS.map((key) => this.getSecret(key))
- // Add promise for custom modes which is handled separately
- const customModesPromise = this.customModesManager.getCustomModes()
- let idx = 0
- const valuePromises = await Promise.all([...statePromises, ...secretPromises, customModesPromise])
- // Populate stateValues and secretValues
- GLOBAL_STATE_KEYS.forEach((key, _) => {
- stateValues[key] = valuePromises[idx]
- idx = idx + 1
- })
- SECRET_KEYS.forEach((key, index) => {
- secretValues[key] = valuePromises[idx]
- idx = idx + 1
- })
- let customModes = valuePromises[idx] as ModeConfig[] | undefined
- // Determine apiProvider with the same logic as before
- let apiProvider: ApiProvider
- if (stateValues.apiProvider) {
- apiProvider = stateValues.apiProvider
- } else {
- // Either new user or legacy user that doesn't have the apiProvider stored in state
- // (If they're using OpenRouter or Bedrock, then apiProvider state will exist)
- if (secretValues.apiKey) {
- apiProvider = "anthropic"
- } else {
- // New users should default to openrouter
- apiProvider = "openrouter"
- }
- }
- // Build the apiConfiguration object combining state values and secrets
- // Using the dynamic approach with API_CONFIG_KEYS
- const apiConfiguration: ApiConfiguration = {
- // Dynamically add all API-related keys from stateValues
- ...Object.fromEntries(API_CONFIG_KEYS.map((key) => [key, stateValues[key]])),
- // Add all secrets
- ...secretValues,
- }
- // Ensure apiProvider is set properly if not already in state
- if (!apiConfiguration.apiProvider) {
- apiConfiguration.apiProvider = apiProvider
- }
- // Return the same structure as before
- return {
- apiConfiguration,
- lastShownAnnouncementId: stateValues.lastShownAnnouncementId,
- customInstructions: stateValues.customInstructions,
- alwaysAllowReadOnly: stateValues.alwaysAllowReadOnly ?? false,
- alwaysAllowWrite: stateValues.alwaysAllowWrite ?? false,
- alwaysAllowExecute: stateValues.alwaysAllowExecute ?? false,
- alwaysAllowBrowser: stateValues.alwaysAllowBrowser ?? false,
- alwaysAllowMcp: stateValues.alwaysAllowMcp ?? false,
- alwaysAllowModeSwitch: stateValues.alwaysAllowModeSwitch ?? false,
- alwaysAllowSubtasks: stateValues.alwaysAllowSubtasks ?? false,
- taskHistory: stateValues.taskHistory,
- allowedCommands: stateValues.allowedCommands,
- soundEnabled: stateValues.soundEnabled ?? false,
- diffEnabled: stateValues.diffEnabled ?? true,
- enableCheckpoints: stateValues.enableCheckpoints ?? true,
- checkpointStorage: stateValues.checkpointStorage ?? "task",
- soundVolume: stateValues.soundVolume,
- browserViewportSize: stateValues.browserViewportSize ?? "900x600",
- screenshotQuality: stateValues.screenshotQuality ?? 75,
- fuzzyMatchThreshold: stateValues.fuzzyMatchThreshold ?? 1.0,
- writeDelayMs: stateValues.writeDelayMs ?? 1000,
- terminalOutputLimit: stateValues.terminalOutputLimit ?? TERMINAL_OUTPUT_LIMIT,
- mode: stateValues.mode ?? defaultModeSlug,
- preferredLanguage:
- stateValues.preferredLanguage ??
- (() => {
- // Get VSCode's locale setting
- const vscodeLang = vscode.env.language
- // Map VSCode locale to our supported languages
- const langMap: { [key: string]: string } = {
- en: "English",
- ar: "Arabic",
- "pt-br": "Brazilian Portuguese",
- ca: "Catalan",
- cs: "Czech",
- fr: "French",
- de: "German",
- hi: "Hindi",
- hu: "Hungarian",
- it: "Italian",
- ja: "Japanese",
- ko: "Korean",
- pl: "Polish",
- pt: "Portuguese",
- ru: "Russian",
- zh: "Simplified Chinese",
- "zh-cn": "Simplified Chinese",
- es: "Spanish",
- "zh-tw": "Traditional Chinese",
- tr: "Turkish",
- }
- // Return mapped language or default to English
- return langMap[vscodeLang] ?? langMap[vscodeLang.split("-")[0]] ?? "English"
- })(),
- mcpEnabled: stateValues.mcpEnabled ?? true,
- enableMcpServerCreation: stateValues.enableMcpServerCreation ?? true,
- alwaysApproveResubmit: stateValues.alwaysApproveResubmit ?? false,
- requestDelaySeconds: Math.max(5, stateValues.requestDelaySeconds ?? 10),
- rateLimitSeconds: stateValues.rateLimitSeconds ?? 0,
- currentApiConfigName: stateValues.currentApiConfigName ?? "default",
- listApiConfigMeta: stateValues.listApiConfigMeta ?? [],
- modeApiConfigs: stateValues.modeApiConfigs ?? ({} as Record<Mode, string>),
- customModePrompts: stateValues.customModePrompts ?? {},
- customSupportPrompts: stateValues.customSupportPrompts ?? {},
- enhancementApiConfigId: stateValues.enhancementApiConfigId,
- experiments: stateValues.experiments ?? experimentDefault,
- autoApprovalEnabled: stateValues.autoApprovalEnabled ?? false,
- customModes,
- maxOpenTabsContext: stateValues.maxOpenTabsContext ?? 20,
- openRouterUseMiddleOutTransform: stateValues.openRouterUseMiddleOutTransform ?? true,
- browserToolEnabled: stateValues.browserToolEnabled ?? true,
- telemetrySetting: stateValues.telemetrySetting || "unset",
- showRooIgnoredFiles: stateValues.showRooIgnoredFiles ?? true,
- }
- }
- async updateTaskHistory(item: HistoryItem): Promise<HistoryItem[]> {
- const history = ((await this.getGlobalState("taskHistory")) as HistoryItem[] | undefined) || []
- const existingItemIndex = history.findIndex((h) => h.id === item.id)
- if (existingItemIndex !== -1) {
- history[existingItemIndex] = item
- } else {
- history.push(item)
- }
- await this.updateGlobalState("taskHistory", history)
- return history
- }
- // global
- async updateGlobalState(key: GlobalStateKey, value: any) {
- await this.contextProxy.updateGlobalState(key, value)
- }
- async getGlobalState(key: GlobalStateKey) {
- return await this.contextProxy.getGlobalState(key)
- }
- // secrets
- public async storeSecret(key: SecretKey, value?: string) {
- await this.contextProxy.storeSecret(key, value)
- }
- private async getSecret(key: SecretKey) {
- return await this.contextProxy.getSecret(key)
- }
- // dev
- async resetState() {
- const answer = await vscode.window.showInformationMessage(
- "Are you sure you want to reset all state and secret storage in the extension? This cannot be undone.",
- { modal: true },
- "Yes",
- )
- if (answer !== "Yes") {
- return
- }
- await this.contextProxy.resetAllState()
- await this.configManager.resetAllConfigs()
- await this.customModesManager.resetCustomModes()
- await this.removeClineFromStack()
- await this.postStateToWebview()
- await this.postMessageToWebview({ type: "action", action: "chatButtonClicked" })
- }
- // logging
- public log(message: string) {
- this.outputChannel.appendLine(message)
- console.log(message)
- }
- // integration tests
- get viewLaunched() {
- return this.isViewLaunched
- }
- get messages() {
- return this.getCurrentCline()?.clineMessages || []
- }
- // Add public getter
- public getMcpHub(): McpHub | undefined {
- return this.mcpHub
- }
- /**
- * Returns properties to be included in every telemetry event
- * This method is called by the telemetry service to get context information
- * like the current mode, API provider, etc.
- */
- public async getTelemetryProperties(): Promise<Record<string, any>> {
- const { mode, apiConfiguration } = await this.getState()
- const appVersion = this.context.extension?.packageJSON?.version
- const vscodeVersion = vscode.version
- const platform = process.platform
- const properties: Record<string, any> = {
- vscodeVersion,
- platform,
- }
- // Add extension version
- if (appVersion) {
- properties.appVersion = appVersion
- }
- // Add current mode
- if (mode) {
- properties.mode = mode
- }
- // Add API provider
- if (apiConfiguration?.apiProvider) {
- properties.apiProvider = apiConfiguration.apiProvider
- }
- // Add model ID if available
- const currentCline = this.getCurrentCline()
- if (currentCline?.api) {
- const { id: modelId } = currentCline.api.getModel()
- if (modelId) {
- properties.modelId = modelId
- }
- }
- return properties
- }
- }
|