Default timeout of commands should be documented in API reference

[bartekpacia]

Commands that wait by default if the action cannot be performed immediately (e.g. tapOn on a view that is not yet visible, waitForAnimationToEnd) should have their timeouts clearly documented in API reference.

I just wanted to find out what the timeout for waitForAnimationToEnd is, and to do that, I had to look at the source code.

[bartekpacia]

Ah, it's here: https://maestro.mobile.dev/advanced/configuring-maestro-driver-timeout.

I think this page should be linked to from Commands.

[CyberCyclone]

Ah, it's here: https://maestro.mobile.dev/advanced/configuring-maestro-driver-timeout.

MAESTRO_DRIVER_STARTUP_TIMEOUT is just for app startup. It doesn't change the default timeout between actions. E.g, an action that takes 60 seconds to process is terminated early even with MAESTRO_DRIVER_STARTUP_TIMEOUT set.

[btrautmann]

Is there no way to actually configure command timeouts individually? I can't seem to find one 🤔

- runFlow:
    when:
      visible: "${INPUT_TEXT}.*" # I want to configure this to something like 1500ms
    commands:
      - tapOn: "${INPUT_TEXT}.*"

[navignaw]

In case it's useful, I did some spelunking in the source code and found a waitUntilVisible function which appears to wait up to 10 seconds, checking every second. It doesn't seem too hard to make it configurable by adding an extra parameter.

I do agree that documenting the default timeout in all of these commands would be great. It might even be desirable to configure the default timeout with an env variable like MAESTRO_DEFAULT_TIMEOUT, so that you can set it once rather than per command.

[Fishbowler]

Configurable things:

• waitForAnimationToEnd has a default timeout of 15s
• scrollUntilVisible has a default timeout of 20s

Fixed things:

• Lots of commands have waitForAppToSettle, which on Android should have a max time of 750ms, and on iOS is 3s.
• As spotted by @navignaw, a tap also has a wait for an element to be visible, if it isn't already, that will wait a maximum of 10s