Merge pull request #8329 from s1ck/decouple-cypher-projection

Refactor Cypher Projection into its own module
neo4j · Nov 2, 2023 · 635eedb · 635eedb
2 parents 7bde22e + b491725
commit 635eedb
Show file tree

Hide file tree

Showing 45 changed files with 190 additions and 76 deletions.
diff --git a/alpha/alpha-proc/build.gradle b/alpha/alpha-proc/build.gradle
@@ -29,6 +29,7 @@ dependencies {
     implementation project(':core')
     implementation project(':core-utils')
     implementation project(':core-write')
+    implementation project(':legacy-cypher-projection')
     implementation project(':executor')
     implementation project(':memory-usage')
     implementation project(':neo4j-api')

diff --git a/alpha/alpha-proc/src/main/java/org/neo4j/gds/linkprediction/LinkPredictionFunc.java b/alpha/alpha-proc/src/main/java/org/neo4j/gds/linkprediction/LinkPredictionFunc.java
@@ -31,7 +31,7 @@
 import java.util.Map;
 import java.util.Set;
 
-import static org.neo4j.gds.config.GraphProjectFromCypherConfig.RELATIONSHIP_QUERY_KEY;
+import static org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig.RELATIONSHIP_QUERY_KEY;
 import static org.neo4j.gds.core.ProcedureConstants.DIRECTION_KEY;
 
 public class LinkPredictionFunc extends BaseProc {

diff --git a/applications/graph-store-catalog/build.gradle b/applications/graph-store-catalog/build.gradle
@@ -32,6 +32,7 @@ dependencies {
     implementation project(':config-api')
     implementation project(':core')
     implementation project(':core-write')
+    implementation project(':legacy-cypher-projection')
     implementation project(':executor')
     implementation project(':graph-projection-api')
     implementation project(':graph-sampling')

diff --git a/...log/src/main/java/org/neo4j/gds/applications/graphstorecatalog/CatalogBusinessFacade.java b/...log/src/main/java/org/neo4j/gds/applications/graphstorecatalog/CatalogBusinessFacade.java
@@ -25,7 +25,6 @@
 import org.neo4j.gds.core.loading.GraphDropNodePropertiesResult;
 import org.neo4j.gds.core.loading.GraphDropRelationshipResult;
 import org.neo4j.gds.core.loading.GraphFilterResult;
-import org.neo4j.gds.core.loading.GraphProjectCypherResult;
 import org.neo4j.gds.core.loading.GraphStoreWithConfig;
 import org.neo4j.gds.core.utils.TerminationFlag;
 import org.neo4j.gds.core.utils.progress.TaskRegistryFactory;
@@ -34,6 +33,7 @@
 import org.neo4j.gds.core.write.NodePropertyExporterBuilder;
 import org.neo4j.gds.core.write.RelationshipExporterBuilder;
 import org.neo4j.gds.core.write.RelationshipPropertiesExporterBuilder;
+import org.neo4j.gds.legacycypherprojection.GraphProjectCypherResult;
 import org.neo4j.gds.projection.GraphProjectNativeResult;
 import org.neo4j.gds.results.MemoryEstimateResult;
 import org.neo4j.gds.transaction.TransactionContext;

diff --git a/...c/main/java/org/neo4j/gds/applications/graphstorecatalog/CatalogConfigurationService.java b/...c/main/java/org/neo4j/gds/applications/graphstorecatalog/CatalogConfigurationService.java
@@ -25,7 +25,6 @@
 import org.neo4j.gds.config.BaseConfig;
 import org.neo4j.gds.config.GraphDropNodePropertiesConfig;
 import org.neo4j.gds.config.GraphProjectConfig;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
 import org.neo4j.gds.config.GraphProjectFromGraphConfig;
 import org.neo4j.gds.config.GraphRemoveGraphPropertiesConfig;
 import org.neo4j.gds.config.GraphStreamGraphPropertiesConfig;
@@ -36,6 +35,7 @@
 import org.neo4j.gds.core.CypherMapAccess;
 import org.neo4j.gds.core.CypherMapWrapper;
 import org.neo4j.gds.core.loading.GraphStoreWithConfig;
+import org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig;
 import org.neo4j.gds.graphsampling.config.CommonNeighbourAwareRandomWalkConfig;
 import org.neo4j.gds.projection.GraphProjectFromStoreConfig;
 

diff --git a/.../src/main/java/org/neo4j/gds/applications/graphstorecatalog/CypherProjectApplication.java b/.../src/main/java/org/neo4j/gds/applications/graphstorecatalog/CypherProjectApplication.java
@@ -21,11 +21,11 @@
 
 import org.neo4j.gds.api.DatabaseId;
 import org.neo4j.gds.config.GraphProjectConfig;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
-import org.neo4j.gds.core.loading.GraphProjectCypherResult;
 import org.neo4j.gds.core.utils.TerminationFlag;
 import org.neo4j.gds.core.utils.progress.TaskRegistryFactory;
 import org.neo4j.gds.core.utils.warnings.UserLogRegistryFactory;
+import org.neo4j.gds.legacycypherprojection.GraphProjectCypherResult;
+import org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig;
 import org.neo4j.gds.results.MemoryEstimateResult;
 import org.neo4j.gds.transaction.TransactionContext;
 import org.neo4j.graphdb.GraphDatabaseService;

diff --git a/.../main/java/org/neo4j/gds/applications/graphstorecatalog/DefaultCatalogBusinessFacade.java b/.../main/java/org/neo4j/gds/applications/graphstorecatalog/DefaultCatalogBusinessFacade.java
@@ -30,7 +30,6 @@
 import org.neo4j.gds.core.loading.GraphDropNodePropertiesResult;
 import org.neo4j.gds.core.loading.GraphDropRelationshipResult;
 import org.neo4j.gds.core.loading.GraphFilterResult;
-import org.neo4j.gds.core.loading.GraphProjectCypherResult;
 import org.neo4j.gds.core.loading.GraphStoreCatalogService;
 import org.neo4j.gds.core.loading.GraphStoreWithConfig;
 import org.neo4j.gds.core.utils.TerminationFlag;
@@ -40,6 +39,7 @@
 import org.neo4j.gds.core.write.NodePropertyExporterBuilder;
 import org.neo4j.gds.core.write.RelationshipExporterBuilder;
 import org.neo4j.gds.core.write.RelationshipPropertiesExporterBuilder;
+import org.neo4j.gds.legacycypherprojection.GraphProjectCypherResult;
 import org.neo4j.gds.graphsampling.RandomWalkBasedNodesSampler;
 import org.neo4j.gds.graphsampling.config.RandomWalkWithRestartsConfig;
 import org.neo4j.gds.logging.Log;

diff --git a/core/build.gradle b/core/build.gradle
@@ -61,10 +61,11 @@ dependencies {
     testAnnotationProcessor project(':config-generator')
     testAnnotationProcessor group: 'org.immutables', name: 'value', version: ver.'immutables'
 
+    testImplementation project(':legacy-cypher-projection')
+    testImplementation project(':edition-api')
     testImplementation project(':progress-tracking')
     testImplementation project(':test-graph-loaders')
     testImplementation project(':test-utils')
-    testImplementation project(':edition-api')
 
     testImplementation group: 'net.jqwik',          name: 'jqwik',                  version: ver.'jqwik'
     testImplementation group: 'io.qala.datagen',    name: 'qala-datagen-junit5',    version: ver.'qala-datagen'

diff --git a/core/src/main/java/org/neo4j/gds/config/GraphProjectConfig.java b/core/src/main/java/org/neo4j/gds/config/GraphProjectConfig.java
@@ -118,8 +118,6 @@ default void validateReadConcurrency() {
 
     interface Cases<R> {
 
-        R cypher(GraphProjectFromCypherConfig cypherConfig);
-
         R graph(GraphProjectFromGraphConfig graphConfig);
 
         R random(RandomGraphGeneratorConfig randomGraphConfig);
@@ -131,12 +129,6 @@ interface Cases<R> {
 
     interface Visitor extends Cases<Void> {
 
-        @Override
-        default Void cypher(GraphProjectFromCypherConfig cypherConfig) {
-            visit(cypherConfig);
-            return null;
-        }
-
         @Override
         default Void graph(GraphProjectFromGraphConfig graphConfig) {
             visit(graphConfig);
@@ -161,8 +153,6 @@ default Void catalog(GraphCatalogConfig graphCatalogConfig) {
             return null;
         }
 
-        default void visit(GraphProjectFromCypherConfig cypherConfig) {}
-
         default void visit(GraphProjectFromGraphConfig graphConfig) {}
 
         default void visit(RandomGraphGeneratorConfig randomGraphConfig) {}

diff --git a/core/src/test/java/org/neo4j/gds/core/GraphLoaderDirectionalityTest.java b/core/src/test/java/org/neo4j/gds/core/GraphLoaderDirectionalityTest.java
@@ -24,7 +24,7 @@
 import org.neo4j.gds.Orientation;
 import org.neo4j.gds.StoreLoaderBuilder;
 import org.neo4j.gds.api.Graph;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
+import org.neo4j.gds.legacycypherprojection.GraphProjectFromCypherConfig;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.neo4j.gds.GraphFactoryTestSupport.AllGraphStoreFactoryTypesTest;

diff --git a/graph-construction/build.gradle b/graph-construction/build.gradle
@@ -0,0 +1,38 @@
+apply plugin: 'java-library'
+
+description = 'Neo4j Graph Data Science :: Graph Construction'
+group = 'org.neo4j.gds'
+
+dependencies {
+    annotationProcessor project(':annotations')
+    annotationProcessor group: 'org.immutables',  name: 'builder',     version: ver.'immutables'
+    annotationProcessor group: 'org.immutables',  name: 'value',       version: ver.'immutables'
+    annotationProcessor group: 'org.neo4j',       name: 'annotations', version: ver.'neo4j'
+
+    compileOnly group: 'org.immutables', name: 'builder',           version: ver.'immutables'
+    compileOnly group: 'org.immutables', name: 'value-annotations', version: ver.'immutables'
+    compileOnly group: 'org.jetbrains',  name: 'annotations',       version: ver.'jetbrains-annotations'
+
+    implementation project(':annotations')
+//    implementation project(':config-api')
+    implementation project(':core')
+//    implementation project(':core-utils')
+    implementation project(':graph-schema-api')
+//    implementation project(':memory-usage')
+//    implementation project(':progress-tracking')
+//    implementation project(':string-formatting')
+//    implementation project(':transaction')
+
+//    implementation group: 'org.openjdk.jol',   name: 'jol-core',                  version: ver.'jol'
+//    implementation group: 'org.opencypher',    name: 'cypher-javacc-parser-9.0',  version: ver.'opencypher-front-end', transitive: false
+//    implementation group: 'org.hdrhistogram',  name: 'HdrHistogram',              version: ver.'HdrHistogram'
+
+    testAnnotationProcessor project(':annotations')
+
+    testCompileOnly group: 'org.immutables', name: 'value-annotations', version: ver.'immutables'
+    testCompileOnly group: 'org.immutables', name: 'builder',           version: ver.'immutables'
+    testCompileOnly group: 'org.jetbrains',  name: 'annotations',       version: ver.'jetbrains-annotations'
+    testCompileOnly group: 'com.github.spotbugs', name: 'spotbugs-annotations', version: ver.'spotbugsToolVersion'
+
+    testImplementation project(':test-utils')
+}
diff --git a/legacy-cypher-projection/build.gradle b/legacy-cypher-projection/build.gradle
@@ -0,0 +1,52 @@
+apply plugin: 'java-library'
+
+description = 'Neo4j Graph Data Science :: Cypher Projection'
+group = 'org.neo4j.gds'
+
+dependencies {
+    annotationProcessor project(':annotations')
+    annotationProcessor project(':config-generator')
+    annotationProcessor group: 'org.immutables',  name: 'builder',     version: ver.'immutables'
+    annotationProcessor group: 'org.immutables',  name: 'value',       version: ver.'immutables'
+    annotationProcessor group: 'org.neo4j',       name: 'annotations', version: ver.'neo4j'
+
+    compileOnly group: 'org.immutables', name: 'value-annotations', version: ver.'immutables'
+    compileOnly group: 'org.jetbrains',  name: 'annotations',       version: ver.'jetbrains-annotations'
+
+    neodeps().each {
+        compileOnly(group: 'org.neo4j', name: it, version: ver.'neo4j') {
+            transitive = false
+        }
+    }
+
+    implementation project(':annotations')
+    implementation project(':config-api')
+    implementation project(':core')
+    implementation project(':graph-schema-api')
+    implementation project(':memory-usage')
+    implementation project(':progress-tracking')
+    implementation project(':string-formatting')
+    implementation project(':transaction')
+
+
+    implementation group: 'org.openjdk.jol',   name: 'jol-core',                  version: ver.'jol'
+    implementation group: 'org.opencypher',    name: 'cypher-javacc-parser-9.0',  version: ver.'opencypher-front-end', transitive: false
+    implementation group: 'org.hdrhistogram',  name: 'HdrHistogram',              version: ver.'HdrHistogram'
+
+    testAnnotationProcessor project(':annotations')
+
+    testCompileOnly group: 'org.immutables', name: 'value-annotations', version: ver.'immutables'
+    testCompileOnly group: 'org.immutables', name: 'builder',           version: ver.'immutables'
+    testCompileOnly group: 'org.jetbrains',  name: 'annotations',       version: ver.'jetbrains-annotations'
+    testCompileOnly group: 'com.github.spotbugs', name: 'spotbugs-annotations', version: ver.'spotbugsToolVersion'
+
+    testImplementation project(':executor')
+    testImplementation project(':test-utils')
+    testImplementation project(':proc-catalog')
+    testImplementation project(':proc-community')
+    testImplementation project(':test-graph-loaders')
+
+    testImplementation group: 'org.neo4j',  name: 'neo4j-cypher-dsl',  version: ver.'cypher-dsl'
+
+    testImplementation project(':opengds-extension')
+}
diff --git a/...o4j/gds/core/loading/BatchLoadResult.java → ...gacycypherprojection/BatchLoadResult.java b/...o4j/gds/core/loading/BatchLoadResult.java → ...gacycypherprojection/BatchLoadResult.java
@@ -17,7 +17,7 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 class BatchLoadResult {
 

diff --git a/...e/loading/CountingCypherRecordLoader.java → ...rojection/CountingCypherRecordLoader.java b/...e/loading/CountingCypherRecordLoader.java → ...rojection/CountingCypherRecordLoader.java
@@ -17,10 +17,9 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 import org.neo4j.gds.api.GraphLoaderContext;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
 import org.neo4j.graphdb.security.AuthorizationViolationException;
 import org.neo4j.kernel.impl.coreapi.InternalTransaction;
 

diff --git a/...neo4j/gds/core/loading/CypherFactory.java → ...legacycypherprojection/CypherFactory.java b/...neo4j/gds/core/loading/CypherFactory.java → ...legacycypherprojection/CypherFactory.java
@@ -17,7 +17,7 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 import org.neo4j.gds.ElementProjection;
 import org.neo4j.gds.NodeLabel;
@@ -30,7 +30,9 @@
 import org.neo4j.gds.api.CSRGraphStoreFactory;
 import org.neo4j.gds.api.DefaultValue;
 import org.neo4j.gds.api.GraphLoaderContext;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
+import org.neo4j.gds.core.loading.CSRGraphStore;
+import org.neo4j.gds.core.loading.Capabilities;
+import org.neo4j.gds.core.loading.ImmutableStaticCapabilities;
 import org.neo4j.gds.core.GraphDimensions;
 import org.neo4j.gds.core.ImmutableGraphDimensions;
 import org.neo4j.gds.core.utils.mem.MemoryEstimation;
@@ -46,7 +48,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.LongStream;
 
-import static org.neo4j.gds.core.loading.CypherQueryEstimator.EstimationResult;
+import static org.neo4j.gds.legacycypherprojection.CypherQueryEstimator.EstimationResult;
 import static org.neo4j.internal.kernel.api.security.AccessMode.Static.READ;
 
 public final class CypherFactory extends CSRGraphStoreFactory<GraphProjectFromCypherConfig> {

diff --git a/.../gds/core/loading/CypherLoadingUtils.java → ...ycypherprojection/CypherLoadingUtils.java b/.../gds/core/loading/CypherLoadingUtils.java → ...ycypherprojection/CypherLoadingUtils.java
@@ -17,7 +17,7 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 import org.neo4j.kernel.impl.query.QueryExecutionKernelException;
 import org.neo4j.kernel.impl.query.QuerySubscription;

diff --git a/...4j/gds/core/loading/CypherNodeLoader.java → ...acycypherprojection/CypherNodeLoader.java b/...4j/gds/core/loading/CypherNodeLoader.java → ...acycypherprojection/CypherNodeLoader.java
@@ -17,12 +17,12 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 import org.immutables.value.Value;
 import org.neo4j.gds.api.GraphLoaderContext;
 import org.neo4j.gds.api.PropertyState;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
+import org.neo4j.gds.core.loading.Nodes;
 import org.neo4j.gds.core.loading.construction.GraphFactory;
 import org.neo4j.gds.core.loading.construction.NodesBuilder;
 import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;

diff --git a/...ds/core/loading/CypherQueryEstimator.java → ...ypherprojection/CypherQueryEstimator.java b/...ds/core/loading/CypherQueryEstimator.java → ...ypherprojection/CypherQueryEstimator.java
@@ -17,7 +17,7 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 import org.neo4j.gds.PropertyMapping;
 import org.neo4j.gds.annotation.ValueClass;

diff --git a/.../gds/core/loading/CypherRecordLoader.java → ...ycypherprojection/CypherRecordLoader.java b/.../gds/core/loading/CypherRecordLoader.java → ...ycypherprojection/CypherRecordLoader.java
@@ -17,11 +17,11 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 import org.neo4j.gds.api.GraphLoaderContext;
 import org.neo4j.gds.compat.Neo4jProxy;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
+import org.neo4j.gds.core.loading.RecordsBatchBuffer;
 import org.neo4j.gds.utils.StringJoining;
 import org.neo4j.graphdb.security.AuthorizationViolationException;
 import org.neo4j.kernel.GraphDatabaseQueryService;

diff --git a/...ore/loading/CypherRelationshipLoader.java → ...rprojection/CypherRelationshipLoader.java b/...ore/loading/CypherRelationshipLoader.java → ...rprojection/CypherRelationshipLoader.java
@@ -17,7 +17,7 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
 import org.eclipse.collections.impl.map.mutable.primitive.ObjectDoubleHashMap;
 import org.immutables.value.Value;
@@ -29,8 +29,8 @@
 import org.neo4j.gds.api.DefaultValue;
 import org.neo4j.gds.api.GraphLoaderContext;
 import org.neo4j.gds.api.IdMap;
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
 import org.neo4j.gds.core.Aggregation;
+import org.neo4j.gds.core.loading.RelationshipImportResult;
 import org.neo4j.gds.core.loading.construction.GraphFactory;
 import org.neo4j.gds.core.loading.construction.RelationshipsBuilder;
 import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;

diff --git a/...ore/loading/GraphProjectCypherResult.java → ...rprojection/GraphProjectCypherResult.java b/...ore/loading/GraphProjectCypherResult.java → ...rprojection/GraphProjectCypherResult.java
@@ -17,9 +17,9 @@
  * 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.core.loading;
+package org.neo4j.gds.legacycypherprojection;
 
-import org.neo4j.gds.config.GraphProjectFromCypherConfig;
+import org.neo4j.gds.core.loading.GraphProjectResult;
 
 public final class GraphProjectCypherResult extends GraphProjectResult {
     public final String nodeQuery;