[7.x] [IngestManager] Move RequiredPackage type near DefaultPackages (#82188) #82654
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
## Summary
- [x] Move the `RequiredPackage` type to the same location as `DefaultPackages` so anyone looking at one will see the other as well
- [x] New approach to defining & using enum-like values.
## The basic outline of the approach
1. Export a JS object `as const` from `common/constants/*` (expose runtime value)
https://github.com/elastic/kibana/blob/d66cf601bb0466bd36254f40339ac41f9935436c/x-pack/plugins/ingest_manager/common/constants/epm.ts#L12-L15
1. Import that JS value and convert to a TS type as `type TSType = typeof jsValue`
<img width="484" alt="Screen Shot 2020-11-02 at 2 12 27 PM" src="https://user-images.githubusercontent.com/57655/97910756-2e693700-1d18-11eb-9605-e33ceb64e857.png">
1. The values (right-hand side) of that type can be converted to a union type with `ValueOf<X>`
<img width="557" alt="Screen Shot 2020-11-02 at 3 10 22 PM" src="https://user-images.githubusercontent.com/57655/97914250-99693c80-1d1d-11eb-9605-92379aa4db38.png">
1. The values can be accessed as TS types `TSType['key']` or JS `jsValue.key`
This way we
- still get the readability of TS `enum`s
- can choose to only import the types of values we need (compile time or runtime)
- use the TS utility types like `Pick`, `Omit`, etc
## More detail on 1
* Value which can be access/iterated at runtime, e.g. `Object.values(requiredPackages)` or `requiredPackages.System`
* narrows the type those exact values, not `string`
<img width="823" alt="Screen Shot 2020-11-02 at 2 15 58 PM" src="https://user-images.githubusercontent.com/57655/97910538-e0ecca00-1d17-11eb-9153-71171e9fba75.png">
* can't be modified (it's `readonly`)
<img width="443" alt="Screen Shot 2020-11-02 at 2 12 09 PM" src="https://user-images.githubusercontent.com/57655/97910753-2dd0a080-1d18-11eb-82d4-3fe635ba3071.png">
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.
Backports the following commits to 7.x: