more logging tweaks: (#94)

* more logging tweaks:
- ensure all logging from site-specific behaviors are wrapped with siteSpecific: true
- if yield returns null, don't log anything (may be logged elsewhere already)
- more log -> debug to reduce logging clutter
- bump to 0.8.4

Author: ikreymer

package.json

@@ -1,6 +1,6 @@
 {
   "name": "browsertrix-behaviors",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "main": "index.js",
   "author": "Webrecorder Software",
   "license": "AGPL-3.0-or-later",

src/index.ts

@@ -132,7 +132,7 @@ export class BehaviorManager {
       for (const name in this.loadedBehaviors) {
         const siteBehaviorClass = this.loadedBehaviors[name];
         if (siteBehaviorClass.isMatch()) {
-          behaviorLog({msg: "Using Site-Specific Behavior: " + name, siteSpecific: true});
+          behaviorLog("Using Site-Specific Behavior: " + name);
           this.mainBehaviorClass = siteBehaviorClass;
           const siteSpecificOpts = typeof opts.siteSpecific === "object" ?
             (opts.siteSpecific[name] || {}) : {};
@@ -210,6 +210,7 @@ export class BehaviorManager {
   async awaitPageLoad() {
     this.selectMainBehavior();
     if (this.mainBehavior?.awaitPageLoad) {
+      behaviorLog("Waiting for custom page load via behavior");
       await this.mainBehavior.awaitPageLoad();
     }
   }

src/lib/behavior.ts

@@ -11,8 +11,8 @@ export class BackgroundBehavior {
     behaviorLog(msg, "error");
   }
 
-  log(msg) {
-    behaviorLog(msg, "info");
+  log(msg, type = "info") {
+    behaviorLog(msg, type);
   }
 }
 
@@ -155,7 +155,8 @@ export class BehaviorRunner extends BackgroundBehavior {
     let {state, opts} = behavior.init();
     state = state || {};
     opts = opts ? {...opts, ...mainOpts} : mainOpts;
-    const log = behaviorLog;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const log = async (data: any, type: string) => this.wrappedLog(data, type);
 
     this.ctx = { Lib, state, opts, log };
 
@@ -164,6 +165,17 @@ export class BehaviorRunner extends BackgroundBehavior {
     this._unpause = null;
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  wrappedLog(data: any, type = "info") {
+    let logData;
+    if (typeof data === "string" || data instanceof String) {
+      logData = {msg: data}
+    } else {
+      logData = data;
+    }
+    this.log({...logData, behavior: this.behaviorProps.id, siteSpecific: true}, type);
+  }
+
   start() {
     this._running = this.run();
   }
@@ -175,20 +187,16 @@ export class BehaviorRunner extends BackgroundBehavior {
   async run() {
     try {
       for await (const step of this.inst.run(this.ctx)) {
-        let logStep;
-        if (typeof step === "string" || step instanceof String) {
-          logStep = {msg: step}
-        } else {
-          logStep = step;
+        if (step) {
+          this.wrappedLog(step);
         }
-        this.log({...logStep, behavior: this.behaviorProps.id, siteSpecific: true});
         if (this.paused) {
           await this.paused;
         }
       }
-      this.log({msg: "done!", behavior: this.behaviorProps.id, siteSpecific: true});
+      this.debug({msg: "done!", behavior: this.behaviorProps.id});
     } catch (e) {
-      this.error({msg: e.toString(), behavior: this.behaviorProps.id, siteSpecific: true});
+      this.error({msg: e.toString(), behavior: this.behaviorProps.id});
     }
   }