-
Notifications
You must be signed in to change notification settings - Fork 49
feat: introduce appendix section #199
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
toddbaert
merged 8 commits into
open-feature:main
from
Kavindu-Dodan:feat/appendix-section
Aug 1, 2023
Merged
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
aabc3aa
add appendix
Kavindu-Dodan b3848ec
improvements
Kavindu-Dodan b767180
Update specification/appendix.md
Kavindu-Dodan c149fd5
review changes
Kavindu-Dodan 31e9b29
improvements
Kavindu-Dodan 60bbcb1
Merge branch 'main' into feat/appendix-section
Kavindu-Dodan 9a4df2f
Update specification/appendix-A.md
toddbaert e9fa564
Update specification/appendix-A.md
toddbaert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: Appendix A: Included Utilities | ||
| description: Information on OpenFeature ecosystem utilities | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
| # Appendix A: Included Utilities | ||
|
|
||
| This document contains requirements for auxiliary utilities provided by the SDK, such as testing utilities. | ||
|
|
||
| ## In-memory provider | ||
|
|
||
| > Language specific OpenFeature SDK implementations **SHOULD** expose an in-memory provider built into the SDK. | ||
|
|
||
| The in-memory provider is intended to be used for testing, SDK consumers may use it for their use cases. | ||
| Hence, the packaging, naming and access modifiers must be set appropriately. | ||
|
|
||
| Given below are features this provider **MUST** support, | ||
|
|
||
| - Provider must be initiated with a pre-defined set of flags provided to a constructor | ||
| - Feature Flag structure must be minimal but should help testing OpenFeature specification | ||
| - EvaluationContext support should be provided through callbacks/lambda expressions | ||
| - Provider must support a means of updating flag values, resulting in the emission of `PROVIDER_CONFIGURATION_CHANGED` events | ||
| - Provider must be maintained to support specification changes | ||
|
|
||
| ## SDK end-to-end testing | ||
|
|
||
| > E2E tests must utilize [in-memory provider](#in-memory-provider) defined withing the SDK and must be self-contained. | ||
|
|
||
| OpenFeature project maintains end-to-end(e2e) test suite defined with [Gherkin syntax](https://cucumber.io/docs/gherkin/). | ||
| These test definitions resides in [OpenFeature test-harness](https://github.com/open-feature/test-harness) repository. | ||
toddbaert marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| subgraph SDK | ||
| A[e2e Tests] -.-> B[In-memory provider] | ||
| end | ||
| ``` | ||
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.
Uh oh!
There was an error while loading. Please reload this page.