Use LongStringClient.substring to get fulltext

After a brief discussion in #1015 (#1015 (comment)),
we decided that it'd be better to delegate client picking and invoking responsibilities
to the `ObjectInspector`, by passing the `LongStringClient` creator to it
(`WebConsoleClient.longString`).

Author: 2007heaven

packages/devtools-reps/src/object-inspector/actions.js

@@ -5,11 +5,11 @@
 // @flow
 
 import type {
+  CreateLongStringClient,
+  CreateObjectClient,
   GripProperties,
   LoadedProperties,
   Node,
-  ObjectClient,
-  RdpGrip,
   ReduxAction,
 } from "./types";
 
@@ -32,7 +32,8 @@ function nodeExpand(
   node : Node,
   actor?: string,
   loadedProperties : LoadedProperties,
-  createObjectClient : (RdpGrip) => ObjectClient
+  createObjectClient : CreateObjectClient,
+  createLongStringClient : CreateLongStringClient
 ) {
   return async ({dispatch} : ThunkArg) => {
     dispatch({
@@ -41,7 +42,8 @@ function nodeExpand(
     });
 
     if (!loadedProperties.has(node.path)) {
-      dispatch(nodeLoadProperties(node, actor, loadedProperties, createObjectClient));
+      dispatch(nodeLoadProperties(node, actor, loadedProperties, createObjectClient,
+        createLongStringClient));
     }
   };
 }
@@ -67,12 +69,14 @@ function nodeLoadProperties(
   item : Node,
   actor?: string,
   loadedProperties : LoadedProperties,
-  createObjectClient : (RdpGrip) => ObjectClient
+  createObjectClient : CreateObjectClient,
+  createLongStringClient : CreateLongStringClient
 ) {
   return async ({dispatch} : ThunkArg) => {
     try {
       const properties =
-        await loadItemProperties(item, createObjectClient, loadedProperties);
+        await loadItemProperties(item, createObjectClient, createLongStringClient,
+          loadedProperties);
       dispatch(nodePropertiesLoaded(item, actor, properties));
     } catch (e) {
       console.error(e);

packages/devtools-reps/src/object-inspector/component.js

@@ -178,6 +178,7 @@ class ObjectInspector extends Component {
 
     const {
       createObjectClient,
+      createLongStringClient,
       loadedProperties,
       nodeExpand,
       nodeCollapse,
@@ -192,7 +193,8 @@ class ObjectInspector extends Component {
         return rootValue && rootValue.actor === value.actor;
       });
       const actor = isRoot || !value ? null : value.actor;
-      nodeExpand(item, actor, loadedProperties, createObjectClient);
+      nodeExpand(item, actor, loadedProperties, createObjectClient,
+        createLongStringClient);
     } else {
       nodeCollapse(item);
     }

packages/devtools-reps/src/object-inspector/types.js

@@ -50,9 +50,23 @@ export type ObjectClient = {
   enumProperties: (options: Object) => Promise<PropertiesIterator>,
   enumSymbols: () => Promise<PropertiesIterator>,
   getPrototype: () => Promise<{prototype: Object}>,
-  getString: (object: NodeContents) => Promise<string | NodeContents>,
 };
 
+export type LongStringClient = {
+  substring: (
+    start: number,
+    end: number,
+    response: {
+      substring?: string,
+      error?: Error,
+      message?: string,
+    }) => void,
+}
+
+export type CreateObjectClient = (RdpGrip) => ObjectClient;
+
+export type CreateLongStringClient = (RdpGrip) => LongStringClient;
+
 export type CachedNodes = Map<Path, Array<Node>>;
 
 export type LoadedProperties = Map<Path, GripProperties>;
@@ -74,7 +88,8 @@ export type Props = {
   disableWrap: boolean,
   dimTopLevelWindow: boolean,
   releaseActor: string => void,
-  createObjectClient: RdpGrip => ObjectClient,
+  createObjectClient: CreateObjectClient,
+  createLongStringClient: CreateLongStringClient,
   onFocus: ?(Node) => any,
   onDoubleClick: ?(
     item: Node,

packages/devtools-reps/src/object-inspector/utils/client.js

@@ -7,7 +7,7 @@ import type {
   GripProperties,
   ObjectClient,
   PropertiesIterator,
-  NodeContents,
+  NodeContents, LongStringClient,
 } from "../types";
 
 async function enumIndexedProperties(
@@ -82,14 +82,25 @@ async function getPrototype(
 }
 
 async function getFullText(
-  objectClient: ObjectClient,
+  longStringClient: LongStringClient,
   object: NodeContents,
-) : Promise<?string | {}> {
-  if (typeof objectClient.getString !== "function") {
-    console.error("objectClient.getString is not a function");
-    return Promise.resolve({});
-  }
-  return objectClient.getString(object);
+) : Promise<?Object> {
+  const { initial, length } = object;
+
+  return new Promise((resolve, reject) => {
+    longStringClient.substring(initial.length, length, response => {
+      if (response.error) {
+        console.error("LongStringClient.substring",
+          response.error + ": " + response.message);
+        reject({});
+        return;
+      }
+
+      resolve({
+        fullText: initial + response.substring
+      });
+    });
+  });
 }
 
 function iteratorSlice(

packages/devtools-reps/src/object-inspector/utils/load-properties.js

@@ -29,16 +29,17 @@ const {
 } = require("./node");
 
 import type {
+  CreateLongStringClient,
+  CreateObjectClient,
   GripProperties,
   LoadedProperties,
   Node,
-  ObjectClient,
-  RdpGrip,
 } from "../types";
 
 function loadItemProperties(
   item : Node,
-  createObjectClient : (RdpGrip) => ObjectClient,
+  createObjectClient : CreateObjectClient,
+  createLongStringClient : CreateLongStringClient,
   loadedProperties : LoadedProperties,
 ) : Promise<GripProperties> {
   const gripItem = getClosestGripNode(item);
@@ -72,11 +73,8 @@ function loadItemProperties(
     promises.push(enumSymbols(getObjectClient(), start, end));
   }
 
-  if (shouldLoadFullText(item, loadedProperties)) {
-    promises.push(
-      getFullText(getObjectClient(), getValue(item))
-        .then(fullString => ({fullString}))
-    );
+  if (shouldLoadItemFullText(item, loadedProperties)) {
+    promises.push(getFullText(createLongStringClient(value), value));
   }
 
   return Promise.all(promises).then(mergeResponses);
@@ -99,7 +97,7 @@ function mergeResponses(responses: Array<Object>) : Object {
     }
 
     if (response.fullText) {
-      data.fullText = response.response;
+      data.fullText = response.fullText;
     }
   }
 
@@ -189,7 +187,10 @@ function shouldLoadItemSymbols(
     && !nodeIsProxy(item);
 }
 
-function shouldLoadFullText(item: Node, loadedProperties: LoadedProperties = new Map()) {
+function shouldLoadItemFullText(
+  item: Node,
+  loadedProperties: LoadedProperties = new Map()
+) {
   return !loadedProperties.has(item.path) && nodeIsLongString(item);
 }
 
@@ -201,5 +202,5 @@ module.exports = {
   shouldLoadItemNonIndexedProperties,
   shouldLoadItemPrototype,
   shouldLoadItemSymbols,
-  shouldLoadFullText
+  shouldLoadItemFullText
 };