Log behavior name and siteSpecific: true for site-specific behaviors (#92)

* Ensure all built-in behaviors have a static id

* Log behavior id and siteSpecific bool when behaviors log on step

* Log built-in behavior logs at debug logLevel

* add error() for behavior logging exceptions from run()

* Update autoscroll test

* bump to 0.8.2

---------
Co-authored-by: Ilya Kreymer <[email protected]>

Author: tw4l

.github/workflows/autoscroll.yaml

@@ -35,11 +35,11 @@ jobs:
       run:  docker pull $BROWSERTRIX_IMAGE
 
     - name: run crawl
-      run: docker run -v $PWD/dist/behaviors.js:/app/node_modules/browsertrix-behaviors/dist/behaviors.js $BROWSERTRIX_IMAGE crawl --url https://www.iana.org/numbers --limit 1 --logging behaviors --behaviors autoplay,autofetch,autoscroll > ./log
+      run: docker run -v $PWD/dist/behaviors.js:/app/node_modules/browsertrix-behaviors/dist/behaviors.js $BROWSERTRIX_IMAGE crawl --url https://www.iana.org/numbers --limit 1 --logging debug --context behaviorScript --behaviors autoscroll > ./log
 
-    - name: cat log
-      run: cat ./log
+    - name: check for autoscroll debug log line
+      run: grep 'Skipping autoscroll, page seems to not be responsive to scrolling events' ./log
 
-    - name: compare crawl log to expected
-      run: cat ./log | jq -c 'select(.context == "behaviorScript") | .details' | diff - ./test/expected-autoscroll.log
+    - name: check that state is logged as well
+      run: grep '{"state":{"segments":1}' ./log
 

package.json

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

src/autoclick.ts

@@ -10,6 +10,8 @@ export class AutoClick extends BackgroundBehavior
   selector: string;
   seenElem = new WeakSet<HTMLElement>();
 
+  static id = "Autoclick";
+
   constructor(selector = "a") {
     super();
     this.selector = selector;

src/autofetcher.ts

@@ -37,7 +37,7 @@ export class AutoFetcher extends BackgroundBehavior {
   active: boolean;
   running = false;
 
-  static id = "AutoFetcher";
+  static id = "Autofetcher";
 
   constructor(active = false, headers = null, startEarly = false) {
     super();

src/lib/behavior.ts

@@ -7,6 +7,10 @@ export class BackgroundBehavior {
     behaviorLog(msg, "debug");
   }
 
+  error(msg) {
+    behaviorLog(msg, "error");
+  }
+
   log(msg) {
     behaviorLog(msg, "info");
   }
@@ -43,14 +47,14 @@ export class Behavior extends BackgroundBehavior {
   async run() {
     try {
       for await (const step of this) {
-        this.log(step);
+        this.debug(step);
         if (this.paused) {
           await this.paused;
         }
       }
-      this.log(this.getState("done!"));
+      this.debug(this.getState("done!"));
     } catch (e) {
-      this.log(this.getState(e));
+      this.error(e.toString());
     }
   }
 
@@ -167,14 +171,20 @@ export class BehaviorRunner extends BackgroundBehavior {
   async run() {
     try {
       for await (const step of this.inst.run(this.ctx)) {
-        this.log(step);
+        let logStep;
+        if (typeof step === "string" || step instanceof String) {
+          logStep = {msg: step}
+        } else {
+          logStep = step;
+        }
+        this.log({...logStep, behavior: this.behaviorProps.id, siteSpecific: true});
         if (this.paused) {
           await this.paused;
         }
       }
-      this.log("done!");
+      this.log({msg: "done!", behavior: this.behaviorProps.id, siteSpecific: true});
     } catch (e) {
-      this.log(e.toString());
+      this.error({msg: e.toString(), behavior: this.behaviorProps.id, siteSpecific: true});
     }
   }