refactor(webhooks): rename ungzip_payload to gunzip_payload + add golden fixtures (CHA-3071)

Per Tommaso's suggestion, align the gzip helper with the GNU `gunzip`
command name. The function was added in this PR and not yet released,
so this is a straight rename with no back-compat alias.

Adds Tommaso's reference fixtures to the test suite as named cases so
future SDKs can sanity-check against the same payloads:

  aGVsbG93b3JsZA==                          -> helloworld   (base64)
  H4sIAGrYAWoAA8tIzcnJL88vykkBAK0g6/kKAAAA -> helloworld   (base64+gzip)

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: nijeesh-stream

docs/webhooks/webhooks_overview/webhooks_overview.md

@@ -177,7 +177,7 @@ event = webhook.verify_and_parse_sqs(message_body, signature, secret)
 event = webhook.verify_and_parse_sns(notification_body, signature, secret)
 ```
 
-The module also exposes the primitives the composites are built from — `ungzip_payload`, `decode_sqs_payload`, `decode_sns_payload`, `verify_signature` (constant-time HMAC-SHA256), and `parse_event` — for callers that need to run the steps individually.
+The module also exposes the primitives the composites are built from — `gunzip_payload`, `decode_sqs_payload`, `decode_sns_payload`, `verify_signature` (constant-time HMAC-SHA256), and `parse_event` — for callers that need to run the steps individually.
 
 All webhook requests contain these headers:
 

stream_chat/tests/test_webhook_compression.py

@@ -4,7 +4,7 @@
 
 * Module-level functions in :mod:`stream_chat.webhook`:
 
-  * primitives - ``ungzip_payload``, ``decode_sqs_payload``,
+  * primitives - ``gunzip_payload``, ``decode_sqs_payload``,
     ``decode_sns_payload``, ``verify_signature``, ``parse_event``
   * composite helpers - ``verify_and_parse_webhook``,
     ``verify_and_parse_sqs``, ``verify_and_parse_sns``
@@ -32,8 +32,8 @@
     GZIP_MAGIC,
     decode_sns_payload,
     decode_sqs_payload,
+    gunzip_payload,
     parse_event,
-    ungzip_payload,
     verify_and_parse_sns,
     verify_and_parse_sqs,
     verify_and_parse_webhook,
@@ -66,32 +66,36 @@ def sync_client() -> StreamChat:
     return StreamChat(api_key=API_KEY, api_secret=API_SECRET)
 
 
-class TestUngzipPayload:
+class TestGunzipPayload:
     def test_passthrough_plain_bytes(self):
-        assert ungzip_payload(JSON_BODY) == JSON_BODY
+        assert gunzip_payload(JSON_BODY) == JSON_BODY
 
     def test_passthrough_str_input(self):
-        assert ungzip_payload(JSON_BODY.decode("utf-8")) == JSON_BODY
+        assert gunzip_payload(JSON_BODY.decode("utf-8")) == JSON_BODY
 
     def test_inflates_gzip_bytes(self):
-        assert ungzip_payload(_gzip(JSON_BODY)) == JSON_BODY
+        assert gunzip_payload(_gzip(JSON_BODY)) == JSON_BODY
 
     def test_returns_bytes(self):
-        assert isinstance(ungzip_payload(JSON_BODY), bytes)
-        assert isinstance(ungzip_payload(_gzip(JSON_BODY)), bytes)
+        assert isinstance(gunzip_payload(JSON_BODY), bytes)
+        assert isinstance(gunzip_payload(_gzip(JSON_BODY)), bytes)
 
     def test_empty_input(self):
-        assert ungzip_payload(b"") == b""
+        assert gunzip_payload(b"") == b""
 
     def test_short_input_below_magic_length(self):
-        assert ungzip_payload(b"ab") == b"ab"
+        assert gunzip_payload(b"ab") == b"ab"
 
     def test_truncated_gzip_with_magic_raises(self):
         bad = GZIP_MAGIC + b"\x00\x00\x00"
         with pytest.raises(WebhookSignatureError) as exc_info:
-            ungzip_payload(bad)
+            gunzip_payload(bad)
         assert "decompress" in str(exc_info.value).lower()
 
+    def test_decompresses_helloworld_fixture(self):
+        gz_bytes = base64.b64decode("H4sIAGrYAWoAA8tIzcnJL88vykkBAK0g6/kKAAAA")
+        assert gunzip_payload(gz_bytes) == b"helloworld"
+
 
 class TestDecodeSqsPayload:
     def test_base64_only_no_compression(self):
@@ -114,6 +118,15 @@ def test_invalid_base64_raises(self):
             decode_sqs_payload("!!!not-valid-base64!!!")
         assert "base64" in str(exc_info.value).lower()
 
+    def test_decodes_helloworld_base64_fixture(self):
+        assert decode_sqs_payload("aGVsbG93b3JsZA==") == b"helloworld"
+
+    def test_decodes_helloworld_base64_gzip_fixture(self):
+        assert (
+            decode_sqs_payload("H4sIAGrYAWoAA8tIzcnJL88vykkBAK0g6/kKAAAA")
+            == b"helloworld"
+        )
+
 
 def _sns_envelope(inner_message: str) -> str:
     return json.dumps(

stream_chat/webhook.py

@@ -36,7 +36,7 @@ def _to_bytes(body: _BytesLike) -> bytes:
     raise TypeError(f"webhook body must be bytes or str, got {type(body).__name__}")
 
 
-def ungzip_payload(body: _BytesLike) -> bytes:
+def gunzip_payload(body: _BytesLike) -> bytes:
     """Return ``body`` unchanged unless it starts with the gzip magic
     (``1f 8b``, per RFC 1952), in which case the gzip stream is decompressed.
 
@@ -67,7 +67,7 @@ def decode_sqs_payload(body: _BytesLike) -> bytes:
         decoded = base64.b64decode(raw, validate=True)
     except ValueError as exc:
         raise WebhookSignatureError(f"failed to base64-decode payload: {exc}")
-    return ungzip_payload(decoded)
+    return gunzip_payload(decoded)
 
 
 def decode_sns_payload(notification_body: _BytesLike) -> bytes:
@@ -168,7 +168,7 @@ def verify_and_parse_webhook(
     :param secret: the app's API secret
     :raises WebhookSignatureError: on signature mismatch or decode error
     """
-    inflated = ungzip_payload(body)
+    inflated = gunzip_payload(body)
     return _verify_and_parse(inflated, signature, secret)