Transform both switchToXHR() and removeXhr() to xmlHttpRequest() #26381

Simperfit · 2018-03-02T17:49:30Z

Q	A
Branch?	4.1
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	none
License	MIT
Doc PR	Will do.

See #24778 (comment) for more information about this.

We are switching from a possible global estate change to just only one request affected.

ro0NL · 2018-03-03T07:15:09Z

i think it should be either xhr() or xmlHttpRequest() :) preferring the first i guess.

Simperfit · 2018-03-04T13:47:44Z

@javiereguiluz WDYT of @ro0NL's advice ?

javiereguiluz · 2018-03-04T16:19:01Z

On Symfony Slack xmlHttpRequest() won 2 to 1 to xhrRequest() Other proposals were ajaxRequest() and asyncRequest()

ro0NL · 2018-03-04T17:39:57Z

👍 for xmlHttpRequest

Simperfit · 2018-03-05T16:56:11Z

PR updated.

dmaicher · 2018-03-07T20:27:18Z

src/Symfony/Component/BrowserKit/Tests/ClientTest.php

-        $client->request('GET', 'http://example.com/', array(), array(), array(), null, true, true);
-        $this->assertEquals($client->getRequest()->getServer()['HTTP_X_REQUESTED_WITH'], 'XMLHttpRequest');
-        $client->removeXHR();
+        $client->xmlHttpRequest('GET', 'http://example.com/', array(), array(), array(), null, true);


in the end this test does not really test much. You can replace this with $client->request(...) and the test still passes.

Imho we should test that the client really receives a request with the correct header/server param?

You could modify the TestClient so you have access to the internal request maybe?

