[embedlite-components] Condition logging for JS components. JB#49804

JSScripts see Logger directly as they are loaded under embedhelper.js. For JSComps we need to load Logger per component. No longer use dump directly rathre Logger.debug or Logger.warn. Environment variable EMBEDLITE_COMPONENTS_LOGGING=1 can be used for enabling logs. There are no concept of logging categories, maybe we should have such when going forward.
sailfishos · May 15, 2020 · a6aa81f · a6aa81f
1 parent 522a195
commit a6aa81f
Show file tree

Hide file tree

Showing 31 changed files with 228 additions and 131 deletions.
diff --git a/jscomps/AboutRedirector.js b/jscomps/AboutRedirector.js
@@ -6,6 +6,8 @@ const Ci = Components.interfaces;
 
 Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 let modules = {
   // about:
   "": {
@@ -33,7 +35,9 @@ let modules = {
   }
 }
 
-function AboutRedirector() {}
+function AboutRedirector() {
+  Logger.debug("JSComp: AboutRedirector.js loaded");
+}
 AboutRedirector.prototype = {
   QueryInterface: XPCOMUtils.generateQI([Ci.nsIAboutModule]),
   classID: Components.ID("{59f3da9a-6c88-11e2-b875-33d1bd379849}"),

diff --git a/jscomps/AlertsService.js b/jscomps/AlertsService.js
@@ -8,11 +8,15 @@ const Cu = Components.utils;
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 // -----------------------------------------------------------------------
 // Alerts Service
 // -----------------------------------------------------------------------
 
-function AlertsService() { }
+function AlertsService() {
+  Logger.debug("JSComp: AlertsService.js loaded");
+}
 
 AlertsService.prototype = {
   classID: Components.ID("{b98ab6b8-6c88-11e2-99bc-6745f7369235}"),

diff --git a/jscomps/ContentPermissionPrompt.js b/jscomps/ContentPermissionPrompt.js
@@ -14,10 +14,14 @@ XPCOMUtils.defineLazyServiceGetter(Services, "embedlite",
                                     "@mozilla.org/embedlite-app-service;1",
                                     "nsIEmbedAppService");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 const kEntities = { "geolocation": "geolocation",
                     "desktop-notification": "desktopNotification" };
 
-function ContentPermissionPrompt() {}
+function ContentPermissionPrompt() {
+  Logger.debug("JSComp: ContentPermissionPrompt.js loaded");
+}
 
 ContentPermissionPrompt.prototype = {
   classID: Components.ID("{C6E8C44D-9F39-4AF7-BCC0-76E38A8310F5}"),

diff --git a/jscomps/EmbedLiteConsoleListener.js b/jscomps/EmbedLiteConsoleListener.js
@@ -12,11 +12,16 @@ Components.utils.import("resource://gre/modules/Services.jsm");
 XPCOMUtils.defineLazyServiceGetter(Services, 'env',
                                   '@mozilla.org/process/environment;1',
                                   'nsIEnvironment');
+
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 // Common helper service
 
 function SPConsoleListener(dumpStdOut) {
   this._dumpToStdOut = dumpStdOut;
   this._cacheLogs = true;
+
+  Logger.debug("JSComp: EmbedLiteConsoleListener.js loaded");
 }
 
 SPConsoleListener.prototype = {

diff --git a/jscomps/EmbedLiteErrorPageHandler.js b/jscomps/EmbedLiteErrorPageHandler.js
@@ -17,10 +17,13 @@ XPCOMUtils.defineLazyServiceGetter(Services, "embedlite",
                                    "@mozilla.org/embedlite-app-service;1",
                                    "nsIEmbedAppService");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 // Common helper service
 
 function EmbedLiteErrorPageHandler()
 {
+  Logger.debug("JSComp: EmbedLiteErrorPageHandler.js loaded");
 }
 
 function EventLinkListener(aWindow)

diff --git a/jscomps/EmbedLiteFaviconService.js b/jscomps/EmbedLiteFaviconService.js
@@ -16,10 +16,13 @@ XPCOMUtils.defineLazyServiceGetter(Services, "embedlite",
                                    "@mozilla.org/embedlite-app-service;1",
                                    "nsIEmbedAppService");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 // Common helper service
 
 function EmbedLiteFaviconService()
 {
+  Logger.debug("JSComp: EmbedLiteFaviconService.js loaded");
 }
 
 function resolveGeckoURI(aURI) {

diff --git a/jscomps/EmbedLiteGlobalHelper.js b/jscomps/EmbedLiteGlobalHelper.js
@@ -10,10 +10,13 @@ Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
 Components.utils.import("resource://gre/modules/Services.jsm");
 Components.utils.import("resource://gre/modules/LoginManagerParent.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 // Common helper service
 
 function EmbedLiteGlobalHelper()
 {
+  Logger.debug("JSComp: EmbedLiteGlobalHelper.js loaded");
 }
 
 EmbedLiteGlobalHelper.prototype = {
@@ -23,28 +26,28 @@ EmbedLiteGlobalHelper.prototype = {
     switch(aTopic) {
       // Engine DownloadManager notifications
       case "app-startup": {
-        dump("EmbedLiteGlobalHelper app-startup\n");
+        Logger.debug("EmbedLiteGlobalHelper app-startup");
         Services.obs.addObserver(this, "invalidformsubmit", false);
         Services.obs.addObserver(this, "xpcom-shutdown", false);
         Services.obs.addObserver(this, "profile-after-change", false);
         break;
       }
       case "invalidformsubmit": {
-        dump("EmbedLiteGlobalHelper invalidformsubmit\n");
+        Logger.debug("EmbedLiteGlobalHelper invalidformsubmit");
         break;
       }
       case "profile-after-change": {
         // Init LoginManager
         try {
           Cc["@mozilla.org/login-manager;1"].getService(Ci.nsILoginManager);
         } catch (e) {
-          dump("E login manager\n");
+          Logger.warn("E login manager:", e);
         }
         LoginManagerParent.init();
         break;
       }
       case "xpcom-shutdown": {
-        dump("EmbedLiteGlobalHelper xpcom-shutdown\n");
+        Logger.debug("EmbedLiteGlobalHelper xpcom-shutdown");
         Services.obs.removeObserver(this, "invalidformsubmit", false);
         Services.obs.removeObserver(this, "xpcom-shutdown", false);
         break;
@@ -53,7 +56,7 @@ EmbedLiteGlobalHelper.prototype = {
   },
 
   notifyInvalidSubmit: function notifyInvalidSubmit(aFormElement, aInvalidElements) {
-    dump("NOT IMPLEMENTED Invalid Form Submit, need to do something about it\n");
+    Logger.warn("NOT IMPLEMENTED Invalid Form Submit, need to do something about it.");
     if (!aInvalidElements.length)
       return;
   },

diff --git a/jscomps/EmbedLiteOrientationChangeHandler.js b/jscomps/EmbedLiteOrientationChangeHandler.js
@@ -15,8 +15,11 @@ XPCOMUtils.defineLazyServiceGetter(Services, "embedlite",
                                    "@mozilla.org/embedlite-app-service;1",
                                    "nsIEmbedAppService");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 function EmbedLiteOrientationChangeHandler()
 {
+  Logger.debug("JSComp: EmbedLiteOrientationChangeHandler.js loaded");
 }
 
 EmbedLiteOrientationChangeHandler.prototype = {

diff --git a/jscomps/EmbedLiteSearchEngine.js b/jscomps/EmbedLiteSearchEngine.js
@@ -10,9 +10,12 @@ const Cu = Components.utils;
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 // Common helper service
 function EmbedLiteSearchEngine()
 {
+  Logger.debug("JSComp: EmbedLiteSearchEngine.js loaded");
 }
 
 EmbedLiteSearchEngine.prototype = {

diff --git a/jscomps/EmbedLiteSyncService.js b/jscomps/EmbedLiteSyncService.js
@@ -10,6 +10,7 @@ const Cu = Components.utils;
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
 
 function EmbedLiteSyncServiceImpotUtils()
 {
@@ -34,6 +35,7 @@ function EmbedLiteSyncServiceImpotUtils()
 
 function EmbedLiteSyncService()
 {
+  Logger.debug("JSComp: EmbedLiteSyncService.js loaded");
 }
 
 
@@ -44,13 +46,13 @@ EmbedLiteSyncService.prototype = {
     switch(aTopic) {
       // Engine DownloadManager notifications
       case "app-startup": {
-        dump("EmbedLiteSyncService app-startup\n");
+        Logger.debug("EmbedLiteSyncService app-startup");
         Services.prefs.setCharPref("services.sync.registerEngines", "Tab,Bookmarks,Form,History,Password,Prefs");
         Services.obs.addObserver(this, "embedui:initsync", true);
         break;
       }
       case "embedui:initsync": {
-        dump("EmbedLiteSyncService embedui:initsync\n");
+        Logger.debug("EmbedLiteSyncService embedui:initsync");
         var data = JSON.parse(aData);
         EmbedLiteSyncServiceImpotUtils();
         Service.login(data.username, data.password, data.key);
@@ -80,35 +82,35 @@ EmbedLiteSyncService.prototype = {
   embedLiteSyncServiceFetchBookmarks: function () {
     this._embedLiteSyncServiceFetch("bookmarks", PlacesItem, function(item) {
       if (item.type == "bookmark") {
-        dump("Title: " + item.title + ", Uri: " + item.bmkUri + "\n");
+        Logger.debug("Title:", item.title, "Uri:", item.bmkUri);
       }
     });
   },
 
   embedLiteSyncServiceFetchHistory: function () {
     this._embedLiteSyncServiceFetch("history", HistoryRec, function(item) {
-      dump("Title: " +  item.title + ", Uri:" +  item.histUri + "\n");
+      Logger.debug("Title:", item.title, "Uri:", item.histUri);
     });
   },
 
   embedLiteSyncServiceFetchTabs: function () {
     this._embedLiteSyncServiceFetch("tabs", TabSetRecord, function(item) {
-      dump('Tab:' + JSON.stringify(item) + "\n");
+      Logger.debug("Tab:", JSON.stringify(item));
     });
   },
   embedLiteSyncServiceFetchForms: function () {
     this._embedLiteSyncServiceFetch("forms", FormRec, function(item) {
-      dump('Forms:' + JSON.stringify(item) + "\n");
+      Logger.debug("Forms:", JSON.stringify(item));
     });
   },
   embedLiteSyncServiceFetchPassword: function () {
     this._embedLiteSyncServiceFetch("passwords", LoginRec, function(item) {
-      dump('Login:' + JSON.stringify(item) + "\n");
+      Logger.debug("Login:", JSON.stringify(item));
     });
   },
   embedLiteSyncServiceFetchPrefs: function () {
     this._embedLiteSyncServiceFetch("prefs", PrefRec, function(item) {
-      dump('Pref:' + JSON.stringify(item) + "\n");
+      Logger.debug("Pref:", JSON.stringify(item));
     });
   },
 

diff --git a/jscomps/EmbedLiteWebAppInstall.js b/jscomps/EmbedLiteWebAppInstall.js
@@ -10,8 +10,11 @@ const Cu = Components.utils;
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 function EmbedLiteWebAppInstall()
 {
+  Logger.debug("JSComp: EmbedLiteWebAppInstall.js loaded");
 }
 
 EmbedLiteWebAppInstall.prototype = {

diff --git a/jscomps/EmbedPrefService.js b/jscomps/EmbedPrefService.js
@@ -9,13 +9,15 @@ const Cr = Components.results;
 Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
 Components.utils.import("resource://gre/modules/Services.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 // -----------------------------------------------------------------------
 // Download Manager UI
 // -----------------------------------------------------------------------
 
 function EmbedPrefService()
 {
-  dump("PREFS SERVICE INITAILIZED\n");
+  Logger.debug("JSComp: EmbedPrefService.js loaded");
 }
 
 EmbedPrefService.prototype = {
@@ -65,7 +67,7 @@ EmbedPrefService.prototype = {
     switch(aTopic) {
       // Engine DownloadManager notifications
       case "app-startup": {
-        dump("EmbedPrefService app-startup\n");
+        Logger.debug("EmbedPrefService app-startup");
         Services.obs.addObserver(this, "embedui:prefs", true);
         Services.obs.addObserver(this, "embedui:saveprefs", true);
         Services.obs.addObserver(this, "embedui:allprefs", true);
@@ -77,10 +79,10 @@ EmbedPrefService.prototype = {
       }
       case "embedui:prefs": {
         var data = JSON.parse(aData);
-        dump("UI Wants some prefs back: " + data.msg + "\n");
+        Logger.debug("UI Wants some prefs back:", data.msg);
         let retPrefs = [];
         for (let pref of data.prefs) {
-            dump("pref: " + pref + "\n");
+            Logger.debug("pref:", pref);
             switch (Services.prefs.getPrefType(pref)) {
                 case Services.prefs.PREF_BOOL:
                     retPrefs.push({ name: pref, value: Services.prefs.getBoolPref(pref)});

diff --git a/jscomps/EmbedliteDownloadManager.js b/jscomps/EmbedliteDownloadManager.js
@@ -23,6 +23,8 @@ XPCOMUtils.defineLazyModuleGetter(this, "Services",
 XPCOMUtils.defineLazyModuleGetter(this, "Task",
                                   "resource://gre/modules/Task.jsm");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 ////////////////////////////////////////////////////////////////////////////////
 //// DownloadViewer
 
@@ -73,7 +75,7 @@ let DownloadView = {
     }
 
     if (download.error) {
-      dump("EmbedliteDownloadManager error: " + download.error.message + "\n");
+      Logger.warn("EmbedliteDownloadManager error:", download.error.message);
       Services.obs.notifyObservers(null, "embed:download",
                                    JSON.stringify({
                                        msg: "dl-fail",
@@ -112,7 +114,7 @@ let DownloadView = {
     this.prevState[download].succeeded = download.succeeded;
 
     if (!this.prevState[download].error && download.error) {
-      dump("EmbedliteDownloadManager error: " + download.error.message + "\n");
+      Logger.debug("EmbedliteDownloadManager error:", download.error.message);
       Services.obs.notifyObservers(null, "embed:download",
                                    JSON.stringify({
                                        msg: "dl-fail",
@@ -155,7 +157,7 @@ let DownloadView = {
 
 function EmbedliteDownloadManager()
 {
-  dump("EmbedliteDownloadManager initialized\n");
+  Logger.debug("JSComp: EmbedliteDownloadManager.js loaded");
 }
 
 EmbedliteDownloadManager.prototype = {

diff --git a/jscomps/FilePicker.js b/jscomps/FilePicker.js
@@ -18,7 +18,10 @@ XPCOMUtils.defineLazyServiceGetter(Services, "embedlite",
                                     "@mozilla.org/embedlite-app-service;1",
                                     "nsIEmbedAppService");
 
+Services.scriptloader.loadSubScript("chrome://embedlite/content/Logger.js");
+
 function FilePicker() {
+  Logger.debug("JSComp: FilePicker.js loaded");
 }
 
 FilePicker.prototype = {