From a841c4eb82849cf625a527446f34cfd77ab6dfeb Mon Sep 17 00:00:00 2001
From: doubleface <christophe@cozycloud.cc>
Date: Mon, 17 Jun 2024 09:09:09 +0200
Subject: [PATCH] feat: Add optionnal suffix property to runInWorkerUntilTrue

This property, if present, will be used to better identify
the source of timeout error and especially the selector which failed to
be found.

Usage:

```javascript
this.runInWorkerUntilTrue({method, suffix: 'current context as string'})
```
---
 .../cozy-clisk/src/contentscript/ContentScript.js     | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/packages/cozy-clisk/src/contentscript/ContentScript.js b/packages/cozy-clisk/src/contentscript/ContentScript.js
index 5448183b7..1e659ec8e 100644
--- a/packages/cozy-clisk/src/contentscript/ContentScript.js
+++ b/packages/cozy-clisk/src/contentscript/ContentScript.js
@@ -358,11 +358,17 @@ export default class ContentScript {
    * @param {object} options        - options object
    * @param {string} options.method - name of the method to run
    * @param {number} [options.timeout] - number of miliseconds before the function sends a timeout error. Default Infinity
+   * @param {string} [options.suffix] - suffix used in timeout error message, to better identify error source
    * @param {Array} [options.args] - array of args to pass to the method
    * @returns {Promise<boolean>} - true
    * @throws {TimeoutError} - if timeout expired
    */
-  async runInWorkerUntilTrue({ method, timeout = Infinity, args = [] }) {
+  async runInWorkerUntilTrue({
+    method,
+    timeout = Infinity,
+    suffix = '',
+    args = []
+  }) {
     this.onlyIn(PILOT_TYPE, 'runInWorkerUntilTrue')
     log.debug('runInWorkerUntilTrue', method)
     let result = false
@@ -371,7 +377,7 @@ export default class ContentScript {
     while (!result) {
       if (isTimeout()) {
         throw new TimeoutError(
-          `runInWorkerUntilTrue ${method} Timeout error after ${timeout}`
+          `runInWorkerUntilTrue ${method}${suffix} Timeout error after ${timeout}`
         )
       }
       log.debug('runInWorker call', method)
@@ -394,6 +400,7 @@ export default class ContentScript {
     this.onlyIn(PILOT_TYPE, 'waitForElementInWorker')
     await this.runInWorkerUntilTrue({
       method: 'waitForElementNoReload',
+      suffix: selector,
       timeout:
         options?.timeout ?? DEFAULT_WAIT_FOR_ELEMENT_ACCROSS_PAGES_TIMEOUT,
       args: [selector, { includesText: options.includesText }]