Introduce state management package to keep state of messages feature and global state #4948
Conversation
|
Download the artifacts for this pull request:
See Testing a PR |
|
Please add to the OP a practical statement about what this will be used for and what it means. You'll need to explain "state management" and its impact on existing code. Also, please say whether this could be introduced in the near term or whether it needs to wait until after our major release. |
gilbertsoft
force-pushed
the
task/introduce-state
branch
2 times, most recently
from
ca50cb1
to
03d7957
Compare
Done. As written above code is currently not in use but a preparation for #4885. |
|
What I'm asking for is a practical description of what this does and why, and how it will change other code. Please choose an example command/state/config and explain how this will change that. |
sth like this? https://github.com/ddev/ddev/pull/4948/files#diff-102188c33aa91417b0ad17f55fa004a97b79d743024b7be5c1db269da3380076 |
|
I'm asking you to improve the PR OP above with a practical example, taken from DDEV, of how this changes things. Explain what this means to DDEV, what it changes, what motivates it. |
|
If my words in this PR don't make any sense I'm happy to do a call with you and we can do question-and-answer to get this out. |
rfay
changed the title
gilbertsoft
force-pushed
the
task/introduce-state
branch
2 times, most recently
from
d5bc45a
to
8c40d2f
Compare
gilbertsoft
force-pushed
the
task/introduce-state
branch
from
8c40d2f
to
2f10f03
Compare
|
https://github.com/mitchellh/mapstructure looks like a wonderful thing. Could be used several other places. |
There was a problem hiding this comment.
Thanks, I'll go with it! You can merge when you think it's ready. I usually try to make sure that the tests on master have succeeded before merging something new; the last two should be getting there pretty soon, but that latest commit there isn't very important (tests only) and the last two tests don't even use mutagen.
Yes, makes some things easier and more flexible compared to the json and yaml implementation. |
The Issue
State is currently mixed into configuration but should be separated into a dedicated state file instead. E.g. there is some state in the globalconfig
~/.ddev/global_config.ymlnamely the project infos or last started version.How This PR Solves The Issue
This PR introduces a small state management package which makes state handling easy possible by defining e.g. a state struct. The package supports the management of multiple states completey independant, means no cross dependencies are added from a state to another, a single state works completely independant. This ensures a clean per package state management but in a central place for the whole application within one state file. A state is accessed by his unique key.
PR should be merged as soon as the tests are completed.
Manual Testing Instructions
No manual testing is possible at the moment because the code is not used so far.
Automated Testing Overview
The packages are fully automated tested with multiple unit tests and for the YAML state storage also benchmark tests are included.
Related Issue Link(s)
Release/Deployment Notes
No side effects are possible at the moment because the code is not used so far.