Feature/371/logging provider (#456)

* (#371) Added first definition of log provider interface

* (#371) First draft implementation of a log provider

* (#371) Register log provider in registry

* (#371) Export function to connect external logger

* (#371) First test log

* (#371) Restructured log providers

* (#371) Restructured logging code, extended functionality of ConsoleLogProvider for timestamps and log levels

* (#371) Removed dev code from mouse.class

* (#371) Added log output to provider registry

* (#371) Updated exports

* (#371) Introduced dedicated folder for log providers

* (#371) Started adding log output to window.function.ts, sleep.function.ts and screen.class.ts

* (#371) More log output for screen.class.ts

* (#371) Clipboard logging

* (#371) Fixed tests

* Deleted debug file

* (#371) Updated .gitignore

* (#371) Added early returns to image processor + test case

* (#371) ConsoleLogProvider test

Author: s1hofmann

.gitignore

@@ -140,3 +140,5 @@ fabric.properties
 /foo_asdf.jpg
 /.scratch/
 docs
+scratch.js
+debug.js

index.ts

@@ -39,6 +39,12 @@ export { Region } from "./lib/region.class";
 export { Window } from "./lib/window.class";
 export { FileType } from "./lib/file-type.enum";
 export { ColorMode } from "./lib/colormode.enum";
+export { LogProviderInterface } from "./lib/provider/log-provider.interface";
+export {
+  useLogger,
+  useConsoleLogger,
+  ConsoleLogLevel,
+} from "./lib/logging.function";
 
 const lineHelper = new LineHelper();
 
@@ -63,6 +69,7 @@ const imageResource = (fileName: string) =>
     screen.config.resourceDirectory,
     fileName
   );
+
 export { fetchFromUrl } from "./lib/imageResources.function";
 
 export {

lib/clipboard.class.spec.ts

@@ -2,6 +2,7 @@ import { ClipboardClass } from "./clipboard.class";
 import { ProviderRegistry } from "./provider/provider-registry.class";
 import { mockPartial } from "sneer";
 import { ClipboardProviderInterface } from "./provider";
+import { NoopLogProvider } from "./provider/log/noop-log-provider.class";
 
 jest.mock("jimp", () => {});
 
@@ -21,6 +22,7 @@ describe("Clipboard class", () => {
         copy: copyMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
     const textToCopy = "bar";
 
     // WHEN
@@ -40,6 +42,7 @@ describe("Clipboard class", () => {
         paste: pasteMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
     // WHEN
     SUT.paste();

lib/clipboard.class.ts

@@ -15,13 +15,15 @@ export class ClipboardClass {
    * @param text The text to copy
    */
   public copy(text: string): Promise<void> {
+    this.providerRegistry.getLogProvider().debug(`Saving to clipboard`);
     return this.providerRegistry.getClipboard().copy(text);
   }
 
   /**
    * {@link paste} returns the current content of the system clipboard (limited to text)
    */
   public paste(): Promise<string> {
+    this.providerRegistry.getLogProvider().debug(`Fetching clipboard content`);
     return this.providerRegistry.getClipboard().paste();
   }
 }

lib/logging.function.ts

@@ -0,0 +1,13 @@
+import { LogProviderInterface } from "./provider";
+import { ConsoleLogLevel, ConsoleLogProvider, ConsoleLogProviderConfig } from "./provider/log/console-log-provider.class";
+import providerRegistry from "./provider/provider-registry.class";
+
+export const useLogger = (logger: LogProviderInterface) => {
+  providerRegistry.registerLogProvider(logger);
+};
+
+export const useConsoleLogger = (config?: ConsoleLogProviderConfig) => {
+  providerRegistry.registerLogProvider(new ConsoleLogProvider(config));
+}
+
+export { ConsoleLogLevel }

lib/mouse.class.spec.ts

@@ -5,6 +5,7 @@ import { LineHelper } from "./util/linehelper.class";
 import { ProviderRegistry } from "./provider/provider-registry.class";
 import { mockPartial } from "sneer";
 import { MouseProviderInterface } from "./provider";
+import { NoopLogProvider } from "./provider/log/noop-log-provider.class";
 
 beforeEach(() => {
   jest.clearAllMocks();
@@ -43,6 +44,7 @@ describe("Mouse class", () => {
         scrollLeft: scrollMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
     // WHEN
     const result = await SUT.scrollLeft(scrollAmount);
@@ -64,6 +66,7 @@ describe("Mouse class", () => {
         scrollRight: scrollMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
     // WHEN
     const result = await SUT.scrollRight(scrollAmount);
@@ -85,6 +88,7 @@ describe("Mouse class", () => {
         scrollDown: scrollMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
     // WHEN
     const result = await SUT.scrollDown(scrollAmount);
@@ -106,6 +110,7 @@ describe("Mouse class", () => {
         scrollUp: scrollMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
     // WHEN
     const result = await SUT.scrollUp(scrollAmount);
@@ -127,6 +132,7 @@ describe("Mouse class", () => {
         setMousePosition: setPositionMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
     // WHEN
     const result = await SUT.move(path);
@@ -152,6 +158,7 @@ describe("Mouse class", () => {
         releaseButton: releaseButtonMock,
       })
     );
+    providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
     // WHEN
     const result = await SUT.drag(path);
@@ -182,6 +189,7 @@ describe("Mouse class", () => {
             releaseButton: releaseButtonMock,
           })
         );
+        providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
         // WHEN
         const pressed = await SUT.pressButton(input);
@@ -209,6 +217,7 @@ describe("Mouse class", () => {
             pressButton: mouseMock,
           })
         );
+        providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
         // WHEN
         const start = Date.now();
@@ -232,6 +241,7 @@ describe("Mouse class", () => {
             releaseButton: mouseMock,
           })
         );
+        providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
         // WHEN
         const start = Date.now();
@@ -262,6 +272,7 @@ describe("Mouse class", () => {
               click: clickMock,
             })
           );
+          providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
           // WHEN
           await SUT.click(input);
@@ -289,6 +300,7 @@ describe("Mouse class", () => {
               doubleClick: clickMock,
             })
           );
+          providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
           // WHEN
           await SUT.doubleClick(input);
@@ -312,6 +324,7 @@ describe("Mouse class", () => {
             click: clickMock,
           })
         );
+        providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
         // WHEN
         const result = await SUT.leftClick();
@@ -336,6 +349,7 @@ describe("Mouse class", () => {
             click: clickMock,
           })
         );
+        providerRegistryMock.getLogProvider = () => new NoopLogProvider();
 
         // WHEN
         const result = await SUT.rightClick();

lib/mouse.class.ts

@@ -50,11 +50,15 @@ export class MouseClass {
         `setPosition requires a Point, but received ${JSON.stringify(target)}`
       );
     }
+    this.providerRegistry
+      .getLogProvider()
+      .info("Setting mouse position", target);
     return new Promise<MouseClass>(async (resolve, reject) => {
       try {
         await this.providerRegistry.getMouse().setMousePosition(target);
         resolve(this);
       } catch (e) {
+        this.providerRegistry.getLogProvider().error(e as Error);
         reject(e);
       }
     });

lib/provider/image/jimp-image-processor.class.spec.ts

@@ -0,0 +1,60 @@
+import { Image } from "../../image.class";
+import { Point } from "../../point.class";
+import JimpImageProcessor from "./jimp-image-processor.class";
+
+const imageWidth = 10;
+const imageHeight = 20;
+
+describe("JimpImageProcessor", () => {
+  it.each([[new Point(-1, 5)], [new Point(imageWidth + 5, 5)]])(
+    `should reject on out of bounds x coordinates`,
+    async (outOfBoundsPoint: Point) => {
+      // GIVEN
+      const inputImage = new Image(
+        imageWidth,
+        imageHeight,
+        Buffer.from([0, 0, 0]),
+        3,
+        "input_image",
+        4,
+        4
+      );
+      const SUT = new JimpImageProcessor();
+
+      // WHEN
+      const result = SUT.colorAt(inputImage, outOfBoundsPoint);
+
+      // THEN
+      await expect(result).rejects.toBe(
+        `Query location out of bounds. Should be in range 0 <= x < image.width, is ${outOfBoundsPoint.x}`
+      );
+    }
+  );
+
+  it.each([[new Point(5, -1)], [new Point(5, imageHeight + 10)]])(
+    `should reject on out of bounds y coordinates`,
+    async (outOfBoundsPoint: Point) => {
+      // GIVEN
+      const imageWidth = 10;
+      const imageHeight = 20;
+      const inputImage = new Image(
+        imageWidth,
+        imageHeight,
+        Buffer.from([0, 0, 0]),
+        3,
+        "input_image",
+        4,
+        4
+      );
+      const SUT = new JimpImageProcessor();
+
+      // WHEN
+      const result = SUT.colorAt(inputImage, outOfBoundsPoint);
+
+      // THEN
+      await expect(result).rejects.toBe(
+        `Query location out of bounds. Should be in range 0 <= y < image.height, is ${outOfBoundsPoint.y}`
+      );
+    }
+  );
+});

lib/provider/image/jimp-image-processor.class.ts

@@ -17,11 +17,13 @@ export default class implements ImageProcessor {
         reject(
           `Query location out of bounds. Should be in range 0 <= x < image.width, is ${location.x}`
         );
+        return;
       }
       if (location.y < 0 || location.y >= img.height) {
         reject(
           `Query location out of bounds. Should be in range 0 <= y < image.height, is ${location.y}`
         );
+        return;
       }
       const jimpImage = imageToJimp(img);
       const rgba = Jimp.intToRGBA(

lib/provider/index.ts

@@ -1,10 +1,11 @@
-export { ClipboardProviderInterface } from "./clipboard-provider.interface";
-export { DataSinkInterface } from "./data-sink.interface";
-export { DataSourceInterface } from "./data-source.interface";
-export { ImageFinderInterface } from "./image-finder.interface";
-export { ImageReader } from "./image-reader.type";
-export { ImageWriter, ImageWriterParameters } from "./image-writer.type";
-export { KeyboardProviderInterface } from "./keyboard-provider.interface";
-export { MouseProviderInterface } from "./mouse-provider.interface";
-export { ScreenProviderInterface } from "./screen-provider.interface";
-export { WindowProviderInterface } from "./window-provider.interface";
+export {ClipboardProviderInterface} from "./clipboard-provider.interface";
+export {DataSinkInterface} from "./data-sink.interface";
+export {DataSourceInterface} from "./data-source.interface";
+export {ImageFinderInterface} from "./image-finder.interface";
+export {ImageReader} from "./image-reader.type";
+export {ImageWriter, ImageWriterParameters} from "./image-writer.type";
+export {KeyboardProviderInterface} from "./keyboard-provider.interface";
+export {MouseProviderInterface} from "./mouse-provider.interface";
+export {ScreenProviderInterface} from "./screen-provider.interface";
+export {WindowProviderInterface} from "./window-provider.interface";
+export {LogProviderInterface} from "./log-provider.interface";