Add a noGrip prop to force object to be rendered using non-remote reps.

nchevobbe · nchevobbe · commit 2d4546d1e29a · 2017-07-05T15:55:14.000+02:00
Modify the getRep and supportsObject functions so we can pass this noGrip
property to it.
Add tests in the Obj reps which try to render stubs representing different
remote object, with the noGrip prop, and makes sure it uses the Obj rep,
and not the "remote" one.
diff --git a/packages/devtools-reps/src/reps/attribute.js b/packages/devtools-reps/src/reps/attribute.js
@@ -48,8 +48,8 @@ function getTitle(grip) {
 }
 
 // Registration
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/comment-node.js b/packages/devtools-reps/src/reps/comment-node.js
@@ -42,8 +42,8 @@ function CommentNode(props) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
   return object.preview && object.preview.nodeType === nodeConstants.COMMENT_NODE;
diff --git a/packages/devtools-reps/src/reps/date-time.js b/packages/devtools-reps/src/reps/date-time.js
@@ -45,8 +45,8 @@ function getTitle(props, grip) {
 }
 
 // Registration
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/document.js b/packages/devtools-reps/src/reps/document.js
@@ -47,8 +47,8 @@ function getTitle(props, grip) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/element-node.js b/packages/devtools-reps/src/reps/element-node.js
@@ -130,8 +130,8 @@ function getElements(grip, mode) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
   return object.preview && object.preview.nodeType === nodeConstants.ELEMENT_NODE;
diff --git a/packages/devtools-reps/src/reps/error.js b/packages/devtools-reps/src/reps/error.js
@@ -46,8 +46,8 @@ function ErrorRep(props) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
   return (object.preview && type === "Error");
diff --git a/packages/devtools-reps/src/reps/event.js b/packages/devtools-reps/src/reps/event.js
@@ -87,8 +87,8 @@ function getTitle(props) {
 }
 
 // Registration
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/function.js b/packages/devtools-reps/src/reps/function.js
@@ -75,8 +75,8 @@ function renderParams(props) {
 }
 
 // Registration
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return (type == "function");
   }
 
diff --git a/packages/devtools-reps/src/reps/grip-array.js b/packages/devtools-reps/src/reps/grip-array.js
@@ -185,8 +185,8 @@ function getEmptySlotsElement(number) {
   return `<${number} empty slot${number > 1 ? "s" : ""}>`;
 }
 
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/grip-map.js b/packages/devtools-reps/src/reps/grip-map.js
@@ -192,8 +192,8 @@ function getEntriesIndexes(entries, max, filter) {
     }, []);
 }
 
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
   return (grip.preview && grip.preview.kind == "MapLike");
diff --git a/packages/devtools-reps/src/reps/grip.js b/packages/devtools-reps/src/reps/grip.js
@@ -31,6 +31,7 @@ GripRep.propTypes = {
   onDOMNodeMouseOver: React.PropTypes.func,
   onDOMNodeMouseOut: React.PropTypes.func,
   onInspectIconClick: React.PropTypes.func,
+  noGrip: React.PropTypes.bool,
 };
 
 function GripRep(props) {
@@ -242,8 +243,8 @@ function getPropValue(property) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
   return (object.preview && object.preview.ownProperties);
diff --git a/packages/devtools-reps/src/reps/long-string.js b/packages/devtools-reps/src/reps/long-string.js
@@ -53,8 +53,8 @@ function LongStringRep(props) {
   return span(config, formattedString);
 }
 
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
   return object.type === "longString";
diff --git a/packages/devtools-reps/src/reps/null.js b/packages/devtools-reps/src/reps/null.js
@@ -21,7 +21,11 @@ function Null(props) {
   );
 }
 
-function supportsObject(object, type) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true) {
+    return false;
+  }
+
   if (object && object.type && object.type == "null") {
     return true;
   }
