Merge pull request #21054 from nextcloud/feature/noid/default-gzip-en…

…coding-for-http-clients Allow gzip encoded requests by default
nextcloud · May 20, 2020 · 0a45f44 · 0a45f44
2 parents 526905c + 8123737
commit 0a45f44
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 47 deletions.
diff --git a/lib/private/App/AppStore/Fetcher/Fetcher.php b/lib/private/App/AppStore/Fetcher/Fetcher.php
@@ -98,11 +98,12 @@ protected function fetch($ETag, $content) {
 
 		$options = [
 			'timeout' => 10,
-			'headers' => ['Accept-Encoding' => 'gzip'],
 		];
 
 		if ($ETag !== '') {
-			$options['headers']['If-None-Match'] = $ETag;
+			$options['headers'] = [
+				'If-None-Match' => $ETag,
+			];
 		}
 
 		$client = $this->clientService->newClient();

diff --git a/lib/private/Http/Client/Client.php b/lib/private/Http/Client/Client.php
@@ -89,6 +89,10 @@ private function buildRequestOptions(array $options): array {
 			$options[RequestOptions::HEADERS]['User-Agent'] = 'Nextcloud Server Crawler';
 		}
 
+		if (!isset($options[RequestOptions::HEADERS]['Accept-Encoding'])) {
+			$options[RequestOptions::HEADERS]['Accept-Encoding'] = 'gzip';
+		}
+
 		return $options;
 	}
 

diff --git a/tests/lib/App/AppStore/Fetcher/FetcherBase.php b/tests/lib/App/AppStore/Fetcher/FetcherBase.php
@@ -249,15 +249,7 @@ public function testGetWithAlreadyExistingFileAndOutdatedTimestamp() {
 		$client
 			->expects($this->once())
 			->method('get')
-			->with(
-				$this->equalTo($this->endpoint),
-				$this->equalTo([
-					'timeout' => 10,
-					'headers' => [
-						'Accept-Encoding' => 'gzip',
-					]
-				])
-			)
+			->with($this->endpoint)
 			->willReturn($response);
 		$response
 			->expects($this->once())
@@ -350,15 +342,7 @@ public function testGetWithAlreadyExistingFileAndNoVersion() {
 		$client
 			->expects($this->once())
 			->method('get')
-			->with(
-				$this->equalTo($this->endpoint),
-				$this->equalTo([
-					'timeout' => 10,
-					'headers' => [
-						'Accept-Encoding' => 'gzip',
-					]
-				])
-			)
+			->with($this->endpoint)
 			->willReturn($response);
 		$response
 			->expects($this->once())
@@ -446,15 +430,7 @@ public function testGetWithAlreadyExistingFileAndOutdatedVersion() {
 		$client
 			->expects($this->once())
 			->method('get')
-			->with(
-				$this->equalTo($this->endpoint),
-				$this->equalTo([
-					'timeout' => 10,
-					'headers' => [
-						'Accept-Encoding' => 'gzip',
-					]
-				])
-			)
+			->with($this->endpoint)
 			->willReturn($response);
 		$response
 			->expects($this->once())
@@ -519,15 +495,7 @@ public function testGetWithExceptionInClient() {
 		$client
 			->expects($this->once())
 			->method('get')
-			->with(
-				$this->equalTo($this->endpoint),
-				$this->equalTo([
-					'timeout' => 10,
-					'headers' => [
-						'Accept-Encoding' => 'gzip',
-					]
-				])
-			)
+			->with($this->endpoint)
 			->willThrowException(new \Exception());
 
 		$this->assertSame([], $this->fetcher->get());
@@ -584,8 +552,7 @@ public function testGetMatchingETag() {
 				$this->equalTo([
 					'timeout' => 10,
 					'headers' => [
-						'Accept-Encoding' => 'gzip',
-						'If-None-Match' => '"myETag"',
+						'If-None-Match' => '"myETag"'
 					]
 				])
 			)->willReturn($response);
@@ -657,7 +624,6 @@ public function testGetNoMatchingETag() {
 				$this->equalTo([
 					'timeout' => 10,
 					'headers' => [
-						'Accept-Encoding' => 'gzip',
 						'If-None-Match' => '"myETag"',
 					]
 				])
@@ -744,9 +710,6 @@ public function testFetchAfterUpgradeNoETag() {
 				$this->equalTo($this->endpoint),
 				$this->equalTo([
 					'timeout' => 10,
-					'headers' => [
-						'Accept-Encoding' => 'gzip',
-					],
 				])
 			)
 			->willReturn($response);

diff --git a/tests/lib/Http/Client/ClientTest.php b/tests/lib/Http/Client/ClientTest.php
@@ -292,6 +292,7 @@ private function setUpDefaultRequestOptions(): void {
 			],
 			'headers' => [
 				'User-Agent' => 'Nextcloud Server Crawler',
+				'Accept-Encoding' => 'gzip',
 			],
 			'timeout' => 30,
 		];
@@ -467,7 +468,8 @@ public function testSetDefaultOptionsWithNotInstalled(): void {
 		$this->assertEquals([
 			'verify' => \OC::$SERVERROOT . '/resources/config/ca-bundle.crt',
 			'headers' => [
-				'User-Agent' => 'Nextcloud Server Crawler'
+				'User-Agent' => 'Nextcloud Server Crawler',
+				'Accept-Encoding' => 'gzip',
 			],
 			'timeout' => 30,
 		], self::invokePrivate($this->client, 'buildRequestOptions', [[]]));
@@ -502,7 +504,8 @@ public function testSetDefaultOptionsWithProxy(): void {
 				'https' => 'foo'
 			],
 			'headers' => [
-				'User-Agent' => 'Nextcloud Server Crawler'
+				'User-Agent' => 'Nextcloud Server Crawler',
+				'Accept-Encoding' => 'gzip',
 			],
 			'timeout' => 30,
 		], self::invokePrivate($this->client, 'buildRequestOptions', [[]]));
@@ -538,7 +541,8 @@ public function testSetDefaultOptionsWithProxyAndExclude(): void {
 				'no' => ['bar']
 			],
 			'headers' => [
-				'User-Agent' => 'Nextcloud Server Crawler'
+				'User-Agent' => 'Nextcloud Server Crawler',
+				'Accept-Encoding' => 'gzip',
 			],
 			'timeout' => 30,
 		], self::invokePrivate($this->client, 'buildRequestOptions', [[]]));