Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debugging TypeScript in non-root folder can't find corresponding Java… #1064

Merged
merged 1 commit into from
Jan 21, 2023
Merged

Debugging TypeScript in non-root folder can't find corresponding Java… #1064

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 64 additions & 15 deletions ...wildwebdeveloper/src/org/eclipse/wildwebdeveloper/debug/node/NodeRunDAPDebugDelegate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2018, 2020 Red Hat Inc. and others.
* Copyright (c) 2018, 2023 Red Hat Inc. and others.
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
Expand Down Expand Up @@ -78,6 +78,21 @@ public class NodeRunDAPDebugDelegate extends DSPLaunchDelegate {
private static final String ENV = "env"; //$NON-NLS-1$
private static final String RUNTIME_EXECUTABLE = "runtimeExecutable"; //$NON-NLS-1$

public static final String NODE_DEBUG_CMD = "/node_modules/node-debug2/out/src/nodeDebug.js"; //$NON-NLS-1$
public static final String TYPESCRIPT_CONTENT_TYPE = "org.eclipse.wildwebdeveloper.ts"; //$NON-NLS-1$
public static final String JAVACRIPT_CONTENT_TYPE = "org.eclipse.wildwebdeveloper.js"; //$NON-NLS-1$

private static final String TS_CONFIG_NAME = "tsconfig.json"; //$NON-NLS-1$
private static final String COMPILER_OPTIONS = "compilerOptions"; //$NON-NLS-1$
private static final String SOURCE_MAP = "sourceMap"; //$NON-NLS-1$
private static final String SOURCE_MAPS = "sourceMaps"; //$NON-NLS-1$
private static final String MODULE = "module"; //$NON-NLS-1$
private static final String MODULE_AMD = "amd"; //$NON-NLS-1$
private static final String MODULE_SYSTEM = "system"; //$NON-NLS-1$
private static final String OUT_DIR = "outDir"; //$NON-NLS-1$
private static final String OUT_FILE = "outFile"; //$NON-NLS-1$
private static final String ROOT_DIR = "rootDir"; //$NON-NLS-1$

@Override
public void launch(ILaunchConfiguration configuration, String mode, ILaunch launch, IProgressMonitor monitor)
throws CoreException {
Expand Down Expand Up @@ -126,7 +141,7 @@ public void launch(ILaunchConfiguration configuration, String mode, ILaunch laun

try {
URL fileURL = FileLocator.toFileURL(
getClass().getResource("/node_modules/node-debug2/out/src/nodeDebug.js"));
getClass().getResource(NODE_DEBUG_CMD));
File file = new File(fileURL.getPath());
List<String> debugCmdArgs = Collections.singletonList(file.getAbsolutePath());

Expand All @@ -152,14 +167,20 @@ private boolean configureAdditionalParameters(Map<String, Object> param) {
}

File programFile = new File(program);
if (Platform.getContentTypeManager().getContentType("org.eclipse.wildwebdeveloper.ts")
if (Platform.getContentTypeManager().getContentType(TYPESCRIPT_CONTENT_TYPE)
.isAssociatedWith(programFile.getName())) {
// TypeScript Source Mappings Configuration
File parentDirectory = cwd == null ? programFile.getParentFile() : new File(cwd);
File tsConfigFile = findTSConfigFile(parentDirectory);
if (tsConfigFile != null && tsConfigFile.exists()) {
parentDirectory = tsConfigFile.getParentFile();
}

String errorMessage = null;
Map<String, Object> tsConfig = readJSonFile(tsConfigFile);
Map<String, Object> co = tsConfig == null ? null : (Map<String, Object>)tsConfig.get("compilerOptions");

@SuppressWarnings("unchecked")
Map<String, Object> co = tsConfig == null ? null : (Map<String, Object>)tsConfig.get(COMPILER_OPTIONS);
if (co == null) {
errorMessage = Messages.NodeDebug_TSConfirError_NoTsConfig;
co = new HashMap<>();
Expand All @@ -169,7 +190,7 @@ private boolean configureAdditionalParameters(Map<String, Object> param) {
param.putAll(co);

if (errorMessage == null) {
Object option = co.get("sourceMap");
Object option = co.get(SOURCE_MAP);
boolean sourceMap = option instanceof Boolean b && b.booleanValue();
if (!sourceMap) {
errorMessage = Messages.NodeDebug_TSConfirError_SourceMapIsNotEnabled;
Expand All @@ -178,27 +199,54 @@ private boolean configureAdditionalParameters(Map<String, Object> param) {

// Override "outDir" option by converting it to an absolute path
boolean outDirOrFileIsSet = false;
Object option = co.get("module");
Object option = co.get(MODULE);
String module = option instanceof String o ? o.trim() : null;

option = co.get("outDir");
option = co.get(OUT_DIR);
String outDir = option instanceof String o ? o.trim() : null;
if (outDir != null && outDir.length() > 0 && !".".equals(outDir) && !"./".equals(outDir)) {
param.put("outDir", cwd + "/" + outDir);
File outDirFile = new File(parentDirectory, outDir);
try {
outDir = outDirFile.getCanonicalPath();
} catch (IOException e) {
// Default to an absolute file path (non-checked)
outDir = outDirFile.getAbsolutePath();
}
param.put(OUT_DIR, outDir);
outDirOrFileIsSet = true;
}

option = co.get("outFile");
option = co.get(OUT_FILE);
String outFile = option instanceof String o ? o.trim() : null;
if (outFile != null && outFile.length() != 0) {
param.put("outFile", cwd + "/" + outFile);
File outFileFile = new File(parentDirectory, outFile);
try {
outFile = outFileFile.getCanonicalPath();
} catch (IOException e) {
// Default to an absolute file path (non-checked)
outFile = outFileFile.getAbsolutePath();
}
param.put(OUT_FILE, outFile);
outDirOrFileIsSet = true;

if (!"amd".equalsIgnoreCase(module) && !"system".equalsIgnoreCase(module)) {
if (!MODULE_AMD.equalsIgnoreCase(module) && !MODULE_SYSTEM.equalsIgnoreCase(module)) {
errorMessage = Messages.NodeDebug_TSConfigError_OutDirNotSupportedModule;
}
}

option = co.get(ROOT_DIR);
String rootDir = option instanceof String o ? o.trim() : null;
if (rootDir != null && rootDir.length() > 0 && !".".equals(outDir) && !"./".equals(outDir)) {
File rootDirFile = new File(parentDirectory, rootDir);
try {
rootDir = rootDirFile.getCanonicalPath();
} catch (IOException e) {
// Default to an absolute file path (non-checked)
rootDir = rootDirFile.getAbsolutePath();
}
param.put(ROOT_DIR, rootDir);
}

if (!outDirOrFileIsSet && errorMessage == null) {
errorMessage = Messages.NodeDebug_TSConfigError_OutDirIsNotSet;
}
Expand All @@ -210,6 +258,7 @@ private boolean configureAdditionalParameters(Map<String, Object> param) {
final String editTSConfig = tsConfigFile.exists() && tsConfigFile.isFile() ?
Messages.NodeDebug_TSConfirError_OpenTSConfigInEditor :
Messages.NodeDebug_TSConfirError_CreateAndOpenTSConfigInEditor;
final File directory = parentDirectory;

Display.getDefault().syncExec(() -> {
MessageDialog dialog = new MessageDialog(DebugUIPlugin.getShell(),
Expand All @@ -224,7 +273,7 @@ private boolean configureAdditionalParameters(Map<String, Object> param) {
Display.getDefault().asyncExec(new Runnable() {
@Override
public void run() {
IFile file = createNewEmptyFile(new File(parentDirectory, "tsconfig.json"));
IFile file = createNewEmptyFile(new File(directory, TS_CONFIG_NAME));
if (file != null) {
try {
IDE.openEditor(
Expand Down Expand Up @@ -280,15 +329,15 @@ void createContainers(IResource resource) throws CoreException {
}

return true;
} else if (Platform.getContentTypeManager().getContentType("org.eclipse.wildwebdeveloper.js")
} else if (Platform.getContentTypeManager().getContentType(JAVACRIPT_CONTENT_TYPE)
.isAssociatedWith(programFile.getName())) {

// JavaScript configuration

// workaround until
// https://github.com/microsoft/vscode-node-debug2/commit/f2dfa4ca4026fb3e4f143a391270a03df8187b42#diff-d03a74f75ec189cbc7dd3d2e105fc9c9R625
// is released in VSCode
param.put("sourceMaps", false);
param.put(SOURCE_MAPS, false);
return true;
}
return false;
Expand All @@ -297,7 +346,7 @@ void createContainers(IResource resource) throws CoreException {
private File findTSConfigFile(File parentDirectory) {
File tsConfigFile;
do {
tsConfigFile = new File(parentDirectory, "tsconfig.json");
tsConfigFile = new File(parentDirectory, TS_CONFIG_NAME);
if (tsConfigFile.isFile()) {
return tsConfigFile;
}
Expand Down