diff --git a/packages/devtools-reps/src/reps/object-with-text.js b/packages/devtools-reps/src/reps/object-with-text.js
@@ -52,8 +52,8 @@ function getDescription(grip) {
 }
 
 // Registration
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/object-with-url.js b/packages/devtools-reps/src/reps/object-with-url.js
@@ -47,8 +47,8 @@ function getDescription(grip) {
 }
 
 // Registration
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/promise.js b/packages/devtools-reps/src/reps/promise.js
@@ -96,8 +96,8 @@ function getProps(props, promiseState) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
   return type === "Promise";
diff --git a/packages/devtools-reps/src/reps/regexp.js b/packages/devtools-reps/src/reps/regexp.js
@@ -35,8 +35,8 @@ function getSource(grip) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/rep.js b/packages/devtools-reps/src/reps/rep.js
@@ -80,7 +80,7 @@ const Rep = function (props) {
     object,
     defaultRep,
   } = props;
-  let rep = getRep(object, defaultRep);
+  let rep = getRep(object, defaultRep, props.noGrip);
   return rep(props);
 };
 
@@ -96,12 +96,14 @@ const Rep = function (props) {
  *
  * @param defaultObject {React.Component} The default template
  * that should be used to render given object if none is found.
+ *
+ * @param noGrip {Boolean} If true, will only check reps not made for remote objects.
  */
-function getRep(object, defaultRep = Obj) {
+function getRep(object, defaultRep = Obj, noGrip = false) {
   let type = typeof object;
   if (type == "object" && object instanceof String) {
     type = "string";
-  } else if (object && type == "object" && object.type) {
+  } else if (object && type == "object" && object.type && noGrip !== true) {
     type = object.type;
   }
 
@@ -115,7 +117,7 @@ function getRep(object, defaultRep = Obj) {
       // supportsObject could return weight (not only true/false
       // but a number), which would allow to priorities templates and
       // support better extensibility.
-      if (rep.supportsObject(object, type)) {
+      if (rep.supportsObject(object, type, noGrip)) {
         return rep.rep;
       }
     } catch (err) {
diff --git a/packages/devtools-reps/src/reps/stylesheet.js b/packages/devtools-reps/src/reps/stylesheet.js
@@ -47,8 +47,8 @@ function getLocation(grip) {
 }
 
 // Registration
-function supportsObject(object, type) {
-  if (!isGrip(object)) {
+function supportsObject(object, type, noGrip = false) {
+  if (noGrip === true || !isGrip(object)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/tests/object.js b/packages/devtools-reps/src/reps/tests/object.js
@@ -191,3 +191,140 @@ describe("Object - Object link", () => {
       .toEqual(defaultOutput);
   });
 });
+
+// Test that object that might look like Grips are rendered as Object when passed
+// the `noGrip` property.
+describe("Object - noGrip prop", () => {
+  it("object with type property", () => {
+    expect(getRep({type: "string"}, undefined, true)).toBe(Obj.rep);
+  });
+
+  it("object with actor property", () => {
+    expect(getRep({actor: "fake/actorId"}, undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Attribute grip", () => {
+    const stubs = require("../stubs/attribute");
+    expect(getRep(stubs.get("Attribute"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("CommentNode grip", () => {
+    const stubs = require("../stubs/comment-node");
+    expect(getRep(stubs.get("Comment"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("DateTime grip", () => {
+    const stubs = require("../stubs/date-time");
+    expect(getRep(stubs.get("DateTime"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Document grip", () => {
+    const stubs = require("../stubs/document");
+    expect(getRep(stubs.get("Document"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("ElementNode grip", () => {
+    const stubs = require("../stubs/element-node");
+    expect(getRep(stubs.get("BodyNode"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Error grip", () => {
+    const stubs = require("../stubs/error");
+    expect(getRep(stubs.get("SimpleError"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Event grip", () => {
+    const stubs = require("../stubs/event");
+    expect(getRep(stubs.get("testEvent"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Function grip", () => {
+    const stubs = require("../stubs/function");
+    expect(getRep(stubs.get("Named"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Array grip", () => {
+    const stubs = require("../stubs/grip-array");
+    expect(getRep(stubs.get("testMaxProps"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Map grip", () => {
+    const stubs = require("../stubs/grip-map");
+    expect(getRep(stubs.get("testSymbolKeyedMap"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Object grip", () => {
+    const stubs = require("../stubs/grip");
+    expect(getRep(stubs.get("testMaxProps"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Infinity grip", () => {
+    const stubs = require("../stubs/infinity");
+    expect(getRep(stubs.get("Infinity"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("LongString grip", () => {
+    const stubs = require("../stubs/long-string");
+    expect(getRep(stubs.get("testMultiline"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("NaN grip", () => {
+    const stubs = require("../stubs/nan");
+    expect(getRep(stubs.get("NaN"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Null grip", () => {
+    const stubs = require("../stubs/null");
+    expect(getRep(stubs.get("Null"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Number grip", () => {
+    const stubs = require("../stubs/number");
+    expect(getRep(stubs.get("NegZeroGrip"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("ObjectWithText grip", () => {
+    const stubs = require("../stubs/object-with-text");
+    expect(getRep(stubs.get("ObjectWithText"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("ObjectWithURL grip", () => {
+    const stubs = require("../stubs/object-with-url");
+    expect(getRep(stubs.get("ObjectWithUrl"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Promise grip", () => {
+    const stubs = require("../stubs/promise");
+    expect(getRep(stubs.get("Pending"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("RegExp grip", () => {
+    const stubs = require("../stubs/regexp");
+    expect(getRep(stubs.get("RegExp"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Stylesheet grip", () => {
+    const stubs = require("../stubs/stylesheet");
+    expect(getRep(stubs.get("StyleSheet"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Symbol grip", () => {
+    const stubs = require("../stubs/symbol");
+    expect(getRep(stubs.get("Symbol"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("TextNode grip", () => {
+    const stubs = require("../stubs/text-node");
+    expect(getRep(stubs.get("testRendering"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Undefined grip", () => {
+    const stubs = require("../stubs/undefined");
+    expect(getRep(stubs.get("Undefined"), undefined, true)).toBe(Obj.rep);
+  });
+
+  it("Window grip", () => {
+    const stubs = require("../stubs/window");
+    expect(getRep(stubs.get("Window"), undefined, true)).toBe(Obj.rep);
+  });
+});
diff --git a/packages/devtools-reps/src/reps/text-node.js b/packages/devtools-reps/src/reps/text-node.js
@@ -94,8 +94,8 @@ function getTitle(props, grip) {
 }
 
 // Registration
-function supportsObject(grip, type) {
-  if (!isGrip(grip)) {
+function supportsObject(grip, type, noGrip = false) {
+  if (noGrip === true || !isGrip(grip)) {
     return false;
   }
 
diff --git a/packages/devtools-reps/src/reps/undefined.js b/packages/devtools-reps/src/reps/undefined.js
diff --git a/packages/devtools-reps/src/reps/window.js b/packages/devtools-reps/src/reps/window.js

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@ function getTitle(grip) {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`// Registration`
`51`		`-function supportsObject(grip, type) {`
`52`		`- if (!isGrip(grip)) {`
	`51`	`+function supportsObject(grip, type, noGrip = false) {`
	`52`	`+ if (noGrip === true \|\| !isGrip(grip)) {`
`53`	`53`	`return false;`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,8 @@ function CommentNode(props) {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`// Registration`
`45`		`-function supportsObject(object, type) {`
`46`		`- if (!isGrip(object)) {`
	`45`	`+function supportsObject(object, type, noGrip = false) {`
	`46`	`+ if (noGrip === true \|\| !isGrip(object)) {`
`47`	`47`	`return false;`
`48`	`48`	`}`
`49`	`49`	`return object.preview && object.preview.nodeType === nodeConstants.COMMENT_NODE;`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,8 @@ function getTitle(props, grip) {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`// Registration`
`48`		`-function supportsObject(grip, type) {`
`49`		`- if (!isGrip(grip)) {`
	`48`	`+function supportsObject(grip, type, noGrip = false) {`
	`49`	`+ if (noGrip === true \|\| !isGrip(grip)) {`
`50`	`50`	`return false;`
`51`	`51`	`}`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -47,8 +47,8 @@ function getTitle(props, grip) {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`// Registration`
`50`		`-function supportsObject(object, type) {`
`51`		`- if (!isGrip(object)) {`
	`50`	`+function supportsObject(object, type, noGrip = false) {`
	`51`	`+ if (noGrip === true \|\| !isGrip(object)) {`
`52`	`52`	`return false;`
`53`	`53`	`}`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -130,8 +130,8 @@ function getElements(grip, mode) {`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`// Registration`
`133`		`-function supportsObject(object, type) {`
`134`		`- if (!isGrip(object)) {`
	`133`	`+function supportsObject(object, type, noGrip = false) {`
	`134`	`+ if (noGrip === true \|\| !isGrip(object)) {`
`135`	`135`	`return false;`
`136`	`136`	`}`
`137`	`137`	`return object.preview && object.preview.nodeType === nodeConstants.ELEMENT_NODE;`
Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ function ErrorRep(props) {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`// Registration`
`49`		`-function supportsObject(object, type) {`
`50`		`- if (!isGrip(object)) {`
	`49`	`+function supportsObject(object, type, noGrip = false) {`
	`50`	`+ if (noGrip === true \|\| !isGrip(object)) {`
`51`	`51`	`return false;`
`52`	`52`	`}`
`53`	`53`	`return (object.preview && type === "Error");`
Original file line number	Diff line number	Diff line change
`@@ -87,8 +87,8 @@ function getTitle(props) {`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`// Registration`
`90`		`-function supportsObject(grip, type) {`
`91`		`- if (!isGrip(grip)) {`
	`90`	`+function supportsObject(grip, type, noGrip = false) {`
	`91`	`+ if (noGrip === true \|\| !isGrip(grip)) {`
`92`	`92`	`return false;`
`93`	`93`	`}`
`94`	`94`
Original file line number	Diff line number	Diff line change
`@@ -75,8 +75,8 @@ function renderParams(props) {`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`// Registration`
`78`		`-function supportsObject(grip, type) {`
`79`		`- if (!isGrip(grip)) {`
	`78`	`+function supportsObject(grip, type, noGrip = false) {`
	`79`	`+ if (noGrip === true \|\| !isGrip(grip)) {`
`80`	`80`	`return (type == "function");`
`81`	`81`	`}`
`82`	`82`
Original file line number	Diff line number	Diff line change
`@@ -185,8 +185,8 @@ function getEmptySlotsElement(number) {`
`185`	`185`	return `<${number} empty slot${number > 1 ? "s" : ""}>`;
`186`	`186`	`}`
`187`	`187`
`188`		`-function supportsObject(grip, type) {`
`189`		`- if (!isGrip(grip)) {`
	`188`	`+function supportsObject(grip, type, noGrip = false) {`
	`189`	`+ if (noGrip === true \|\| !isGrip(grip)) {`
`190`	`190`	`return false;`
`191`	`191`	`}`
`192`	`192`
Original file line number	Diff line number	Diff line change
`@@ -192,8 +192,8 @@ function getEntriesIndexes(entries, max, filter) {`
`192`	`192`	`}, []);`
`193`	`193`	`}`
`194`	`194`
`195`		`-function supportsObject(grip, type) {`
`196`		`- if (!isGrip(grip)) {`
	`195`	`+function supportsObject(grip, type, noGrip = false) {`
	`196`	`+ if (noGrip === true \|\| !isGrip(grip)) {`
`197`	`197`	`return false;`
`198`	`198`	`}`
`199`	`199`	`return (grip.preview && grip.preview.kind == "MapLike");`