Merge pull request #679 from bserdar/678

dcrissman · web-flow · commit 282643beaa9b · 2016-08-05T08:54:57.000-04:00
Fix #678: explain plan descends using toJson, not explain
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Assemble.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Assemble.java
@@ -187,24 +187,34 @@ public void commit() {
             queries = new ArrayList<>();
         }
     }
-
-    @Override
-    public JsonNode toJson() {
+    
+    private JsonNode toJson(Step.ToJsonCb<Step> scb,Step.ToJsonCb<ExecutionBlock> bcb) {
         ObjectNode o = JsonNodeFactory.instance.objectNode();
         ObjectNode a = JsonNodeFactory.instance.objectNode();
         o.set("assemble", a);
         a.set("entity", JsonNodeFactory.instance.textNode(block.getMetadata().getName()));
-        a.set("left", source.getStep().toJson());
+        a.set("left", scb.toJson(source.getStep()));
         ArrayNode array = JsonNodeFactory.instance.arrayNode();
         a.set("right", array);
         for (ExecutionBlock b : destinationBlocks) {
             ObjectNode detail=JsonNodeFactory.instance.objectNode();
             AssociationQuery aq = b.getAssociationQueryForEdge(block);
             detail.set("associationQuery",aq.getQuery().toJson());
-            detail.set("source",b.toJson());
+            detail.set("source",bcb.toJson(b));
             array.add(detail);
         }
         return o;
     }
 
+    @Override
+    public JsonNode toJson() {
+        return toJson(Step::toJson,ExecutionBlock::toJson);
+    }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        return toJson(s->{return s.explain(ctx);},
+                      t->{return t.explain(ctx);});
+    }
+
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Copy.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Copy.java
@@ -65,4 +65,11 @@ public JsonNode toJson() {
         node.set("copy", source.getStep().toJson());
         return node;
     }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        ObjectNode node = JsonNodeFactory.instance.objectNode();
+        node.set("copy", source.getStep().explain(ctx));
+        return node;
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/ExecutionBlock.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/ExecutionBlock.java
@@ -235,4 +235,8 @@ public String toString() {
     public JsonNode toJson() {
         return resultStep.toJson();
     }
+
+    public JsonNode explain(ExecutionContext ctx) {
+        return resultStep.explain(ctx);
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Filter.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Filter.java
@@ -60,4 +60,12 @@ public JsonNode toJson() {
         o.set("source", source.getStep().toJson());
         return o;
     }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        ObjectNode o = JsonNodeFactory.instance.objectNode();
+        o.set("filter", q.toJson());
+        o.set("source", source.getStep().explain(ctx));
+        return o;
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Join.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Join.java
@@ -226,14 +226,23 @@ private void computeJoinTuples() {
         }
     }
 
-    @Override
-    public JsonNode toJson() {
+    private JsonNode toJson(ToJsonCb<Step> cb) {
         ObjectNode o = JsonNodeFactory.instance.objectNode();
         ArrayNode arr = JsonNodeFactory.instance.arrayNode();
         for (Source<ResultDocument> s : sources) {
-            arr.add(s.getStep().toJson());
+            arr.add(cb.toJson(s.getStep()));
         }
         o.set("join", arr);
         return o;
     }
+
+    @Override
+    public JsonNode toJson() {
+        return toJson(Step::toJson);
+    }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        return toJson(s->{return s.explain(ctx);});
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/JoinSearch.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/JoinSearch.java
@@ -124,4 +124,26 @@ public JsonNode toJson() {
         }
         return o;
     }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        ObjectNode o = JsonNodeFactory.instance.objectNode();
+        o.set("join-search", source.getStep().explain(ctx));
+        if (query != null) {
+            o.set("query", query.toJson());
+        }
+        if (projection != null) {
+            o.set("projection", projection.toJson());
+        }
+        if (sort != null) {
+            o.set("sort", sort.toJson());
+        }
+        if (from != null) {
+            o.set("from", JsonNodeFactory.instance.numberNode(from));
+        }
+        if (to != null) {
+            o.set("to", JsonNodeFactory.instance.numberNode(to));
+        }
+        return o;
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Limit.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Limit.java
@@ -55,4 +55,12 @@ public JsonNode toJson() {
         o.set("source", source.getStep().toJson());
         return o;
     }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        ObjectNode o = JsonNodeFactory.instance.objectNode();
+        o.set("limit", JsonNodeFactory.instance.numberNode(limit));
+        o.set("source", source.getStep().explain(ctx));
+        return o;
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Project.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Project.java
@@ -60,4 +60,13 @@ public JsonNode toJson() {
         o.set("source", source.getStep().toJson());
         return o;
     }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        ObjectNode o = JsonNodeFactory.instance.objectNode();
+        o.set("project", projection.toJson());
+        o.set("source", source.getStep().explain(ctx));
+        return o;
+    }
+
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Skip.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Skip.java
@@ -58,4 +58,12 @@ public JsonNode toJson() {
         o.set("source", source.getStep().toJson());
         return o;
     }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        ObjectNode o = JsonNodeFactory.instance.objectNode();
