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

Jump to bottom

Eagerly filter classes #333

Merged
merged 1 commit into from Aug 30, 2022
Merged

Eagerly filter classes #333

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
207 changes: 156 additions & 51 deletions japicmp/src/main/java/japicmp/cmp/JarArchiveComparator.java
View file
Open in desktop
Expand Up @@ -13,15 +13,17 @@
import japicmp.model.JavaObjectSerializationCompatibility;
import japicmp.output.OutputFilter;
import japicmp.util.AnnotationHelper;
import java.util.function.Supplier;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.NotFoundException;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.io.InputStream;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.jar.JarEntry;
Expand All @@ -36,9 +38,9 @@
*/
public class JarArchiveComparator {
private static final Logger LOGGER = Logger.getLogger(JarArchiveComparator.class.getName());
private ClassPool commonClassPool;
private ClassPool oldClassPool;
private ClassPool newClassPool;
private ReducibleClassPool commonClassPool;
private ReducibleClassPool oldClassPool;
private ReducibleClassPool newClassPool;
private String commonClassPathAsString = "";
private String oldClassPathAsString = "";
private String newClassPathAsString = "";
Expand Down Expand Up @@ -102,12 +104,12 @@ private void checkJavaObjectSerializationCompatibility(List<JApiClass> jApiClass

private void setupClasspaths() {
if (this.options.getClassPathMode() == JarArchiveComparatorOptions.ClassPathMode.ONE_COMMON_CLASSPATH) {
commonClassPool = new ClassPool();
commonClassPool = new ReducibleClassPool();
commonClassPathAsString = setupClasspath(commonClassPool, this.options.getClassPathEntries());
} else if (this.options.getClassPathMode() == JarArchiveComparatorOptions.ClassPathMode.TWO_SEPARATE_CLASSPATHS) {
oldClassPool = new ClassPool();
oldClassPool = new ReducibleClassPool();
oldClassPathAsString = setupClasspath(oldClassPool, this.options.getOldClassPath());
newClassPool = new ClassPool();
newClassPool = new ReducibleClassPool();
newClassPathAsString = setupClasspath(newClassPool, this.options.getNewClassPath());
} else {
throw new JApiCmpException(Reason.IllegalState, "Unknown classpath mode: " + this.options.getClassPathMode());
Expand Down Expand Up @@ -201,10 +203,8 @@ private List<JApiClass> createAndCompareClassLists(List<File> oldArchives, List<
* @return a list of {@link japicmp.model.JApiClass} that represent the changes
*/
List<JApiClass> compareClassLists(JarArchiveComparatorOptions options, List<CtClass> oldClasses, List<CtClass> newClasses) {
List<CtClass> oldClassesFiltered = applyFilter(options, oldClasses);
List<CtClass> newClassesFiltered = applyFilter(options, newClasses);
ClassesComparator classesComparator = new ClassesComparator(this, options);
classesComparator.compare(oldClassesFiltered, newClassesFiltered);
classesComparator.compare(oldClasses, newClasses);
List<JApiClass> classList = classesComparator.getClasses();
if (LOGGER.isLoggable(Level.FINE)) {
for (JApiClass jApiClass : classList) {
Expand All @@ -217,55 +217,53 @@ List<JApiClass> compareClassLists(JarArchiveComparatorOptions options, List<CtCl
return classList;
}

private List<CtClass> applyFilter(JarArchiveComparatorOptions options, List<CtClass> ctClasses) {
List<CtClass> newList = new ArrayList<>(ctClasses.size());
for (CtClass ctClass : ctClasses) {
if (options.getFilters().includeClass(ctClass)) {
newList.add(ctClass);
}
}
return newList;
private List<CtClass> createListOfCtClasses(List<File> archives, ReducibleClassPool classPool) {
return createListOfCtClasses(() -> new JarsCtClassIterable(archives, classPool), classPool);
}

List<CtClass> createListOfCtClasses(Supplier<Iterable<CtClass>> ctClasses, ReducibleClassPool classPool) {
return loadAndFilterClasses(ctClasses, classPool, false);
}

private List<CtClass> createListOfCtClasses(List<File> archives, ClassPool classPool) {
private List<CtClass> loadAndFilterClasses(Supplier<Iterable<CtClass>> ctClasses, ReducibleClassPool classPool, boolean ignorePackageFilters) {
// marks whether any package was found
// if so we need to go over _all_ classes again
boolean packageFilterEncountered = false;

List<CtClass> classes = new LinkedList<>();
for (File archive : archives) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine("Loading classes from jar file '" + archive.getAbsolutePath() + "'");
}
try (JarFile jarFile = new JarFile(archive)) {
Enumeration<JarEntry> entryEnumeration = jarFile.entries();
while (entryEnumeration.hasMoreElements()) {
JarEntry jarEntry = entryEnumeration.nextElement();
String name = jarEntry.getName();
if (name.endsWith(".class")) {
CtClass ctClass;
try {
ctClass = classPool.makeClass(jarFile.getInputStream(jarEntry));
} catch (Exception e) {
throw new JApiCmpException(Reason.IoException, String.format("Failed to load file from jar '%s' as class file: %s.", name, e.getMessage()), e);
}
classes.add(ctClass);
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(String.format("Adding class '%s' with jar name '%s' to list.", ctClass.getName(), name));
}
if (name.endsWith("package-info.class")) {
updatePackageFilter(ctClass);
}
} else {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(String.format("Skipping file '%s' because filename does not end with '.class'.", name));
}
for (CtClass ctClass : ctClasses.get()) {
if (!packageFilterEncountered) {
if (options.getFilters().includeClass(ctClass)) {
classes.add(ctClass);
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(String.format("Adding class '%s' with jar name '%s' to list.", ctClass.getName(), ctClass.getName()));
}
} else {
classPool.remove(ctClass);
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(String.format("Ignoring class '%s' with jar name '%s'.", ctClass.getName(), ctClass.getName()));
}
}
} catch (IOException e) {
throw new JApiCmpException(Reason.IoException, String.format("Processing of jar file %s failed: %s", archive.getAbsolutePath(), e.getMessage()), e);
}
if (!ignorePackageFilters && ctClass.getName().endsWith("package-info")) {
packageFilterEncountered |= updatePackageFilter(ctClass);
if (packageFilterEncountered) {
// we found a package filter, so any filtering we did so far may be invalid
// reset everything and restart after having read all remaining filters
classes.forEach(classPool::remove);
classes.clear();
}
}
}
return classes;

return packageFilterEncountered
? loadAndFilterClasses(ctClasses, classPool, true)
: classes;
}

private void updatePackageFilter(CtClass ctClass) {

private boolean updatePackageFilter(CtClass ctClass) {
boolean filtersUpdated = false;
Filters filters = options.getFilters();
List<Filter> newFilters = new LinkedList<>();
for (Filter filter : filters.getIncludes()) {
Expand All @@ -279,6 +277,7 @@ private void updatePackageFilter(CtClass ctClass) {
if (newFilters.size() > 0) {
filters.getIncludes().addAll(newFilters);
newFilters.clear();
filtersUpdated = true;
}
for (Filter filter : filters.getExcludes()) {
if (filter instanceof AnnotationFilterBase) {
Expand All @@ -291,7 +290,9 @@ private void updatePackageFilter(CtClass ctClass) {
if (newFilters.size() > 0) {
filters.getExcludes().addAll(newFilters);
newFilters.clear();
filtersUpdated = true;
}
return filtersUpdated;
}

/**
Expand All @@ -309,7 +310,7 @@ public JarArchiveComparatorOptions getJarArchiveComparatorOptions() {
*
* @return an instance of ClassPool
*/
public ClassPool getCommonClassPool() {
public ReducibleClassPool getCommonClassPool() {
return commonClassPool;
}

Expand Down Expand Up @@ -377,4 +378,108 @@ public Optional<CtClass> loadClass(ArchiveType archiveType, String name) {
}
return loadedClass;
}

private static class JarsCtClassIterable implements Iterable<CtClass>, Iterator<CtClass> {
private final Iterator<File> archives;
private final ClassPool classPool;

private Iterator<CtClass> currentIterator = null;

public JarsCtClassIterable(List<File> archives, ClassPool classPool) {
this.archives = archives.iterator();
this.classPool = classPool;
}

@Override
public boolean hasNext() {
if (currentIterator != null) {
if (currentIterator.hasNext()) {
return true;
} else {
currentIterator = null;
}
}
if (archives.hasNext()) {
final File archive = archives.next();
currentIterator = new JarCtClassIterator(archive, classPool);
return hasNext();
}
return false;
}

@Override
public CtClass next() {
return currentIterator.next();
}

@Override
public Iterator<CtClass> iterator() {
return this;
}
}

private static class JarCtClassIterator implements Iterator<CtClass> {

private final File archive;
private final JarFile jarFile;
private final Enumeration<JarEntry> entryEnumeration;
private final ClassPool classPool;

private CtClass next = null;

public JarCtClassIterator(File archive, ClassPool classPool) {
this.archive = archive;
try {
this.jarFile = new JarFile(archive);
} catch (IOException e) {
throw new JApiCmpException(Reason.IoException, String.format("Processing of jar file %s failed: %s", archive.getAbsolutePath(), e.getMessage()), e);
}
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine("Loading classes from jar file '" + archive.getAbsolutePath() + "'");
}
this.entryEnumeration = jarFile.entries();
this.classPool = classPool;
}

@Override
public boolean hasNext() {
if (next != null) {
return true;
}

while (entryEnumeration.hasMoreElements()) {
JarEntry jarEntry = entryEnumeration.nextElement();
String name = jarEntry.getName();
if (name.endsWith(".class")) {
CtClass ctClass;
try (InputStream classFile = jarFile.getInputStream(jarEntry)) {
ctClass = classPool.makeClass(classFile);
} catch (Exception e) {
throw new JApiCmpException(Reason.IoException, String.format("Failed to load file from jar '%s' as class file: %s.", name, e.getMessage()), e);
}
next = ctClass;
return true;
} else {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(String.format("Skipping file '%s' because filename does not end with '.class'.", name));
}
}
}
try {
jarFile.close();
} catch (IOException e) {
throw new JApiCmpException(Reason.IoException, String.format("Processing of jar file %s failed: %s", archive.getAbsolutePath(), e.getMessage()), e);
}
return false;
}

@Override
public CtClass next() {
try {
return next;
} finally {
next = null;
}
}
}
}
14 changes: 14 additions & 0 deletions japicmp/src/main/java/japicmp/cmp/ReducibleClassPool.java
View file
Open in desktop
@@ -0,0 +1,14 @@
package japicmp.cmp;

import javassist.ClassPool;
import javassist.CtClass;

/**
* A {@link ClassPool} that allows to remove a class from the pool.
*/
public class ReducibleClassPool extends ClassPool {
public void remove(CtClass ctClass) {
removeCached(ctClass.getName());
}
}

8 changes: 5 additions & 3 deletions japicmp/src/test/java/japicmp/cmp/ClassesHelper.java
View file
Open in desktop
Expand Up @@ -16,10 +16,12 @@ public interface ClassesGenerator {

public static List<JApiClass> compareClasses(JarArchiveComparatorOptions options, ClassesGenerator classesGenerator) throws Exception {
JarArchiveComparator jarArchiveComparator = new JarArchiveComparator(options);
ClassPool classPool = jarArchiveComparator.getCommonClassPool();
List<CtClass> oldClasses = classesGenerator.createOldClasses(classPool);
ReducibleClassPool classPool = jarArchiveComparator.getCommonClassPool();
final List<CtClass> oldClasses = classesGenerator.createOldClasses(classPool);
List<CtClass> newClasses = classesGenerator.createNewClasses(classPool);
return jarArchiveComparator.compareClassLists(options, oldClasses, newClasses);
List<CtClass> filteredOldClasses = jarArchiveComparator.createListOfCtClasses(() -> oldClasses, classPool);
List<CtClass> filteredNewClasses = jarArchiveComparator.createListOfCtClasses(() -> newClasses, classPool);
return jarArchiveComparator.compareClassLists(options, filteredOldClasses, filteredNewClasses);
}

public static class CompareClassesResult {
Expand Down