Introduce Interfaces for library classes #248
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
evansims
commented
Jan 17, 2022
| @@ -37,7 +37,17 @@ public function getSdk(): \Auth0\SDK\Auth0 | |||
| } | |||
|
|
|||
| /** | |||
| * Create/return instance of the Auth0-PHP SdkConfiguration. | |||
| * @inheritdoc | |||
There was a problem hiding this comment.
Added to ease unit testing purposes, allows overwriting the Auth0-PHP SDK instance.
evansims
commented
Jan 17, 2022
| @@ -49,7 +59,17 @@ public function getConfiguration(): \Auth0\SDK\Configuration\SdkConfiguration | |||
| } | |||
|
|
|||
| /** | |||
| * Create/create a request state instance, a storage singleton containing authenticated user data. | |||
| * @inheritdoc | |||
There was a problem hiding this comment.
Also dded to ease unit testing purposes.
sergiught
approved these changes
Jan 17, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds Interfaces to allow for class mocking within customer/downstream unit tests. This is necessary as we use the
finalkeyword on classes to disallow extending/manipulating library methods, for reliability and safety best practices purposes.The size of this PR is partly due to docblock changes, transitioning those documentation blocks from the classes and into their interfaces.