feat: add stop token option to API configuration and update debug output settings

Author: d-oit

package.json

@@ -270,16 +270,10 @@
 					},
 					"description": "Settings for VSCode Language Model API"
 				},
-				"roo-cline.debug": {
-					"type": "object",
-					"description": "Debug settings for Roo Code",
-					"properties": {
-						"mistral": {
-							"type": "boolean",
-							"default": false,
-							"description": "Enable debug output channel for Mistral API interactions"
-						}
-					}
+				"roo-cline.debug.mistral": {
+					"type": "boolean",
+					"default": false,
+					"description": "Enable debug output channel 'Roo Code Mistral' for Mistral API interactions"
 				}
 			}
 		}

src/api/providers/mistral.ts

@@ -42,23 +42,31 @@ export class MistralHandler implements ApiHandler {
 		const baseUrl = this.getBaseUrl()
 		this.logDebug(`MistralHandler using baseUrl: ${baseUrl}`)
 
-		const logger = this.enableDebugOutput
-			? {
-					group: (message: string) => this.logDebug(`[Mistral Group] ${message}`),
-					groupEnd: () => this.logDebug(`[Mistral GroupEnd]`),
-					log: (...args: any[]) =>
-						this.logDebug(
-							`[Mistral Log] ${args
-								.map((arg) => (typeof arg === "object" ? JSON.stringify(arg, null, 2) : arg))
-								.join(" ")}`,
-						),
+		const logger = {
+			group: (message: string) => {
+				if (this.enableDebugOutput && this.outputChannel) {
+					this.outputChannel.appendLine(`[Mistral SDK] Group: ${message}`)
 				}
-			: undefined
+			},
+			groupEnd: () => {
+				if (this.enableDebugOutput && this.outputChannel) {
+					this.outputChannel.appendLine(`[Mistral SDK] GroupEnd`)
+				}
+			},
+			log: (...args: any[]) => {
+				if (this.enableDebugOutput && this.outputChannel) {
+					const formattedArgs = args
+						.map((arg) => (typeof arg === "object" ? JSON.stringify(arg, null, 2) : arg))
+						.join(" ")
+					this.outputChannel.appendLine(`[Mistral SDK] ${formattedArgs}`)
+				}
+			},
+		}
 
 		this.client = new Mistral({
 			serverURL: baseUrl,
 			apiKey: this.options.mistralApiKey,
-			debugLogger: logger,
+			debugLogger: this.enableDebugOutput ? logger : undefined,
 		})
 	}
 
@@ -87,6 +95,7 @@ export class MistralHandler implements ApiHandler {
 			messages: [{ role: "system", content: systemPrompt }, ...convertToMistralMessages(messages)],
 			temperature: this.options?.modelTemperature ?? MISTRAL_DEFAULT_TEMPERATURE,
 			...(this.options?.mistralModelStreamingEnabled === true && { stream: true }),
+			...(this.options?.stopToken?.trim() && { stop: [this.options.stopToken] }),
 		})
 
 		let completeContent = ""

src/core/Cline.ts

