chore: exclude commons logging from artifacts. (#2407)

Spring Boot starters ships with `spring-jcl` module ([doc](https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/logging.adoc)), which comes with its own Commons Logging bridge implemented in the `spring-jcl` module ([Spring Framework doc ](https://docs.spring.io/spring-framework/reference/core/spring-jcl.html)). This has potential conflicts with commons-logging.jar from classpath. In particular, this causes failure for native compilation when logging gets accidentally initialized at runtime instead of build time. This pr tries to exclude `commons-logging` from SCGCP artifacts. With 2 exceptions: preview modules and `spanner-data-spring-data-r2dbc` module. Also removes this flag for native builds: `<buildArg>--initialize-at-build-time=org.apache.commons.logging.LogFactory</buildArg>`
GoogleCloudPlatform · Dec 7, 2023 · 4c084e1 · 4c084e1
1 parent defb840
commit 4c084e1
Show file tree

Hide file tree

Showing 20 changed files with 120 additions and 32 deletions.
diff --git a/pom.xml b/pom.xml
@@ -402,10 +402,6 @@
 					<artifactId>native-maven-plugin</artifactId>
 					<version>${native-maven-plugin.version}</version>
 					<configuration>
-						<buildArgs>
-							<buildArg>--trace-class-initialization=org.apache.commons.logging.LogFactoryService</buildArg>
-							<buildArg>--initialize-at-build-time=org.apache.commons.logging.LogFactory</buildArg>
-						</buildArgs>
 						<classesDirectory>${project.build.outputDirectory}</classesDirectory>
 						<metadataRepository>
 							<enabled>true</enabled>

diff --git a/spring-cloud-gcp-autoconfigure/pom.xml b/spring-cloud-gcp-autoconfigure/pom.xml
@@ -219,6 +219,12 @@
             <groupId>com.google.cloud</groupId>
             <artifactId>google-cloud-firestore</artifactId>
             <optional>true</optional>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <dependency>
@@ -251,6 +257,12 @@
           <groupId>com.google.cloud</groupId>
           <artifactId>google-cloud-vision</artifactId>
           <optional>true</optional>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <dependency>
@@ -278,6 +290,12 @@
             <groupId>com.google.cloud</groupId>
             <artifactId>google-cloud-monitoring</artifactId>
             <optional>true</optional>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <!-- Config -->

diff --git a/spring-cloud-gcp-bigquery/pom.xml b/spring-cloud-gcp-bigquery/pom.xml
@@ -23,6 +23,12 @@
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-bigquery</artifactId>
+      <exclusions>
+        <exclusion>
+          <groupId>commons-logging</groupId>
+          <artifactId>commons-logging</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
   </dependencies>
 </project>
diff --git a/spring-cloud-gcp-data-datastore/pom.xml b/spring-cloud-gcp-data-datastore/pom.xml
@@ -20,6 +20,12 @@
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-datastore</artifactId>
+      <exclusions>
+        <exclusion>
+          <groupId>commons-logging</groupId>
+          <artifactId>commons-logging</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
     <dependency>
       <groupId>org.springframework.data</groupId>

diff --git a/spring-cloud-gcp-data-firestore/pom.xml b/spring-cloud-gcp-data-firestore/pom.xml
@@ -18,6 +18,12 @@
         <dependency>
             <groupId>com.google.cloud</groupId>
             <artifactId>google-cloud-firestore</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
 
         <dependency>

diff --git a/spring-cloud-gcp-data-spanner/pom.xml b/spring-cloud-gcp-data-spanner/pom.xml
@@ -20,6 +20,12 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-spanner</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.data</groupId>

diff --git a/spring-cloud-gcp-kms/pom.xml b/spring-cloud-gcp-kms/pom.xml
@@ -23,6 +23,12 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-kms</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 	</dependencies>
 </project>
diff --git a/spring-cloud-gcp-logging/pom.xml b/spring-cloud-gcp-logging/pom.xml
@@ -28,6 +28,12 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-logging-logback</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>jakarta.servlet</groupId>

diff --git a/spring-cloud-gcp-pubsub/pom.xml b/spring-cloud-gcp-pubsub/pom.xml
@@ -16,11 +16,23 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-pubsub</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-monitoring</artifactId>
 			<optional>true</optional>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>com.google.cloud</groupId>

diff --git a/spring-cloud-gcp-samples/pom.xml b/spring-cloud-gcp-samples/pom.xml
@@ -115,29 +115,6 @@
 				<module>spring-cloud-gcp-sql-postgres-sample</module>
 				<module>spring-cloud-gcp-sql-postgres-r2dbc-sample</module>
 			</modules>
-			<build>
-				<plugins>
-					<plugin>
-						<groupId>org.graalvm.buildtools</groupId>
-						<artifactId>native-maven-plugin</artifactId>
-						<configuration>
-							<buildArgs>
-								<buildArg>--trace-class-initialization=org.apache.commons.logging.LogFactoryService</buildArg>
-								<buildArg>--initialize-at-build-time=org.apache.commons.logging.LogFactory</buildArg>
-							</buildArgs>
-						</configuration>
-						<executions>
-							<execution>
-								<id>build-native</id>
-								<goals>
-									<goal>compile-no-fork</goal>
-								</goals>
-								<phase>package</phase>
-							</execution>
-						</executions>
-					</plugin>
-				</plugins>
-			</build>
 		</profile>
 		<profile>
 			<id>nativeTest</id>

diff --git a/spring-cloud-gcp-secretmanager/pom.xml b/spring-cloud-gcp-secretmanager/pom.xml
@@ -29,6 +29,12 @@
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-secretmanager</artifactId>
+      <exclusions>
+        <exclusion>
+          <groupId>commons-logging</groupId>
+          <artifactId>commons-logging</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
   </dependencies>
 </project>
diff --git a/spring-cloud-gcp-security-iap/pom.xml b/spring-cloud-gcp-security-iap/pom.xml
@@ -25,6 +25,12 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-resourcemanager</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>com.google.cloud</groupId>

diff --git a/spring-cloud-gcp-starters/spring-cloud-gcp-starter-firestore/pom.xml b/spring-cloud-gcp-starters/spring-cloud-gcp-starter-firestore/pom.xml
@@ -24,6 +24,12 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-firestore</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 	</dependencies>
 </project>
diff --git a/spring-cloud-gcp-starters/spring-cloud-gcp-starter-metrics/pom.xml b/spring-cloud-gcp-starters/spring-cloud-gcp-starter-metrics/pom.xml
@@ -21,6 +21,12 @@
 		<dependency>
 			<groupId>io.micrometer</groupId>
 			<artifactId>micrometer-registry-stackdriver</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>

diff --git a/spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-mysql/pom.xml b/spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-mysql/pom.xml
@@ -25,6 +25,12 @@
 		<dependency>
 			<groupId>com.google.cloud.sql</groupId>
 			<artifactId>mysql-socket-factory-connector-j-8</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>com.mysql</groupId>

diff --git a/spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-postgres-r2dbc/pom.xml b/spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-postgres-r2dbc/pom.xml
@@ -27,6 +27,12 @@
         <dependency>
             <groupId>com.google.cloud.sql</groupId>
             <artifactId>cloud-sql-connector-r2dbc-postgres</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>org.postgresql</groupId>

diff --git a/spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-postgresql/pom.xml b/spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-postgresql/pom.xml
@@ -25,6 +25,12 @@
         <dependency>
             <groupId>com.google.cloud.sql</groupId>
             <artifactId>postgres-socket-factory</artifactId>
+            <exclusions>
+                <exclusion>
+                    <groupId>commons-logging</groupId>
+                    <artifactId>commons-logging</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>org.postgresql</groupId>

diff --git a/spring-cloud-gcp-starters/spring-cloud-gcp-starter-trace/pom.xml b/spring-cloud-gcp-starters/spring-cloud-gcp-starter-trace/pom.xml
@@ -59,6 +59,12 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-core-grpc</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>

diff --git a/spring-cloud-gcp-starters/spring-cloud-gcp-starter-vision/pom.xml b/spring-cloud-gcp-starters/spring-cloud-gcp-starter-vision/pom.xml
@@ -24,10 +24,5 @@
 			<artifactId>spring-cloud-gcp-vision</artifactId>
 		</dependency>
 
-		<dependency>
-			<groupId>com.google.cloud</groupId>
-			<artifactId>google-cloud-vision</artifactId>
-		</dependency>
-
 	</dependencies>
 </project>
diff --git a/spring-cloud-gcp-vision/pom.xml b/spring-cloud-gcp-vision/pom.xml
@@ -18,6 +18,12 @@
 		<dependency>
 			<groupId>com.google.cloud</groupId>
 			<artifactId>google-cloud-vision</artifactId>
+			<exclusions>
+				<exclusion>
+					<groupId>commons-logging</groupId>
+					<artifactId>commons-logging</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 
 		<dependency>