Devtools:[CustomFormatter] Allow object tags in headers

Source/core/inspector/InjectedScriptSource.js

 /*
  * Copyright (C) 2007 Apple Inc.  All rights reserved.
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 353 matching lines @@
 
     /**
      * This method cannot throw.
      * @param {*} object
      * @param {string=} objectGroupName
      * @param {boolean=} forceValueType
      * @param {boolean=} generatePreview
      * @param {?Array.<string>=} columnNames
      * @param {boolean=} isTable
      * @param {boolean=} doNotBind
+     * @param {*=} customObjectConfig
      * @return {!RuntimeAgent.RemoteObject}
      * @suppress {checkTypes}
      */
-    _wrapObject: function(object, objectGroupName, forceValueType, generatePreview, columnNames, isTable, doNotBind)
+    _wrapObject: function(object, objectGroupName, forceValueType, generatePreview, columnNames, isTable, doNotBind, customObjectConfig)
     {
         try {
-            return new InjectedScript.RemoteObject(object, objectGroupName, doNotBind, forceValueType, generatePreview, columnNames, isTable, undefined);
+            return new InjectedScript.RemoteObject(object, objectGroupName, doNotBind, forceValueType, generatePreview, columnNames, isTable, undefined, customObjectConfig);
         } catch (e) {
             try {
                 var description = injectedScript._describe(e);
             } catch (ex) {
                 var description = "<failed to convert exception to string>";
             }
             return new InjectedScript.RemoteObject(description);
         }
     },
 
@@ skipping 331 matching lines @@
 
         var objectGroup = InjectedScriptHost.idToObjectGroupName(parsedObjectId.id);
 
         /**
          * @suppressReceiverCheck
          * @param {*} object
          * @param {boolean=} forceValueType
          * @param {boolean=} generatePreview
          * @param {?Array.<string>=} columnNames
          * @param {boolean=} isTable
+         * @param {*=} customObjectConfig
          * @return {!RuntimeAgent.RemoteObject}
          * @this {InjectedScript}
          */
-        function wrap(object, forceValueType, generatePreview, columnNames, isTable)
+        function wrap(object, forceValueType, generatePreview, columnNames, isTable, customObjectConfig)
         {
-            return this._wrapObject(object, objectGroup, forceValueType, generatePreview, columnNames, isTable);
+            return this._wrapObject(object, objectGroup, forceValueType, generatePreview, columnNames, isTable, false, customObjectConfig);
         }
 
         try {
 
             var remoteObjectAPI = { bindRemoteObject: bind(wrap, this), __proto__: null};
             InjectedScriptHost.setNonEnumProperty(inspectedWindow, "__remoteObjectAPI", remoteObjectAPI);
 
             var func = InjectedScriptHost.eval("with (typeof __remoteObjectAPI !== 'undefined' ? __remoteObjectAPI : { __proto__: null }) {(" + expression + ")}");
             if (typeof func !== "function")
                 return "Given expression does not evaluate to a function";
 
             return { wasThrown: false,
                      result: this._wrapObject(InjectedScriptHost.callFunction(func, object, resolvedArgs), objectGroup, returnByValue),
                      __proto__: null };
         } catch (e) {
             return this._createThrownValue(e, objectGroup, false);
         } finally {
             try {
                 delete inspectedWindow["__remoteObjectAPI"];
             } catch(e) {
             }
         }
     },
 
     /**
      * @param {string|undefined} objectGroupName
      * @param {*} jsonMLObject
      * @throws {string} error message
      */
