Add State Provider Framework Deep Dive #248
Conversation
|
No New Or Fixed Issues Found |
Co-authored-by: Matt Gibson <[email protected]>
Deploying contributing-docs with
|
| Latest commit: |
fcdc588
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://060117a9.contributing-docs.pages.dev |
| Branch Preview URL: | https://add-state-provider-framework.contributing-docs.pages.dev |
Co-authored-by: Matt Gibson <[email protected]>
Co-authored-by: Matt Bishop <[email protected]>
Co-authored-by: audrey-jensen <[email protected]>
* First pass at derived state documentation * `npm run prettier` 🤖 * Apply suggestions from code review Co-authored-by: Matt Bishop <[email protected]> --------- Co-authored-by: Matt Bishop <[email protected]>
There was a problem hiding this comment.
I'm happy with this, but I'll leave it to @withinfocus since I worked on this quite a bit.
|
|
||
| ## Structure | ||
|
|
||
|  |
There was a problem hiding this comment.
🌱 I'm noticing a lot of variety in our diagrams. Would be nice to standardize on look and feel.
There was a problem hiding this comment.
I think this probably used Excalidraw, whereas we've previously used PlantUML. I personally like the slightly less formal style of this diagram, but if we'd like standardization I can move this to PlantUML if it would be helpful.
There was a problem hiding this comment.
Another possibility is to use a markdown-compatible renderer, such as mermaid or GoAT.
Co-authored-by: Matt Bishop <[email protected]>
#296) * Added optional constructor parameter and updated mapping instructions. * Fixed table * Changed verbiage. * Updated verbiage.
…itwarden/contributing-docs into add-state-provider-framework-deep-dive
justindbaur
requested review from
withinfocus,
MGibson1,
trmartin4 and
audreyality
|
Well it has only been 8 months but I'd love to try and merge this in 🫤. |
|
|
||
| ::: | ||
|
|
||
| #### `StateDefinition` | ||
|
|
||
| :::note | ||
|
|
||
| Secure storage is not currently supported as a storage location in the State Provider Framework. For |
There was a problem hiding this comment.
❓ Is secure storage just a description, or does it refer to an emerging web api?
| The Platform team will be responsible to reviewing all new and updated entries in this file and will | ||
| be looking to make sure that there are no duplicate entries containing the same state name and state |
There was a problem hiding this comment.
⛏️ Consider using present tense.
| The framework provides both `KeyDefinition` and `UserKeyDefinition` for teams to use. The | ||
| `UserKeyDefinition` should be used for defining pieces of state that are scoped at a user level. |
There was a problem hiding this comment.
⛏️ Consider stating this as an instruction. "Use UserKeyDefinition for state scoped to a user and KeyDefinition for user-independent state." or similar.
| [`KeyDefinitionOptions`](#keydefinitionoptions). | ||
| The arguments for defining a `KeyDefinition` or `UserKeyDefinition` are: | ||
|
|
||
| | Argument | Usage | |
There was a problem hiding this comment.
👍🏻 Love presenting the options and arguments using tables!
| @@ -172,6 +200,13 @@ class FolderService { | |||
|
|
|||
| ### `ActiveUserState<T>` | |||
|
|
|||
| :::warning | |||
|
|
|||
| `ActiveUserState` has problems with consider not using it anymore, | |||
There was a problem hiding this comment.
⛏️ Looks like you a word. "ActiveUserState has race condition problems. Do not use it for updates and consider transitioning your code to SingleUserState instead."
Objective
To document the newly added State Provider Framework added in bitwarden/clients#6640 and refined in bitwarden/clients#6860.