docs: Explain how FlowStages work and their rationale #558
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
civsiv
reviewed
Aug 31, 2023
packages/openactive-integration-tests/test/helpers/flow-stages/README.md
Outdated
Show resolved
Hide resolved
civsiv
reviewed
Aug 31, 2023
| FlowStages can then be queried after they've run in order to: | ||
|
|
||
| 1. Check that the FlowStage was successful | ||
| - This is overridable per-FlowStage. For example, B's Flow Stage considers the run successful if the HTTP response has status 201 |
There was a problem hiding this comment.
Are there default success checks? I can't remember if it does a default 200 check? If so something like:
Suggested change
| - This is overridable per-FlowStage. For example, B's Flow Stage considers the run successful if the HTTP response has status 201 | |
| - This is overridable per-FlowStage. For example, B's Flow Stage considers the run successful if the HTTP response has status 201 as opposed to the default FlowStage behaviour that checks for status 200 |
The only reason I'm wondering whether there's default behaiour is due to the word "overridable". If there's no default behaviour, what's being overridden?
There was a problem hiding this comment.
There are not. So I'll change the word overridable
civsiv
reviewed
Aug 31, 2023
| - This is overridable per-FlowStage. For example, B's Flow Stage considers the run successful if the HTTP response has status 201 | ||
| - FlowStage method: `itSuccessChecks()` | ||
| 2. Perform validation checks on the output | ||
| - This is overridable per-FlowStage. In all cases, this is a case of calling [Validator](https://github.com/openactive/data-model-validator) on the HTTP output. |
There was a problem hiding this comment.
Same comment here re overridable
civsiv
reviewed
Aug 31, 2023
packages/openactive-integration-tests/test/helpers/flow-stages/README.md
Outdated
Show resolved
Hide resolved
civsiv
requested changes
Aug 31, 2023
|
|
||
| Flows, consisting of Flow Stages, run the underlying API calls which are being tested, via Jest in the various Test Suite tests. | ||
|
|
||
| Jest tests involve a custom course of execution, in which setup occurs in `beforeEach`/`beforeAll` hooks, tests are run in `it` hooks, etc. Flow Stages are designed to work with this. |
There was a problem hiding this comment.
Suggested change
| Jest tests involve a custom course of execution, in which setup occurs in `beforeEach`/`beforeAll` hooks, tests are run in `it` hooks, etc. Flow Stages are designed to work with this. | |
| Jest tests involve a custom course of execution, in which setup occurs in `beforeEach`/`beforeAll` hooks and tests are run in `it` hooks, etc. Flow Stages are designed to work with this. |
There was a problem hiding this comment.
i've done it slightly differently involving semicolons
packages/openactive-integration-tests/test/helpers/flow-stages/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: civsiv <[email protected]>
Co-authored-by: civsiv <[email protected]>
Co-authored-by: civsiv <[email protected]>
|
@civsiv confirmed this as approved on another channel |
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.
Closes #557