diff --git a/src/Symfony/Component/BrowserKit/Tests/ClientTest.php b/src/Symfony/Component/BrowserKit/Tests/ClientTest.php index e715bb9a4c..cd7989c6a2 100644 --- a/src/Symfony/Component/BrowserKit/Tests/ClientTest.php +++ b/src/Symfony/Component/BrowserKit/Tests/ClientTest.php @@ -25,6 +25,7 @@ class TestClient extends Client { protected $nextResponse = null; protected $nextScript = null; + protected $request = null; public function setNextResponse(Response $response) { @@ -38,6 +39,8 @@ class TestClient extends Client protected function doRequest($request) { + $this->request = $request; + if (null === $this->nextResponse) { return new Response(); } @@ -70,6 +73,11 @@ require_once('$path'); echo serialize($this->nextScript); EOF; } + + public function getRequest() + { + return $this->request; + } }

I agree, the test does not really test anything here.

Doing it, I agree too.

fabpot · 2018-03-13T12:37:16Z

src/Symfony/Component/BrowserKit/Client.php

+    /**
+     * Calls a URI with XMLHttpRequest.
+     *
+     * @return Crawler


This could be removed in favor of using : Crawler in the method signature instead.

fabpot · 2018-03-13T12:38:09Z

src/Symfony/Component/BrowserKit/Tests/ClientTest.php

-        $client->request('GET', 'http://example.com/', array(), array(), array(), null, true, true);
-        $this->assertEquals($client->getRequest()->getServer()['HTTP_X_REQUESTED_WITH'], 'XMLHttpRequest');
-        $client->removeXHR();
+        $client->xmlHttpRequest('GET', 'http://example.com/', array(), array(), array(), null, true);


I agree, the test does not really test anything here.

Simperfit · 2018-03-14T09:01:40Z

Test modified, review taken in account.

Status: Needs Review

nicolas-grekas · 2018-03-14T16:43:54Z

src/Symfony/Component/BrowserKit/Tests/ClientTest.php

        return $response;
    }

+    public function getRequest()


where is this method (and corresponding property) used?

It’s used in the tests to check that the header has been added

$this->assertEquals($client->getRequest()->getServer()['HTTP_X_REQUESTED_WITH'], 'XMLHttpRequest');

I'm sorry I don't understand. I tested locally after removing all the changes done here to the TestClient class and tests still do pass.

Ahh @nicolas-grekas is right. The Client already keeps the request internally 😊

https://github.com/Simperfit/symfony/blob/00f26e280c5aec7c27fd25c825285546887a1771/src/Symfony/Component/BrowserKit/Client.php#L36

So the changes to TestClient are indeed not needed and should be reverted.

fabpot · 2018-03-18T19:00:39Z

Tests are apparently broken because of the changes done in this PR.

fabpot · 2018-03-19T21:18:37Z

@Simperfit Can you rebase on current master?

Simperfit · 2018-03-20T07:55:40Z

@fabpot PR Rebased

fabpot · 2018-03-20T08:40:48Z

Thank you @Simperfit.

…pRequest() (Simperfit) This PR was merged into the 4.1-dev branch. Discussion ---------- Transform both switchToXHR() and removeXhr() to xmlHttpRequest() | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | no | New feature? | yes  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | none  | License | MIT | Doc PR | Will do. See #24778 (comment) for more information about this. We are switching from a possible global estate change to just only one request affected. Commits ------- 4ed0889 feature: transform both switchToXHR and removeXhr to a xhrRequest

carsonbot added Status: Needs Review Feature Deprecation labels Mar 2, 2018

nicolas-grekas added this to the 4.1 milestone Mar 2, 2018

Simperfit force-pushed the feature/change-xhr-method-to-xhr-request branch 2 times, most recently from e9c4e08 to cbdfa5d Compare March 2, 2018 17:53

Simperfit force-pushed the feature/change-xhr-method-to-xhr-request branch from cbdfa5d to a9c363c Compare March 5, 2018 16:55

dmaicher reviewed Mar 7, 2018

View reviewed changes

javiereguiluz added the ❄️ Feature Freeze Important Pull Requests to finish before the next Symfony "feature freeze" label Mar 12, 2018

javiereguiluz changed the title ~~feature: transform both switchToXHR and removeXhr to a xhrRequest~~ Transform both switchToXHR() and removeXhr() to xmlHttpRequest() Mar 12, 2018

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 13, 2018

fabpot requested changes Mar 13, 2018

View reviewed changes

Simperfit force-pushed the feature/change-xhr-method-to-xhr-request branch 2 times, most recently from af2da23 to debcc85 Compare March 14, 2018 09:00

carsonbot added Status: Needs Review and removed Status: Needs Work labels Mar 14, 2018

nicolas-grekas reviewed Mar 14, 2018

View reviewed changes

Simperfit force-pushed the feature/change-xhr-method-to-xhr-request branch from debcc85 to 00f26e2 Compare March 16, 2018 09:04

carsonbot added Status: Reviewed and removed Status: Needs Review labels Mar 18, 2018

fabpot approved these changes Mar 18, 2018

View reviewed changes

Simperfit force-pushed the feature/change-xhr-method-to-xhr-request branch from 00f26e2 to fd25010 Compare March 19, 2018 17:26

dmaicher approved these changes Mar 19, 2018

View reviewed changes

feature: transform both switchToXHR and removeXhr to a xhrRequest

4ed0889

Simperfit force-pushed the feature/change-xhr-method-to-xhr-request branch from fd25010 to 4ed0889 Compare March 20, 2018 07:55

fabpot merged commit 4ed0889 into symfony:master Mar 20, 2018

javiereguiluz mentioned this pull request Mar 23, 2018

[BrowserKit] add a way to switch to ajax for one request symfony/symfony-docs#9381

Closed

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

Simperfit deleted the feature/change-xhr-method-to-xhr-request branch May 16, 2018 06:34

Uh oh!

Transform both switchToXHR() and removeXhr() to xmlHttpRequest() #26381

Transform both switchToXHR() and removeXhr() to xmlHttpRequest() #26381

Uh oh!

Conversation

Simperfit commented Mar 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ro0NL commented Mar 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Simperfit commented Mar 4, 2018

Uh oh!

javiereguiluz commented Mar 4, 2018

Uh oh!

ro0NL commented Mar 4, 2018

Uh oh!

Simperfit commented Mar 5, 2018

Uh oh!

dmaicher Mar 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Simperfit commented Mar 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Mar 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabpot commented Mar 18, 2018

Uh oh!

fabpot commented Mar 19, 2018

Uh oh!

Simperfit commented Mar 20, 2018

Uh oh!

fabpot commented Mar 20, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Simperfit commented Mar 2, 2018 •

edited

Loading

ro0NL commented Mar 3, 2018 •

edited

Loading

dmaicher Mar 7, 2018 •

edited

Loading

nicolas-grekas Mar 19, 2018 •

edited

Loading