Setting timeout values not working for custom assertions

[kretschmannj]

I wrote a custom assertion and I'm trying to figure out how to override the default assertion timeout. I know that I can set the retryAssertionTimeout and waitForConditionTimeout values in the nightwatch config file but I don't want to set these values globally. Rather, I want to set the timeout value for only one specific call to my custom assertion. I've tried ...

this.timeouts('implicit', 30000)
this.globals.retryAssertionTimeout = 30000
this.globals.waitForConditionTimeout = 30000
this.options.globals.retryAssertionTimeout = 30000
this.options.globals.waitForConditionTimeout = 30000

... but none of these are overriding the default value (5000ms). Is there a way to override the default assertion timeout value for a single call to a custom assertion?

Nightwatch v. 1.5.0

[beatfactor]

You're probably trying to override the default value when it's already defined. I think what you should do is to specify the element as an object, where you can also specify the timeout as a property.

See Element Properties.

[kretschmannj]

@beatfactor Thanks for the tip. I tried this ...

module.exports = {
    'Demo test': function (browser) {
      browser.verify.visible({selector: '#someBogusElement', timeout: 1})
    }
  }

... but it doesn't seem like the timeout value is being used ...

× Testing if element <#someBogusElement> is visible in 5000ms - expected "is visible" but got: "element could not be located" (5280ms)
at Object.Demo test (C:\git\portal-ui-tests\tests\sandbox\timeoutTest.js:3:22)
at processTicksAndRejections (internal/process/task_queues.js:97:5)

... and in the verbose output I see this ...

→ Running command: verify.visible ({selector, timeout})

→ Running command: isVisible ({selector, timeout}, [Function])
Request POST /wd/hub/session/f0c00512-289a-445e-97f6-4a94f05e6fa1/elements
{ using: 'css selector', value: '#someBogusElement' }
Response 200 POST /wd/hub/session/f0c00512-289a-445e-97f6-4a94f05e6fa1/elements (21ms)
{
state: 'success',
sessionId: null,
class: 'org.openqa.selenium.remote.Response',
value: [],
status: 0
}
→ Completed command: isVisible ({selector, timeout}, [Function]) (26ms)

I'm on Nightwatch v1.5.1

[kretschmannj]

I did a little more testing and found that I can increase the timeout above the default value of 5000ms ...
browser.verify.visible({selector: '#someBogusElement', timeout: 60000})
... but apparently it's not possible to decrease the timeout to less than 5000ms.

[kretschmannj]

So, getting back to the original issue, I wrote a custom assertion 'urlMatches' that is similar to expect.url().to.match('.org') but will accept a string as well as regex and includes some custom logging. Since this assertion doesn't take an 'element' as one of the parameters, it does no good to create an element object with the 'timeout' property. As mentioned, I tried a variety of ways to set the timeout value but none of them work in this case. The main part of the urlMatches assertion looks like this ...

            if (expression.toString().charAt(0) == '/') {
                result = expression.test(value) // 'test' is for regex
            } else {
                result = value.includes(expression) // 'includes' is for string
            }

Some of the URLs I'm testing take longer than 5 seconds to load so I'd like to be able to specify a timeout value so that the urlMatches assertion would continue retrying for the specified timeout.

[beatfactor]

Yes, that's right. We should add it to the main api as I can see it could be useful. Can you open a PR?

[Pieras2]

Honestly speaking it would be nice if assertion timeout could be decreased.
I started some visual regression tests with nightwach--vrt and I cannot decrease timeout to .. have to wait always until default timeout however I know about a fail very quickly ... @beatfactor is it possible to enhance API by assertions timeout?

[ShripadBothale]

On similar line i have few test which checks element not present as per the user roles and it has more than 50 checks so when we had bug in one of the feature and that check failed so the test time was changed dramatically as for every assert it waited for 5 seconds :( .
anyone found any solution on decreasing the timeout?