Moved all metadata parsing in a dedicated class

Moved parsing of RUN message metadata to a class responsible for
SUCCESS metadata parsing. This way all such parsing is in a
single class. Renamed this utility class to `MetadataUtil`.

Author: lutovich

driver/src/main/java/org/neo4j/driver/internal/handlers/PullAllResponseHandler.java

@@ -27,7 +27,7 @@
 import org.neo4j.driver.internal.InternalRecord;
 import org.neo4j.driver.internal.spi.Connection;
 import org.neo4j.driver.internal.spi.ResponseHandler;
-import org.neo4j.driver.internal.summary.ResultSummaryCreator;
+import org.neo4j.driver.internal.util.MetadataUtil;
 import org.neo4j.driver.v1.Record;
 import org.neo4j.driver.v1.Statement;
 import org.neo4j.driver.v1.Value;
@@ -298,6 +298,6 @@ private boolean completeFailureFuture( Throwable error )
     private ResultSummary extractResultSummary( Map<String,Value> metadata )
     {
         long resultAvailableAfter = runResponseHandler.resultAvailableAfter();
-        return ResultSummaryCreator.create( statement, connection, resultAvailableAfter, metadata );
+        return MetadataUtil.extractSummary( statement, connection, resultAvailableAfter, metadata );
     }
 }

driver/src/main/java/org/neo4j/driver/internal/handlers/RunResponseHandler.java

@@ -18,7 +18,6 @@
  */
 package org.neo4j.driver.internal.handlers;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
@@ -27,15 +26,15 @@
 import org.neo4j.driver.v1.Value;
 
 import static java.util.Collections.emptyList;
