Auth\Basic: add input validation to constructor #574
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
schlessera
requested changes
Oct 29, 2021
The `Basic::__construct()` method expects to receive an array of exactly two element and did validate the input received, but only threw an exception when the passed parameter did not match the expected element count, not when the passed parameter wasn't an array. At the same time, the default value of `$args` is `null`, not an empty array and the `$user` and `$pass` properties are both public. The only reason I can think of to have these properties `public` and the default value set to `null`, is to allow for delayed setting of the `$user` and `$pass`, after the class has already been instantiated. To maintain the existing behaviour, but still add input validation, an exception is now thrown when the `$args` parameter is neither an array, nor `null`. Includes; * A dedicated test for the input validation. * An additional test with Basic authentication with an instantiated class, but with delayed setting of the `$user` and `$pass` directly on the instantiated object. This test is solely added to document that this is a supported feature (and to safeguard against regressions in that respect).
... for use when an invalid number of arguments are received for a method. Along the same lines as the `InvalidArgument` exception, this class contains a `create()` method to standardize the text of the exception message. The exception extends the Request native base `Exception` to * Allow for introducing this as a (more specific) replacement for some existing exceptions without BC-break. * Allow for maintaining the "exception type" indicators as were used before. Includes dedicated unit test.
This replaces two pre-existing generic Requests `Exception` usage instances with use of the new `ArgumentCount` exception.
Includes:
* Updating the parameter description for the `$args` parameter of the `Proxy\Http::__construct()` method as those docs were plain incorrect to begin with.
* Updated and improved documentation for these exceptions in the function doc blocks.
Again, the documentation for the exception thrown in the `Proxy\Http` class was incorrect to begin with.
* Updated unit tests for the affected classes to reflect these changes.
jrfnl
force-pushed
the
feature/auth-basic-add-input-validation
branch
from
d94b648
to
6a66c0c
Compare
schlessera
approved these changes
Nov 5, 2021
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.
The
Basic::__construct()method expects to receive an array of exactly two element and did validate the input received, but only threw an exception when the passed parameter did not match the expected element count, not when the passed parameter wasn't an array.At the same time, the default value of
$argsisnull, not an empty array and the$userand$passproperties are both public.The only reason I can think of to have these properties
publicand the default value set tonull, is to allow for delayed setting of the$userand$pass, after the class has already been instantiated.To maintain the existing behaviour, but still add input validation, an exception is now thrown when the
$argsparameter is neither an array, nornull.Includes;
$userand$passdirectly on the instantiated object. This test is solely added to document that this is a supported feature (and to safeguard against regressions in that respect).