Skip to content

fix: honor source encodings when resolving breakpoints #647

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

Merged
Changyong Gong (chagong) merged 2 commits into from
Oct 29, 2026
Merged

fix: honor source encodings when resolving breakpoints #647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a64831
fix: honor source encodings when resolving breakpoints
chagong Oct 29, 2026
46db436
docs: keep encoding fix notes out of public README
chagong Oct 29, 2026
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
54 changes: 54 additions & 0 deletions com.microsoft.java.debug.plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@
<artifactId>com.microsoft.java.debug.plugin</artifactId>
<packaging>eclipse-plugin</packaging>
<name>${base.name} :: Debugger Plugin</name>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
Expand All @@ -33,6 +41,52 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.eclipse.tycho</groupId>
<artifactId>target-platform-configuration</artifactId>
<version>${tycho-version}</version>
<configuration>
<filters>
<filter>
<type>eclipse-plugin</type>
<id>org.eclipse.jdt.core.compiler.batch</id>
<restrictTo>
<!-- Match the JDT model in the Eclipse 4.38 target. -->
<versionRange>[3.44.0,3.45.0)</versionRange>
</restrictTo>
</filter>
</filters>
</configuration>
</plugin>
<plugin>
<groupId>org.eclipse.tycho</groupId>
<artifactId>tycho-surefire-plugin</artifactId>
<version>${tycho-version}</version>
<configuration>
<providerHint>junit4</providerHint>
<importAdditionalPackagesOptional>true</importAdditionalPackagesOptional>
<dependencies>
<dependency>
<type>eclipse-plugin</type>
<artifactId>org.eclipse.m2e.jdt</artifactId>
<version>0.0.0</version>
</dependency>
<dependency>
<type>eclipse-plugin</type>
<artifactId>org.eclipse.buildship.core</artifactId>
<version>0.0.0</version>
</dependency>
</dependencies>
</configuration>
<executions>
<execution>
<goals>
<goal>plugin-test</goal>
<goal>verify</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
Expand Down
39 changes: 20 additions & 19 deletions ...lugin/src/main/java/com/microsoft/java/debug/plugin/internal/JdtSourceLookUpProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@

