(#371) Refined logging for mouse, keyboard and clipboard

Author: s1hofmann

Diff for: lib/clipboard.class.ts

@@ -14,16 +14,17 @@ export class ClipboardClass {
    * {@link setContent} copies a given text to the system clipboard
    * @param text The text to copy
    */
-  public setContent(text: string): Promise<void> {
-    this.providerRegistry.getLogProvider().debug(`Saving to clipboard`);
-    return this.providerRegistry.getClipboard().copy(text);
+  public async setContent(text: string): Promise<void> {
+    await this.providerRegistry.getClipboard().copy(text);
+    this.providerRegistry.getLogProvider().debug(`Saved to clipboard`);
   }
 
   /**
    * {@link getContent} returns the current content of the system clipboard (limited to text)
    */
-  public getContent(): Promise<string> {
-    this.providerRegistry.getLogProvider().debug(`Fetching clipboard content`);
-    return this.providerRegistry.getClipboard().paste();
+  public async getContent(): Promise<string> {
+    const content = await this.providerRegistry.getClipboard().paste();
+    this.providerRegistry.getLogProvider().debug(`Fetched clipboard content`);
+    return content;
   }
 }

Diff for: lib/keyboard.class.spec.ts

@@ -2,7 +2,8 @@ import { Key } from "./key.enum";
 import { KeyboardClass } from "./keyboard.class";
 import { ProviderRegistry } from "./provider/provider-registry.class";
 import { mockPartial } from "sneer";
-import { KeyboardProviderInterface } from "./provider";
+import { KeyboardProviderInterface, LogProviderInterface } from "./provider";
+import { NoopLogProvider } from "./provider/log/noop-log-provider.class";
 
 jest.setTimeout(10000);
 
@@ -11,6 +12,9 @@ beforeEach(() => {
 });
 
 const providerRegistryMock = mockPartial<ProviderRegistry>({
+  getLogProvider(): LogProviderInterface {
+    return new NoopLogProvider();
+  },
   getKeyboard(): KeyboardProviderInterface {
     return mockPartial<KeyboardProviderInterface>({
       setKeyboardDelay: jest.fn(),

Diff for: lib/keyboard.class.ts

@@ -56,12 +56,22 @@ export class KeyboardClass {
           for (const char of input.join(" ")) {
             await sleep(this.config.autoDelayMs);
             await this.providerRegistry.getKeyboard().type(char);
+            this.providerRegistry.getLogProvider().debug(`Tapped ${char}`);
           }
+          this.providerRegistry.getLogProvider().info(`Typed string ${input}`);
         } else {
           await this.providerRegistry.getKeyboard().click(...(input as Key[]));
+          const key = input[input.length - 1];
+          const modifiers = input.slice(0, -1);
+          const keyName = Key[key];
+          const modifierNames = modifiers.map((modifier) => Key[modifier]);
+          this.providerRegistry
+            .getLogProvider()
+            .info(`Tapped key ${keyName} with modifiers ${modifierNames}`);
         }
         resolve(this);
       } catch (e) {
+        this.providerRegistry.getLogProvider().error(e as Error);
         reject(e);
       }
     });
@@ -83,8 +93,11 @@ export class KeyboardClass {
       try {
         await sleep(this.config.autoDelayMs);
         await this.providerRegistry.getKeyboard().pressKey(...keys);
+        const keyNames = keys.map((key) => Key[key]);
+        this.providerRegistry.getLogProvider().info(`Pressed keys ${keyNames}`);
         resolve(this);
       } catch (e) {
+        this.providerRegistry.getLogProvider().error(e as Error);
         reject(e);
       }
     });
@@ -106,8 +119,13 @@ export class KeyboardClass {
       try {
         await sleep(this.config.autoDelayMs);
         await this.providerRegistry.getKeyboard().releaseKey(...keys);
+        const keyNames = keys.map((key) => Key[key]);
+        this.providerRegistry
+          .getLogProvider()
+          .info(`Released keys ${keyNames}`);
         resolve(this);
       } catch (e) {
+        this.providerRegistry.getLogProvider().error(e as Error);
         reject(e);
       }
     });

Diff for: lib/mouse.class.ts

@@ -248,17 +248,10 @@ export class MouseClass {
       try {
         await sleep(this.config.autoDelayMs);
         await this.providerRegistry.getMouse().pressButton(btn);
+        const btnName = Button[btn];
         this.providerRegistry
           .getLogProvider()
-          .info(
-            `Pressed mouse button ${
-              btn === Button.LEFT
-                ? "left"
-                : btn === Button.MIDDLE
-                ? "middle"
-                : "right"
-            }`
-          );
+          .info(`Pressed ${btnName} mouse button`);
         resolve(this);
       } catch (e) {
         this.providerRegistry.getLogProvider().error(e as Error);
@@ -276,17 +269,10 @@ export class MouseClass {
       try {
         await sleep(this.config.autoDelayMs);
         await this.providerRegistry.getMouse().releaseButton(btn);
+        const btnName = Button[btn];
         this.providerRegistry
           .getLogProvider()
-          .info(
-            `Released mouse button ${
-              btn === Button.LEFT
-                ? "left"
-                : btn === Button.MIDDLE
-                ? "middle"
-                : "right"
-            }`
-          );
+          .info(`Pressed ${btnName} mouse button`);
         resolve(this);
       } catch (e) {
         this.providerRegistry.getLogProvider().error(e as Error);
@@ -304,17 +290,10 @@ export class MouseClass {
       try {
         await sleep(this.config.autoDelayMs);
         await this.providerRegistry.getMouse().click(btn);
+        const btnName = Button[btn];
         this.providerRegistry
           .getLogProvider()
-          .info(
-            `Clicked ${
-              btn === Button.LEFT
-                ? "left"
-                : btn === Button.MIDDLE
-                ? "middle"
-                : "right"
-            } button`
-          );
+          .info(`Pressed ${btnName} mouse button`);
         resolve(this);
       } catch (e) {
         this.providerRegistry.getLogProvider().error(e as Error);
@@ -332,17 +311,10 @@ export class MouseClass {
       try {
         await sleep(this.config.autoDelayMs);
         await this.providerRegistry.getMouse().doubleClick(btn);
+        const btnName = Button[btn];
         this.providerRegistry
           .getLogProvider()
-          .info(
-            `Double-clicked ${
-              btn === Button.LEFT
-                ? "left"
-                : btn === Button.MIDDLE
-                ? "middle"
-                : "right"
-            } button`
-          );
+          .info(`Pressed ${btnName} mouse button`);
         resolve(this);
       } catch (e) {
         this.providerRegistry.getLogProvider().error(e as Error);