feat: Renamed algorandFixture's beforeEach to newScope
#362
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…it clearer in intent and ensured that accounts that are registered are copied across successive contexts fix: Resolved bug in transactionLogger.waitForIndexer to only wait for the last transaction, not all logged transactions (which caused problems)
neilcampbell
approved these changes
Dec 21, 2024
| @@ -84,7 +131,7 @@ The `fixture.context` property is of type [`AlgorandTestAutomationContext`](../c | |||
| - `transactionLogger: TransactionLogger` - Transaction logger that will log transaction IDs for all transactions issued by `algod` | |||
| - `testAccount: Account` - Funded test account that is ephemerally created for each test | |||
| - `generateAccount: (params: GetTestAccountParams) => Promise<Account>` - Generate and fund an additional ephemerally created account | |||
| - `waitForIndexer: () => Promise<void>` - Wait for the indexer to catch up with all transactions logged by transactionLogger | |||
| - `waitForIndexer()` - Waits for indexer to catch up with that latest transaction that has been captured by the `transactionLogger` in the Algorand fixture | |||
There was a problem hiding this comment.
Suggested change
| - `waitForIndexer()` - Waits for indexer to catch up with that latest transaction that has been captured by the `transactionLogger` in the Algorand fixture | |
| - `waitForIndexer()` - Waits for indexer to catch up with the latest transaction that has been captured by the `transactionLogger` in the Algorand fixture |
| @@ -170,7 +217,7 @@ This means it's easy to create tests that are flaky and have intermittent test f | |||
| The testing capability provides mechanisms for waiting for indexer to catch up, namely: | |||
|
|
|||
| - `algotesting.runWhenIndexerCaughtUp(run: () => Promise<T>)` - Executes the given action every 200ms up to 20 times until there is no longer an error with a `status` property with `404` and then returns the result of the action; this will work for any call that calls indexer APIs expecting to return a single record | |||
| - `algorandFixture.waitForIndexer()` - Waits for indexer to catch up with all transactions that have been captured by the `transactionLogger` in the Algorand fixture | |||
| - `algorandFixture.waitForIndexer()` - Waits for indexer to catch up with that latest transaction that has been captured by the `transactionLogger` in the Algorand fixture | |||
There was a problem hiding this comment.
Suggested change
| - `algorandFixture.waitForIndexer()` - Waits for indexer to catch up with that latest transaction that has been captured by the `transactionLogger` in the Algorand fixture | |
| - `algorandFixture.waitForIndexer()` - Waits for indexer to catch up with the latest transaction that has been captured by the `transactionLogger` in the Algorand fixture |
| @@ -84,21 +84,26 @@ export function algorandFixture(fixtureConfig?: AlgorandFixtureConfig, config?: | |||
| const indexer = fixtureConfig.indexer ?? ClientManager.getIndexerClient(fixtureConfig.indexerConfig!) | |||
| const kmd = fixtureConfig.kmd ?? ClientManager.getKmdClient(fixtureConfig.kmdConfig!) | |||
| let context: AlgorandTestAutomationContext | |||
| let algorand: AlgorandClient | |||
| let algorand = AlgorandClient.fromClients({ algod, indexer, kmd }) | |||
There was a problem hiding this comment.
If a dev is using this before calling newScope, then the effect of detecting localnet and increasing the default validity window will not have run.
I'm wondering if we even need to create a default instance on calling the algorandFixture function?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes it clearer in intent and ensured that accounts that are registered are copied across successive contexts.
fix: Resolved bug in transactionLogger.waitForIndexer to only wait for the last transaction, not all logged transactions (which caused problems)