|
| 1 | +// Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | +// Licensed under the MIT license. |
| 3 | + |
| 4 | +import { CancellationToken, commands, DocumentLink, DocumentLinkProvider, DocumentSelector, |
| 5 | + env, ExtensionContext, languages, Position, ProviderResult, Range, TextDocument, Uri, |
| 6 | + window, workspace } from "vscode"; |
| 7 | +import { instrumentOperationAsVsCodeCommand, sendInfo } from "vscode-extension-telemetry-wrapper"; |
| 8 | +import { resolveSourceUri } from "./languageServerPlugin"; |
| 9 | +import { parseJavaStackFrame } from "./stackFrameParser"; |
| 10 | +import { getJavaExtensionAPI, isJavaExtEnabled, ServerMode } from "./utility"; |
| 11 | + |
| 12 | +const ANALYZE_STACK_TRACE_COMMAND = "java.debug.analyzeStackTrace"; |
| 13 | +const NAVIGATE_TO_STACK_FRAME_COMMAND = "_java.debug.navigateToStackFrame"; |
| 14 | + |
| 15 | +// Linkify stack traces in scratch documents and .log files. Other plaintext documents stay |
| 16 | +// excluded so the extension does not passively scan unrelated files. |
| 17 | +const STACK_TRACE_DOCUMENT_SELECTOR: DocumentSelector = [ |
| 18 | + { scheme: "untitled" }, |
| 19 | + { pattern: "**/*.log" }, |
| 20 | +]; |
| 21 | + |
| 22 | +// Bound the work performed for large documents and pathological input. The per-line cap mitigates |
| 23 | +// ReDoS in the nested-quantifier regex; the document budgets keep large logs from being fully scanned. |
| 24 | +const MAX_SCANNED_LINE_LENGTH = 1000; |
| 25 | +const MAX_SCANNED_LINES_PER_DOCUMENT = 10000; |
| 26 | +const MAX_SCANNED_CHARACTERS_PER_DOCUMENT = 1000000; |
| 27 | +const MAX_LINKS_PER_DOCUMENT = 2000; |
| 28 | + |
| 29 | +// Only resolve to source locations the language server is expected to return. |
| 30 | +const ALLOWED_SOURCE_SCHEMES = new Set<string>(["file", "jdt"]); |
| 31 | + |
| 32 | +interface IStackFrameLinkArgs { |
| 33 | + stackTrace: string; |
| 34 | + methodName: string; |
| 35 | + lineNumber: number; |
| 36 | +} |
| 37 | + |
| 38 | +function isStackFrameLinkArgs(args: unknown): args is IStackFrameLinkArgs { |
| 39 | + if (typeof args !== "object" || args === null) { |
| 40 | + return false; |
| 41 | + } |
| 42 | + |
| 43 | + const stackTrace = "stackTrace" in args ? args.stackTrace : undefined; |
| 44 | + const methodName = "methodName" in args ? args.methodName : undefined; |
| 45 | + const lineNumber = "lineNumber" in args ? args.lineNumber : undefined; |
| 46 | + if (typeof stackTrace !== "string" || typeof methodName !== "string" || typeof lineNumber !== "number" |
| 47 | + || stackTrace.length === 0 || stackTrace.length > MAX_SCANNED_LINE_LENGTH |
| 48 | + || !Number.isSafeInteger(lineNumber) || lineNumber <= 0) { |
| 49 | + return false; |
| 50 | + } |
| 51 | + |
| 52 | + const frame = parseJavaStackFrame(` at ${stackTrace}`); |
| 53 | + return frame?.stackTrace === stackTrace |
| 54 | + && frame.methodName === methodName |
| 55 | + && frame.lineNumber === lineNumber; |
| 56 | +} |
| 57 | + |
| 58 | +/** |
| 59 | + * Linkifies Java stack frames pasted into untitled (scratch) documents, so that each frame can be |
| 60 | + * clicked to jump to the corresponding source line - without requiring an active debug session. |
| 61 | + * Resolution reuses the session-independent `resolveSourceUri` backend and is performed lazily, |
| 62 | + * only when a link is clicked. |
| 63 | + */ |
| 64 | +export class JavaStackTraceLinkProvider implements DocumentLinkProvider { |
| 65 | + public provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]> { |
| 66 | + const links: DocumentLink[] = []; |
| 67 | + let scannedCharacters = 0; |
| 68 | + const linesToScan = Math.min(document.lineCount, MAX_SCANNED_LINES_PER_DOCUMENT); |
| 69 | + for (let i = 0; i < linesToScan; i++) { |
| 70 | + if (token.isCancellationRequested || links.length >= MAX_LINKS_PER_DOCUMENT) { |
| 71 | + break; |
| 72 | + } |
| 73 | + |
| 74 | + const lineText = document.lineAt(i).text; |
| 75 | + const lineScanCost = lineText.length + 1; |
| 76 | + if (scannedCharacters + lineScanCost > MAX_SCANNED_CHARACTERS_PER_DOCUMENT) { |
| 77 | + break; |
| 78 | + } |
| 79 | + scannedCharacters += lineScanCost; |
| 80 | + |
| 81 | + if (lineText.length > MAX_SCANNED_LINE_LENGTH) { |
| 82 | + continue; |
| 83 | + } |
| 84 | + |
| 85 | + const frame = parseJavaStackFrame(lineText); |
| 86 | + if (!frame) { |
| 87 | + continue; |
| 88 | + } |
| 89 | + |
| 90 | + const range = new Range( |
| 91 | + new Position(i, frame.startIndex), |
| 92 | + new Position(i, frame.startIndex + frame.length), |
| 93 | + ); |
| 94 | + |
| 95 | + const args: IStackFrameLinkArgs = { |
| 96 | + stackTrace: frame.stackTrace, |
| 97 | + methodName: frame.methodName, |
| 98 | + lineNumber: frame.lineNumber, |
| 99 | + }; |
| 100 | + const target = Uri.parse(`command:${NAVIGATE_TO_STACK_FRAME_COMMAND}?${encodeURIComponent(JSON.stringify([args]))}`); |
| 101 | + links.push(new DocumentLink(range, target)); |
| 102 | + } |
| 103 | + |
| 104 | + return links; |
| 105 | + } |
| 106 | +} |
| 107 | + |
| 108 | +/** |
| 109 | + * Resolves a stack frame to its source location and navigates to it. Mirrors the behavior of the |
| 110 | + * terminal link provider: jump to the resolved source line, or fall back to a symbol quick pick. |
| 111 | + */ |
| 112 | +async function navigateToStackFrame(args: unknown): Promise<void> { |
| 113 | + if (!isStackFrameLinkArgs(args)) { |
| 114 | + return; |
| 115 | + } |
| 116 | + |
| 117 | + // Content-free telemetry: a single usage signal (click count), mirroring the terminal link |
| 118 | + // provider. No dimensions - the pasted text is never recorded. |
| 119 | + /* __GDPR__ |
| 120 | + "navigateToJavaStackFrame" : { |
| 121 | + "owner": "vscode-java-debug", |
| 122 | + "comment": "Emitted when a user clicks a linkified Java stack frame; measures feature usage.", |
| 123 | + "operationName": { "classification": "SystemMetaData", "purpose": "FeatureInsight" } |
| 124 | + } |
| 125 | + */ |
| 126 | + sendInfo("", { operationName: "navigateToJavaStackFrame" }); |
| 127 | + |
| 128 | + try { |
| 129 | + const uri = await resolveSourceUri(args.stackTrace); |
| 130 | + if (uri) { |
| 131 | + const parsed = Uri.parse(uri); |
| 132 | + if (!ALLOWED_SOURCE_SCHEMES.has(parsed.scheme)) { |
| 133 | + return; |
| 134 | + } |
| 135 | + const targetLine = Math.max(args.lineNumber - 1, 0); |
| 136 | + await window.showTextDocument(parsed, { |
| 137 | + preserveFocus: true, |
| 138 | + selection: new Range(new Position(targetLine, 0), new Position(targetLine, 0)), |
| 139 | + }); |
| 140 | + } else { |
| 141 | + // No source found: open the symbol quick pick scoped to the class name. |
| 142 | + const fullyQualifiedName = args.methodName.substring(0, args.methodName.lastIndexOf(".")); |
| 143 | + const className = fullyQualifiedName.substring(fullyQualifiedName.lastIndexOf(".") + 1); |
| 144 | + await commands.executeCommand("workbench.action.quickOpen", "#" + className); |
| 145 | + } |
| 146 | + } catch { |
| 147 | + // The internal navigate command is always registered, but resolving a frame needs the Java |
| 148 | + // language server in Standard mode. If it isn't (e.g. server restarting/downgraded) or the |
| 149 | + // resolved document fails to open, fail quietly instead of surfacing an unhandled rejection. |
| 150 | + } |
| 151 | +} |
| 152 | + |
| 153 | +/** |
| 154 | + * Opens a scratch document prefilled with the clipboard content. The document link provider scans |
| 155 | + * a bounded portion after the document opens and makes any stack frames clickable. |
| 156 | + */ |
| 157 | +async function analyzeStackTrace(): Promise<void> { |
| 158 | + // The command itself is auto-instrumented via instrumentOperationAsVsCodeCommand, so no |
| 159 | + // manual telemetry is needed here to track invocations. |
| 160 | + const clipboardContent = await env.clipboard.readText(); |
| 161 | + const document = await workspace.openTextDocument({ language: "log", content: clipboardContent }); |
| 162 | + await window.showTextDocument(document); |
| 163 | +} |
| 164 | + |
| 165 | +export function registerStackTraceLinkProvider(context: ExtensionContext): void { |
| 166 | + // Register handlers immediately for programmatic invocations and existing command links. |
| 167 | + // Palette visibility and creation of new links are gated on language-server readiness elsewhere. |
| 168 | + context.subscriptions.push( |
| 169 | + commands.registerCommand(NAVIGATE_TO_STACK_FRAME_COMMAND, navigateToStackFrame), |
| 170 | + instrumentOperationAsVsCodeCommand(ANALYZE_STACK_TRACE_COMMAND, analyzeStackTrace), |
| 171 | + ); |
| 172 | + |
| 173 | + // Linkifying a frame is only meaningful once the Java language server is in Standard mode, |
| 174 | + // because resolving a frame to source (resolveSourceUri) requires a fully-loaded workspace. |
| 175 | + // Defer registering the link provider until then, mirroring the run/debug CodeLens provider. |
| 176 | + registerLinkProviderWhenReady(context); |
| 177 | +} |
| 178 | + |
| 179 | +function registerLinkProviderWhenReady(context: ExtensionContext): void { |
| 180 | + // Without the Java language server, frames cannot be resolved to source - nothing to linkify. |
| 181 | + if (!isJavaExtEnabled()) { |
| 182 | + return; |
| 183 | + } |
| 184 | + |
| 185 | + const doRegister = () => context.subscriptions.push( |
| 186 | + languages.registerDocumentLinkProvider(STACK_TRACE_DOCUMENT_SELECTOR, new JavaStackTraceLinkProvider()), |
| 187 | + ); |
| 188 | + |
| 189 | + getJavaExtensionAPI().then((api) => { |
| 190 | + if (!api) { |
| 191 | + return; |
| 192 | + } |
| 193 | + |
| 194 | + if (api.serverMode === ServerMode.LIGHTWEIGHT || api.serverMode === ServerMode.HYBRID) { |
| 195 | + let registered = false; |
| 196 | + const serverModeListener = api.onDidServerModeChange((mode: string) => { |
| 197 | + if (mode === ServerMode.STANDARD && !registered) { |
| 198 | + registered = true; |
| 199 | + serverModeListener.dispose(); |
| 200 | + doRegister(); |
| 201 | + } |
| 202 | + }); |
| 203 | + context.subscriptions.push(serverModeListener); |
| 204 | + } else { |
| 205 | + // Already in Standard mode. |
| 206 | + doRegister(); |
| 207 | + } |
| 208 | + }); |
| 209 | +} |
0 commit comments