Skip to content

Fix composer version conflict with react/http v0.8 #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 21, 2017
Merged

Fix composer version conflict with react/http v0.8 #28

merged 5 commits into from
Dec 21, 2017

Conversation

samuelnogueira
Copy link
Contributor

  • Upgraded dependency on react/http-client
  • Introduced dependency on react/socket so \Http\Adapter\React\buildDnsResolver and \Http\Adapter\React\buildHttpClient remain usable as before (no need for major version bump on php-http/react-adapter)
Q A
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Related tickets fixes #25
License MIT

What's in this PR?

Upgraded dependency on react/http-client
Introduced dependency on react/socket so \Http\Adapter\React\buildDnsResolver and \Http\Adapter\React\buildHttpClient remain usable as before (no need for major version bump on php-http/react-adapter)

 - Upgraded dependency on react/http-client
 - Introduced dependency on react/socket so \Http\Adapter\React\buildDnsResolver and \Http\Adapter\React\buildHttpClient remain usable as before (no need for major version bump on php-http/react-adapter)
@@ -54,13 +55,26 @@ public static function buildDnsResolver(
public static function buildHttpClient(
LoopInterface $loop,
DnsResolver $dns = null
) {
$dnsConnector = static::buildDnsConnector($loop, $dns);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did the react client constructor signature change to expect the dns connector instead of the dns resolver? no auto-instantiation?

if so, we should probably follow the pattern of the DnsResolver and add another optional parameter for the connector. hm, but $dns is never needed when you pass the whole connector. maybe remove the typehint from $dns and do instanceof to see if its the resolver or the connector? and deprecate passing only the resolver?

Copy link
Contributor Author

@samuelnogueira samuelnogueira Dec 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did the react client constructor signature change to expect the dns connector instead of the dns resolver? no auto-instantiation?

Yes it did. There is auto-instantiation though, the dns connector could be omitted, and we could simply deprecate the entire $dns param for the buildHttpClient method, however, wouldn't this be a major version bump? Also, the ability to control the dns connector/resolver instance would be lost (was it even needed in the first place?).

About your suggestion, doing the instanceof of the second buildHttpClient parameter to allow either the connector or the dns resolver to be passed looks like a good solution, to maintain retro-compatibility + IoC for the connector instance, I'll push a commit with that change.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would just add the flexibility but deprecate passing the resolver and recommend to pass the connector. i think the factory should keep allowing a custom dns resolution tool.

in a version 2 we can then add the typehint for the connector and thus drop dns resolver support in the http client factory method.

Copy link
Contributor

@dbu dbu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! i wonder if we should bump the minor version of this library. how much does change on react-php side?

composer.json Outdated
@@ -13,9 +13,10 @@
"require": {
"php": "^5.5 || ^7.0",
"php-http/httplug": "^1.0",
"react/http-client": "^0.4.8",
"react/http-client": "^0.5",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we keep allowing 0.4.8 or are there BC breaks?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately there are: https://github.com/reactphp/http-client/releases/tag/v0.5.0
Furthermore, \React\HttpClient\Client's constructor signature has changed, so even calling it directly instead of using Factory won't work the same in v0.4 and v0.5.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay. i suggest we bump the minor version of this library then, and deprecate passing the dns resolver but still support it (see my comment above)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can be BC here and keep 0.4.8 by checking if this React\HttpClient\Factory class exists, then use old behavior in that case, otherwise use the new behavior

@samuelnogueira
Copy link
Contributor Author

Since we are introducing a new public method \Http\Adapter\React\ReactFactory::buildDnsConnector, which is added functionality, I think it makes sense to up the MINOR version.

… a DnsResolver

 - ReactFactory now builds a Connector instance instead of DnsConnector
 - Unit tests
$dns = self::buildDnsResolver($loop);
// build a connector if none is given, or create one attaching given DnsResolver (old deprecated behavior)
if (null === $connector || $connector instanceof DnsResolver) {
$connector = static::buildConnector($loop, $connector);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should only build connector if it's a Resolver, when it's null we should let React do this job as it's an optional argument (less code to maintain as we don't have to follow the default behavior of react of creating a dns connector)

Samuel Nogueira added 2 commits December 19, 2017 23:05
 - Declared dependency on phpunit 4.8.36 (because FC layer)
 - Updated ReactFactory unit tests for compatibility with both phpunit 4 and 5
$connector = null
) {
// build a connector with given DnsResolver if provided (old deprecated behavior)
if ($connector instanceof DnsResolver) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you please add a deprecation warning inside the if?

@trigger_error(sprintf('Passing a %s to buildHttpClient is deprecated since version 2.1.0 and will be removed in 3.0. If you need no specific behaviour, omit the $dns argument, otherwise pass a %s', DnsResolver::class, ConnectorInterface::class), E_USER_DEPRECATED);

* @param LoopInterface $loop
* @param DnsResolver $dns
* @param LoopInterface $loop
* @param ConnectorInterface|DnsResolver|null $connector Passing a DnsResolver instance is deprecated. Should pass a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we should be more specific. say: "Only pass this argument if you need to customize DNS behaviour. With react 0.5, pass a connector, wth react 0.4 this must be a DnsResolver."


// validate connector instance for proper error reporting
if (!$dns instanceof DnsResolver) {
throw new \InvalidArgumentException('$connector must be an instance of DnsResolver');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we should say For react 0.4, $dns must be an instance of DnsResolver

Copy link
Contributor

@dbu dbu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great, thanks for the update. i added some feedback on how we report issues to make things clearer.

can you please also add something to the changelog file?

…eactFactory

- Fixed scrutinizer reported issues
Copy link
Contributor

@dbu dbu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you very much!

@dbu dbu merged commit 04d465b into php-http:master Dec 21, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Composer version conflict with react/http
3 participants