Only show debug log in development mode (#380)

* Only show debug log in development mode * Added setting for debug * Listen force changes in debug setting * Made debug into a graph factory * Updated the comment * Bind this * Update src/core/Debug.ts Co-authored-by: Pokey Rule <pokey.rule@gmail.com> * Update src/core/Debug.ts Co-authored-by: Pokey Rule <pokey.rule@gmail.com> * Cleanup * Allow debug log in startup * Create own log debug function * Added active field to log debug * Moved debug log into debug class * Change stack trace from debug to error Co-authored-by: Pokey Rule <pokey.rule@gmail.com>
cursorless-dev · Dec 16, 2021 · 8884092 · 8884092
1 parent ff74551
commit 8884092
Show file tree

Hide file tree

Showing 9 changed files with 158 additions and 73 deletions.
diff --git a/package.json b/package.json
@@ -112,6 +112,11 @@
 					"default": true,
 					"description": "Whether to show decorations on vscode start."
 				},
+				"cursorless.debug": {
+					"type": "boolean",
+					"default": false,
+					"description": "Whether to show debug logs."
+				},
 				"cursorless.pendingEditDecorationTime": {
 					"type": "integer",
 					"default": 100,

diff --git a/src/core/Debug.ts b/src/core/Debug.ts
@@ -0,0 +1,129 @@
+import {
+  Disposable,
+  ExtensionMode,
+  Location,
+  TextEditorSelectionChangeEvent,
+  window,
+  workspace,
+} from "vscode";
+import { SyntaxNode, TreeCursor } from "web-tree-sitter";
+import { Graph } from "../typings/Types";
+
+export default class Debug {
+  private disposableConfiguration?: Disposable;
+  private disposableSelection?: Disposable;
+  active: boolean;
+
+  constructor(private graph: Graph) {
+    this.graph.extensionContext.subscriptions.push(this);
+
+    this.evaluateSetting = this.evaluateSetting.bind(this);
+    this.logBranchTypes = this.logBranchTypes.bind(this);
+    this.active = true;
+
+    switch (this.graph.extensionContext.extensionMode) {
+      // Development mode. Always enable.
+      case ExtensionMode.Development:
+        this.enableDebugLog();
+        break;
+      // Test mode. Always disable.
+      case ExtensionMode.Test:
+        this.disableDebugLog();
+        break;
+      // Production mode. Enable based on user setting.
+      case ExtensionMode.Production:
+        this.evaluateSetting();
+        this.disposableConfiguration = workspace.onDidChangeConfiguration(
+          this.evaluateSetting
+        );
+        break;
+    }
+  }
+
+  init() {}
+
+  log(...args: any[]) {
+    if (this.active) {
+      console.debug(...args);
+    }
+  }
+
+  dispose() {
+    if (this.disposableConfiguration) {
+      this.disposableConfiguration.dispose();
+    }
+    if (this.disposableSelection) {
+      this.disposableSelection.dispose();
+    }
+  }
+
+  private enableDebugLog() {
+    this.active = true;
+    this.disposableSelection = window.onDidChangeTextEditorSelection(
+      this.logBranchTypes
+    );
+  }
+
+  private disableDebugLog() {
+    this.active = false;
+    if (this.disposableSelection) {
+      this.disposableSelection.dispose();
+      this.disposableSelection = undefined;
+    }
+  }
+
+  private evaluateSetting() {
+    const debugEnabled = workspace
+      .getConfiguration("cursorless")
+      .get<boolean>("debug")!;
+    if (debugEnabled) {
+      this.enableDebugLog();
+    } else {
+      this.disableDebugLog();
+    }
+  }
+
+  private logBranchTypes(event: TextEditorSelectionChangeEvent) {
+    const location = new Location(
+      window.activeTextEditor!.document.uri,
+      event.selections[0]
+    );
+
+    let node: SyntaxNode;
+    try {
+      node = this.graph.getNodeAtLocation(location);
+    } catch (error) {
+      return;
+    }
+
+    const ancestors: SyntaxNode[] = [node];
+    while (node.parent != null) {
+      ancestors.unshift(node.parent);
+      node = node.parent;
+    }
+
+    const cursor = node.tree.walk();
+    this.printCursorLocationInfo(cursor, 0);
+
+    for (let i = 1; i < ancestors.length; ++i) {
+      cursor.gotoFirstChild();
+      while (cursor.currentNode().id !== ancestors[i].id) {
+        if (!cursor.gotoNextSibling()) {
+          return;
+        }
+      }
+      this.printCursorLocationInfo(cursor, i);
+    }
+
+    const leafText = ancestors[ancestors.length - 1].text
+      .replace(/\s+/g, " ")
+      .substring(0, 100);
+    console.debug(">".repeat(ancestors.length), `"${leafText}"`);
+  }
+
+  private printCursorLocationInfo(cursor: TreeCursor, depth: number) {
+    const field = cursor.currentFieldName();
+    const fieldText = field != null ? `${field}: ` : "";
+    console.debug(">".repeat(depth + 1), `${fieldText}${cursor.nodeType}`);
+  }
+}
diff --git a/src/core/HatTokenMap.ts b/src/core/HatTokenMap.ts
@@ -133,7 +133,7 @@ export default class HatTokenMap {
       const newSignalVersion = await phraseStartSignal.getVersion();
 
       if (newSignalVersion !== this.lastSignalVersion) {
-        console.debug("taking snapshot");
+        this.graph.debug.log("taking snapshot");
         this.lastSignalVersion = newSignalVersion;
 
         if (newSignalVersion != null) {

diff --git a/src/core/commandRunner/CommandRunner.ts b/src/core/commandRunner/CommandRunner.ts
@@ -10,7 +10,6 @@ import {
 import { ThatMark } from "../ThatMark";
 import { TestCaseRecorder } from "../../testUtil/TestCaseRecorder";
 import { canonicalizeAndValidateCommand } from "../../util/canonicalizeAndValidateCommand";
-import { SyntaxNode } from "web-tree-sitter";
 import { CommandArgument } from "./types";
 import { isString } from "../../util/type";
 
@@ -22,7 +21,6 @@ export default class CommandRunner {
     private graph: Graph,
     private thatMark: ThatMark,
     private sourceMark: ThatMark,
-    private getNodeAtLocation: (location: vscode.Location) => SyntaxNode,
     private testCaseRecorder: TestCaseRecorder
   ) {
     graph.extensionContext.subscriptions.push(this);
@@ -40,8 +38,10 @@ export default class CommandRunner {
 
   async runCommand(commandArgument: CommandArgument) {
     try {
-      console.debug(`commandArgument:`);
-      console.debug(JSON.stringify(commandArgument, null, 3));
+      if (this.graph.debug.active) {
+        this.graph.debug.log(`commandArgument:`);
+        this.graph.debug.log(JSON.stringify(commandArgument, null, 3));
+      }
 
       const {
         spokenForm,
@@ -76,7 +76,7 @@ export default class CommandRunner {
         hatTokenMap: readableHatMap,
         thatMark: this.thatMark.exists() ? this.thatMark.get() : [],
         sourceMark: this.sourceMark.exists() ? this.sourceMark.get() : [],
-        getNodeAtLocation: this.getNodeAtLocation,
+        getNodeAtLocation: this.graph.getNodeAtLocation,
       };
 
       const selections = processTargets(processedTargetsContext, targets);
@@ -110,8 +110,8 @@ export default class CommandRunner {
       this.testCaseRecorder.commandErrorHook();
       const err = e as Error;
       vscode.window.showErrorMessage(err.message);
-      console.debug(err.message);
-      console.debug(err.stack);
+      console.error(err.message);
+      console.error(err.stack);
       throw err;
     }
   }

diff --git a/src/extension.ts b/src/extension.ts
@@ -2,7 +2,6 @@ import * as vscode from "vscode";
 import graphFactories from "./util/graphFactories";
 import { Graph } from "./typings/Types";
 import makeGraph, { FactoryMap } from "./util/makeGraph";
-import { logBranchTypes } from "./util/debug";
 import { ThatMark } from "./core/ThatMark";
 import { TestCaseRecorder } from "./testUtil/TestCaseRecorder";
 import { getCommandServerApi, getParseTreeApi } from "./util/getExtensionApi";
@@ -17,7 +16,9 @@ export async function activate(context: vscode.ExtensionContext) {
     ...graphFactories,
     extensionContext: () => context,
     commandServerApi: () => commandServerApi,
+    getNodeAtLocation: () => getNodeAtLocation,
   } as FactoryMap<Graph>);
+  graph.debug.init();
   graph.snippets.init();
   await graph.decorations.init();
   graph.hatTokenMap.init();
@@ -47,7 +48,6 @@ export async function activate(context: vscode.ExtensionContext) {
     graph,
     thatMark,
     sourceMark,
-    getNodeAtLocation,
     testCaseRecorder
   );
 
@@ -95,12 +95,7 @@ export async function activate(context: vscode.ExtensionContext) {
     }
   }
 
-  context.subscriptions.push(
-    cursorlessRecordTestCaseDisposable,
-    vscode.window.onDidChangeTextEditorSelection(
-      logBranchTypes(getNodeAtLocation)
-    )
-  );
+  context.subscriptions.push(cursorlessRecordTestCaseDisposable);
 
   return {
     thatMark,

diff --git a/src/test/suite/recorded.test.ts b/src/test/suite/recorded.test.ts
@@ -17,11 +17,9 @@ import {
   SerializedMarks,
 } from "../../testUtil/toPlainObject";
 import { getCursorlessApi } from "../../util/getExtensionApi";
-import { enableDebugLog } from "../../util/debug";
 import { extractTargetedMarks } from "../../testUtil/extractTargetedMarks";
 import asyncSafety from "./asyncSafety";
 import { ReadOnlyHatMap } from "../../core/IndividualHatMap";
-import { mockPrePhraseGetVersion } from "../mockPrePhraseGetVersion";
 import { openNewEditor } from "../openNewEditor";
 import getRecordedTestPaths from "./getRecordedTestPaths";
 
@@ -39,8 +37,6 @@ suite("recorded test cases", async function () {
   this.timeout("100s");
   this.retries(5);
 
-  enableDebugLog(false);
-
   teardown(() => {
     sinon.restore();
   });

diff --git a/src/typings/Types.ts b/src/typings/Types.ts
@@ -11,6 +11,7 @@ import Decorations from "../core/Decorations";
 import FontMeasurements from "../core/FontMeasurements";
 import { CommandServerApi } from "../util/getExtensionApi";
 import { ReadOnlyHatMap } from "../core/IndividualHatMap";
+import Debug from "../core/Debug";
 
 /**
  * A token within a text editor, including the current display line of the token
@@ -445,6 +446,16 @@ export interface Graph {
    * API object for interacting with the command server, if it exists
    */
   readonly commandServerApi: CommandServerApi | null;
+
+  /**
+   * Function to access nodes in the tree sitter.
+   */
+  readonly getNodeAtLocation: (location: vscode.Location) => SyntaxNode;
+
+  /**
+   * Debug logger
+   */
+  readonly debug: Debug;
 }
 
 export type NodeMatcherValue = {

diff --git a/src/util/debug.ts b/src/util/debug.ts
diff --git a/src/util/graphFactories.ts b/src/util/graphFactories.ts
@@ -7,6 +7,7 @@ import { Snippets } from "../core/Snippets";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import Decorations from "../core/Decorations";
 import FontMeasurements from "../core/FontMeasurements";
+import Debug from "../core/Debug";
 
 type ConstructorMap<T> = {
   [P in keyof T]: new (t: T) => T[P];
@@ -20,6 +21,7 @@ const graphConstructors: Partial<ConstructorMap<Graph>> = {
   fontMeasurements: FontMeasurements,
   snippets: Snippets,
   rangeUpdater: RangeUpdater,
+  debug: Debug,
 };
 
 const graphFactories: Partial<FactoryMap<Graph>> = Object.fromEntries(