Bug 1718052 - [marionette] Replace usage of marionette log.js by remo…

…te/shared/Log.jsm r=webdriver-reviewers,whimboo Depends on D119071 Differential Revision: https://phabricator.services.mozilla.com/D119072
dothq · Jul 8, 2021 · 138814b · 138814b
1 parent 5ec437a
commit 138814b
Show file tree

Hide file tree

Showing 30 changed files with 147 additions and 132 deletions.
diff --git a/remote/cdp/CDPConnection.jsm b/remote/cdp/CDPConnection.jsm
@@ -17,7 +17,7 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   WebSocketConnection: "chrome://remote/content/shared/WebSocketConnection.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get(Log.TYPES.CDP));
 
 class CDPConnection extends WebSocketConnection {
   /**

diff --git a/remote/cdp/Error.jsm b/remote/cdp/Error.jsm
@@ -21,7 +21,7 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get(Log.TYPES.CDP));
 
 class RemoteAgentError extends Error {
   constructor(message = "", cause = undefined) {

diff --git a/remote/components/marionette.js b/remote/components/marionette.js
@@ -13,13 +13,15 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   ComponentUtils: "resource://gre/modules/ComponentUtils.jsm",
 
   EnvironmentPrefs: "chrome://remote/content/marionette/prefs.js",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   MarionettePrefs: "chrome://remote/content/marionette/prefs.js",
   Preferences: "resource://gre/modules/Preferences.jsm",
   TCPListener: "chrome://remote/content/marionette/server.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 XPCOMUtils.defineLazyServiceGetter(
   this,

diff --git a/remote/marionette/accessibility.js b/remote/marionette/accessibility.js
@@ -13,10 +13,12 @@ const { XPCOMUtils } = ChromeUtils.import(
 
 XPCOMUtils.defineLazyModuleGetters(this, {
   error: "chrome://remote/content/shared/webdriver/Errors.jsm",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 XPCOMUtils.defineLazyGetter(this, "service", () => {
   try {

diff --git a/remote/marionette/actors/MarionetteCommandsChild.jsm b/remote/marionette/actors/MarionetteCommandsChild.jsm
@@ -23,12 +23,14 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   event: "chrome://remote/content/marionette/event.js",
   interaction: "chrome://remote/content/marionette/interaction.js",
   legacyaction: "chrome://remote/content/marionette/legacyaction.js",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   sandbox: "chrome://remote/content/marionette/evaluate.js",
   Sandboxes: "chrome://remote/content/marionette/evaluate.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 let inputStateIsDirty = false;
 

diff --git a/remote/marionette/actors/MarionetteCommandsParent.jsm b/remote/marionette/actors/MarionetteCommandsParent.jsm
@@ -21,10 +21,12 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   element: "chrome://remote/content/marionette/element.js",
   error: "chrome://remote/content/shared/webdriver/Errors.jsm",
   evaluate: "chrome://remote/content/marionette/evaluate.js",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 XPCOMUtils.defineLazyGetter(this, "elementIdCache", () => {
   return new element.ReferenceStore();
 });

diff --git a/remote/marionette/actors/MarionetteEventsChild.jsm b/remote/marionette/actors/MarionetteEventsChild.jsm
@@ -14,11 +14,13 @@ const { XPCOMUtils } = ChromeUtils.import(
 
 XPCOMUtils.defineLazyModuleGetters(this, {
   event: "chrome://remote/content/marionette/event.js",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   MarionettePrefs: "chrome://remote/content/marionette/prefs.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 XPCOMUtils.defineLazyGetter(this, "isTraceLevel", () => {
   const StdLog = ChromeUtils.import("resource://gre/modules/Log.jsm").Log;

diff --git a/remote/marionette/actors/MarionetteEventsParent.jsm b/remote/marionette/actors/MarionetteEventsParent.jsm
@@ -17,10 +17,12 @@ const { XPCOMUtils } = ChromeUtils.import(
 
 XPCOMUtils.defineLazyModuleGetters(this, {
   EventEmitter: "resource://gre/modules/EventEmitter.jsm",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 // Singleton to allow forwarding events to registered listeners.
 const EventDispatcher = {

diff --git a/remote/marionette/actors/MarionetteReftestChild.jsm b/remote/marionette/actors/MarionetteReftestChild.jsm
@@ -11,10 +11,12 @@ const { XPCOMUtils } = ChromeUtils.import(
 );
 
 XPCOMUtils.defineLazyModuleGetters(this, {
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 /**
  * Child JSWindowActor to handle navigation for reftests relying on marionette.

diff --git a/remote/marionette/browser.js b/remote/marionette/browser.js
@@ -16,14 +16,16 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   AppInfo: "chrome://remote/content/marionette/appinfo.js",
   element: "chrome://remote/content/marionette/element.js",
   error: "chrome://remote/content/shared/webdriver/Errors.jsm",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   MessageManagerDestroyedPromise: "chrome://remote/content/marionette/sync.js",
   waitForEvent: "chrome://remote/content/marionette/sync.js",
   WebElementEventTarget: "chrome://remote/content/marionette/dom.js",
   windowManager: "chrome://remote/content/marionette/window-manager.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 /** @namespace */
 this.browser = {};

diff --git a/remote/marionette/capture.js b/remote/marionette/capture.js
@@ -11,10 +11,12 @@ const { XPCOMUtils } = ChromeUtils.import(
 );
 
 XPCOMUtils.defineLazyModuleGetters(this, {
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 XPCOMUtils.defineLazyGlobalGetters(this, ["crypto"]);
 
 const CONTEXT_2D = "2d";

diff --git a/remote/marionette/doc/Prefs.md b/remote/marionette/doc/Prefs.md
@@ -14,16 +14,12 @@ allow time for user to set breakpoints in the [Browser Toolbox].
 [Browser Toolbox]: https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox
 
 
-`marionette.log.level`
-----------------------
-
-Sets the verbosity level of the Marionette logger repository.  Note
-that this preference does not control the verbosity of other loggers
-used in Firefox or Fennec.
+`marionette.log.level` (deprecated)
+-----------------------------------
 
-The available levels are, in descending order of severity, `Trace`,
-`debug`, `config`, `info`, `warn`, `error`, and `fatal`.  The value
-is treated case-insensitively.
+This preference used to control the verbosity of the Marionette specific logger.
+Marionette is now using the shared Remote logger, please see `remote.log.level`
+in the [Remote Agent Preferences] documentation.
 
 
 `marionette.log.truncate`
@@ -56,3 +52,6 @@ disabling auto-updates, Telemetry, and first-run UX.
 The user preference file takes presedence over the recommended
 preferences, meaning any user-defined preference value will not be
 overridden.
+
+[Remote Agent Preferences]: ../../remote/Prefs.html
+
diff --git a/remote/marionette/doc/internals/log.rst b/remote/marionette/doc/internals/log.rst
diff --git a/remote/marionette/dom.js b/remote/marionette/dom.js
@@ -14,10 +14,12 @@ const { XPCOMUtils } = ChromeUtils.import(
 );
 
 XPCOMUtils.defineLazyModuleGetters(this, {
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 /**
  * The ``EventTarget`` for web elements can be used to observe DOM

diff --git a/remote/marionette/driver.js b/remote/marionette/driver.js
@@ -32,7 +32,7 @@ XPCOMUtils.defineLazyModuleGetters(this, {
     "chrome://remote/content/marionette/actors/MarionetteCommandsParent.jsm",
   IdlePromise: "chrome://remote/content/marionette/sync.js",
   l10n: "chrome://remote/content/marionette/l10n.js",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   MarionettePrefs: "chrome://remote/content/marionette/prefs.js",
   modal: "chrome://remote/content/marionette/modal.js",
   navigate: "chrome://remote/content/marionette/navigate.js",
@@ -62,7 +62,9 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   WindowState: "chrome://remote/content/marionette/browser.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 XPCOMUtils.defineLazyGlobalGetters(this, ["URL"]);
 
 const XUL_NS = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";

diff --git a/remote/marionette/evaluate.js b/remote/marionette/evaluate.js
@@ -17,11 +17,13 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   assert: "chrome://remote/content/marionette/assert.js",
   element: "chrome://remote/content/marionette/element.js",
   error: "chrome://remote/content/shared/webdriver/Errors.jsm",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   WebElement: "chrome://remote/content/marionette/element.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 const ARGUMENTS = "__webDriverArguments";
 const CALLBACK = "__webDriverCallback";

diff --git a/remote/marionette/format.js b/remote/marionette/format.js
@@ -11,11 +11,13 @@ const { XPCOMUtils } = ChromeUtils.import(
 );
 
 XPCOMUtils.defineLazyModuleGetters(this, {
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   MarionettePrefs: "chrome://remote/content/marionette/prefs.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 const ELEMENT_NODE = 1;
 const MAX_STRING_LENGTH = 250;

diff --git a/remote/marionette/interaction.js b/remote/marionette/interaction.js
@@ -20,14 +20,16 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   element: "chrome://remote/content/marionette/element.js",
   error: "chrome://remote/content/shared/webdriver/Errors.jsm",
   event: "chrome://remote/content/marionette/event.js",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   pprint: "chrome://remote/content/marionette/format.js",
   TimedPromise: "chrome://remote/content/marionette/sync.js",
 });
 
 XPCOMUtils.defineLazyGlobalGetters(this, ["File"]);
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 /** XUL elements that support disabled attribute. */
 const DISABLED_ATTRIBUTE_SUPPORTED_XUL = new Set([

diff --git a/remote/marionette/jar.mn b/remote/marionette/jar.mn
@@ -29,7 +29,6 @@ remote.jar:
   content/marionette/interaction.js (interaction.js)
   content/marionette/l10n.js (l10n.js)
   content/marionette/legacyaction.js (legacyaction.js)
-  content/marionette/log.js (log.js)
   content/marionette/message.js (message.js)
   content/marionette/modal.js (modal.js)
   content/marionette/navigate.js (navigate.js)

diff --git a/remote/marionette/legacyaction.js b/remote/marionette/legacyaction.js
@@ -20,11 +20,13 @@ XPCOMUtils.defineLazyModuleGetters(this, {
   error: "chrome://remote/content/shared/webdriver/Errors.jsm",
   evaluate: "chrome://remote/content/marionette/evaluate.js",
   event: "chrome://remote/content/marionette/event.js",
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
   WebElement: "chrome://remote/content/marionette/element.js",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 const CONTEXT_MENU_DELAY_PREF = "ui.click_hold_context_menus.delay";
 const DEFAULT_CONTEXT_MENU_DELAY = 750; // ms

diff --git a/remote/marionette/log.js b/remote/marionette/log.js
diff --git a/remote/marionette/modal.js b/remote/marionette/modal.js
@@ -13,10 +13,12 @@ const { XPCOMUtils } = ChromeUtils.import(
 XPCOMUtils.defineLazyModuleGetters(this, {
   Services: "resource://gre/modules/Services.jsm",
 
-  Log: "chrome://remote/content/marionette/log.js",
+  Log: "chrome://remote/content/shared/Log.jsm",
 });
 
-XPCOMUtils.defineLazyGetter(this, "logger", () => Log.get());
+XPCOMUtils.defineLazyGetter(this, "logger", () =>
+  Log.get(Log.TYPES.MARIONETTE)
+);
 
 const COMMON_DIALOG = "chrome://global/content/commonDialog.xhtml";