User Agent for all HTTP(S) requests. (#873)

* Continuous integration through Travis CI | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | no | Fixed tickets | | License | MIT | Doc PR | * Unit Test (no Azure access). * Unit Test (no Azure access) for Common/Models * Unit Tests (no Azure access) for Common/ * Unit Tests (no Azure access) for MediaServices. * Unit tests for ServiceBus/Internal/ * Unit Tests (no Azure access) for ServiceBus, Service Management, and Service Runtime. * Unit Tests (no Azure access). * test only local unit tests. * Fix travis-ci * case-sensetive * Fix unit test. * Fix casing. * Casing. * Casing. * Casing. * Casing. * typo fix. * HHVM-3.9, no PHP 5.4, no PHP 7 * HHVM removed for now. * Authentication local test * Include skipped tests. * Upper-case bug is fixed. * Upper-case bug is fixed. * Upper-case bug is fixed. * Set User-Agent for HttpClient requests. * Replace www.microsoft.com with example.com. Because www.microsoft.com behaviour depends on if the 'User-Agent' header is present. * Remove a user agent from ServiceBuilder. * Additional test to validate User-Agent header. * Changelog.
Azure · Sep 22, 2016 · 36e79cb · 36e79cb
1 parent d303c34
commit 36e79cb
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 29 deletions.
diff --git a/changelog.txt b/changelog.txt
@@ -1,3 +1,4 @@
+- All HTTP(S) requests have the same 'User-Agent' header.
 - Updated packages: firebase/php-jwt 3.0 => 4.0, fabpot/php-cs-fixer => friendofphp/php-cs-fixer.
 - Support for HTTP_PROXY environment variable for logging with Fiddler
 - Support for LiveStreaming in Media Services - AMS SDK Live Features & Samples

diff --git a/phpunit.local.xml.dist b/phpunit.local.xml.dist
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- Generated by PHP Project Wizard (PPW) 1.1.0-dev on Tue Feb 22 10:57:31 CET 2011 -->
 
 <phpunit bootstrap="vendor/autoload.php"
          backupGlobals="false"

diff --git a/src/Common/Internal/Http/HttpClient.php b/src/Common/Internal/Http/HttpClient.php
@@ -119,10 +119,9 @@ public function __construct(
             null, null, $config
         );
 
-        $this->setHeaders(array(
-            'user-agent' => null,
-            'expect' => '',
-        ));
+        // Replace User-Agent.
+        $this->setHeader(Resources::USER_AGENT, Resources::SDK_USER_AGENT, true);
+        $this->setHeader('expect', '');
 
         $this->_requestUrl = null;
         $this->_response = null;

diff --git a/src/Common/ServicesBuilder.php b/src/Common/ServicesBuilder.php
@@ -219,9 +219,7 @@ public function createServiceBusService($connectionString)
         );
 
         // Adding headers filter
-        $headers = array(
-            Resources::USER_AGENT => Resources::SDK_USER_AGENT,
-        );
+        $headers = array();
 
         $headersFilter = new HeadersFilter($headers);
         $serviceBusWrapper = $serviceBusWrapper->withFilter($headersFilter);
@@ -265,9 +263,7 @@ public function createServiceManagementService($connectionString)
         );
 
         // Adding headers filter
-        $headers = array(
-            Resources::USER_AGENT => Resources::SDK_USER_AGENT,
-        );
+        $headers = array();
 
         $headers[Resources::X_MS_VERSION] = Resources::SM_API_LATEST_VERSION;
 
@@ -315,15 +311,13 @@ public function createMediaServicesService($settings)
         $dataMaxVersion = Resources::MEDIA_SERVICES_MAX_DATA_SERVICE_VERSION_VALUE;
         $accept = Resources::ACCEPT_HEADER_VALUE;
         $contentType = Resources::ATOM_ENTRY_CONTENT_TYPE;
-        $userAgent = Resources::SDK_USER_AGENT;
 
         $headers = array(
             Resources::X_MS_VERSION => $xMSVersion,
             Resources::DATA_SERVICE_VERSION => $dataVersion,
             Resources::MAX_DATA_SERVICE_VERSION => $dataMaxVersion,
             Resources::ACCEPT_HEADER => $accept,
             Resources::CONTENT_TYPE => $contentType,
-            Resources::USER_AGENT => $userAgent,
         );
 
         $headersFilter = new HeadersFilter($headers);

diff --git a/tests/unit/WindowsAzure/Common/Internal/Filters/HeadersFilterTest.php b/tests/unit/WindowsAzure/Common/Internal/Filters/HeadersFilterTest.php
@@ -27,6 +27,7 @@
 
 use WindowsAzure\Common\Internal\Filters\HeadersFilter;
 use WindowsAzure\Common\Internal\Http\HttpClient;
