feat/types/remove-aws-xray-sdk-deps #749
Merged
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
In several plugin definitions `aws-xray-sdk` was used. The problem is that we need to be able to continue using those plugins without being dependent on `aws-xray-sdk`. In this PR I propose to remove this dependency, and to use the `Options` interface defined in `utils` to define the interfaces of each dependent plugins. This allows a simpler management of types, in case of update of `aws-xray-sdk`, we will have only one element to modify. The type of `awsClientCapture` in `utils.Options`. There are some plugins that use only one part of the attributes of the "Option" interface, for this case I use the typescript utility type : [`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)
willfarrell
approved these changes
Nov 16, 2021
|
Can someone else that uses TypeScript give this a review before I merge? |
|
May I raise? |
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.
What does this implement/fix? Explain your changes.
In several plugin definitions
aws-xray-sdkwas used. The problem is that we need to be able to continue using those plugins without being dependent onaws-xray-sdk.In this PR I propose to remove this dependency, and to use the
Optionsinterface defined inutilsto define the interfaces of each dependent plugins.This allows a simpler management of types, in case of update of
aws-xray-sdk(or other changes), we will have only one element to modify. The type ofawsClientCaptureinutils.Options(or other attribute types...)There are some plugins that use only some attributes of the "Options" interface, for this case I use the typescript utility type :
PickDoes this close any currently open issues?
Typescript comment related
Where has this been tested?