+import static org.neo4j.driver.internal.util.MetadataUtil.extractResultAvailableAfter;
+import static org.neo4j.driver.internal.util.MetadataUtil.extractStatementKeys;
 
 public class RunResponseHandler implements ResponseHandler
 {
-    private static final int UNKNOWN = -1;
-
     private final CompletableFuture<Void> runCompletedFuture;
 
     private List<String> statementKeys = emptyList();
-    private long resultAvailableAfter = UNKNOWN;
+    private long resultAvailableAfter = -1;
 
     public RunResponseHandler( CompletableFuture<Void> runCompletedFuture )
     {
@@ -45,7 +44,7 @@ public RunResponseHandler( CompletableFuture<Void> runCompletedFuture )
     @Override
     public void onSuccess( Map<String,Value> metadata )
     {
-        statementKeys = extractKeys( metadata );
+        statementKeys = extractStatementKeys( metadata );
         resultAvailableAfter = extractResultAvailableAfter( metadata );
 
         completeRunFuture();
@@ -82,33 +81,4 @@ private void completeRunFuture()
     {
         runCompletedFuture.complete( null );
     }
-
-    private static List<String> extractKeys( Map<String,Value> metadata )
-    {
-        Value keysValue = metadata.get( "fields" );
-        if ( keysValue != null )
-        {
-            if ( !keysValue.isEmpty() )
-            {
-                List<String> keys = new ArrayList<>( keysValue.size() );
-                for ( Value value : keysValue.values() )
-                {
-                    keys.add( value.asString() );
-                }
-
-                return keys;
-            }
-        }
-        return emptyList();
-    }
-
-    private static long extractResultAvailableAfter( Map<String,Value> metadata )
-    {
-        Value resultAvailableAfterValue = metadata.get( "result_available_after" );
-        if ( resultAvailableAfterValue != null )
-        {
-            return resultAvailableAfterValue.asLong();
-        }
-        return UNKNOWN;
-    }
 }

driver/src/main/java/org/neo4j/driver/internal/summary/ResultSummaryCreator.java renamed to driver/src/main/java/org/neo4j/driver/internal/util/MetadataUtil.java

@@ -16,13 +16,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver.internal.summary;
+package org.neo4j.driver.internal.util;
 
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
 import org.neo4j.driver.internal.spi.Connection;
+import org.neo4j.driver.internal.summary.InternalNotification;
+import org.neo4j.driver.internal.summary.InternalPlan;
+import org.neo4j.driver.internal.summary.InternalProfiledPlan;
+import org.neo4j.driver.internal.summary.InternalResultSummary;
+import org.neo4j.driver.internal.summary.InternalServerInfo;
+import org.neo4j.driver.internal.summary.InternalSummaryCounters;
 import org.neo4j.driver.v1.Statement;
 import org.neo4j.driver.v1.Value;
 import org.neo4j.driver.v1.summary.Notification;
@@ -32,13 +39,44 @@
 import org.neo4j.driver.v1.summary.ServerInfo;
 import org.neo4j.driver.v1.summary.StatementType;
 
-public final class ResultSummaryCreator
+import static java.util.Collections.emptyList;
+
+public final class MetadataUtil
 {
-    private ResultSummaryCreator()
+    private MetadataUtil()
+    {
+    }
+
+    public static List<String> extractStatementKeys( Map<String,Value> metadata )
     {
+        Value keysValue = metadata.get( "fields" );
+        if ( keysValue != null )
+        {
+            if ( !keysValue.isEmpty() )
+            {
+                List<String> keys = new ArrayList<>( keysValue.size() );
+                for ( Value value : keysValue.values() )
+                {
+                    keys.add( value.asString() );
+                }
+
+                return keys;
+            }
+        }
+        return emptyList();
+    }
+
+    public static long extractResultAvailableAfter( Map<String,Value> metadata )
+    {
+        Value resultAvailableAfterValue = metadata.get( "result_available_after" );
+        if ( resultAvailableAfterValue != null )
+        {
+            return resultAvailableAfterValue.asLong();
+        }
+        return -1;
     }
 
-    public static ResultSummary create( Statement statement, Connection connection, long resultAvailableAfter,
+    public static ResultSummary extractSummary( Statement statement, Connection connection, long resultAvailableAfter,
             Map<String,Value> metadata )
     {
         ServerInfo serverInfo = new InternalServerInfo( connection.serverAddress(), connection.serverVersion() );

driver/src/test/java/org/neo4j/driver/internal/summary/ResultSummaryCreatorTest.java renamed to driver/src/test/java/org/neo4j/driver/internal/util/MetadataUtilTest.java

@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.neo4j.driver.internal.summary;
+package org.neo4j.driver.internal.util;
 
 import org.junit.Test;
 
@@ -26,7 +26,7 @@
 
 import org.neo4j.driver.internal.BoltServerAddress;
 import org.neo4j.driver.internal.spi.Connection;
-import org.neo4j.driver.internal.util.ServerVersion;
+import org.neo4j.driver.internal.summary.InternalInputPosition;
 import org.neo4j.driver.v1.Statement;
 import org.neo4j.driver.v1.Value;
 import org.neo4j.driver.v1.summary.Notification;
@@ -35,6 +35,7 @@
 import org.neo4j.driver.v1.summary.ResultSummary;
 
 import static java.util.Arrays.asList;
+import static java.util.Collections.emptyList;
 import static java.util.Collections.emptyMap;
 import static java.util.Collections.singletonMap;
 import static org.junit.Assert.assertEquals;
@@ -44,7 +45,9 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 import static org.neo4j.driver.internal.summary.InternalSummaryCounters.EMPTY_STATS;
-import static org.neo4j.driver.internal.summary.ResultSummaryCreator.create;
+import static org.neo4j.driver.internal.util.MetadataUtil.extractResultAvailableAfter;
+import static org.neo4j.driver.internal.util.MetadataUtil.extractStatementKeys;
+import static org.neo4j.driver.internal.util.MetadataUtil.extractSummary;
 import static org.neo4j.driver.v1.Values.parameters;
 import static org.neo4j.driver.v1.Values.value;
 import static org.neo4j.driver.v1.Values.values;
@@ -53,15 +56,45 @@
 import static org.neo4j.driver.v1.summary.StatementType.SCHEMA_WRITE;
 import static org.neo4j.driver.v1.summary.StatementType.WRITE_ONLY;
 
-public class ResultSummaryCreatorTest
+public class MetadataUtilTest
 {
+    @Test
+    public void shouldExtractStatementKeys()
+    {
+        List<String> keys = asList( "hello", " ", "world", "!" );
+        List<String> extractedKeys = extractStatementKeys( singletonMap( "fields", value( keys ) ) );
+        assertEquals( keys, extractedKeys );
+    }
+
+    @Test
+    public void shouldExtractEmptyStatementKeysWhenNoneInMetadata()
+    {
+        List<String> extractedKeys = extractStatementKeys( emptyMap() );
+        assertEquals( emptyList(), extractedKeys );
+    }
+
+    @Test
+    public void shouldExtractResultAvailableAfter()
+    {
+        long extractedResultAvailableAfter = extractResultAvailableAfter(
+                singletonMap( "result_available_after", value( 424242 ) ) );
+        assertEquals( 424242L, extractedResultAvailableAfter );
+    }
+
+    @Test
+    public void shouldExtractNoResultAvailableAfterWhenNoneInMetadata()
+    {
+        long extractedResultAvailableAfter = extractResultAvailableAfter( emptyMap() );
+        assertEquals( -1, extractedResultAvailableAfter );
+    }
+
     @Test
     public void shouldBuildResultSummaryWithStatement()
     {
         Statement statement = new Statement( "UNWIND range(10, 100) AS x CREATE (:Node {name: $name, x: x})",
                 singletonMap( "name", "Apa" ) );
 
-        ResultSummary summary = create( statement, connectionMock(), 42, emptyMap() );
+        ResultSummary summary = extractSummary( statement, connectionMock(), 42, emptyMap() );
 
         assertEquals( statement, summary.statement() );
     }
@@ -71,7 +104,7 @@ public void shouldBuildResultSummaryWithServerInfo()
     {
         Connection connection = connectionMock( new BoltServerAddress( "server:42" ), ServerVersion.v3_2_0 );
 
-        ResultSummary summary = create( statement(), connection, 42, emptyMap() );
+        ResultSummary summary = extractSummary( statement(), connection, 42, emptyMap() );
 
         assertEquals( "server:42", summary.server().address() );
         assertEquals( "Neo4j/3.2.0", summary.server().version() );
@@ -107,7 +140,7 @@ public void shouldBuildResultSummaryWithCounters()
 
         Map<String,Value> metadata = singletonMap( "stats", stats );
 
-        ResultSummary summary = create( statement(), connectionMock(), 42, metadata );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, metadata );
 
         assertEquals( 42, summary.counters().nodesCreated() );
         assertEquals( 4242, summary.counters().nodesDeleted() );
@@ -125,7 +158,7 @@ public void shouldBuildResultSummaryWithCounters()
     @Test
     public void shouldBuildResultSummaryWithoutCounters()
     {
-        ResultSummary summary = create( statement(), connectionMock(), 42, emptyMap() );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, emptyMap() );
         assertEquals( EMPTY_STATS, summary.counters() );
     }
 
@@ -146,7 +179,7 @@ public void shouldBuildResultSummaryWithPlan()
         ) );
         Map<String,Value> metadata = singletonMap( "plan", plan );
 
-        ResultSummary summary = create( statement(), connectionMock(), 42, metadata );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, metadata );
 
         assertTrue( summary.hasPlan() );
         assertEquals( "Projection", summary.plan().operatorType() );
@@ -166,7 +199,7 @@ public void shouldBuildResultSummaryWithPlan()
     @Test
     public void shouldBuildResultSummaryWithoutPlan()
     {
-        ResultSummary summary = create( statement(), connectionMock(), 42, emptyMap() );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, emptyMap() );
         assertFalse( summary.hasPlan() );
         assertNull( summary.plan() );
     }
@@ -192,7 +225,7 @@ public void shouldBuildResultSummaryWithProfiledPlan()
         ) );
         Map<String,Value> metadata = singletonMap( "profile", profile );
 