+        o.set("skip", JsonNodeFactory.instance.numberNode(skip));
+        o.set("source", source.getStep().explain(ctx));
+        return o;
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/SortResults.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/SortResults.java
@@ -78,4 +78,12 @@ public JsonNode toJson() {
         o.set("source", source.getStep().toJson());
         return o;
     }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        ObjectNode o = JsonNodeFactory.instance.objectNode();
+        o.set("sort", sort.toJson());
+        o.set("source", source.getStep().explain(ctx));
+        return o;
+    }
 }
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Step.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Step.java
@@ -33,6 +33,10 @@ public abstract class Step<R> {
 
     protected final ExecutionBlock block;
 
+    public interface ToJsonCb<T> {
+        JsonNode toJson(T t);
+    }
+
     public Step(ExecutionBlock block) {
         this.block = block;
         block.registerStep(this);
@@ -48,9 +52,7 @@ public Step(ExecutionBlock block) {
     public void initialize() {
     }
 
-    public JsonNode explain(ExecutionContext ctx) {
-        return toJson();
-    }
+    public abstract JsonNode explain(ExecutionContext ctx);
 
     /**
      * Returns the associated block of this step
diff --git a/crud/src/main/java/com/redhat/lightblue/assoc/ep/Unique.java b/crud/src/main/java/com/redhat/lightblue/assoc/ep/Unique.java
@@ -65,15 +65,24 @@ public boolean test(ResultDocument doc) {
         };
     }
 
-    @Override
-    public JsonNode toJson() {
+    private JsonNode toJson(ToJsonCb<Step> cb) {
         ObjectNode o = JsonNodeFactory.instance.objectNode();
         ArrayNode arr = JsonNodeFactory.instance.arrayNode();
         for (Path p : idx.getIdentityFields()) {
             arr.add(JsonNodeFactory.instance.textNode(p.toString()));
         }
         o.set("unique", arr);
-        o.set("source", source.getStep().toJson());
+        o.set("source", cb.toJson(source.getStep()));
         return o;
     }
+
+    @Override
+    public JsonNode toJson() {
+        return toJson(Step::toJson);
+    }
+
+    @Override
+    public JsonNode explain(ExecutionContext ctx) {
+        return toJson(s->{return s.explain(ctx);});
+    }
 }
diff --git a/crud/src/test/java/com/redhat/lightblue/assoc/ep/JoinTest.java b/crud/src/test/java/com/redhat/lightblue/assoc/ep/JoinTest.java
@@ -107,6 +107,9 @@ public Stream<ResultDocument> stream() {
         public JsonNode toJson() {
             return null;
         }
+        public JsonNode explain(ExecutionContext ctx) {
+            return null;
+        }
     }
 
     private Projection projection(String s) throws Exception {
diff --git a/crud/src/test/java/com/redhat/lightblue/assoc/ep/SearchesTest.java b/crud/src/test/java/com/redhat/lightblue/assoc/ep/SearchesTest.java
@@ -106,6 +106,9 @@ public Stream<ResultDocument> stream() {
         public JsonNode toJson() {
             return null;
         }
+        public JsonNode explain(ExecutionContext ctx) {
+            return null;
+        }
     }
 
     private Projection projection(String s) throws Exception {
diff --git a/crud/src/test/java/com/redhat/lightblue/mediator/CompositeFinderTest.java b/crud/src/test/java/com/redhat/lightblue/mediator/CompositeFinderTest.java
@@ -50,6 +50,7 @@
 import com.redhat.lightblue.crud.UpdateRequest;
 import com.redhat.lightblue.crud.DeleteRequest;
 import com.redhat.lightblue.crud.CRUDDeleteResponse;
+import com.redhat.lightblue.crud.ExplainQuerySupport;
 import com.redhat.lightblue.crud.validator.DefaultFieldConstraintValidators;
 import com.redhat.lightblue.crud.validator.EmptyEntityConstraintValidators;
 
@@ -124,7 +125,7 @@ private static OperationContext getLastContext(Mediator m) {
         return ((TestMediator) m).ctx;
     }
 
-    private class CompositeTestCrudController extends TestCrudController {
+    private class CompositeTestCrudController extends TestCrudController implements ExplainQuerySupport {
         public CompositeTestCrudController(TestCrudController.GetData gd) {
             super(gd);
         }
@@ -160,6 +161,16 @@ public CRUDFindResponse find(CRUDOperationContext ctx,
                 return super.find(ctx, query, projection, sort, from, to);
             }
         }
+        @Override
+        public void explain(CRUDOperationContext ctx,
+                            QueryExpression query,
+                            Projection projection,
+                            Sort sort,
+                            Long from,
+                            Long to,
+                            JsonDoc destDoc) {
+            destDoc.modify(new Path("testController"),JsonNodeFactory.instance.textNode("test"),true);
+        }
     }
 
     @Before
@@ -349,6 +360,21 @@ public void retrieveAandConly_CFirst_range() throws Exception {
         Assert.assertEquals(1, response.getEntityData().size());
     }
 
+    @Test
+    public void retrieveAandConly_CFirst_range_explain() throws Exception {
+        FindRequest fr = new FindRequest();
+        fr.setQuery(query("{'field':'obj1.c.*.objectType','op':'=','rvalue':'C'}"));
+        fr.setProjection(projection("[{'field':'*','recursive':1},{'field':'obj1.c'}]"));
+        fr.setFrom(0l);
+        fr.setTo(0l);
+        fr.setEntityVersion(new EntityVersion("A", "1.0.0"));
+        Response response = mediator.explain(fr);
+        Assert.assertEquals(1, response.getEntityData().size());
+        JsonNode doc=response.getEntityData().get(0);
+        // Make sure explain descends all the way to the  controller
+        Assert.assertTrue(doc.toString().indexOf("testController")!=-1);
+    }
+
     @Test
     public void retrieveAandBonly_2q() throws Exception {
         FindRequest fr = new FindRequest();

Original file line number	Diff line number	Diff line change
`@@ -65,4 +65,11 @@ public JsonNode toJson() {`
`65`	`65`	`node.set("copy", source.getStep().toJson());`
`66`	`66`	`return node;`
`67`	`67`	`}`
	`68`	`+`
	`69`	`+ @Override`
	`70`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`71`	`+ ObjectNode node = JsonNodeFactory.instance.objectNode();`
	`72`	`+ node.set("copy", source.getStep().explain(ctx));`
	`73`	`+ return node;`
	`74`	`+ }`
`68`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -235,4 +235,8 @@ public String toString() {`
`235`	`235`	`public JsonNode toJson() {`
`236`	`236`	`return resultStep.toJson();`
`237`	`237`	`}`
	`238`	`+`
	`239`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`240`	`+ return resultStep.explain(ctx);`
	`241`	`+ }`
`238`	`242`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,4 +60,12 @@ public JsonNode toJson() {`
`60`	`60`	`o.set("source", source.getStep().toJson());`
`61`	`61`	`return o;`
`62`	`62`	`}`
	`63`	`+`
	`64`	`+ @Override`
	`65`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`66`	`+ ObjectNode o = JsonNodeFactory.instance.objectNode();`
	`67`	`+ o.set("filter", q.toJson());`
	`68`	`+ o.set("source", source.getStep().explain(ctx));`
	`69`	`+ return o;`
	`70`	`+ }`
`63`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -226,14 +226,23 @@ private void computeJoinTuples() {`
`226`	`226`	`}`
`227`	`227`	`}`
`228`	`228`
`229`		`- @Override`
`230`		`- public JsonNode toJson() {`
	`229`	`+ private JsonNode toJson(ToJsonCb<Step> cb) {`
`231`	`230`	`ObjectNode o = JsonNodeFactory.instance.objectNode();`
`232`	`231`	`ArrayNode arr = JsonNodeFactory.instance.arrayNode();`
`233`	`232`	`for (Source<ResultDocument> s : sources) {`
`234`		`- arr.add(s.getStep().toJson());`
	`233`	`+ arr.add(cb.toJson(s.getStep()));`
`235`	`234`	`}`
`236`	`235`	`o.set("join", arr);`
`237`	`236`	`return o;`
`238`	`237`	`}`
	`238`	`+`
	`239`	`+ @Override`
	`240`	`+ public JsonNode toJson() {`
	`241`	`+ return toJson(Step::toJson);`
	`242`	`+ }`
	`243`	`+`
	`244`	`+ @Override`
	`245`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`246`	`+ return toJson(s->{return s.explain(ctx);});`
	`247`	`+ }`
`239`	`248`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,12 @@ public JsonNode toJson() {`
`55`	`55`	`o.set("source", source.getStep().toJson());`
`56`	`56`	`return o;`
`57`	`57`	`}`
	`58`	`+`
	`59`	`+ @Override`
	`60`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`61`	`+ ObjectNode o = JsonNodeFactory.instance.objectNode();`
	`62`	`+ o.set("limit", JsonNodeFactory.instance.numberNode(limit));`
	`63`	`+ o.set("source", source.getStep().explain(ctx));`
	`64`	`+ return o;`
	`65`	`+ }`
`58`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,4 +60,13 @@ public JsonNode toJson() {`
`60`	`60`	`o.set("source", source.getStep().toJson());`
`61`	`61`	`return o;`
`62`	`62`	`}`
	`63`	`+`
	`64`	`+ @Override`
	`65`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`66`	`+ ObjectNode o = JsonNodeFactory.instance.objectNode();`
	`67`	`+ o.set("project", projection.toJson());`
	`68`	`+ o.set("source", source.getStep().explain(ctx));`
	`69`	`+ return o;`
	`70`	`+ }`
	`71`	`+`
`63`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,4 +58,12 @@ public JsonNode toJson() {`
`58`	`58`	`o.set("source", source.getStep().toJson());`
`59`	`59`	`return o;`
`60`	`60`	`}`
	`61`	`+`
	`62`	`+ @Override`
	`63`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`64`	`+ ObjectNode o = JsonNodeFactory.instance.objectNode();`
	`65`	`+ o.set("skip", JsonNodeFactory.instance.numberNode(skip));`
	`66`	`+ o.set("source", source.getStep().explain(ctx));`
	`67`	`+ return o;`
	`68`	`+ }`
`61`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,4 +78,12 @@ public JsonNode toJson() {`
`78`	`78`	`o.set("source", source.getStep().toJson());`
`79`	`79`	`return o;`
`80`	`80`	`}`
	`81`	`+`
	`82`	`+ @Override`
	`83`	`+ public JsonNode explain(ExecutionContext ctx) {`
	`84`	`+ ObjectNode o = JsonNodeFactory.instance.objectNode();`
	`85`	`+ o.set("sort", sort.toJson());`
	`86`	`+ o.set("source", source.getStep().explain(ctx));`
	`87`	`+ return o;`
	`88`	`+ }`
`81`	`89`	`}`