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

Author: s1hofmann

Diff for: lib/screen.class.ts

@@ -78,6 +78,7 @@ export class ScreenClass {
      * Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher width in in actual pixels
      */
     public width() {
+        this.providerRegistry.getLogProvider().debug(`Fetching screen width`);
         return this.providerRegistry.getScreen().screenWidth();
     }
 
@@ -87,6 +88,7 @@ export class ScreenClass {
      * Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher height in in actual pixels
      */
     public height() {
+        this.providerRegistry.getLogProvider().debug(`Fetching screen height`);
         return this.providerRegistry.getScreen().screenHeight();
     }
 
@@ -108,6 +110,7 @@ export class ScreenClass {
         } = await this.getFindParameters(params);
 
         const needle = await ScreenClass.getNeedle(template);
+        this.providerRegistry.getLogProvider().info(`Searching for image ${needle.id} in region ${searchRegion.toString()} ${searchMultipleScales ? 'over multiple scales' : 'without scaling'}. Required confidence: ${minMatch}`);
 
         const matchRequest = new MatchRequest(
             screenImage,
@@ -119,9 +122,12 @@ export class ScreenClass {
         return new Promise<Region>(async (resolve, reject) => {
             try {
                 validateSearchRegion(searchRegion, screenSize);
+                this.providerRegistry.getLogProvider().debug(`Search region is valid`);
                 const matchResult = await this.providerRegistry.getImageFinder().findMatch(matchRequest);
                 const possibleHooks = this.findHooks.get(needle) || [];
+                this.providerRegistry.getLogProvider().debug(`${possibleHooks.length} hooks triggered for match`);
                 for (const hook of possibleHooks) {
+                    this.providerRegistry.getLogProvider().debug(`Executing hook`);
                     await hook(matchResult);
                 }
                 const resultRegion = new Region(
@@ -130,7 +136,9 @@ export class ScreenClass {
                     matchResult.location.width,
                     matchResult.location.height
                 )
+                this.providerRegistry.getLogProvider().info(`Match is located at ${resultRegion.toString()}`);
                 if (this.config.autoHighlight) {
+                    this.providerRegistry.getLogProvider().debug(`Autohighlight is enabled`);
                     resolve(this.highlight(resultRegion));
                 } else {
                     resolve(resultRegion);
@@ -161,6 +169,7 @@ export class ScreenClass {
         } = await this.getFindParameters(params);
 
         const needle = await ScreenClass.getNeedle(template);
+        this.providerRegistry.getLogProvider().info(`Searching for image ${needle.id} in region ${searchRegion.toString()} ${searchMultipleScales ? 'over multiple scales' : 'without scaling'}. Required confidence: ${minMatch}`);
 
         const matchRequest = new MatchRequest(
             screenImage,
@@ -172,22 +181,28 @@ export class ScreenClass {
         return new Promise<Region[]>(async (resolve, reject) => {
             try {
                 validateSearchRegion(searchRegion, screenSize);
+                this.providerRegistry.getLogProvider().debug(`Search region is valid`);
                 const matchResults = await this.providerRegistry.getImageFinder().findMatches(matchRequest);
                 const possibleHooks = this.findHooks.get(needle) || [];
+                this.providerRegistry.getLogProvider().debug(`${possibleHooks.length} hooks triggered for ${matchResults.length} matches`);
                 for (const hook of possibleHooks) {
                     for (const matchResult of matchResults) {
+                        this.providerRegistry.getLogProvider().debug(`Executing hook`);
                         await hook(matchResult);
                     }
                 }
                 const resultRegions = matchResults.map(matchResult => {
-                    return new Region(
+                    const resultRegion = new Region(
                         searchRegion.left + matchResult.location.left,
                         searchRegion.top + matchResult.location.top,
                         matchResult.location.width,
                         matchResult.location.height
                     )
+                    this.providerRegistry.getLogProvider().info(`Match is located at ${resultRegion.toString()}`);
+                    return resultRegion;
                 })
                 if (this.config.autoHighlight) {
+                    this.providerRegistry.getLogProvider().debug(`Autohighlight is enabled`);
                     resultRegions.forEach(region => this.highlight(region));
                     resolve(resultRegions);
                 } else {
@@ -207,6 +222,7 @@ export class ScreenClass {
      */
     public async highlight(regionToHighlight: Region | Promise<Region>): Promise<Region> {
         const highlightRegion = await regionToHighlight;
+        this.providerRegistry.getLogProvider().info(`Highlighting ${highlightRegion.toString()} for ${this.config.highlightDurationMs / 1000} with ${this.config.highlightOpacity * 100}% opacity`);
         await this.providerRegistry.getScreen().highlightScreenRegion(highlightRegion, this.config.highlightDurationMs, this.config.highlightOpacity);
         return highlightRegion;
     }
@@ -229,6 +245,7 @@ export class ScreenClass {
         if (!isImage(needle)) {
             throw Error(`waitFor requires an Image, but received ${JSON.stringify(templateImage)}`)
         }
+        this.providerRegistry.getLogProvider().info(`Waiting for image ${needle.id} to appear on screen. Timeout: ${timeoutMs / 1000} seconds, interval: ${updateInterval} ms`);
         return timeout(updateInterval, timeoutMs, () => this.find(needle, params), {signal: params?.abort});
     }
 
@@ -243,6 +260,7 @@ export class ScreenClass {
         }
         const existingHooks = this.findHooks.get(templateImage) || [];
         this.findHooks.set(templateImage, [...existingHooks, callback]);
+        this.providerRegistry.getLogProvider().info(`Registered callback for image ${templateImage.id}. There are currently ${existingHooks.length + 1} hooks registered`);
     }
 
     /**

Diff for: lib/sleep.function.ts

@@ -1,4 +1,7 @@
+import providerRegistry from "./provider/provider-registry.class";
+
 export const sleep = async (ms: number) => {
+  providerRegistry.getLogProvider().info(`Sleeping for ${ms / 1000} seconds`);
   return new Promise<void>(resolve => setTimeout(resolve, ms));
 };
 

Diff for: lib/window.function.ts

@@ -6,10 +6,12 @@ export const createWindowApi = (providerRegistry: ProviderRegistry): WindowApi =
   return ({
     async getActiveWindow(): Promise<Window> {
       const windowHandle = await providerRegistry.getWindow().getActiveWindow();
+      providerRegistry.getLogProvider().info('Active window handle', {windowHandle});
       return new Window(providerRegistry, windowHandle);
     },
     async getWindows(): Promise<Window[]> {
       const windowHandles = await providerRegistry.getWindow().getWindows();
+      providerRegistry.getLogProvider().info(`Retrieved ${windowHandles.length} window handles`);
       return windowHandles.map((handle: number) => {
         return new Window(providerRegistry, handle);
       });