-    _checkObjectTagsInCustomPreview: function(objectGroupName, jsonMLObject)
+    _substituteObjectTagsInCustomPreview: function(objectGroupName, jsonMLObject)
     {
-        if (!isArrayLike(jsonMLObject))
-            return;
+        var maxCustomPreviewRecursionDepth = 20;
+        this._customPreviewRecursionDepth = (this._customPreviewRecursionDepth || 0) + 1
+        try {
+            if (this._customPreviewRecursionDepth >= maxCustomPreviewRecursionDepth)
+                throw new Error("Too deep hierarchy of inlined custom previews");
 
-        if (jsonMLObject[0] === "object")
-            throw "Illegal format: object tag is forbidden in header";
+            if (!isArrayLike(jsonMLObject))
+                return;
 
-        for (var i = 0; i < jsonMLObject.length; ++i)
-            this._checkObjectTagsInCustomPreview(objectGroupName, jsonMLObject[i]);
+            if (jsonMLObject[0] === "object") {
+                var attributes = jsonMLObject[1];
+                var originObject = attributes["object"];
+                var config = attributes["config"];
+                if (typeof originObject === "undefined")
+                    throw new Error("Illegal format: obligatory attribute \"object\" isn't specified");
+
+                jsonMLObject[1] = this._wrapObject(originObject, objectGroupName, false, false, null, false, false, config);
+                return;
+            }
+
+            for (var i = 0; i < jsonMLObject.length; ++i)
+                this._substituteObjectTagsInCustomPreview(objectGroupName, jsonMLObject[i]);
+        } finally {
+            this._customPreviewRecursionDepth--;
+        }
     },
 
     /**
      * Resolves a value from CallArgument description.
      * @param {!RuntimeAgent.CallArgument} callArgumentJson
      * @return {*} resolved value
      * @throws {string} error message
      */
     _resolveCallArgument: function(callArgumentJson)
     {
@@ skipping 439 matching lines @@
 /**
  * @constructor
  * @param {*} object
  * @param {string=} objectGroupName
  * @param {boolean=} doNotBind
  * @param {boolean=} forceValueType
  * @param {boolean=} generatePreview
  * @param {?Array.<string>=} columnNames
  * @param {boolean=} isTable
  * @param {boolean=} skipEntriesPreview
+ * @param {*=} customObjectConfig
  */
-InjectedScript.RemoteObject = function(object, objectGroupName, doNotBind, forceValueType, generatePreview, columnNames, isTable, skipEntriesPreview)
+InjectedScript.RemoteObject = function(object, objectGroupName, doNotBind, forceValueType, generatePreview, columnNames, isTable, skipEntriesPreview, customObjectConfig)
 {
     this.type = typeof object;
     if (this.type === "undefined" && injectedScript._isHTMLAllCollection(object))
         this.type = "object";
 
     if (injectedScript.isPrimitiveValue(object) || object === null || forceValueType) {
         // We don't send undefined values over JSON.
         if (this.type !== "undefined")
             this.value = object;
 
@@ skipping 27 matching lines @@
         this.subtype = subtype;
     var className = InjectedScriptHost.internalConstructorName(object);
     if (className)
         this.className = className;
     this.description = injectedScript._describe(object);
 
     if (generatePreview && this.type === "object" && this.subtype !== "node")
         this.preview = this._generatePreview(object, undefined, columnNames, isTable, skipEntriesPreview);
 
     if (injectedScript._customObjectFormatterEnabled) {
-        var customPreview = this._customPreview(object, objectGroupName);
+        var customPreview = this._customPreview(object, objectGroupName, customObjectConfig);
         if (customPreview)
             this.customPreview = customPreview;
     }
 }
 
 InjectedScript.RemoteObject.prototype = {
 
     /**
      * @param {*} object
      * @param {string=} objectGroupName
+     * @param {*=} customObjectConfig
      * @return {?RuntimeAgent.CustomPreview}
      */
-    _customPreview: function(object, objectGroupName)
+    _customPreview: function(object, objectGroupName, customObjectConfig)
     {
+        /**
+         * @param {!Error} error
+         */
+        function logError(error)
+        {
+            Promise.resolve().then(inspectedWindow.console.error.bind(inspectedWindow.console, "Custom Formatter Failed: " + error.message));
+        }
+
         try {
             var formatters = inspectedWindow["devtoolsFormatters"];
             if (!formatters || !isArrayLike(formatters))
                 return null;
 
             for (var i = 0; i < formatters.length; ++i) {
                 try {
-                    var formatted = formatters[i].header(object);
+                    var formatted = formatters[i].header(object, customObjectConfig);
                     if (!formatted)
                         continue;
 
-                    var hasBody = formatters[i].hasBody(object);
-                    injectedScript._checkObjectTagsInCustomPreview(objectGroupName, formatted);
+                    var hasBody = formatters[i].hasBody(object, customObjectConfig);
+                    injectedScript._substituteObjectTagsInCustomPreview(objectGroupName, formatted);
+                    var customObjectId = customObjectConfig ? injectedScript._bind(customObjectConfig, objectGroupName) : undefined;
                     var formatterObjectId = injectedScript._bind(formatters[i], objectGroupName);
-                    return {header: JSON.stringify(formatted), hasBody: !!hasBody, formatterObjectId: formatterObjectId};
+                    return {header: JSON.stringify(formatted), hasBody: !!hasBody, formatterObjectId: formatterObjectId, configObjectId: customObjectId};
                 } catch (e) {
-                    inspectedWindow.console.error("Custom Formatter Failed: " + e);
+                    logError(e);
                 }
             }
         } catch (e) {
-            inspectedWindow.console.error("Custom Formatter Failed: " + e);
+            logError(e);
         }
         return null;
     },
 
     /**
      * @return {!RuntimeAgent.ObjectPreview} preview
      */
     _createEmptyPreview: function()
     {
         var preview = {
@@ skipping 658 matching lines @@
      */
     _logEvent: function(event)
     {
         inspectedWindow.console.log(event.type, event);
     }
 }
 
 injectedScript._commandLineAPIImpl = new CommandLineAPIImpl();
 return injectedScript;
 })