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

fix: exclude project maven dependencies from isolated class loader (#20523) (CP: 24.4) #20530

Merged
merged 1 commit into from
Nov 21, 2024
Merged

fix: exclude project maven dependencies from isolated class loader (#20523) (CP: 24.4) #20530

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions ...-plugins/flow-dev-bundle-plugin/src/main/java/com/vaadin/flow/plugin/maven/Reflector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;

Expand All @@ -48,6 +49,9 @@
public final class Reflector {

public static final String INCLUDE_FROM_COMPILE_DEPS_REGEX = ".*(/|\\\\)(portlet-api|javax\\.servlet-api)-.+jar$";
private static final Set<String> DEPENDENCIES_GROUP_EXCLUSIONS = Set.of(
"org.apache.maven", "org.codehaus.plexus", "org.slf4j",
"org.eclipse.sisu");

private final URLClassLoader isolatedClassLoader;
private Object classFinder;
Expand Down Expand Up @@ -223,6 +227,10 @@ private static URLClassLoader createIsolatedClassLoader(

Map<String, Artifact> projectDependencies = new HashMap<>(project
.getArtifacts().stream()
// Exclude all maven artifacts to prevent class loading clash
// with maven.api class realm
.filter(artifact -> !DEPENDENCIES_GROUP_EXCLUSIONS
.contains(artifact.getGroupId()))
.filter(artifact -> artifact.getFile() != null
&& artifact.getArtifactHandler().isAddedToClasspath()
&& (Artifact.SCOPE_COMPILE.equals(artifact.getScope())
Expand All @@ -238,6 +246,10 @@ private static URLClassLoader createIsolatedClassLoader(
if (mojoExecution != null) {
mojoExecution.getMojoDescriptor().getPluginDescriptor()
.getArtifacts().stream()
// Exclude all maven artifacts to prevent class loading
// clash with maven.api class realm
.filter(artifact -> !DEPENDENCIES_GROUP_EXCLUSIONS
.contains(artifact.getGroupId()))
.filter(artifact -> !projectDependencies
.containsKey(keyMapper.apply(artifact)))
.forEach(artifact -> projectDependencies
Expand Down
17 changes: 17 additions & 0 deletions flow-plugins/flow-maven-plugin/src/it/ignore-maven-deps-from-project/invoker.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#
# Copyright 2000-2024 Vaadin Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.
#

invoker.goals=clean package
88 changes: 88 additions & 0 deletions flow-plugins/flow-maven-plugin/src/it/ignore-maven-deps-from-project/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.vaadin.test.maven</groupId>
<artifactId>resources-from-project</artifactId>
<version>1.0</version>
<packaging>jar</packaging>

<description>
Tests that plugin dependencies do not override resources from project artifacts.
</description>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.release>17</maven.compiler.release>
<maven.compiler.source>${maven.compiler.release}</maven.compiler.source>
<maven.compiler.target>${maven.compiler.release}</maven.compiler.target>
<maven.test.skip>true</maven.test.skip>

<flow.version>@project.version@</flow.version>
<maven.version>3.9.9</maven.version>
</properties>

<dependencies>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>flow-server</artifactId>
<version>${flow.version}</version>
</dependency>
<dependency>
<groupId>com.vaadin</groupId>
<artifactId>flow-client</artifactId>
<version>${flow.version}</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-artifact</artifactId>
<version>${maven.version}</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-core</artifactId>
<version>${maven.version}</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>${maven.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>2.0.16</version>
</dependency>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-build-api</artifactId>
<version>1.2.0</version>
</dependency>

</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.13.0</version>
</plugin>
<plugin>
<groupId>com.vaadin</groupId>
<artifactId>flow-maven-plugin</artifactId>
<version>${flow.version}</version>
<executions>
<execution>
<goals>
<goal>prepare-frontend</goal>
<goal>build-frontend</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

</project>
20 changes: 20 additions & 0 deletions ...it/ignore-maven-deps-from-project/src/main/java/com/vaadin/test/ProjectFlowExtension.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package com.vaadin.test;

import java.util.List;

import com.vaadin.flow.server.frontend.Options;
import com.vaadin.flow.server.frontend.TypeScriptBootstrapModifier;
import com.vaadin.flow.server.frontend.scanner.FrontendDependenciesScanner;

/**
* Hello world!
*/
public class ProjectFlowExtension implements TypeScriptBootstrapModifier {

@Override
public void modify(List<String> bootstrapTypeScript, Options options,
FrontendDependenciesScanner frontendDependenciesScanner) {
System.out.println("ProjectFlowExtension");
bootstrapTypeScript.add("(window as any).testProject=1;");
}
}
12 changes: 12 additions & 0 deletions flow-plugins/flow-maven-plugin/src/main/java/com/vaadin/flow/plugin/maven/Reflector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;

Expand All @@ -48,6 +49,9 @@
public final class Reflector {

public static final String INCLUDE_FROM_COMPILE_DEPS_REGEX = ".*(/|\\\\)(portlet-api|javax\\.servlet-api)-.+jar$";
private static final Set<String> DEPENDENCIES_GROUP_EXCLUSIONS = Set.of(
"org.apache.maven", "org.codehaus.plexus", "org.slf4j",
"org.eclipse.sisu");

private final URLClassLoader isolatedClassLoader;
private Object classFinder;
Expand Down Expand Up @@ -223,6 +227,10 @@ private static URLClassLoader createIsolatedClassLoader(

Map<String, Artifact> projectDependencies = new HashMap<>(project
.getArtifacts().stream()
// Exclude all maven artifacts to prevent class loading clash
// with maven.api class realm
.filter(artifact -> !DEPENDENCIES_GROUP_EXCLUSIONS
.contains(artifact.getGroupId()))
.filter(artifact -> artifact.getFile() != null
&& artifact.getArtifactHandler().isAddedToClasspath()
&& (Artifact.SCOPE_COMPILE.equals(artifact.getScope())
Expand All @@ -238,6 +246,10 @@ private static URLClassLoader createIsolatedClassLoader(
if (mojoExecution != null) {
mojoExecution.getMojoDescriptor().getPluginDescriptor()
.getArtifacts().stream()
// Exclude all maven artifacts to prevent class loading
// clash with maven.api class realm
.filter(artifact -> !DEPENDENCIES_GROUP_EXCLUSIONS
.contains(artifact.getGroupId()))
.filter(artifact -> !projectDependencies
.containsKey(keyMapper.apply(artifact)))
.forEach(artifact -> projectDependencies
Expand Down