Add log line to detect edge condition (#1654)

* Add log line to detect edge condition * Change log position * Fix coverage * Change log type to debug * Update packages/core/src/network.js Co-authored-by: Pradum Kumar <[email protected]> * Change timing log to debug log * Fix test --------- Co-authored-by: Pradum Kumar <[email protected]>
percy · Jul 19, 2024 · c3cfcc4 · c3cfcc4
1 parent a1b2590
commit c3cfcc4
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 4 deletions.
diff --git a/packages/core/src/network.js b/packages/core/src/network.js
@@ -107,6 +107,19 @@ export class Network {
         throw error;
       }
     });
+
+    // After waiting for network to idle check if there are still some request
+    const activeRequests = this.getActiveRequests(filter);
+    /* istanbul ignore if: race condition, very hard to mock this */
+    if (activeRequests.length > 0) {
+      this.log.debug(`There are ${activeRequests.length} active requests pending during asset discovery. Try increasing the networkIdleTimeout to resolve this issue. \n ${activeRequests}`);
+    }
+  }
+
+  getActiveRequests(filter) {
+    let requests = Array.from(this.#requests.values()).filter(filter);
+    requests = requests.filter((req) => !this.#finishedUrls.has(req.url));
+    return requests;
   }
 
   // Validates that requestId is still valid as sometimes request gets cancelled and we have already executed

diff --git a/packages/core/src/timing.js b/packages/core/src/timing.js
@@ -16,7 +16,7 @@ export default class TimeIt {
       return await callback();
     } finally {
       const duration = Date.now() - startTime;
-      this.log.info(`${name} - ${identifier} - ${duration / 1000}s`);
+      this.log.debug(`${name} - ${identifier} - ${duration / 1000}s`);
     }
   }
 }
diff --git a/packages/core/test/snapshot.test.js b/packages/core/test/snapshot.test.js
@@ -587,7 +587,6 @@ describe('Snapshot', () => {
       domSnapshot: testDOM
     });
 
-    expect(logger.stdout).toContain(jasmine.stringContaining('[percy] asset-discovery - test snapshot'));
     expect(logger.stderr).toEqual([
       '[percy] Encountered an error taking snapshot: test snapshot',
       '[percy] Error: unexpected snapshot error'

diff --git a/packages/core/test/unit/timing.test.js b/packages/core/test/unit/timing.test.js
@@ -25,11 +25,14 @@ describe('TimeIt', () => {
       // response for it as well.
       spyOn(Date, 'now').and.returnValues(date1, date1, date2, date1);
       const timeit = new TimeIt();
+      timeit.log.loglevel('debug');
       const callback = async () => { log.info('abcd'); };
       await timeit.measure('step', 'test', callback);
       expect(mockLogger.stdout).toEqual([
-        '[percy] abcd',
-        '[percy] step - test - 60s'
+        '[percy] abcd'
+      ]);
+      expect(mockLogger.stderr).toEqual([
+        '[percy:timer] step - test - 60s'
       ]);
     });
   });