Remove weak etag mutate setting flag

Author: jlopex

flask_compress/flask_compress.py

@@ -165,7 +165,6 @@ def init_app(self, app):
             ("COMPRESS_CACHE_BACKEND", None),
             ("COMPRESS_REGISTER", True),
             ("COMPRESS_STREAMS", True),
-            ("COMPRESS_MUTATE_WEAK_ETAGS", True),
             ("COMPRESS_EVALUATE_CONDITIONAL_REQUEST", False),
             ("COMPRESS_ALGORITHM", ["zstd", "br", "gzip", "deflate"]),
         ]
@@ -234,7 +233,7 @@ def after_request(self, response):
         # W/"123456789" => W/"123456789:gzip" - A weak ETag validator
         etag, is_weak = response.get_etag()
 
-        if etag and (not is_weak or app.config["COMPRESS_MUTATE_WEAK_ETAGS"]):
+        if etag and not is_weak:
             response.set_etag(f"{etag}:{chosen_algorithm}", weak=is_weak)
 
         if (

tests/test_flask_compress.py

@@ -91,10 +91,6 @@ def test_quality_level_default_zstd(self):
         """Tests COMPRESS_ZSTD_LEVEL default value is correctly set."""
         self.assertEqual(self.app.config["COMPRESS_ZSTD_LEVEL"], 3)
 
-    def test_mutate_weak_etags(self):
-        """Tests COMPRESS_MUTATE_WEAK_ETAGS default value is correctly set."""
-        self.assertEqual(self.app.config["COMPRESS_MUTATE_WEAK_ETAGS"], True)
-
     def test_evaluate_conditional_request(self):
         """Tests COMPRESS_EVALUATE_CONDITIONAL_REQUEST default value
         is correctly set."""
@@ -625,30 +621,7 @@ def test_strong_etag_is_mutated_with_suffix_and_remains_strong(self):
         self.assertEqual(tag, "abc123:gzip")
         self.assertEqual(int(r.headers["Content-Length"]), len(r.data))
 
-    def test_weak_etag_is_mutated_when_flag_true(self):
-        client = self.app.test_client()
-        r = client.get("/weak/", headers=[("Accept-Encoding", "gzip")])
-        self.assertEqual(r.status_code, 200)
-        self.assertEqual(r.headers.get("Content-Encoding"), "gzip")
-
-        tag, is_weak = r.get_etag()
-        self.assertTrue(is_weak)
-        self.assertEqual(tag, "abc123:gzip")
-
-    def test_strong_etag_is_mutated_when_flag_false(self):
-        self.app.config["COMPRESS_MUTATE_WEAK_ETAGS"] = False
-        client = self.app.test_client()
-        r = client.get("/strong/", headers=[("Accept-Encoding", "gzip")])
-        self.assertEqual(r.status_code, 200)
-        self.assertEqual(r.headers.get("Content-Encoding"), "gzip")
-
-        tag, is_weak = r.get_etag()
-        self.assertFalse(is_weak)
-        # :gzip suffix when flag is False
-        self.assertEqual(tag, "abc123:gzip")
-
-    def test_weak_etag_is_preserved_when_flag_false(self):
-        self.app.config["COMPRESS_MUTATE_WEAK_ETAGS"] = False
+    def test_weak_etag_is_preserved(self):
         client = self.app.test_client()
         r = client.get("/weak/", headers=[("Accept-Encoding", "gzip")])
         self.assertEqual(r.status_code, 200)
@@ -678,17 +651,18 @@ def test_conditional_get_uses_strong_compressed_representation(self):
     def test_conditional_get_uses_weak_compressed_representation(self):
         client = self.app.test_client()
         r1 = client.get("/weak/", headers=[("Accept-Encoding", "gzip")])
+        etag_header = r1.headers["ETag"]
+
         r2 = client.get(
             "/weak/",
-            headers=[
-                ("Accept-Encoding", "gzip"),
-                ("If-None-Match", r1.headers["ETag"]),
-            ],
+            headers=[("Accept-Encoding", "gzip"), ("If-None-Match", etag_header)],
         )
-        # This is the current behavior that breaks make_conditional
-        # weak 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)
+        # This is the new behaviour we would expect by not mutating
+        # the weak etags at after_request
+        self.assertEqual(r2.status_code, 304)
+        self.assertEqual(r2.headers.get("ETag"), etag_header)
+        self.assertNotIn("Content-Encoding", r2.headers)
+        self.assertEqual(len(r2.get_data()), 0)
 
     def test_conditional_get_uses_strong_compressed_representation_evaluate_conditional(
         self,
@@ -732,23 +706,6 @@ def test_conditional_get_uses_weak_compressed_representation_evaluate_conditiona
         self.assertNotIn("Content-Encoding", r2.headers)
         self.assertEqual(len(r2.get_data()), 0)
 
-    def test_conditional_get_uses_weak_compressed_representation_no_mutate_etag(self):
-        self.app.config["COMPRESS_MUTATE_WEAK_ETAGS"] = False
-        client = self.app.test_client()
-        r1 = client.get("/weak/", headers=[("Accept-Encoding", "gzip")])
-        etag_header = r1.headers["ETag"]
-
-        r2 = client.get(
-            "/weak/",
-            headers=[("Accept-Encoding", "gzip"), ("If-None-Match", etag_header)],
-        )
-        # This is the new behaviour we would expect by not mutating
-        # the weak etags at after_request
-        self.assertEqual(r2.status_code, 304)
-        self.assertEqual(r2.headers.get("ETag"), etag_header)
-        self.assertNotIn("Content-Encoding", r2.headers)
-        self.assertEqual(len(r2.get_data()), 0)
-
 
 if __name__ == "__main__":
     unittest.main()