Make COMPRESS_EVALUATE_CONDITIONAL_REQUEST default to True

Author: alexprengere

README.md

@@ -144,4 +144,4 @@ Within your Flask application's settings you can provide the following settings
 | `COMPRESS_REGISTER` | Specifies if compression should be automatically registered. | `True` |
 | `COMPRESS_ALGORITHM` | Supported compression algorithms. | `['zstd', 'br', 'gzip', 'deflate']` |
 | `COMPRESS_STREAMS` | Compress content streams. | `True` |
-| `COMPRESS_EVALUATE_CONDITIONAL_REQUEST` | Compress evaluates conditional requests. | `False` |
+| `COMPRESS_EVALUATE_CONDITIONAL_REQUEST` | Compress evaluates conditional requests. | `True` |

flask_compress/flask_compress.py

@@ -165,7 +165,7 @@ def init_app(self, app):
             ("COMPRESS_CACHE_BACKEND", None),
             ("COMPRESS_REGISTER", True),
             ("COMPRESS_STREAMS", True),
-            ("COMPRESS_EVALUATE_CONDITIONAL_REQUEST", False),
+            ("COMPRESS_EVALUATE_CONDITIONAL_REQUEST", True),
             ("COMPRESS_ALGORITHM", ["zstd", "br", "gzip", "deflate"]),
         ]
 

tests/test_flask_compress.py

@@ -95,7 +95,7 @@ def test_evaluate_conditional_request(self):
         """Tests COMPRESS_EVALUATE_CONDITIONAL_REQUEST default value
         is correctly set."""
         self.assertEqual(
-            self.app.config["COMPRESS_EVALUATE_CONDITIONAL_REQUEST"], False
+            self.app.config["COMPRESS_EVALUATE_CONDITIONAL_REQUEST"], True
         )
 
 
@@ -633,6 +633,7 @@ def test_weak_etag_is_preserved(self):
         self.assertEqual(tag, "abc123")
 
     def test_conditional_get_uses_strong_compressed_representation(self):
+        self.app.config["COMPRESS_EVALUATE_CONDITIONAL_REQUEST"] = False
         client = self.app.test_client()
         r1 = client.get("/strong/", headers=[("Accept-Encoding", "gzip")])
 
@@ -643,12 +644,13 @@ def test_conditional_get_uses_strong_compressed_representation(self):
                 ("If-None-Match", r1.headers["ETag"]),
             ],
         )
-        # This is the current behavior that breaks make_conditional
+        # This is the old behavior that broke make_conditional
         # strong etags due rewrite at after_request
         # We would expect a 304 but it does not because of etag mismatch
         self.assertEqual(r2.status_code, 200)
 
     def test_conditional_get_uses_weak_compressed_representation(self):
+        self.app.config["COMPRESS_EVALUATE_CONDITIONAL_REQUEST"] = False
         client = self.app.test_client()
         r1 = client.get("/weak/", headers=[("Accept-Encoding", "gzip")])
         etag_header = r1.headers["ETag"]
@@ -657,7 +659,7 @@ def test_conditional_get_uses_weak_compressed_representation(self):
             "/weak/",
             headers=[("Accept-Encoding", "gzip"), ("If-None-Match", etag_header)],
         )
-        # This is the new behaviour we would expect by not mutating
+        # This is the behaviour we expect by not mutating
         # the weak etags at after_request
         self.assertEqual(r2.status_code, 304)
         self.assertEqual(r2.headers.get("ETag"), etag_header)
@@ -667,7 +669,6 @@ def test_conditional_get_uses_weak_compressed_representation(self):
     def test_conditional_get_uses_strong_compressed_representation_evaluate_conditional(
         self,
     ):
-        self.app.config["COMPRESS_EVALUATE_CONDITIONAL_REQUEST"] = True
         client = self.app.test_client()
         r1 = client.get(
             "/strong-compress-conditional/", headers=[("Accept-Encoding", "gzip")]
@@ -678,7 +679,7 @@ def test_conditional_get_uses_strong_compressed_representation_evaluate_conditio
             "/strong-compress-conditional/",
             headers=[("Accept-Encoding", "gzip"), ("If-None-Match", etag_header)],
         )
-        # This is the new behaviour we would expect after evaluating
+        # This is the behaviour we would expect after evaluating
         # flask make_conditional at after_request
         self.assertEqual(r2.status_code, 304)
         self.assertEqual(r2.headers.get("ETag"), etag_header)
@@ -688,7 +689,6 @@ def test_conditional_get_uses_strong_compressed_representation_evaluate_conditio
     def test_conditional_get_uses_weak_compressed_representation_evaluate_conditional(
         self,
     ):
-        self.app.config["COMPRESS_EVALUATE_CONDITIONAL_REQUEST"] = True
         client = self.app.test_client()
         r1 = client.get(
             "/weak-compress-conditional/", headers=[("Accept-Encoding", "gzip")]
@@ -699,7 +699,7 @@ def test_conditional_get_uses_weak_compressed_representation_evaluate_conditiona
             "/weak-compress-conditional/",
             headers=[("Accept-Encoding", "gzip"), ("If-None-Match", etag_header)],
         )
-        # This is the new behaviour we would expect after evaluating
+        # This is the behaviour we would expect after evaluating
         # flask make_conditional at after_request
         self.assertEqual(r2.status_code, 304)
         self.assertEqual(r2.headers.get("ETag"), etag_header)