add compression order to the config (optional) #5

Author: d8vjork

config/response-compression.php

@@ -14,6 +14,8 @@
     */
 
     'enable' => env('RESPONSE_COMPRESSION_ENABLE', true),
+    
+    'order' => explode(',', env('RESPONSE_COMPRESSION_ORDER', '')),
 
     // Threshold size in bytes from where the compression will be applied to responses
     // @see https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html#http-api-quotas

src/ResponseCompression.php

@@ -78,9 +78,22 @@ protected function shouldCompressResponse($response): bool
      */
     protected function shouldCompressUsing($request): ?array
     {
+        $clientSupportedList = $request->getEncodings();
+        
         $supportedList = CompressionEncoding::listSupported();
 
-        $fromSupportedList = array_intersect($request->getEncodings(), array_keys($supportedList));
+        /** @var string[] $preferenceList */
+        $preferenceList = config('response-compression.order', []);
+
+        if (count($preferenceList) > 0) {
+            $preferenceList = array_merge($preferenceList, array_diff(array_keys($supportedList), $preferenceList));
+        }
+
+        $fromSupportedList = array_intersect(
+            $preferenceList ?: $clientSupportedList,
+            $clientSupportedList,
+            array_keys($supportedList)
+        );
 
         if ($fromSupportedList[0] ?? false) {
             return [$fromSupportedList[0], $supportedList[$fromSupportedList[0]]];

tests/ResponseCompressionTest.php

@@ -91,6 +91,24 @@ public function testClientGetResponseInThePreferredEncoding()
             json_encode(['content' => $this->heavyResponseContent])
         );
     }
+    
+    public function testClientGetResponseInThePreferredAsFirstOrderConfiguredEncoding()
+    {
+        config(['response-compression.order' => ['br', 'gzip']]);
+        
+        $response = $this->get('/heavy', ['Accept-Encoding' => implode(', ', [
+            CompressionEncoding::Zstandard->value,
+            CompressionEncoding::Gzip->value,
+            CompressionEncoding::Brotli->value,
+        ])]);
+
+        $response->assertHeader('Content-Encoding', CompressionEncoding::Brotli->value);
+
+        $this->assertEquals(
+            brotli_uncompress($response->getContent()),
+            json_encode(['content' => $this->heavyResponseContent])
+        );
+    }
 
     public function testClientGetResponseAskingAnUnrecognisedEncodingReceivesRawResponse()
     {