Migrate from Guzzle to Symfony HttpClient - 1

app/config/config.yml

@@ -47,6 +47,10 @@ framework:
                     X-Accept: 'application/json'
             request_html_function.client:
                 scope: '.*'
+            browser.client:
+                scope: '.*'
+                verify_host: false
+                verify_peer: false
 
 # Twig Configuration
 twig:

app/config/services.yml

@@ -214,6 +214,10 @@ services:
 
     GuzzleHttp\Cookie\CookieJar: ~
 
+    Symfony\Component\BrowserKit\HttpBrowser:
+        arguments:
+            $client: '@browser.client'
+
     Wallabag\Helper\HttpClientFactory:
         calls:
             - ['addSubscriber', ['@Wallabag\Guzzle\AuthenticatorSubscriber']]

src/Guzzle/AuthenticatorSubscriber.php

@@ -61,15 +61,10 @@ class AuthenticatorSubscriber implements SubscriberInterface, LoggerAwareInterfa
             return;
         }
 
-        $client = $event->getClient();
-
-        if (!$this->authenticator->isLoggedIn($config, $client)) {
+        if (!$this->authenticator->isLoggedIn($config)) {
             $this->logger->debug('loginIfRequired> user is not logged in, attach authenticator');
 
-            $emitter = $client->getEmitter();
-            $emitter->detach($this);
-            $this->authenticator->login($config, $client);
-            $emitter->attach($this);
+            $this->authenticator->login($config);
         }
     }
 
