Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[HttpClient] Document the state object that is passed around by the HttpClient #30967

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 12, 2019
Merged

[HttpClient] Document the state object that is passed around by the HttpClient #30967

merged 1 commit into from
Apr 12, 2019

Conversation

derrabus
Copy link
Member

@derrabus derrabus commented Apr 7, 2019 •
edited
Loading

Q A
Branch? master
Bug fix? yes
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets N/A
License MIT
Doc PR N/A

In an attempt to make the code of the new HttpClient component more understandable, I've introduced internal classes that document the $multi object that is being passed around between *Client and *Response classes.

My goal is to make the code more accessible to potential contributors and static code analyzers.

@derrabus derrabus force-pushed the improvement/http-client-state branch 2 times, most recently from 5a6a40b to 1407181 Compare April 7, 2019 10:35
@xabbuh xabbuh added this to the next milestone Apr 7, 2019
greg0ire
greg0ire reviewed Apr 7, 2019
View reviewed changes
greg0ire
greg0ire reviewed Apr 7, 2019
View reviewed changes
@derrabus
Copy link
Member Author

derrabus commented Apr 7, 2019

ping @nicolas-grekas

linaori
linaori reviewed Apr 7, 2019
View reviewed changes
Copy link
Contributor

@linaori linaori left a comment

Choose a reason for hiding this comment

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

I like these changes from a reader's perspective, it makes things easier to understand!

derrabus
derrabus commented Apr 7, 2019
View reviewed changes
src/Symfony/Component/HttpClient/Response/ResponseTrait.php
@@ -49,7 +50,7 @@ trait ResponseTrait
'error' => null,
];

private $multi;
Copy link
Member Author

Choose a reason for hiding this comment

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

The trait itself does not use that property. And since both implementations use different classes for $multi, I've moved the property to the classes.

@derrabus derrabus changed the title Document the state object that is passed around by the HttpClient [HttpClient] Document the state object that is passed around by the HttpClient Apr 7, 2019
@derrabus derrabus marked this pull request as ready for review April 7, 2019 17:57
nicolas-grekas
nicolas-grekas reviewed Apr 8, 2019
View reviewed changes
Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

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

nice improvements, thanks :)

src/Symfony/Component/HttpClient/Response/NativeResponse.php Outdated
@@ -162,7 +166,7 @@ private function open(): void
/**
* {@inheritdoc}
*/
private function close(): void
protected function close(): void
Copy link
Member

Choose a reason for hiding this comment

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

private was good - traits are not contracts (same below)

Copy link
Member Author

Choose a reason for hiding this comment

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

This was done inconsistently. Sometimes the overridden trait methods were private, sometimes protected.

Apart from that, PhpStorm has troubles inspecting this, but this is probably something JetBrains should fix.

@stof stof mentioned this pull request Apr 8, 2019
Closed
stof
stof reviewed Apr 8, 2019
View reviewed changes
Copy link
Member

@stof stof left a comment

Choose a reason for hiding this comment

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

Symfony\Component\VarDumper\Caster\SymfonyCaster should be updated for the new type of the multi property.

@nicolas-grekas
Copy link
Member

Symfony\Component\VarDumper\Caster\SymfonyCaster should be updated for the new type of the multi property.

actually, there is nothing to do on the topic, the caster just cuts the property:

symfony/src/Symfony/Component/VarDumper/Caster/SymfonyCaster.php

Lines 44 to 50 in 4e1244e

public static function castHttpClient($client, array $a, Stub $stub, $isNested)
{
$multiKey = sprintf("\0%s\0multi", \get_class($client));
$a[$multiKey] = new CutStub($a[$multiKey]);
return $a;
}

@derrabus derrabus force-pushed the improvement/http-client-state branch from af3eeee to 2d579d6 Compare April 10, 2019 07:48
@derrabus
Copy link
Member Author

PR is ready for review again.

@derrabus derrabus force-pushed the improvement/http-client-state branch from ac249d1 to 20f4eb3 Compare April 10, 2019 11:03
dbrumann
dbrumann approved these changes Apr 11, 2019
View reviewed changes
ro0NL
ro0NL reviewed Apr 11, 2019
View reviewed changes
src/Symfony/Component/HttpClient/Internal/DnsCache.php
public $hostnames = [];

/**
* @var string[]
Copy link
Contributor

Choose a reason for hiding this comment

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

below you're inlining docblocks into a single line :/

Copy link
Member Author

Choose a reason for hiding this comment

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

Shall I do this here as well?

Copy link
Contributor

Choose a reason for hiding this comment

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

i believe multi-line is the most common CS rule in symfony.

@fabpot
Copy link
Member

fabpot commented Apr 12, 2019

Thank you @derrabus.

@fabpot fabpot merged commit 20f4eb3 into symfony:master Apr 12, 2019
fabpot added a commit that referenced this pull request Apr 12, 2019
@fabpot
bug #30967 [HttpClient] Document the state object that is passed arou…
9edd84b 
…nd by the HttpClient (derrabus)

This PR was merged into the 4.3-dev branch.

Discussion
----------

[HttpClient] Document the state object that is passed around by the HttpClient

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | N/A

In an attempt to make the code of the new HttpClient component more understandable, I've introduced internal classes that document the `$multi` object that is being passed around between *Client and *Response classes.

My goal is to make the code more accessible to potential contributors and static code analyzers.

Commits
-------

20f4eb3 Document the state object that is passed around by the HttpClient.
@nicolas-grekas nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019
@derrabus derrabus deleted the improvement/http-client-state branch May 15, 2019 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

@stof stof stof left review comments

@greg0ire greg0ire greg0ire left review comments

@ro0NL ro0NL ro0NL left review comments

@linaori linaori linaori left review comments

@fabpot fabpot fabpot approved these changes

@dbrumann dbrumann dbrumann approved these changes

Assignees
No one assigned
Labels
Bug HttpClient Status: Reviewed
Projects
None yet
Milestone
4.3
Development

Successfully merging this pull request may close these issues.