Replace GraphProjectConfig#graphStoreFactory with service loading

Author: vnickolov

applications/graph-store-catalog/src/main/java/org/neo4j/gds/applications/graphstorecatalog/GraphStoreFromDatabaseLoader.java

@@ -25,7 +25,7 @@
 import org.neo4j.gds.api.ResultStore;
 import org.neo4j.gds.config.GraphProjectConfig;
 import org.neo4j.gds.core.GraphDimensions;
-import org.neo4j.gds.core.ImmutableGraphLoader;
+import org.neo4j.gds.core.GraphStoreFactorySupplier;
 import org.neo4j.gds.mem.MemoryEstimation;
 
 public class GraphStoreFromDatabaseLoader implements GraphStoreCreator {
@@ -79,12 +79,6 @@ public MemoryEstimation estimateMemoryUsageAfterLoading() {
     }
 
     private GraphStoreFactory<?, ?> graphStoreFactory() {
-        return ImmutableGraphLoader
-            .builder()
-            .context(graphLoaderContext)
-            .username(username)
-            .projectConfig(graphProjectConfig)
-            .build()
-            .graphStoreFactory();
+        return GraphStoreFactorySupplier.supplier(graphProjectConfig).get(graphLoaderContext);
     }
 }

applications/graph-store-catalog/src/test/java/org/neo4j/gds/applications/graphstorecatalog/StubGraphProjectConfig.java

@@ -58,11 +58,6 @@ public Map<String, Object> asProcedureResultConfigurationField() {
         throw new UnsupportedOperationException("TODO");
     }
 
