fix: AlloyDB should not load when Postgres starter is used (#2848)

Making `alloydb-jdbc-connector` optional dependency in autoconfig module. Fixes: #2847.
GoogleCloudPlatform · May 6, 2024 · 2c8e5cb · 2c8e5cb
1 parent 891701e
commit 2c8e5cb
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/spring-cloud-gcp-autoconfigure/pom.xml b/spring-cloud-gcp-autoconfigure/pom.xml
@@ -302,6 +302,7 @@
         <dependency>
             <groupId>com.google.cloud</groupId>
             <artifactId>alloydb-jdbc-connector</artifactId>
+            <optional>true</optional>
         </dependency>
 
         <!-- Config -->

diff --git a/...n/java/com/google/cloud/spring/autoconfigure/alloydb/AlloyDbEnvironmentPostProcessor.java b/...n/java/com/google/cloud/spring/autoconfigure/alloydb/AlloyDbEnvironmentPostProcessor.java
@@ -85,11 +85,11 @@ && isOnClasspath(JDBC_DRIVER_CLASS)) {
       environment
           .getPropertySources()
           .addFirst(new MapPropertySource("ALLOYDB_DATA_SOURCE_URL", primaryMap));
-    }
 
-    // support usage metrics
-    ConnectorRegistry.addArtifactId(
-        "spring-cloud-gcp-alloydb/" + this.getClass().getPackage().getImplementationVersion());
+      // support usage metrics
+      ConnectorRegistry.addArtifactId(
+          "spring-cloud-gcp-alloydb/" + this.getClass().getPackage().getImplementationVersion());
+    }
   }
 
   private String getJdbcUrl(AlloyDbProperties properties) {

diff --git a/...stgres-sample/src/test/java/com/example/SqlPostgresSampleApplicationIntegrationTests.java b/...stgres-sample/src/test/java/com/example/SqlPostgresSampleApplicationIntegrationTests.java
@@ -32,6 +32,7 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
+import org.springframework.util.ClassUtils;
 
 /** Simple integration test to verify the SQL sample application with Postgres. */
 @EnabledIfSystemProperty(named = "it.cloudsql", matches = "true")
@@ -69,4 +70,10 @@ void testSqlRowsAccess() {
             "[jonas@example.com, Jonas, Goncalves]",
             "[fejsa@example.com, Ljubomir, Fejsa]");
   }
+
+  @Test
+  void testNoAllyDbLoaded() {
+    assertThat(ClassUtils.isPresent("com.google.cloud.alloydb.SocketFactory", null))
+        .isFalse();
+  }
 }