-        ResultSummary summary = create( statement(), connectionMock(), 42, metadata );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, metadata );
 
         assertTrue( summary.hasPlan() );
         assertTrue( summary.hasProfile() );
@@ -216,7 +249,7 @@ public void shouldBuildResultSummaryWithProfiledPlan()
     @Test
     public void shouldBuildResultSummaryWithoutProfiledPlan()
     {
-        ResultSummary summary = create( statement(), connectionMock(), 42, emptyMap() );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, emptyMap() );
         assertFalse( summary.hasProfile() );
         assertNull( summary.profile() );
     }
@@ -249,7 +282,7 @@ public void shouldBuildResultSummaryWithNotifications()
         Value notifications = value( notification1, notification2 );
         Map<String,Value> metadata = singletonMap( "notifications", notifications );
 
-        ResultSummary summary = create( statement(), connectionMock(), 42, metadata );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, metadata );
 
         assertEquals( 2, summary.notifications().size() );
         Notification firstNotification = summary.notifications().get( 0 );
@@ -271,7 +304,7 @@ public void shouldBuildResultSummaryWithNotifications()
     @Test
     public void shouldBuildResultSummaryWithoutNotifications()
     {
-        ResultSummary summary = create( statement(), connectionMock(), 42, emptyMap() );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, emptyMap() );
         assertEquals( 0, summary.notifications().size() );
     }
 
@@ -280,7 +313,7 @@ public void shouldBuildResultSummaryWithResultAvailableAfter()
     {
         int value = 42_000;
 
-        ResultSummary summary = create( statement(), connectionMock(), value, emptyMap() );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), value, emptyMap() );
 
         assertEquals( 42, summary.resultAvailableAfter( TimeUnit.SECONDS ) );
         assertEquals( value, summary.resultAvailableAfter( TimeUnit.MILLISECONDS ) );
@@ -292,7 +325,7 @@ public void shouldBuildResultSummaryWithResultConsumedAfter()
         int value = 42_000;
         Map<String,Value> metadata = singletonMap( "result_consumed_after", value( value ) );
 
-        ResultSummary summary = create( statement(), connectionMock(), 42, metadata );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, metadata );
 
         assertEquals( 42, summary.resultConsumedAfter( TimeUnit.SECONDS ) );
         assertEquals( value, summary.resultConsumedAfter( TimeUnit.MILLISECONDS ) );
@@ -301,15 +334,15 @@ public void shouldBuildResultSummaryWithResultConsumedAfter()
     @Test
     public void shouldBuildResultSummaryWithoutResultConsumedAfter()
     {
-        ResultSummary summary = create( statement(), connectionMock(), 42, emptyMap() );
+        ResultSummary summary = extractSummary( statement(), connectionMock(), 42, emptyMap() );
         assertEquals( -1, summary.resultConsumedAfter( TimeUnit.SECONDS ) );
         assertEquals( -1, summary.resultConsumedAfter( TimeUnit.MILLISECONDS ) );
     }
 
     private static ResultSummary createWithStatementType( Value typeValue )
     {
         Map<String,Value> metadata = singletonMap( "type", typeValue );
-        return create( statement(), connectionMock(), 42, metadata );
+        return extractSummary( statement(), connectionMock(), 42, metadata );
     }
 
     private static Statement statement()