Fix bug where the number of rows wasn't being counted

Since we are now streaming the result the old way of assuming all records
had been eagerly pulled is no longer working.

Author: pontusmelke

cypher-shell/src/integration-test/java/org/neo4j/shell/commands/CypherShellVerboseIntegrationTest.java

@@ -218,4 +218,14 @@ public void cypherWithExplainAndRulePlanner() throws CommandException {
         assertThat(actual, containsString("\"RULE\""));
         assertThat(actual, containsString("\"INTERPRETED\""));
     }
+
+    @Test
+    public void shouldShowTheNumberOfRows() throws CommandException {
+        //when
+        shell.execute("UNWIND [1,2,3] AS row RETURN row");
+
+        //then
+        String actual = linePrinter.output();
+        assertThat(actual, containsString("3 rows available"));
+    }
 }

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/OutputFormatter.java

@@ -30,7 +30,7 @@ enum Capabilities {INFO, PLAN, RESULT, FOOTER, STATISTICS}
     String SPACE = " ";
     String NEWLINE =  System.getProperty("line.separator");
 
-    void format(@Nonnull BoltResult result, @Nonnull LinePrinter linePrinter);
+    int formatAndCount(@Nonnull BoltResult result, @Nonnull LinePrinter linePrinter);
 
     @Nonnull default String formatValue(final Value value) {
         if (value == null) return "";
@@ -70,10 +70,10 @@ enum Capabilities {INFO, PLAN, RESULT, FOOTER, STATISTICS}
     @Nonnull
     default String pointAsString(Point point) {
         StringBuilder stringBuilder = new StringBuilder("point({");
-        stringBuilder.append("srid:" + point.srid() + ",");
+        stringBuilder.append("srid:").append(point.srid()).append(",");
         stringBuilder.append(" x:").append(point.x()).append(",");
         stringBuilder.append(" y:").append(point.y());
-        Double z = point.z();
+        double z = point.z();
         if (!Double.isNaN(z)) {
             stringBuilder.append(", z:").append(z);
         }
@@ -182,7 +182,7 @@ static boolean isNotBlank(String string) {
     @Nonnull default String formatInfo(@Nonnull ResultSummary summary) {
         return "";
     }
-    @Nonnull default String formatFooter(@Nonnull BoltResult result) {
+    @Nonnull default String formatFooter(@Nonnull BoltResult result, int numberOfRows) {
         return "";
     }
 

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/PrettyPrinter.java

@@ -23,11 +23,14 @@ public PrettyPrinter(@Nonnull PrettyConfig prettyConfig) {
     public void format(@Nonnull final BoltResult result, LinePrinter linePrinter) {
         Set<OutputFormatter.Capabilities> capabilities = outputFormatter.capabilities();
 
-        if (capabilities.contains(RESULT)) outputFormatter.format(result, linePrinter);
+        int numberOfRows = 0;
+        if (capabilities.contains(RESULT)) {
+            numberOfRows = outputFormatter.formatAndCount(result, linePrinter);
+        }
 
         if (capabilities.contains(INFO)) linePrinter.printOut(outputFormatter.formatInfo(result.getSummary()));
         if (capabilities.contains(PLAN)) linePrinter.printOut(outputFormatter.formatPlan(result.getSummary()));
-        if (capabilities.contains(FOOTER)) linePrinter.printOut(outputFormatter.formatFooter(result));
+        if (capabilities.contains(FOOTER)) linePrinter.printOut(outputFormatter.formatFooter(result, numberOfRows));
         if (capabilities.contains(STATISTICS)) linePrinter.printOut(statisticsCollector.collect(result.getSummary()));
     }
 

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/SimpleOutputFormatter.java

@@ -17,16 +17,20 @@
 public class SimpleOutputFormatter implements OutputFormatter {
 
     @Override
-    public void format(@Nonnull BoltResult result, @Nonnull LinePrinter output) {
+    public int formatAndCount(@Nonnull BoltResult result, @Nonnull LinePrinter output) {
         Iterator<Record> records = result.iterate();
+        int numberOfRows = 0;
         if (records.hasNext()) {
             Record firstRow = records.next();
             output.printOut(String.join(COMMA_SEPARATOR, firstRow.keys()));
             output.printOut(formatRecord(firstRow));
+            numberOfRows++;
             while (records.hasNext()) {
                 output.printOut(formatRecord(records.next()));
+                numberOfRows++;
             }
         }
+        return numberOfRows;
     }
 
     @Nonnull

cypher-shell/src/main/java/org/neo4j/shell/prettyprint/TableOutputFormatter.java

@@ -24,14 +24,14 @@ public TableOutputFormatter(boolean wrap, int numSampleRows) {
     }
 
     @Override
-    public void format(@Nonnull BoltResult result, @Nonnull LinePrinter output) {
+    public int formatAndCount(@Nonnull BoltResult result, @Nonnull LinePrinter output) {
         String[] columns = result.getKeys().toArray(new String[0]);
         if (columns.length == 0) {
-            return;
+            return 0;
         }
 
         Iterator<Record> records = result.iterate();
-        formatResult(columns, records, output);
+        return formatResultAndCountRows(columns, records, output);
     }
 
     private List<Record> take(Iterator<Record> records, int count) {
@@ -42,9 +42,9 @@ private List<Record> take(Iterator<Record> records, int count) {
         return topRecords;
     }
 
-    private void formatResult(String[] columns,
-                              Iterator<Record> records,
-                              LinePrinter output) {
+    private int formatResultAndCountRows(String[] columns,
+                                         Iterator<Record> records,
+                                         LinePrinter output) {
 
         List<Record> topRecords = take(records, numSampleRows);
         int[] columnSizes = calculateColumnSizes(columns, topRecords);
@@ -63,13 +63,17 @@ private void formatResult(String[] columns,
         output.printOut(headerLine);
         output.printOut(dashes);
 
+        int numberOfRows = 0;
         for (Record record : topRecords) {
             output.printOut(formatRecord(builder, columnSizes, record));
+            numberOfRows++;
         }
         while (records.hasNext()) {
             output.printOut(formatRecord(builder, columnSizes, records.next()));
+            numberOfRows++;
         }
         output.printOut(dashes);
+        return numberOfRows;
     }
 
     private int[] calculateColumnSizes(@Nonnull String[] columns, @Nonnull List<Record> data) {
@@ -136,11 +140,10 @@ private String formatRow(StringBuilder sb, int[] columnSizes, String[] row) {
 
     @Override
     @Nonnull
-    public String formatFooter(@Nonnull BoltResult result) {
-        int rows = result.getRecords().size();
+    public String formatFooter(@Nonnull BoltResult result, int numberOfRows) {
         ResultSummary summary = result.getSummary();
         return String.format("%d row%s available after %d ms, " +
-                        "consumed after another %d ms", rows, rows != 1 ? "s" : "",
+                        "consumed after another %d ms", numberOfRows, numberOfRows != 1 ? "s" : "",
                 summary.resultAvailableAfter(MILLISECONDS),
                 summary.resultConsumedAfter(MILLISECONDS));
     }
@@ -155,7 +158,7 @@ public String formatInfo(@Nonnull ResultSummary summary) {
         String[] columns = info.keySet().toArray(new String[0]);
         StringBuilder sb = new StringBuilder();
         Record record = new InternalRecord(asList(columns), info.values().toArray(new Value[0]));
-        formatResult(columns, Collections.singletonList(record).iterator(), sb::append);
+        formatResultAndCountRows(columns, Collections.singletonList(record).iterator(), sb::append);
         return sb.toString();
     }
 

cypher-shell/src/test/java/org/neo4j/shell/prettyprint/TableOutputFormatterTest.java

@@ -2,23 +2,9 @@
 
 import org.hamcrest.CoreMatchers;
 import org.junit.Test;
-import org.neo4j.driver.internal.InternalIsoDuration;
-import org.neo4j.driver.internal.InternalNode;
-import org.neo4j.driver.internal.InternalPath;
-import org.neo4j.driver.internal.InternalPoint2D;
-import org.neo4j.driver.internal.InternalPoint3D;
-import org.neo4j.driver.internal.InternalRecord;
-import org.neo4j.driver.internal.InternalRelationship;
-import org.neo4j.driver.internal.value.DurationValue;
-import org.neo4j.driver.internal.value.NodeValue;
-import org.neo4j.driver.internal.value.PathValue;
-import org.neo4j.driver.internal.value.PointValue;
-import org.neo4j.driver.internal.value.RelationshipValue;
-import org.neo4j.driver.v1.Record;
-import org.neo4j.driver.v1.Statement;
-import org.neo4j.driver.v1.StatementResult;
-import org.neo4j.driver.v1.Value;
-import org.neo4j.driver.v1.Values;
+import org.neo4j.driver.internal.*;
+import org.neo4j.driver.internal.value.*;
+import org.neo4j.driver.v1.*;
 import org.neo4j.driver.v1.summary.ProfiledPlan;
 import org.neo4j.driver.v1.summary.ResultSummary;
 import org.neo4j.driver.v1.summary.StatementType;
@@ -288,7 +274,7 @@ public void wrapContent()
         StatementResult result = mockResult( asList( "c1"), "a", "bb","ccc","dddd","eeeee" );
         // WHEN
         ToStringLinePrinter printer = new ToStringLinePrinter();
-        new TableOutputFormatter(true, 2).format(new ListBoltResult(result.list(), result.summary()), printer);
+        new TableOutputFormatter(true, 2).formatAndCount(new ListBoltResult(result.list(), result.summary()), printer);
         String table = printer.result();
         // THEN
         assertThat(table, is(String.join(NEWLINE,
@@ -314,7 +300,7 @@ public void truncateContent()
         StatementResult result = mockResult( asList( "c1"), "a", "bb","ccc","dddd","eeeee" );
         // WHEN
         ToStringLinePrinter printer = new ToStringLinePrinter();
-        new TableOutputFormatter(false, 2).format(new ListBoltResult(result.list(), result.summary()), printer);
+        new TableOutputFormatter(false, 2).formatAndCount(new ListBoltResult(result.list(), result.summary()), printer);
         String table = printer.result();
         // THEN
         assertThat(table, is(String.join(NEWLINE,
@@ -360,7 +346,7 @@ public void formatEntities() {
 
     private String formatResult(StatementResult result) {
         ToStringLinePrinter printer = new ToStringLinePrinter();
-        new TableOutputFormatter(true, 1000).format(new ListBoltResult(result.list(), result.summary()), printer);
+        new TableOutputFormatter(true, 1000).formatAndCount(new ListBoltResult(result.list(), result.summary()), printer);
         return printer.result();
     }