@@ -98,12 +93,7 @@ class AuthenticatorSubscriber implements SubscriberInterface, LoggerAwareInterfa
         $this->logger->debug('loginIfRequested> retry #' . $this->retries . ' with login ' . ($isLoginRequired ? '' : 'not ') . 'required');
 
         if ($isLoginRequired && $this->retries < self::MAX_RETRIES) {
-            $client = $event->getClient();
-
-            $emitter = $client->getEmitter();
-            $emitter->detach($this);
-            $this->authenticator->login($config, $client);
-            $emitter->attach($this);
+            $this->authenticator->login($config);
 
             $event->retry();
 

src/SiteConfig/LoginFormAuthenticator.php

@@ -2,18 +2,19 @@
 
 namespace Wallabag\SiteConfig;
 
-use GuzzleHttp\ClientInterface;
-use GuzzleHttp\Cookie\CookieJar;
+use Symfony\Component\BrowserKit\HttpBrowser;
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Wallabag\ExpressionLanguage\AuthenticatorProvider;
 
 class LoginFormAuthenticator
 {
+    private HttpBrowser $browser;
     private ExpressionLanguage $expressionLanguage;
 
-    public function __construct(AuthenticatorProvider $authenticatorProvider)
+    public function __construct(HttpBrowser $browser, AuthenticatorProvider $authenticatorProvider)
     {
+        $this->browser = $browser;
         $this->expressionLanguage = new ExpressionLanguage(null, [$authenticatorProvider]);
     }
 
@@ -22,17 +23,14 @@ class LoginFormAuthenticator
      *
      * @return self
      */
-    public function login(SiteConfig $siteConfig, ClientInterface $guzzle)
+    public function login(SiteConfig $siteConfig)
     {
         $postFields = [
             $siteConfig->getUsernameField() => $siteConfig->getUsername(),
             $siteConfig->getPasswordField() => $siteConfig->getPassword(),
         ] + $this->getExtraFields($siteConfig);
 
-        $guzzle->post(
-            $siteConfig->getLoginUri(),
-            ['body' => $postFields, 'allow_redirects' => true, 'verify' => false]
-        );
+        $this->browser->request('POST', $siteConfig->getLoginUri(), $postFields);
 
         return $this;
     }
@@ -42,15 +40,12 @@ class LoginFormAuthenticator
      *
      * @return bool
      */
-    public function isLoggedIn(SiteConfig $siteConfig, ClientInterface $guzzle)
+    public function isLoggedIn(SiteConfig $siteConfig)
     {
-        if (($cookieJar = $guzzle->getDefaultOption('cookies')) instanceof CookieJar) {
-            /** @var \GuzzleHttp\Cookie\SetCookie $cookie */
-            foreach ($cookieJar as $cookie) {
-                // check required cookies
-                if ($cookie->getDomain() === $siteConfig->getHost()) {
-                    return true;
-                }
+        foreach ($this->browser->getCookieJar()->all() as $cookie) {
+            // check required cookies
+            if ($cookie->getDomain() === $siteConfig->getHost()) {
+                return true;
             }
         }
 

tests/SiteConfig/LoginFormAuthenticatorTest.php

@@ -2,13 +2,12 @@
 
 namespace Tests\Wallabag\SiteConfig;
 
-use GuzzleHttp\Client;
-use GuzzleHttp\Message\Response;
-use GuzzleHttp\Stream\Stream;
-use GuzzleHttp\Subscriber\Mock;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\BrowserKit\HttpBrowser;
 use Symfony\Component\HttpClient\MockHttpClient;
 use Symfony\Component\HttpClient\Response\MockResponse;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
 use Wallabag\ExpressionLanguage\AuthenticatorProvider;
 use Wallabag\SiteConfig\LoginFormAuthenticator;
 use Wallabag\SiteConfig\SiteConfig;
@@ -30,19 +29,17 @@ class LoginFormAuthenticatorTest extends TestCase
             'password' => 'unkn0wn',
         ]);
 
-        $response = new Response(
-            200,
-            ['content-type' => 'text/html'],
-            Stream::factory('')
-        );
-        $guzzle = new Client();
-        $guzzle->getEmitter()->attach(new Mock([$response]));
+        $browserResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $browserClient = new MockHttpClient([$browserResponse]);
+        $browser = new HttpBrowser($browserClient);
 
-        $mockHttpClient = new MockHttpClient([new MockResponse('', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']])]);
+        $requestHtmlFunctionResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $requestHtmlFunctionClient = new MockHttpClient([$requestHtmlFunctionResponse]);
+        $authenticatorProvider = new AuthenticatorProvider($requestHtmlFunctionClient);
 
-        $authenticatorProvider = new AuthenticatorProvider($mockHttpClient);
-        $auth = new LoginFormAuthenticator($authenticatorProvider);
-        $res = $auth->login($siteConfig, $guzzle);
+        $auth = new LoginFormAuthenticator($browser, $authenticatorProvider);
+
+        $res = $auth->login($siteConfig);
 
         $this->assertInstanceOf(LoginFormAuthenticator::class, $res);
     }
@@ -63,19 +60,17 @@ class LoginFormAuthenticatorTest extends TestCase
             'password' => 'unkn0wn',
         ]);
 
-        $response = new Response(
-            200,
-            ['content-type' => 'text/html'],
-            Stream::factory('<html></html>')
-        );
-        $guzzle = new Client();
-        $guzzle->getEmitter()->attach(new Mock([$response, $response]));
+        $browserResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $browserClient = new MockHttpClient([$browserResponse]);
+        $browser = new HttpBrowser($browserClient);
 
-        $mockHttpClient = new MockHttpClient([new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']])]);
+        $requestHtmlFunctionResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $requestHtmlFunctionClient = new MockHttpClient([$requestHtmlFunctionResponse]);
+        $authenticatorProvider = new AuthenticatorProvider($requestHtmlFunctionClient);
 
-        $authenticatorProvider = new AuthenticatorProvider($mockHttpClient);
-        $auth = new LoginFormAuthenticator($authenticatorProvider);
-        $res = $auth->login($siteConfig, $guzzle);
+        $auth = new LoginFormAuthenticator($browser, $authenticatorProvider);
+
+        $res = $auth->login($siteConfig);
 
         $this->assertInstanceOf(LoginFormAuthenticator::class, $res);
     }
@@ -96,121 +91,44 @@ class LoginFormAuthenticatorTest extends TestCase
             'password' => 'unkn0wn',
         ]);
 
-        $response = $this->getMockBuilder(Response::class)
-            ->disableOriginalConstructor()
+        $browserResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $browserClient = new MockHttpClient([$browserResponse]);
+        $browser = $this->getMockBuilder(HttpBrowser::class)
+            ->setConstructorArgs([$browserClient])
             ->getMock();
-
-        $response->expects($this->any())
-            ->method('getBody')
-            ->willReturn(file_get_contents(__DIR__ . '/../fixtures/aoc.media.html'));
-
-        $response->expects($this->any())
-            ->method('getStatusCode')
-            ->willReturn(200);
-
-        $mockHttpClient = new MockHttpClient([new MockResponse(file_get_contents(__DIR__ . '/../fixtures/aoc.media.html'), ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']])]);
-
-        $client = $this->getMockBuilder(Client::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $client->expects($this->any())
-            ->method('post')
+        $browser->expects($this->any())
+            ->method('request')
             ->with(
+                $this->equalTo('POST'),
                 $this->equalTo('https://aoc.media/wp-admin/admin-ajax.php'),
                 $this->equalTo([
-                    'body' => [
-                        'nom' => 'johndoe',
-                        'password' => 'unkn0wn',
-                        'security' => 'c506c1b8bc',
-                        'action' => 'login_user',
-                    ],
-                    'allow_redirects' => true,
-                    'verify' => false,
+                    'nom' => 'johndoe',
+                    'password' => 'unkn0wn',
+                    'security' => 'c506c1b8bc',
+                    'action' => 'login_user',
                 ])
             )
-            ->willReturn($response);
+        ;
 
-        $client->expects($this->any())
-            ->method('get')
+        $requestHtmlFunctionResponse = $this->getMockBuilder(ResponseInterface::class)->getMock();
+        $requestHtmlFunctionResponse->expects($this->any())
+            ->method('getContent')
+            ->willReturn(file_get_contents(__DIR__ . '/../fixtures/aoc.media.html'))
+        ;
+        $requestHtmlFunctionClient = $this->getMockBuilder(HttpClientInterface::class)->getMock();
+        $requestHtmlFunctionClient->expects($this->any())
+            ->method('request')
             ->with(
+                $this->equalTo('GET'),
                 $this->equalTo('https://aoc.media/'),
-                $this->equalTo([])
             )
-            ->willReturn($response);
+            ->willReturn($requestHtmlFunctionResponse)
+        ;
+        $authenticatorProvider = new AuthenticatorProvider($requestHtmlFunctionClient);
 
-        $authenticatorProvider = new AuthenticatorProvider($mockHttpClient);
-        $auth = new LoginFormAuthenticator($authenticatorProvider);
-        $res = $auth->login($siteConfig, $client);
+        $auth = new LoginFormAuthenticator($browser, $authenticatorProvider);
 
-        $this->assertInstanceOf(LoginFormAuthenticator::class, $res);
-    }
-
-    public function testLoginPostWithExtraFieldsWithData()
-    {
-        $siteConfig = new SiteConfig([
-            'host' => 'nextinpact.com',
-            'loginUri' => 'https://compte.nextinpact.com/Account/Login',
-            'usernameField' => 'UserName',
-            'passwordField' => 'Password',
-            'extraFields' => [
-                '__RequestVerificationToken' => '@=xpath(\'//form[@action="/Account/Login"]/input[@name="__RequestVerificationToken"]\', request_html(\'https://compte.nextinpact.com/Account/Login?http://www.nextinpact.com/\', {\'headers\': {\'X-Requested-With\':\'XMLHttpRequest\'}}))',
-                'returnUrl' => 'https://www.nextinpact.com/news/102835-pour-cour-comptes-fonctionnement-actuel-vote-par-internet-nest-pas-satisfaisant.htm',
-            ],
-            'username' => 'johndoe',
-            'password' => 'unkn0wn',
-        ]);
-
-        $response = $this->getMockBuilder(Response::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $response->expects($this->any())
-            ->method('getBody')
-            ->willReturn(file_get_contents(__DIR__ . '/../fixtures/nextinpact-login.html'));
-
-        $response->expects($this->any())
-            ->method('getStatusCode')
-            ->willReturn(200);
-
-        $mockHttpClient = new MockHttpClient([new MockResponse(file_get_contents(__DIR__ . '/../fixtures/nextinpact-login.html'), ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']])]);
-
-        $client = $this->getMockBuilder(Client::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $client->expects($this->any())
-            ->method('post')
-            ->with(
-                $this->equalTo('https://compte.nextinpact.com/Account/Login'),
-                $this->equalTo([
-                    'body' => [
-                        'UserName' => 'johndoe',
-                        'Password' => 'unkn0wn',
-                        '__RequestVerificationToken' => 's6x2QcnQDUL92mkKSi_JuUBXcgUYx_Plf-KyQ2eJypKAjQZIeTvaFHOsfEdTrcSXt3dt2CW39V7r9V16LUtvjszodAU1',
-                        'returnUrl' => 'https://www.nextinpact.com/news/102835-pour-cour-comptes-fonctionnement-actuel-vote-par-internet-nest-pas-satisfaisant.htm',
-                    ],
-                    'allow_redirects' => true,
-                    'verify' => false,
-                ])
-            )
-            ->willReturn($response);
-
-        $client->expects($this->any())
-            ->method('get')
-            ->with(
-                $this->equalTo('https://compte.nextinpact.com/Account/Login?http://www.nextinpact.com/'),
-                $this->equalTo([
-                    'headers' => [
-                        'X-Requested-With' => 'XMLHttpRequest',
-                    ],
-                ])
-            )
-            ->willReturn($response);
-
-        $authenticatorProvider = new AuthenticatorProvider($mockHttpClient);
-        $auth = new LoginFormAuthenticator($authenticatorProvider);
-        $res = $auth->login($siteConfig, $client);
+        $res = $auth->login($siteConfig);
 
         $this->assertInstanceOf(LoginFormAuthenticator::class, $res);
     }
@@ -225,10 +143,16 @@ class LoginFormAuthenticatorTest extends TestCase
             'password' => 'unkn0wn',
         ]);
 
-        $mockHttpClient = new MockHttpClient();
+        $browserResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $browserClient = new MockHttpClient([$browserResponse]);
+        $browser = new HttpBrowser($browserClient);
+
+        $requestHtmlFunctionResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $requestHtmlFunctionClient = new MockHttpClient([$requestHtmlFunctionResponse]);
+        $authenticatorProvider = new AuthenticatorProvider($requestHtmlFunctionClient);
+
+        $auth = new LoginFormAuthenticator($browser, $authenticatorProvider);
 
-        $authenticatorProvider = new AuthenticatorProvider($mockHttpClient);
-        $auth = new LoginFormAuthenticator($authenticatorProvider);
         $loginRequired = $auth->isLoginRequired($siteConfig, file_get_contents(__DIR__ . '/../fixtures/nextinpact-login.html'));
 
         $this->assertFalse($loginRequired);
@@ -245,10 +169,16 @@ class LoginFormAuthenticatorTest extends TestCase
             'notLoggedInXpath' => '//h2[@class="title_reserve_article"]',
         ]);
 
-        $mockHttpClient = new MockHttpClient();
+        $browserResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $browserClient = new MockHttpClient([$browserResponse]);
+        $browser = new HttpBrowser($browserClient);
+
+        $requestHtmlFunctionResponse = new MockResponse('<html></html>', ['http_code' => 200, 'response_headers' => ['content-type' => 'text/html']]);
+        $requestHtmlFunctionClient = new MockHttpClient([$requestHtmlFunctionResponse]);
+        $authenticatorProvider = new AuthenticatorProvider($requestHtmlFunctionClient);
+
+        $auth = new LoginFormAuthenticator($browser, $authenticatorProvider);
 
-        $authenticatorProvider = new AuthenticatorProvider($mockHttpClient);
-        $auth = new LoginFormAuthenticator($authenticatorProvider);
         $loginRequired = $auth->isLoginRequired($siteConfig, file_get_contents(__DIR__ . '/../fixtures/nextinpact-article.html'));
 
         $this->assertTrue($loginRequired);