Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 421
Expand file tree
/
Copy pathnoConfigDebugInit.ts
More file actions
247 lines (219 loc) · 10.6 KB
/
Copy pathnoConfigDebugInit.ts
File metadata and controls
247 lines (219 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
import * as fs from 'fs';
import * as path from 'path';
import * as crypto from 'crypto';
import * as vscode from 'vscode';
import { sendInfo, sendError } from "vscode-extension-telemetry-wrapper";
import { getJavaHome } from "./utility";
/**
* Registers the configuration-less debugging setup for the extension.
*
* This function sets up environment variables and a file system watcher to
* facilitate debugging without requiring a pre-configured launch.json file.
*
* @param envVarCollection - The collection of environment variables to be modified.
* @param extPath - The path to the extension directory.
*
* Environment Variables:
* - `VSCODE_JDWP_ADAPTER_ENDPOINTS`: Path to the file containing the debugger adapter endpoint.
* - `JAVA_TOOL_OPTIONS`: JDWP configuration for automatic debugging.
* - `PATH`: Appends the path to the noConfigScripts directory.
*/
export async function registerNoConfigDebug(
envVarCollection: vscode.EnvironmentVariableCollection,
extPath: string,
): Promise<vscode.Disposable> {
const collection = envVarCollection;
// create a temp directory for the noConfigDebugAdapterEndpoints
// file path format: extPath/.noConfigDebugAdapterEndpoints/endpoint-stableWorkspaceHash.txt
let workspaceString = vscode.workspace.workspaceFile?.fsPath;
if (!workspaceString) {
workspaceString = vscode.workspace.workspaceFolders?.map((e) => e.uri.fsPath).join(';');
}
if (!workspaceString) {
const error: Error = {
name: "NoConfigDebugError",
message: '[Java Debug] No workspace folder found',
};
sendError(error);
return Promise.resolve(new vscode.Disposable(() => { }));
}
// create a stable hash for the workspace folder, reduce terminal variable churn
const hash = crypto.createHash('sha256');
hash.update(workspaceString.toString());
const stableWorkspaceHash = hash.digest('hex').slice(0, 16);
const tempDirPath = path.join(extPath, '.noConfigDebugAdapterEndpoints');
const tempFilePath = path.join(tempDirPath, `endpoint-${stableWorkspaceHash}.txt`);
// create the temp directory if it doesn't exist
if (!fs.existsSync(tempDirPath)) {
fs.mkdirSync(tempDirPath, { recursive: true });
} else {
// remove endpoint file in the temp directory if it exists (async to avoid blocking)
if (fs.existsSync(tempFilePath)) {
fs.promises.unlink(tempFilePath).catch((err) => {
const error: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] Failed to cleanup old endpoint file: ${err}`,
};
sendError(error);
});
}
}
// clear the env var collection to remove any existing env vars
collection.clear();
// Add env var for VSCODE_JDWP_ADAPTER_ENDPOINTS
// Note: We do NOT set JAVA_TOOL_OPTIONS globally to avoid affecting all Java processes
// (javac, maven, gradle, language server, etc.). Instead, JAVA_TOOL_OPTIONS is set
// only in the debugjava wrapper scripts (debugjava.ps1, debugjava.bat, debugjava)
collection.replace('VSCODE_JDWP_ADAPTER_ENDPOINTS', tempFilePath);
// Try to get Java executable from Java Language Server
// This ensures we use the same Java version as the project is compiled with
try {
const javaHome = await getJavaHome();
if (javaHome) {
const javaExec = path.join(javaHome, 'bin', 'java');
collection.replace('VSCODE_JAVA_EXEC', javaExec);
}
} catch (error) {
// If we can't get Java from Language Server, that's okay
// The wrapper script will fall back to JAVA_HOME or PATH
}
const noConfigScriptsDir = path.join(extPath, 'bundled', 'scripts', 'noConfigScripts');
const pathSeparator = process.platform === 'win32' ? ';' : ':';
// Check if the current PATH already ends with a path separator to avoid double separators
const currentPath = process.env.PATH || '';
const needsSeparator = currentPath.length > 0 && !currentPath.endsWith(pathSeparator);
const pathValueToAppend = needsSeparator ? `${pathSeparator}${noConfigScriptsDir}` : noConfigScriptsDir;
collection.append('PATH', pathValueToAppend);
// create file system watcher for the debuggerAdapterEndpointFolder for when the communication port is written
const fileSystemWatcher = vscode.workspace.createFileSystemWatcher(
new vscode.RelativePattern(tempDirPath, '**/*.txt')
);
// Track active debug sessions to prevent duplicates
const activeDebugSessions = new Set<number>();
// Handle both file creation and modification to support multiple runs
const handleEndpointFile = async (uri: vscode.Uri) => {
const filePath = uri.fsPath;
// Add a small delay to ensure file is fully written
// File system events can fire before write is complete
await new Promise(resolve => setTimeout(resolve, 100));
fs.readFile(filePath, (err, data) => {
if (err) {
const error: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] No-config debug failed: file_read_error - ${err}`,
};
sendError(error);
return;
}
try {
// parse the client port
const dataParse = data.toString();
const jsonData = JSON.parse(dataParse);
// Validate JSON structure
if (!jsonData || typeof jsonData !== 'object' || !jsonData.client) {
const error: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] No-config debug failed: invalid_format - ${dataParse}`,
};
sendError(error);
return;
}
const clientPort = jsonData.client.port;
// Validate port number
if (!clientPort || typeof clientPort !== 'number' || clientPort < 1 || clientPort > 65535) {
const error: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] No-config debug failed: invalid_port - ${clientPort}`,
};
sendError(error);
return;
}
// Check if we already have an active session for this port
if (activeDebugSessions.has(clientPort)) {
// Skip duplicate session silently - this is expected behavior
return;
}
// Mark this port as active
activeDebugSessions.add(clientPort);
const options: vscode.DebugSessionOptions = {
noDebug: false,
};
// start debug session with the client port
vscode.debug.startDebugging(
undefined,
{
type: 'java',
request: 'attach',
name: 'Attach to Java (No-Config)',
hostName: 'localhost',
port: clientPort,
},
options,
).then(
(started) => {
if (started) {
// Send telemetry only on successful session start with port info
sendInfo('', { message: '[Java Debug] No-config debug session started', port: clientPort });
// Clean up the endpoint file after successful debug session start (async)
if (fs.existsSync(filePath)) {
fs.promises.unlink(filePath).catch((cleanupErr) => {
// Cleanup failure is non-critical, just log for debugging
const error: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] No-config debug failed: cleanup_error - ${cleanupErr}`,
};
sendError(error);
});
}
} else {
const error: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] No-config debug failed: attach_failed - port ${clientPort}`,
};
sendError(error);
// Remove from active sessions on failure
activeDebugSessions.delete(clientPort);
}
},
(error) => {
const attachError: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] No-config debug failed: attach_error - port ${clientPort} - ${error}`,
};
sendError(attachError);
// Remove from active sessions on error
activeDebugSessions.delete(clientPort);
},
);
} catch (parseErr) {
const error: Error = {
name: "NoConfigDebugError",
message: `[Java Debug] No-config debug failed: parse_error - ${parseErr}`,
};
sendError(error);
}
});
};
// Listen for both file creation and modification events
const fileCreationEvent = fileSystemWatcher.onDidCreate(handleEndpointFile);
const fileChangeEvent = fileSystemWatcher.onDidChange(handleEndpointFile);
// Clean up active sessions when debug session ends
const debugSessionEndListener = vscode.debug.onDidTerminateDebugSession((session) => {
if (session.name === 'Attach to Java (No-Config)' && session.configuration.port) {
const port = session.configuration.port;
activeDebugSessions.delete(port);
// Session end is normal operation, no telemetry needed
}
});
return Promise.resolve(
new vscode.Disposable(() => {
fileSystemWatcher.dispose();
fileCreationEvent.dispose();
fileChangeEvent.dispose();
debugSessionEndListener.dispose();
activeDebugSessions.clear();
}),
);
}
You can’t perform that action at this time.