-//    @Override
-//    public GraphStoreFactory.Supplier graphStoreFactory() {
-//        throw new UnsupportedOperationException("TODO");
-//    }
-
     @Override
     public Optional<String> usernameOverride() {
         throw new UnsupportedOperationException("TODO");

config-api/src/main/java/org/neo4j/gds/config/GraphProjectConfig.java

@@ -95,13 +95,6 @@ default boolean validateRelationships() {
         return false;
     }
 
-//    @Configuration.Ignore
-//    default GraphStoreFactory.Supplier graphStoreFactory() {
-//        return loaderContext -> {
-//            throw new UnsupportedOperationException("GraphStoreFactory not set");
-//        };
-//    }
-
     @Configuration.Check
     default void validateReadConcurrency() {
         ConcurrencyValidatorService

config-api/src/main/java/org/neo4j/gds/config/GraphProjectFromGraphConfig.java

@@ -80,12 +80,6 @@ default Map<String, Object> parameters() {
         return Collections.emptyMap();
     }
 
-//    @Configuration.Ignore
-//    @Override
-//    default GraphStoreFactory.Supplier graphStoreFactory() {
-//        return originalConfig().graphStoreFactory();
-//    }
-
     // Inherited, but ignored config keys
 
     @Override

config-api/src/main/java/org/neo4j/gds/config/GraphSampleProcConfig.java

@@ -46,10 +46,4 @@ default Map<String, Object> asProcedureResultConfigurationField() {
     @Configuration.Parameter
     GraphSampleAlgoConfig sampleAlgoConfig();
 
-//    @Configuration.Ignore
-//    @Override
-//    default GraphStoreFactory.Supplier graphStoreFactory() {
-//        return originalConfig().graphStoreFactory();
-//    }
-
 }

config-api/src/main/java/org/neo4j/gds/config/RandomGraphGeneratorConfig.java

@@ -116,13 +116,6 @@ default RelationshipProjections relationshipProjections() {
             .build();
     }
 
-//    @Configuration.Ignore
-//    @Override
-//    default GraphStoreFactory.Supplier graphStoreFactory() {
-//        // TODO: maybe we could introduce a RandomGraphFactory
-//        throw new UnsupportedOperationException("RandomGraphGeneratorConfig requires explicit graph generation.");
-//    }
-
     @Configuration.Ignore
     default Set<String> outputFieldDenylist() {
         return Set.of(READ_CONCURRENCY_KEY,  NODE_COUNT_KEY, RELATIONSHIP_COUNT_KEY, "validateRelationships");

core/build.gradle

@@ -24,9 +24,9 @@ dependencies {
     implementation project(':config-api')
     implementation project(':core-utils')
     implementation project(':gds-values')
+    implementation project(':graph-schema-api')
     implementation project(':licensing')
     implementation project(':logging')
-    implementation project(':graph-schema-api')
     implementation project(':memory-usage')
     implementation project(':open-licensing')
     implementation project(':string-formatting')

core/src/main/java/org/neo4j/gds/api/GraphStoreFactorySupplierProvider.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.api;
+
+import org.neo4j.annotations.service.Service;
+import org.neo4j.gds.config.GraphProjectConfig;
+
+@Service
+public interface GraphStoreFactorySupplierProvider {
+    boolean canSupplyFactoryFor(GraphProjectConfig graphProjectConfig);
+    GraphStoreFactory.Supplier supplier(GraphProjectConfig graphProjectConfig);
+}

core/src/main/java/org/neo4j/gds/core/GraphLoader.java

@@ -19,37 +19,36 @@
  */
 package org.neo4j.gds.core;
 
-import org.immutables.value.Value;
-import org.neo4j.gds.annotation.ValueClass;
 import org.neo4j.gds.api.Graph;
-import org.neo4j.gds.api.GraphLoaderContext;
 import org.neo4j.gds.api.GraphStore;
 import org.neo4j.gds.api.GraphStoreFactory;
 import org.neo4j.gds.config.GraphProjectConfig;
 
-@ValueClass
-public interface GraphLoader {
+public class GraphLoader {
+    private final GraphProjectConfig projectConfig;
+    private final GraphStoreFactory<? extends GraphStore, ? extends GraphProjectConfig> graphStoreFactory;
 
-    GraphLoaderContext context();
-
-    @Value.Default
-    default String username() {
-        return projectConfig().username();
+    public GraphLoader(
+        GraphProjectConfig projectConfig,
+        GraphStoreFactory<? extends GraphStore, ? extends GraphProjectConfig> graphStoreFactory
+    ) {
+        this.projectConfig = projectConfig;
+        this.graphStoreFactory = graphStoreFactory;
     }
 
-    GraphProjectConfig projectConfig();
-
-    default Graph graph() {
+    public Graph graph() {
         return graphStore().getUnion();
     }
 
-    default GraphStore graphStore() {
-        return graphStoreFactory().build();
+    public GraphStore graphStore() {
+        return graphStoreFactory.build();
+    }
+
+    public GraphProjectConfig projectConfig() {
+        return projectConfig;
     }
 
-    default GraphStoreFactory<? extends GraphStore, ? extends GraphProjectConfig> graphStoreFactory() {
-        return GraphStoreFactorySupplier
-            .supplier(projectConfig())
-            .get(context());
+    public GraphStoreFactory<? extends GraphStore, ? extends GraphProjectConfig> graphStoreFactory() {
+        return graphStoreFactory;
     }
 }

core/src/main/java/org/neo4j/gds/core/GraphStoreFactorySupplier.java

@@ -20,14 +20,37 @@
 package org.neo4j.gds.core;
 
 import org.neo4j.gds.api.GraphStoreFactory;
+import org.neo4j.gds.api.GraphStoreFactorySupplierProvider;
 import org.neo4j.gds.config.GraphProjectConfig;
 
+import java.util.List;
+import java.util.ServiceLoader;
+import java.util.stream.Collectors;
+
+import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;
+
 public final class GraphStoreFactorySupplier {
 
     private GraphStoreFactorySupplier() {}
 
-    public static GraphStoreFactory.Supplier supplier(GraphProjectConfig graphProjectConfig) {
-        return null;
+    private static final List<GraphStoreFactorySupplierProvider> PROVIDERS;
+
+    static {
+        PROVIDERS = ServiceLoader
+            .load(GraphStoreFactorySupplierProvider.class, GraphStoreFactorySupplierProvider.class.getClassLoader())
+            .stream()
+            .map(ServiceLoader.Provider::get)
+            .collect(Collectors.toList());
     }
 
+    public static GraphStoreFactory.Supplier supplier(GraphProjectConfig graphProjectConfig) {
+        return PROVIDERS.stream()
+            .filter(f -> f.canSupplyFactoryFor(graphProjectConfig))
+            .findFirst()
+            .orElseThrow(() -> new UnsupportedOperationException(formatWithLocale(
+                "%s does not support GraphStoreFactory creation",
+                graphProjectConfig.getClass().getName()
+            )))
+            .supplier(graphProjectConfig);
+    }
 }