[WIP] Modular request decorations (and pluggable authentication) #1
Conversation
alekitto
changed the title
|
Added WIP tag. What’s missing, to be added in the next few days:
|
There was a problem hiding this comment.
Hey there, @alekitto!
Thanks again for this really useful improvement. This permits every possible user to customize our client request management!!
Just left some really minor comments :)
lib/Http/Client.js
Outdated
| import NotFoundHttpException from '../Exception/NotFoundHttpException'; | ||
|
|
||
| /** | ||
| * @memberOf Fazland.Atlante.Api |
There was a problem hiding this comment.
@memberOf Fazland.Atlante.Http
lib/Http/Client.js
Outdated
| * Constructor. | ||
| * | ||
| * @param {RequesterInterface} requester Object which performs http requests. | ||
| * @param {DecoratorInterface[]} requestDecorators Decorators to apply to the request. |
There was a problem hiding this comment.
* @param {DecoratorInterface[]} [requestDecorators = []] Decorators to apply to the request.
| import Headers from '../../Headers'; | ||
| import NoTokenAvailableException from '../../../Exception/NoTokenAvailableException'; | ||
|
|
||
| export default class OAuthClientTokenAuthenticator { |
There was a problem hiding this comment.
Generic subnamespace Fazland.Atlante.Decorator.Authentication.OAuth instead having the prefix in the class name
| * @param {string} [data_encoding] could be "json" or "form". If "json" encodes token request data with JSON.stringify, | ||
| * if "form" data will be encoded as form data. | ||
| */ | ||
| constructor( |
There was a problem hiding this comment.
The jsdoc is not aligned to the configuration object specified in the signature
| import NoTokenAvailableException from '../../../Exception/NoTokenAvailableException'; | ||
| import OAuthClientTokenAuthenticator from './OAuthClientTokenAuthenticator'; | ||
|
|
||
| export default class OAuthTokenPasswordAuthenticator extends OAuthClientTokenAuthenticator { |
There was a problem hiding this comment.
Subnamespace also for this :)
| * @param {null|string} [client_secret] | ||
| * @param {string} [client_token_key] | ||
| * @param {string} [data_encoding] | ||
| * @param {string} [access_token_key] |
There was a problem hiding this comment.
* @param {string} [access_token_key = 'access_token']
| * @param {string} [client_token_key] | ||
| * @param {string} [data_encoding] | ||
| * @param {string} [access_token_key] | ||
| * @param {string} [refresh_token_key] |
There was a problem hiding this comment.
* @param {string} [refresh_token_key = 'refresh_token']
lib/Requester/Header/BaseAccept.js
Outdated
|
|
||
| /** | ||
| * @param {string} key | ||
| * @param {*} default_ |
There was a problem hiding this comment.
* @param {*} [default_ = null]
Autoconfigured api client was deprecated in favor to a modular http client.
Where possible breaking changes has been avoided.
This is a major change
Motivation:
Custom authenticator was needed in a non-oauth-bundle enabled application.
Basic authentication is required on some urls, OpenID connect on others. This was impossible to handle without rewriting the
requestmethod of the Client class.Proposed solution and examples:
When creating an Http client a set of decorators could be passed to handle transformations and authentication. This allows custom authenticators to be added simpy implementing
DecoratorInterfaceand passing it to the client.Other transformations could be added based on custom logic. Ex:
Changes summary:
ContextualClientclass has been removed, as thewithContextclient method.Http.Clientclass (Api.Clienthas been deprecated).UrlDecorator: resolves path with defined base urlVersionSetterDecorator: appendsversionparameter to accept headerBodyConverterDecorator: converts js object when passed as request data (JSON.stringify)OAuthClientTokenAuthenticator: authenticates request with client credentials tokenOAuthTokenPasswordAuthenticator: authenticates request using access/refresh token pairs where available. Exposesauthenticate(user, password)andlogout()methods to log users in/out.Acceptheader has now its own class to handle modifications properly.