+use WindowsAzure\Common\Internal\Resources;
 
 /**
  * Unit tests for class HeadersFilter.
@@ -56,8 +57,11 @@ public function testHandleRequestEmptyHeaders()
         // Test
         $request = $filter->handleRequest($channel);
 
-        // Assert. there is one header returned back
-        $this->assertCount(1, $request->getHeaders());
+        $headers = $request->getHeaders();
+        // Assert. there are two header returned back
+        // 'User-Agent' and 'expect'.
+        $this->assertCount(2, $headers);
+        $this->assertEquals(Resources::SDK_USER_AGENT, $headers['user-agent']);
     }
 
     /**

diff --git a/tests/unit/WindowsAzure/Common/Internal/Http/HttpClientTest.php b/tests/unit/WindowsAzure/Common/Internal/Http/HttpClientTest.php
@@ -144,8 +144,8 @@ public function testSetHeaders()
         $channel->setHeaders($headers);
 
         // Assert
-        $channelHeaders = $channel->getHeaders();
-        $this->assertCount(3, $channelHeaders);
+        $channelHeaders = $channel->getHeaders();    
+        $this->assertCount(4, $channelHeaders);
         $this->assertEquals($value1, $channelHeaders[$header1]);
         $this->assertEquals($value2, $channelHeaders[$header2]);
     }
@@ -168,7 +168,7 @@ public function testGetHeaders()
         $headers = $channel->getHeaders();
 
         // Assert
-        $this->assertCount(3, $headers);
+        $this->assertCount(4, $headers);
         $this->assertEquals($value1, $headers[$header1]);
         $this->assertEquals($value2, $headers[$header2]);
     }
@@ -186,7 +186,7 @@ public function testSetHeaderNewHeader()
 
         // Assert
         $headers = $channel->getHeaders();
-        $this->assertCount(2, $headers);
+        $this->assertCount(3, $headers);
         $this->assertEquals(TestResources::HEADER1_VALUE, $headers[TestResources::HEADER1]);
     }
 
@@ -204,7 +204,7 @@ public function testSetHeaderExistingHeaderReplace()
 
         // Assert
         $headers = $channel->getHeaders();
-        $this->assertCount(2, $headers);
+        $this->assertCount(3, $headers);
         $this->assertEquals(TestResources::HEADER2_VALUE, $headers[TestResources::HEADER1]);
     }
 
@@ -223,7 +223,7 @@ public function testSetHeaderExistingHeaderAppend()
 
         // Assert
         $headers = $channel->getHeaders();
-        $this->assertCount(2, $headers);
+        $this->assertCount(3, $headers);
         $this->assertEquals($expected, $headers[TestResources::HEADER1]);
     }
 
@@ -234,7 +234,7 @@ public function testSendSimple()
     {
         // Setup
         $channel = new HttpClient();
-        $url = new Url('http://www.microsoft.com/');
+        $url = new Url('http://example.com/');
         $channel->setExpectedStatusCode('200');
 
         // Test
@@ -251,11 +251,11 @@ public function testSendWithContent()
     {
         // Setup
         $channel = new HttpClient();
-        $url = new Url('http://www.microsoft.com/');
+        $url = new Url('http://example.com/');
         $channel->setExpectedStatusCode('200');
         $channel->setBody('This is body');
         $channel->setMethod('PUT');
-        $this->setExpectedException(get_class(new ServiceException('404')));
+        $this->setExpectedException(get_class(new ServiceException('405')));
 
         // Test
         $channel->send(array(), $url);
@@ -268,7 +268,7 @@ public function testSendWithOneFilter()
     {
         // Setup
         $channel = new HttpClient();
-        $url = new Url('http://www.microsoft.com/');
+        $url = new Url('http://example.com/');
         $channel->setExpectedStatusCode('200');
         $expectedHeader = TestResources::HEADER1;
         $expectedResponseSubstring = TestResources::HEADER1_VALUE;
@@ -291,7 +291,7 @@ public function testSendWithMultipleFilters()
     {
         // Setup
         $channel = new HttpClient();
-        $url = new Url('http://www.microsoft.com/');
+        $url = new Url('http://example.com/');
         $channel->setExpectedStatusCode('200');
         $expectedHeader1 = TestResources::HEADER1;
         $expectedResponseSubstring1 = TestResources::HEADER1_VALUE;
@@ -319,7 +319,7 @@ public function testSendFail()
     {
         // Setup
         $channel = new HttpClient();
-        $url = new Url('http://www.microsoft.com/');
+        $url = new Url('http://example.com/');
         $channel->setExpectedStatusCode('201');
         $this->setExpectedException(get_class(new ServiceException('200')));
 
@@ -456,7 +456,7 @@ public function test__clone()
 
         // Test
         $actual = clone $channel;
-        $channel->setUrl(new Url('http://www.microsoft.com'));
+        $channel->setUrl(new Url('http://example.com/'));
         $channel->setHeader('headerx', 'valuex');
 
         // Assert
@@ -471,7 +471,7 @@ public function testGetResponse()
     {
         // Setup
         $channel = new HttpClient();
-        $url = new Url('http://www.microsoft.com/');
+        $url = new Url('http://example.com/');
         $channel->setExpectedStatusCode('200');
         $channel->send(array(), $url);