Move ShortestPathWriteStep to dedicated module

Author: vnickolov

applications/algorithms/path-finding/src/main/java/org/neo4j/gds/applications/algorithms/pathfinding/PathFindingAlgorithmsWriteModeBusinessFacade.java

@@ -38,6 +38,7 @@
 import org.neo4j.gds.mem.MemoryEstimation;
 import org.neo4j.gds.pathfinding.BellmanFordWriteStep;
 import org.neo4j.gds.pathfinding.KSpanningTreeWriteStep;
+import org.neo4j.gds.pathfinding.ShortestPathWriteStep;
 import org.neo4j.gds.paths.WritePathOptionsConfig;
 import org.neo4j.gds.paths.astar.config.ShortestPathAStarWriteConfig;
 import org.neo4j.gds.paths.bellmanford.AllShortestPathsBellmanFordWriteConfig;
@@ -294,10 +295,13 @@ private <CONFIGURATION extends AlgoBaseConfig & RelationshipWeightConfig & Write
         Computation<PathFindingResult> algorithm,
         ResultBuilder<CONFIGURATION, PathFindingResult, RESULT_TO_CALLER, RelationshipsWritten> resultBuilder
     ) {
-        var writeStep = new ShortestPathWriteStep<>(
-            log,
+        var writeStep = new ShortestPathWriteStep(
             writeRelationshipService,
-            configuration
+            configuration.writeRelationshipType(),
+            configuration.writeNodeIds(),
+            configuration.writeCosts(),
+            configuration::resolveResultStore,
+            configuration.jobId()
         );
 
         return runAlgorithmAndWrite(

procedures/path-finding-write-steps/src/main/java/org/neo4j/gds/pathfinding/PathFindingWriteRelationshipSpecification.java

@@ -28,7 +28,7 @@
 
 import java.util.List;
 
-public final class PathFindingWriteRelationshipSpecification {
+final class PathFindingWriteRelationshipSpecification {
 
     private static final String TOTAL_COST_KEY = "totalCost";
     private static final String NODE_IDS_KEY = "nodeIds";
@@ -39,13 +39,13 @@ public final class PathFindingWriteRelationshipSpecification {
     private final boolean writeNodeIds;
     private final boolean writeCosts;
 
-    public PathFindingWriteRelationshipSpecification(IdMap idMap, boolean writeNodeIds, boolean writeCosts) {
+    PathFindingWriteRelationshipSpecification(IdMap idMap, boolean writeNodeIds, boolean writeCosts) {
         this.idMap = idMap;
         this.writeNodeIds = writeNodeIds;
         this.writeCosts = writeCosts;
     }
 
-    public List<String> createKeys() {
+    List<String> createKeys() {
         if (writeNodeIds && writeCosts) {
             return List.of(
                 TOTAL_COST_KEY,
@@ -68,7 +68,7 @@ public List<String> createKeys() {
         return List.of(TOTAL_COST_KEY);
     }
 
-     public List<ValueType> createTypes() {
+     List<ValueType> createTypes() {
         if (writeNodeIds && writeCosts) {
             return List.of(
                 ValueType.DOUBLE,
@@ -124,7 +124,7 @@ private long[] toOriginalIds( long[] internalIds) {
         return internalIds;
     }
 
-     public ExportedRelationship createRelationship(PathResult pathResult){
+     ExportedRelationship createRelationship(PathResult pathResult){
         return new ExportedRelationship(
             pathResult.sourceNode(),
             pathResult.targetNode(),

…s/pathfinding/ShortestPathWriteStep.java …s/pathfinding/ShortestPathWriteStep.javaapplications/algorithms/path-finding/src/main/java/org/neo4j/gds/applications/algorithms/pathfinding/ShortestPathWriteStep.java renamed to procedures/path-finding-write-steps/src/main/java/org/neo4j/gds/pathfinding/ShortestPathWriteStep.java applications/algorithms/path-finding/src/main/java/org/neo4j/gds/applications/algorithms/pathfinding/ShortestPathWriteStep.java renamed to procedures/path-finding-write-steps/src/main/java/org/neo4j/gds/pathfinding/ShortestPathWriteStep.java

@@ -17,40 +17,46 @@
  * 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.applications.algorithms.pathfinding;
+package org.neo4j.gds.pathfinding;
 
 import org.neo4j.gds.api.Graph;
 import org.neo4j.gds.api.GraphStore;
 import org.neo4j.gds.api.ResultStore;
 import org.neo4j.gds.applications.algorithms.machinery.WriteRelationshipService;
 import org.neo4j.gds.applications.algorithms.machinery.WriteStep;
 import org.neo4j.gds.applications.algorithms.metadata.RelationshipsWritten;
-import org.neo4j.gds.config.JobIdConfig;
-import org.neo4j.gds.config.WriteRelationshipConfig;
 import org.neo4j.gds.core.utils.progress.JobId;
-import org.neo4j.gds.logging.Log;
-import org.neo4j.gds.pathfinding.PathFindingWriteRelationshipSpecification;
-import org.neo4j.gds.paths.WritePathOptionsConfig;
 import org.neo4j.gds.paths.dijkstra.PathFindingResult;
 
+import java.util.Optional;
+import java.util.function.Function;
+
 
 /**
  * This is relationship writes as needed by path finding algorithms (for now).
  */
-class ShortestPathWriteStep<CONFIGURATION extends WriteRelationshipConfig & WritePathOptionsConfig & JobIdConfig> implements
-    WriteStep<PathFindingResult, RelationshipsWritten> {
-    private final Log log;
+public class ShortestPathWriteStep implements WriteStep<PathFindingResult, RelationshipsWritten> {
     private final WriteRelationshipService writeRelationshipService;
-    private final CONFIGURATION configuration;
+    private final String writeRelationshipType;
+    private final boolean writeNodeIds;
+    private final boolean writeCosts;
+    private final Function<ResultStore, Optional<ResultStore>> resultStoreResolver;
+    private final JobId jobId;
 
-    ShortestPathWriteStep(
-        Log log,
+    public ShortestPathWriteStep(
         WriteRelationshipService writeRelationshipService,
-        CONFIGURATION configuration
+        String writeRelationshipType,
+        boolean writeNodeIds,
+        boolean writeCosts,
+        Function<ResultStore, Optional<ResultStore>> resultStoreResolver,
+        JobId jobId
     ) {
-        this.log = log;
         this.writeRelationshipService = writeRelationshipService;
-        this.configuration = configuration;
+        this.writeRelationshipType = writeRelationshipType;
+        this.writeNodeIds = writeNodeIds;
+        this.writeCosts = writeCosts;
+        this.resultStoreResolver = resultStoreResolver;
+        this.jobId = jobId;
     }
 
     /**
@@ -65,8 +71,6 @@ public RelationshipsWritten execute(
         PathFindingResult result,
         JobId jobId
     ) {
-        var writeNodeIds = configuration.writeNodeIds();
-        var writeCosts = configuration.writeCosts();
 
         var specification = new PathFindingWriteRelationshipSpecification(graph,writeNodeIds,writeCosts);
         var keys = specification.createKeys();
@@ -85,14 +89,14 @@ public RelationshipsWritten execute(
 
             // the final result is the side effect of writing to the database, plus this metadata
             return writeRelationshipService.writeFromRelationshipStream(
-                configuration.writeRelationshipType(),
+                writeRelationshipType,
                 keys,
                 types,
                 relationshipStream,
                 graph,
                 "Write shortest Paths",
-                configuration.resolveResultStore(resultStore),
-                configuration.jobId()
+                resultStoreResolver.apply(resultStore),
+                this.jobId
             );
         }
     }