expose current retry attempt with test / hook to programatically handle retries

[mattrlong]

Current behavior:

Prior to v5.0.0 and using cypress-retries-plugin the retry attempt could be programmatically obtained through Cypress.currentTest.currentRetry()

Have tried using Mocha's this.test._currentRetry but this is only usable within the tests (.it) and not the hooks where much of our test setup resides.

Interestingly keeping the plugin installed as a dependency seems to be working, although not sure what other consequences this might cause.

Desired behavior:

The same feature being made available natively through Cypress. Would be great to be made available on the Cypress global as before.

Test code to reproduce

Previous usage documented here.

Versions

Cypress v5.0.0

[kuceb]

It's undocumented, but you may use cy.state('test').currentRetry() to get the current retry number from anywhere in the spec.

If you use function () {} syntax,
In test bodies you may use this.test.currentRetry()
In hooks you may use this.currentTest.currentRetry()

I agree we should add a better api for accessing this and document it.

[mattrlong]

Thanks @bkucera, cy.state('test').currentRetry() looks to fulfil our requirements as this can also be used in support files.

[emilyrohrbough]

This was exposed as Cypress.currentRetry() in 12.3.0.