Bug 1524276 - Expose category and innerWindowID properties in ConsoleMessage. r=bgrins.

This will be used to group similar messages together. Stubs are updated. Differential Revision: https://phabricator.services.mozilla.com/D23549 --HG-- extra : moz-landing-system : lando
2024-10-21 09:15:35 +00:00 · 2019-03-30 11:07:56 +00:00 · 2019-03-30 11:07:56 +00:00 · 4a7ea2cf9d
commit 4a7ea2cf9d
parent aca368bbe4
8 changed files with 273 additions and 56 deletions
--- a/devtools/client/webconsole/test/fixtures/stub-generators/head.js
+++ b/devtools/client/webconsole/test/fixtures/stub-generators/head.js
@ -62,6 +62,10 @@ function getCleanedPacket(key, packet) {
      res.timeStamp = existingPacket.timeStamp;
    }

+    if (res.innerWindowID) {
+      res.innerWindowID = existingPacket.innerWindowID;
+    }
+
    if (res.startedDateTime) {
      res.startedDateTime = existingPacket.startedDateTime;
    }
@ -81,6 +85,8 @@ function getCleanedPacket(key, packet) {
          res.message.timer.duration = existingPacket.message.timer.duration;
        }
      }
+      // Clean innerWindowId on the message prop.
+      res.message.innerWindowID = existingPacket.message.innerWindowID;

      if (Array.isArray(res.message.arguments)) {
        res.message.arguments = res.message.arguments.map((argument, i) => {
@ -171,8 +177,9 @@ function getCleanedPacket(key, packet) {
    }

    if (res.pageError) {
-      // Clean timeStamp on pageError messages.
+      // Clean timeStamp and innerWindowID on pageError messages.
      res.pageError.timeStamp = existingPacket.pageError.timeStamp;
+      res.pageError.innerWindowID = existingPacket.pageError.innerWindowID;

      if (
        typeof res.pageError.errorMessage === "object"
--- a/devtools/client/webconsole/test/fixtures/stubs/consoleApi.js
+++ b/devtools/client/webconsole/test/fixtures/stubs/consoleApi.js
--- a/devtools/client/webconsole/test/fixtures/stubs/cssMessage.js
+++ b/devtools/client/webconsole/test/fixtures/stubs/cssMessage.js
@ -15,12 +15,14 @@ const stubPreparedMessages = new Map();
 const stubPackets = new Map();
 stubPreparedMessages.set(`Unknown property ‘such-unknown-property’.  Declaration dropped.`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": 15032385539,
  "allowRepeating": true,
  "source": "css",
  "timeStamp": 1479159920406,
  "type": "log",
  "helperType": null,
  "level": "warn",
+  "category": "CSS Parser",
  "messageText": "Unknown property ‘such-unknown-property’.  Declaration dropped.",
  "parameters": null,
  "repeatId": "{\"frame\":{\"source\":\"http://example.com/browser/devtools/client/webconsole/test/fixtures/stub-generators/test-css-message.html\",\"sourceId\":null,\"line\":3,\"column\":25},\"groupId\":null,\"indent\":0,\"level\":\"warn\",\"messageText\":\"Unknown property ‘such-unknown-property’.  Declaration dropped.\",\"parameters\":null,\"source\":\"css\",\"type\":\"log\",\"userProvidedStyles\":null,\"private\":false,\"stacktrace\":null}",
@ -42,12 +44,14 @@ stubPreparedMessages.set(`Unknown property ‘such-unknown-property’.  Declara

 stubPreparedMessages.set(`Error in parsing value for ‘padding-top’.  Declaration dropped.`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": 15032385539,
  "allowRepeating": true,
  "source": "css",
  "timeStamp": 1479159920465,
  "type": "log",
  "helperType": null,
  "level": "warn",
+  "category": "CSS Parser",
  "messageText": "Error in parsing value for ‘padding-top’.  Declaration dropped.",
  "parameters": null,
  "repeatId": "{\"frame\":{\"source\":\"http://example.com/browser/devtools/client/webconsole/test/fixtures/stub-generators/test-css-message.html\",\"sourceId\":null,\"line\":3,\"column\":16},\"groupId\":null,\"indent\":0,\"level\":\"warn\",\"messageText\":\"Error in parsing value for ‘padding-top’.  Declaration dropped.\",\"parameters\":null,\"source\":\"css\",\"type\":\"log\",\"userProvidedStyles\":null,\"private\":false,\"stacktrace\":null}",
@ -77,6 +81,7 @@ stubPackets.set(`Unknown property ‘such-unknown-property’.  Declaration drop
    "lineNumber": 3,
    "columnNumber": 25,
    "category": "CSS Parser",
+    "innerWindowID": 15032385539,
    "timeStamp": 1479159920406,
    "warning": true,
    "error": false,
@ -101,6 +106,7 @@ stubPackets.set(`Error in parsing value for ‘padding-top’.  Declaration drop
    "lineNumber": 3,
    "columnNumber": 16,
    "category": "CSS Parser",
+    "innerWindowID": 15032385539,
    "timeStamp": 1479159920465,
    "warning": true,
    "error": false,
--- a/devtools/client/webconsole/test/fixtures/stubs/evaluationResult.js
+++ b/devtools/client/webconsole/test/fixtures/stubs/evaluationResult.js
@ -15,12 +15,14 @@ const stubPreparedMessages = new Map();
 const stubPackets = new Map();
 stubPreparedMessages.set(`new Date(0)`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1479159921364,
  "type": "result",
  "helperType": null,
  "level": "log",
+  "category": null,
  "parameters": [
    {
      "type": "object",
@ -47,12 +49,14 @@ stubPreparedMessages.set(`new Date(0)`, new ConsoleMessage({

 stubPreparedMessages.set(`asdf()`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1479159921377,
  "type": "result",
  "helperType": null,
  "level": "error",
+  "category": null,
  "messageText": "ReferenceError: asdf is not defined",
  "parameters": [
    {
@ -77,12 +81,14 @@ stubPreparedMessages.set(`asdf()`, new ConsoleMessage({

 stubPreparedMessages.set(`1 + @`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1479159921399,
  "type": "result",
  "helperType": null,
  "level": "error",
+  "category": null,
  "messageText": "SyntaxError: illegal character",
  "parameters": [
    {
@ -107,12 +113,14 @@ stubPreparedMessages.set(`1 + @`, new ConsoleMessage({

 stubPreparedMessages.set(`inspect({a: 1})`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1499776070751,
  "type": "result",
  "helperType": "inspectObject",
  "level": "log",
+  "category": null,
  "parameters": [
    {
      "type": "object",
@ -151,12 +159,14 @@ stubPreparedMessages.set(`inspect({a: 1})`, new ConsoleMessage({

 stubPreparedMessages.set(`cd(document)`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1510650094657,
  "type": "result",
  "helperType": "error",
  "level": "error",
+  "category": null,
  "messageText": "Cannot cd() to the given window. Invalid argument.",
  "parameters": [
    {
@ -175,12 +185,14 @@ stubPreparedMessages.set(`cd(document)`, new ConsoleMessage({

 stubPreparedMessages.set(`undefined`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1518606917356,
  "type": "result",
  "helperType": null,
  "level": "log",
+  "category": null,
  "parameters": [
    {
      "type": "undefined"
@ -198,12 +210,14 @@ stubPreparedMessages.set(`undefined`, new ConsoleMessage({

 stubPreparedMessages.set(`longString message Error`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1493108241073,
  "type": "result",
  "helperType": null,
  "level": "error",
+  "category": null,
  "messageText": {
    "type": "longString",
    "initial": "Error: Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Lon",
@ -227,12 +241,14 @@ stubPreparedMessages.set(`longString message Error`, new ConsoleMessage({

 stubPreparedMessages.set(`eval throw ""`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1517990289517,
  "type": "result",
  "helperType": null,
  "level": "error",
+  "category": null,
  "messageText": "Error",
  "parameters": [
    {
@ -251,12 +267,14 @@ stubPreparedMessages.set(`eval throw ""`, new ConsoleMessage({

 stubPreparedMessages.set(`eval throw "tomato"`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": null,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1517990289520,
  "type": "result",
  "helperType": null,
  "level": "error",
+  "category": null,
  "messageText": "Error: tomato",
  "parameters": [
    {
--- a/devtools/client/webconsole/test/fixtures/stubs/pageError.js
+++ b/devtools/client/webconsole/test/fixtures/stubs/pageError.js
@ -15,12 +15,14 @@ const stubPreparedMessages = new Map();
 const stubPackets = new Map();
 stubPreparedMessages.set(`ReferenceError: asdf is not defined`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": 6442450949,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1476573167137,
  "type": "log",
  "helperType": null,
  "level": "error",
+  "category": "content javascript",
  "messageText": "ReferenceError: asdf is not defined",
  "parameters": null,
  "repeatId": "{\"frame\":{\"source\":\"http://example.com/browser/devtools/client/webconsole/test/fixtures/stub-generators/test-console-api.html\",\"sourceId\":null,\"line\":3,\"column\":5},\"groupId\":null,\"indent\":0,\"level\":\"error\",\"messageText\":\"ReferenceError: asdf is not defined\",\"parameters\":null,\"source\":\"javascript\",\"type\":\"log\",\"userProvidedStyles\":null,\"private\":false,\"stacktrace\":[{\"filename\":\"http://example.com/browser/devtools/client/webconsole/test/fixtures/stub-generators/test-console-api.html\",\"sourceId\":\"server1.conn0.child1/source25\",\"lineNumber\":3,\"columnNumber\":5,\"functionName\":\"bar\"},{\"filename\":\"http://example.com/browser/devtools/client/webconsole/test/fixtures/stub-generators/test-console-api.html\",\"sourceId\":\"server1.conn0.child1/source25\",\"lineNumber\":6,\"columnNumber\":5,\"functionName\":\"foo\"},{\"filename\":\"http://example.com/browser/devtools/client/webconsole/test/fixtures/stub-generators/test-console-api.html\",\"sourceId\":\"server1.conn0.child1/source25\",\"lineNumber\":9,\"columnNumber\":3,\"functionName\":null},{\"filename\":\"resource://testing-common/content-task.js line 59 > eval\",\"sourceId\":null,\"lineNumber\":7,\"columnNumber\":31,\"functionName\":null},{\"filename\":\"resource://testing-common/content-task.js\",\"sourceId\":null,\"lineNumber\":60,\"columnNumber\":29,\"functionName\":null}]}",
@ -79,12 +81,14 @@ stubPreparedMessages.set(`ReferenceError: asdf is not defined`, new ConsoleMessa

 stubPreparedMessages.set(`SyntaxError: redeclaration of let a`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": 6442450949,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1487992945524,
  "type": "log",
  "helperType": null,
  "level": "error",
+  "category": "content javascript",
  "messageText": "SyntaxError: redeclaration of let a",
  "parameters": null,
  "repeatId": "{\"frame\":{\"source\":\"http://example.com/browser/devtools/client/webconsole/test/fixtures/stub-generators/test-console-api.html\",\"sourceId\":null,\"line\":2,\"column\":9},\"groupId\":null,\"indent\":0,\"level\":\"error\",\"messageText\":\"SyntaxError: redeclaration of let a\",\"parameters\":null,\"source\":\"javascript\",\"type\":\"log\",\"userProvidedStyles\":null,\"private\":false,\"stacktrace\":[{\"filename\":\"resource://testing-common/content-task.js line 59 > eval\",\"sourceId\":null,\"lineNumber\":7,\"columnNumber\":31,\"functionName\":null},{\"filename\":\"resource://testing-common/content-task.js\",\"sourceId\":null,\"lineNumber\":60,\"columnNumber\":29,\"functionName\":null}]}",
@ -132,12 +136,14 @@ stubPreparedMessages.set(`SyntaxError: redeclaration of let a`, new ConsoleMessa

 stubPreparedMessages.set(`TypeError longString message`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": 6442450949,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1493109507061,
  "type": "log",
  "helperType": null,
  "level": "error",
+  "category": "content javascript",
  "messageText": {
    "type": "longString",
    "initial": "Error: Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Long error Lon",
@ -186,12 +192,14 @@ stubPreparedMessages.set(`TypeError longString message`, new ConsoleMessage({

 stubPreparedMessages.set(`throw ""`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": 6442450949,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1517942398629,
  "type": "log",
  "helperType": null,
  "level": "error",
+  "category": "content javascript",
  "messageText": "uncaught exception: ",
  "parameters": null,
  "repeatId": "{\"frame\":null,\"groupId\":null,\"indent\":0,\"level\":\"error\",\"messageText\":\"uncaught exception: \",\"parameters\":null,\"source\":\"javascript\",\"type\":\"log\",\"userProvidedStyles\":null,\"private\":false,\"stacktrace\":null}",
@ -208,12 +216,14 @@ stubPreparedMessages.set(`throw ""`, new ConsoleMessage({

 stubPreparedMessages.set(`throw "tomato"`, new ConsoleMessage({
  "id": "1",
+  "innerWindowID": 6442450949,
  "allowRepeating": true,
  "source": "javascript",
  "timeStamp": 1517942398637,
  "type": "log",
  "helperType": null,
  "level": "error",
+  "category": "content javascript",
  "messageText": "uncaught exception: tomato",
  "parameters": null,
  "repeatId": "{\"frame\":null,\"groupId\":null,\"indent\":0,\"level\":\"error\",\"messageText\":\"uncaught exception: tomato\",\"parameters\":null,\"source\":\"javascript\",\"type\":\"log\",\"userProvidedStyles\":null,\"private\":false,\"stacktrace\":null}",
@ -239,6 +249,7 @@ stubPackets.set(`ReferenceError: asdf is not defined`, {
    "lineNumber": 3,
    "columnNumber": 5,
    "category": "content javascript",
+    "innerWindowID": 6442450949,
    "timeStamp": 1476573167137,
    "warning": false,
    "error": false,
@ -300,6 +311,7 @@ stubPackets.set(`SyntaxError: redeclaration of let a`, {
    "lineNumber": 2,
    "columnNumber": 9,
    "category": "content javascript",
+    "innerWindowID": 6442450949,
    "timeStamp": 1487992945524,
    "warning": false,
    "error": false,
@ -354,6 +366,7 @@ stubPackets.set(`TypeError longString message`, {
    "lineNumber": 1,
    "columnNumber": 7,
    "category": "content javascript",
+    "innerWindowID": 6442450949,
    "timeStamp": 1493109507061,
    "warning": false,
    "error": false,
@ -400,6 +413,7 @@ stubPackets.set(`throw ""`, {
    "lineNumber": 0,
    "columnNumber": 0,
    "category": "content javascript",
+    "innerWindowID": 6442450949,
    "timeStamp": 1517942398629,
    "warning": false,
    "error": false,
@ -424,6 +438,7 @@ stubPackets.set(`throw "tomato"`, {
    "lineNumber": 0,
    "columnNumber": 0,
    "category": "content javascript",
+    "innerWindowID": 6442450949,
    "timeStamp": 1517942398637,
    "warning": false,
    "error": false,
--- a/devtools/client/webconsole/types.js
+++ b/devtools/client/webconsole/types.js
@ -29,12 +29,14 @@ exports.ConsoleCommand = function(props) {
 exports.ConsoleMessage = function(props) {
  return Object.assign({
    id: null,
+    innerWindowID: null,
    allowRepeating: true,
    source: null,
    timeStamp: null,
    type: null,
    helperType: null,
    level: null,
+    category: null,
    messageText: null,
    parameters: null,
    repeatId: null,
--- a/devtools/client/webconsole/utils/messages.js
+++ b/devtools/client/webconsole/utils/messages.js
@ -245,9 +245,11 @@ function transformPageErrorPacket(packet) {
  const messageSource = matchesCSS ? MESSAGE_SOURCE.CSS
                                  : MESSAGE_SOURCE.JAVASCRIPT;
  return new ConsoleMessage({
+    innerWindowID: pageError.innerWindowID,
    source: messageSource,
    type: MESSAGE_TYPE.LOG,
    level,
+    category: pageError.category,
    messageText: pageError.errorMessage,
    stacktrace: pageError.stacktrace ? pageError.stacktrace : null,
    frame,
--- a/devtools/server/actors/webconsole.js
+++ b/devtools/server/actors/webconsole.js
@ -1519,6 +1519,7 @@ WebConsoleActor.prototype =
      lineNumber: pageError.lineNumber,
      columnNumber: pageError.columnNumber,
      category: pageError.category,
+      innerWindowID: pageError.innerWindowID,
      timeStamp: pageError.timeStamp,
      warning: !!(pageError.flags & pageError.warningFlag),
      error: !!(pageError.flags & pageError.errorFlag),
@ -1717,6 +1718,7 @@ WebConsoleActor.prototype =
    });

    result.category = message.category || "webdev";
+    result.innerWindowID = message.innerID;

    return result;
  },