@@ -74,11 +74,6 @@ type UserContent = Array<
 >
 
 export class Cline {
-	private static readonly outputChannelName = "Roo Code Stream Output"
-	private static sharedOutputChannel: vscode.OutputChannel | undefined
-	// private readonly enableStreamDebug: boolean
-	// private readonly outputChannel?: vscode.OutputChannel
-
 	readonly taskId: string
 	api: ApiHandler
 	private terminalManager: TerminalManager
@@ -135,16 +130,6 @@ export class Cline {
 		historyItem?: HistoryItem | undefined,
 		experiments?: Record<string, boolean>,
 	) {
-		// const config = vscode.workspace.getConfiguration("roo-cline")
-		// this.enableStreamDebug = config.get<boolean>("enableApiStreamDebugOutput", false)
-
-		// if (this.enableStreamDebug) {
-		//     if (!Cline.sharedOutputChannel) {
-		//         Cline.sharedOutputChannel = vscode.window.createOutputChannel(Cline.outputChannelName)
-		//     }
-		//     this.outputChannel = Cline.sharedOutputChannel
-		// }
-
 		if (!task && !images && !historyItem) {
 			throw new Error("Either historyItem or task/images must be provided")
 		}
@@ -175,12 +160,6 @@ export class Cline {
 		}
 	}
 
-	// private logStreamDebug(message: string) {
-	//     if (this.enableStreamDebug && this.outputChannel) {
-	//         this.outputChannel.appendLine(`[Stream Debug] ${message}`)
-	//     }
-	// }
-
 	// Add method to update diffStrategy
 	async updateDiffStrategy(experimentalDiffStrategy?: boolean) {
 		// If not provided, get from current state
@@ -986,17 +965,12 @@ export class Cline {
 		const iterator = stream[Symbol.asyncIterator]()
 
 		try {
-			this.logStreamDebug(
-				`Starting API request - Previous index: ${previousApiReqIndex}, Retry attempt: ${retryAttempt}`,
-			)
 			// awaiting first chunk to see if it will throw an error
 			this.isWaitingForFirstChunk = true
 			const firstChunk = await iterator.next()
-			this.logStreamDebug(`Received first chunk: ${JSON.stringify(firstChunk.value)}`)
 			yield firstChunk.value
 			this.isWaitingForFirstChunk = false
 		} catch (error) {
-			this.logStreamDebug(`Error on first chunk: ${error}`)
 			// note that this api_req_failed ask is unique in that we only present this option if the api hasn't streamed any content yet (ie it fails on the first chunk due), as it would allow them to hit a retry button. However if the api failed mid-stream, it could be in any arbitrary state where some tools may have executed, so that error is handled differently and requires cancelling the task entirely.
 			if (alwaysApproveResubmit) {
 				const errorMsg = error.message ?? "Unknown error"

src/core/webview/ClineProvider.ts

@@ -127,6 +127,7 @@ type GlobalStateKey =
 	| "requestyModelInfo"
 	| "unboundModelInfo"
 	| "modelTemperature"
+	| "stopToken"
 	| "mistralCodestralUrl"
 	| "mistralModelStreamingEnabled"
 	| "maxOpenTabsContext"
@@ -1678,6 +1679,7 @@ export class ClineProvider implements vscode.WebviewViewProvider {
 			requestyModelId,
 			requestyModelInfo,
 			modelTemperature,
+			stopToken,
 		} = apiConfiguration
 		await Promise.all([
 			this.updateGlobalState("apiProvider", apiProvider),
@@ -1726,6 +1728,7 @@ export class ClineProvider implements vscode.WebviewViewProvider {
 			this.updateGlobalState("requestyModelId", requestyModelId),
 			this.updateGlobalState("requestyModelInfo", requestyModelInfo),
 			this.updateGlobalState("modelTemperature", modelTemperature),
+			this.updateGlobalState("stopToken", stopToken),
 		])
 		if (this.cline) {
 			this.cline.api = buildApiHandler(apiConfiguration)
@@ -2609,6 +2612,7 @@ export class ClineProvider implements vscode.WebviewViewProvider {
 			requestyModelId,
 			requestyModelInfo,
 			modelTemperature,
+			stopToken,
 			maxOpenTabsContext,
 		] = await Promise.all([
 			this.getGlobalState("apiProvider") as Promise<ApiProvider | undefined>,
@@ -2692,6 +2696,7 @@ export class ClineProvider implements vscode.WebviewViewProvider {
 			this.getGlobalState("requestyModelId") as Promise<string | undefined>,
 			this.getGlobalState("requestyModelInfo") as Promise<ModelInfo | undefined>,
 			this.getGlobalState("modelTemperature") as Promise<number | undefined>,
+			this.getGlobalState("stopToken") as Promise<string | undefined>,
 			this.getGlobalState("maxOpenTabsContext") as Promise<number | undefined>,
 		])
 
@@ -2757,6 +2762,7 @@ export class ClineProvider implements vscode.WebviewViewProvider {
 				requestyModelId,
 				requestyModelInfo,
 				modelTemperature,
+				stopToken,
 			},
 			lastShownAnnouncementId,
 			customInstructions,

src/shared/api.ts

@@ -68,6 +68,7 @@ export interface ApiHandlerOptions {
 	requestyModelId?: string
 	requestyModelInfo?: ModelInfo
 	modelTemperature?: number
+	stopToken?: string
 }
 
 export type ApiConfiguration = ApiHandlerOptions & {

webview-ui/src/components/settings/ApiOptions.tsx

@@ -348,6 +348,22 @@ const ApiOptions = ({
 						</div>
 					)}
 
+					<VSCodeTextField
+						value={apiConfiguration?.stopToken}
+						style={{ width: "100%", marginTop: "10px" }}
+						onInput={handleInputChange("stopToken")}
+						placeholder="Enter stop token (optional)">
+						<span style={{ fontWeight: 500 }}>Optional: Stop Token e.g. \n\\n\</span>
+					</VSCodeTextField>
+					<p
+						style={{
+							fontSize: "12px",
+							marginTop: 3,
+							color: "var(--vscode-descriptionForeground)",
+						}}>
+						Optional token to stop generation when encountered
+					</p>
+
 					<p>
 						<div style={{ display: "flex", alignItems: "center" }}>
 							<Checkbox