package com.microsoft.java.debug.plugin.internal;

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
Expand All @@ -35,6 +34,9 @@
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.apache.commons.io.ByteOrderMark;
import org.apache.commons.io.IOUtils;
import org.apache.commons.io.input.BOMInputStream;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
Expand Down Expand Up @@ -312,7 +314,9 @@ private CompilationUnit asCompilationUnit(String uri) {
// For file uri, read the file contents directly and pass them to the ast
// parser.
if (filePath != null && Files.isRegularFile(Paths.get(filePath))) {
String source = readFile(filePath);
IFile resource = (IFile) JDTUtils.findResource(JDTUtils.toURI(uri),
ResourcesPlugin.getWorkspace().getRoot()::findFilesForLocationURI);
String source = readFile(filePath, resource);
parser.setSource(source.toCharArray());
/**
* See the java doc for { @link ASTParser#setResolveBindings(boolean) }.
Expand All @@ -326,8 +330,6 @@ private CompilationUnit asCompilationUnit(String uri) {
* setEnvironment(String [], String [], String [], boolean)
* and a unit name setUnitName(String).
*/
IFile resource = (IFile) JDTUtils.findResource(JDTUtils.toURI(uri),
ResourcesPlugin.getWorkspace().getRoot()::findFilesForLocationURI);
if (resource != null && JdtUtils.isJavaProject(resource.getProject())) {
parser.setProject(JavaCore.create(resource.getProject()));
} else {
Expand Down Expand Up @@ -498,22 +500,21 @@ private static IClassFile resolveClassFile(String uriString) {
return null;
}

private static String readFile(String filePath) {
StringBuilder builder = new StringBuilder();
try (BufferedReader bufferReader = new BufferedReader(new InputStreamReader(new FileInputStream(filePath)))) {
final int BUFFER_SIZE = 4096;
char[] buffer = new char[BUFFER_SIZE];
while (true) {
int read = bufferReader.read(buffer, 0, BUFFER_SIZE);
if (read == -1) {
break;
}
builder.append(new String(buffer, 0, read));
private static String readFile(String filePath, IFile resource) {
try {
if (resource != null) {
return resource.readString();
}
try (BOMInputStream input = BOMInputStream.builder().setPath(Paths.get(filePath))
.setByteOrderMarks(ByteOrderMark.UTF_8, ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE).get();
InputStreamReader reader = new InputStreamReader(input,
input.hasBOM() ? input.getBOMCharsetName() : Charset.defaultCharset().name())) {
return IOUtils.toString(reader);
}
} catch (IOException e) {
// do nothing.
} catch (IOException | CoreException e) {
logger.log(Level.SEVERE, "Failed to read source file: " + filePath, e);
return "";
}
return builder.toString();
}

private static String resolveSystemLibraryVersion(IJavaProject project, IVMInstall vmInstall)
Expand Down
142 changes: 142 additions & 0 deletions ...n/src/test/java/com/microsoft/java/debug/plugin/internal/JdtSourceLookUpProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
/*******************************************************************************
* Copyright (c) 2026 Microsoft Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Microsoft Corporation - initial API and implementation
*******************************************************************************/

package com.microsoft.java.debug.plugin.internal;

import static org.junit.Assert.assertEquals;

import java.io.ByteArrayInputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

import com.microsoft.java.debug.core.JavaBreakpointLocation;
import com.microsoft.java.debug.core.protocol.Types.SourceBreakpoint;

@RunWith(Parameterized.class)
public class JdtSourceLookUpProviderTest {
private enum SourceKind {
EXTERNAL, WORKSPACE, FILE_CHARSET, PROJECT_CHARSET
}

private static final String PACKAGE_NAME = "d\u00e9mo"; // A non-ASCII identifier exposes incorrect decoding.
private static final String SOURCE = String.join("\r\n",
"package " + PACKAGE_NAME + ";",
"",
"public class A {",
" public static void main(String[] args) {",
" int x = 1;",
" System.out.println(x);",
" }",
"}",
"");

@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();

private final Charset charset;
private final boolean withBom;
private final SourceKind sourceKind;
private IProject project;

public JdtSourceLookUpProviderTest(Charset charset, boolean withBom, SourceKind sourceKind) {
this.charset = charset;
this.withBom = withBom;
this.sourceKind = sourceKind;
}

@Parameters(name = "{index}: {0}, BOM={1}, {2}")
public static Object[][] encodings() {
return new Object[][] {
{StandardCharsets.UTF_16LE, true, SourceKind.EXTERNAL},
{StandardCharsets.UTF_16BE, true, SourceKind.EXTERNAL},
{StandardCharsets.UTF_8, true, SourceKind.EXTERNAL},
{StandardCharsets.UTF_8, false, SourceKind.EXTERNAL},
{Charset.defaultCharset(), false, SourceKind.EXTERNAL},
{StandardCharsets.UTF_16LE, true, SourceKind.WORKSPACE},
{StandardCharsets.UTF_16BE, true, SourceKind.WORKSPACE},
{StandardCharsets.UTF_8, true, SourceKind.WORKSPACE},
{StandardCharsets.UTF_16LE, false, SourceKind.FILE_CHARSET},
{StandardCharsets.UTF_16BE, false, SourceKind.FILE_CHARSET},
{StandardCharsets.UTF_8, false, SourceKind.FILE_CHARSET},
{StandardCharsets.ISO_8859_1, false, SourceKind.FILE_CHARSET},
{StandardCharsets.ISO_8859_1, false, SourceKind.PROJECT_CHARSET},
{StandardCharsets.UTF_16LE, false, SourceKind.PROJECT_CHARSET}
};
}

@After
public void deleteProject() throws Exception {
if (project != null && project.exists()) {
project.delete(true, true, null);
}
}

@Test
public void resolvesBreakpointClassName() throws Exception {
byte[] contents = (withBom ? "\uFEFF" + SOURCE : SOURCE).getBytes(charset);
String uri;
if (sourceKind == SourceKind.EXTERNAL) {
Path file = temporaryFolder.getRoot().toPath().resolve("A.java");
Files.write(file, contents);
uri = file.toUri().toASCIIString();
} else {
IFile file = createWorkspaceFile(contents);
uri = file.getLocationURI().toASCIIString();
}

JavaBreakpointLocation[] locations = new JdtSourceLookUpProvider().getBreakpointLocations(uri,
new SourceBreakpoint[] {new SourceBreakpoint(5, -1)});

assertEquals(1, locations.length);
assertEquals(PACKAGE_NAME + ".A", locations[0].className());
assertEquals(5, locations[0].lineNumber());
assertEquals(5, locations[0].availableBreakpointLocations()[0].line);
}

private IFile createWorkspaceFile(byte[] contents) throws Exception {
project = ResourcesPlugin.getWorkspace().getRoot().getProject("source-encoding-test");
project.create(null);
project.open(null);
project.setDefaultCharset(StandardCharsets.UTF_8.name(), null);
IProjectDescription description = project.getDescription();
description.setNatureIds(new String[] {JavaCore.NATURE_ID});
project.setDescription(description, null);
IJavaProject javaProject = JavaCore.create(project);
javaProject.setRawClasspath(new IClasspathEntry[] {JavaCore.newSourceEntry(project.getFullPath())},
project.getFullPath().append("bin"), null);

IFile file = project.getFile("A.java");
file.create(new ByteArrayInputStream(contents), true, null);
if (sourceKind == SourceKind.FILE_CHARSET) {
file.setCharset(charset.name(), null);
} else if (sourceKind == SourceKind.PROJECT_CHARSET) {
project.setDefaultCharset(charset.name(), null);
}
return file;
}
}
1 change: 1 addition & 0 deletions com.microsoft.java.debug.target/com.microsoft.java.debug.tp.target
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<locations>
<location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="true" type="InstallableUnit">
<unit id="org.eclipse.platform.feature.group" version="0.0.0"/>
<unit id="org.eclipse.jdt.core.compiler.batch" version="0.0.0"/>
<repository location="https://download.eclipse.org/eclipse/updates/4.38"/>
</location>
<location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="true" type="InstallableUnit">
Expand Down
Loading