babelqueue 0.3.0__tar.gz → 0.4.0__tar.gz

{babelqueue-0.3.0 → babelqueue-0.4.0}/CHANGELOG.md

@@ -9,6 +9,17 @@ The envelope wire format is versioned separately by `meta.schema_version`
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-06-06
+
+### Added
+- `EnvelopeCodec.urn()` — resolve the URN (`job`, accepting `urn` as an alias).
+- `EnvelopeCodec.accepts()` — consumer-side envelope validation (rejects empty URN,
+  unsupported `meta.schema_version`, blank `trace_id`, non-object `data`).
+- Shared **cross-SDK conformance suite** under `tests/conformance/` (vendored from
+  the canonical `conformance/` set) plus a `test_conformance.py` runner.
+
+## [0.3.0] - 2026-06-06
+
 ### Added
 - **RabbitMQ transport** (`PikaTransport`, `amqp://`): durable queue, persistent
   delivery, `basic_get` + manual ack, and the contract AMQP properties (`type`=URN,
@@ -44,6 +55,8 @@ The envelope wire format is versioned separately by `meta.schema_version`
 - Pre-1.0: the public API may change before the `1.0.0` tag.
 - The core has **zero runtime dependencies** (standard library only); Python `>=3.9`.
 
-[Unreleased]: https://github.com/BabelQueue/babelqueue-python/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/BabelQueue/babelqueue-python/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/BabelQueue/babelqueue-python/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/BabelQueue/babelqueue-python/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/BabelQueue/babelqueue-python/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/BabelQueue/babelqueue-python/releases/tag/v0.1.0

{babelqueue-0.3.0 → babelqueue-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: babelqueue
-Version: 0.3.0
+Version: 0.4.0
 Summary: Polyglot Queues, Simplified — the Python core: the canonical BabelQueue wire-envelope codec, contracts and dead-letter helpers.
 Project-URL: Homepage, https://babelqueue.com
 Project-URL: Source, https://github.com/BabelQueue/babelqueue-python

{babelqueue-0.3.0 → babelqueue-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "babelqueue"
-version = "0.3.0"
+version = "0.4.0"
 description = "Polyglot Queues, Simplified — the Python core: the canonical BabelQueue wire-envelope codec, contracts and dead-letter helpers."
 readme = "README.md"
 requires-python = ">=3.9"

{babelqueue-0.3.0 → babelqueue-0.4.0}/src/babelqueue/__init__.py

@@ -19,7 +19,7 @@ from .exceptions import BabelQueueError, UnknownUrnError
 from .routing import UnknownUrnStrategy
 from .transport import InMemoryTransport, ReceivedMessage, Transport
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"
 
 __all__ = [
     "BabelQueue",

{babelqueue-0.3.0 → babelqueue-0.4.0}/src/babelqueue/codec.py

@@ -94,3 +94,36 @@ class EnvelopeCodec:
         except (ValueError, TypeError):
             return {}
         return decoded if isinstance(decoded, dict) else {}
+
+    @staticmethod
+    def urn(envelope: Mapping[str, Any]) -> str:
+        """The message URN: canonical ``job``, with ``urn`` accepted as an alias."""
+        return str(envelope.get("job") or envelope.get("urn") or "")
+
+    @staticmethod
+    def accepts(envelope: Mapping[str, Any]) -> bool:
+        """Whether a consumer should accept this envelope (consumer-side validation).
+
+        Rejects messages with no URN, an unsupported ``meta.schema_version``, a
+        missing/blank ``trace_id``, or a non-object ``data`` / non-integer
+        ``attempts``. (Accepts the ``urn`` alias, unlike the producer JSON Schema.)
+        """
+        if EnvelopeCodec.urn(envelope) == "":
+            return False
+
+        meta = envelope.get("meta")
+        if not isinstance(meta, dict) or meta.get("schema_version") != SCHEMA_VERSION:
+            return False
+
+        if not isinstance(envelope.get("data"), dict):
+            return False
+
+        attempts = envelope.get("attempts")
+        if not isinstance(attempts, int) or isinstance(attempts, bool):
+            return False
+
+        trace_id = envelope.get("trace_id")
+        if not isinstance(trace_id, str) or trace_id == "":
+            return False
+
+        return True

babelqueue-0.4.0/tests/conformance/fixtures/invalid-missing-urn.json

@@ -0,0 +1,14 @@
+{
+  "trace_id": "7b3f9c2a-e41d-4f88-9b2a-1c0d5e6f7a8b",
+  "data": {
+    "order_id": 1042
+  },
+  "meta": {
+    "id": "f1e2d3c4-b5a6-4789-90ab-cdef01234567",
+    "queue": "orders",
+    "lang": "php",
+    "schema_version": 1,
+    "created_at": 1749132727000
+  },
+  "attempts": 0
+}

babelqueue-0.4.0/tests/conformance/fixtures/invalid-unknown-schema-version.json

@@ -0,0 +1,15 @@
+{
+  "job": "urn:babel:orders:created",
+  "trace_id": "7b3f9c2a-e41d-4f88-9b2a-1c0d5e6f7a8b",
+  "data": {
+    "order_id": 1042
+  },
+  "meta": {
+    "id": "f1e2d3c4-b5a6-4789-90ab-cdef01234567",
+    "queue": "orders",
+    "lang": "php",
+    "schema_version": 2,
+    "created_at": 1749132727000
+  },
+  "attempts": 0
+}

babelqueue-0.4.0/tests/conformance/fixtures/unicode-and-numbers.json

@@ -0,0 +1,20 @@
+{
+  "job": "urn:babel:catalog:item.indexed",
+  "trace_id": "3f7a1d2e-9b4c-4a8d-bc1e-0f5a6b7c8d90",
+  "data": {
+    "title": "Café — naïve ☕",
+    "qty": 7,
+    "price_cents": 1299,
+    "ratio": 0.5,
+    "active": true,
+    "note": null
+  },
+  "meta": {
+    "id": "b2c3d4e5-f607-4890-a1b2-c3d4e5f60718",
+    "queue": "catalog",
+    "lang": "python",
+    "schema_version": 1,
+    "created_at": 1749132727000
+  },
+  "attempts": 2
+}

babelqueue-0.4.0/tests/conformance/fixtures/urn-alias.json

@@ -0,0 +1,15 @@
+{
+  "urn": "urn:babel:orders:created",
+  "trace_id": "9c1e0b44-7a2d-4e6f-8a10-2b3c4d5e6f70",
+  "data": {
+    "order_id": 1042
+  },
+  "meta": {
+    "id": "a1b2c3d4-e5f6-4789-90ab-cdef01234567",
+    "queue": "orders",
+    "lang": "go",
+    "schema_version": 1,
+    "created_at": 1749132727000
+  },
+  "attempts": 0
+}

babelqueue-0.4.0/tests/conformance/manifest.json

@@ -0,0 +1,71 @@
+{
+  "schema_version": 1,
+  "description": "Cross-SDK conformance cases. Every BabelQueue SDK core must satisfy these against the canonical wire envelope. Per-message fields (meta.id, trace_id, meta.created_at) are intrinsically unique and are NOT asserted by value.",
+  "cases": [
+    {
+      "name": "order-created",
+      "file": "fixtures/order-created.json",
+      "valid": true,
+      "description": "A normal produced envelope.",
+      "expect": {
+        "urn": "urn:babel:orders:created",
+        "data": { "order_id": 1042 },
+        "attempts": 0,
+        "lang": "php",
+        "schema_version": 1
+      }
+    },
+    {
+      "name": "urn-alias",
+      "file": "fixtures/urn-alias.json",
+      "valid": true,
+      "description": "Consumers MUST accept 'urn' as an inbound alias for 'job'.",
+      "expect": {
+        "urn": "urn:babel:orders:created",
+        "data": { "order_id": 1042 },
+        "attempts": 0,
+        "lang": "go",
+        "schema_version": 1
+      }
+    },
+    {
+      "name": "dead-lettered",
+      "file": "fixtures/dead-lettered.json",
+      "valid": true,
+      "description": "A dead-lettered message: original preserved + additive dead_letter block.",
+      "expect": {
+        "urn": "urn:babel:orders:created",
+        "data": { "order_id": 1042 },
+        "attempts": 3,
+        "lang": "php",
+        "schema_version": 1,
+        "dead_letter": { "reason": "failed", "original_queue": "orders" }
+      }
+    },
+    {
+      "name": "unicode-and-numbers",
+      "file": "fixtures/unicode-and-numbers.json",
+      "valid": true,
+      "description": "UTF-8 strings, integers, an exact float, boolean and null round-trip identically.",
+      "expect": {
+        "urn": "urn:babel:catalog:item.indexed",
+        "data": { "title": "Café — naïve ☕", "qty": 7, "price_cents": 1299, "ratio": 0.5, "active": true, "note": null },
+        "attempts": 2,
+        "lang": "python",
+        "schema_version": 1
+      }
+    },
+    {
+      "name": "invalid-unknown-schema-version",
+      "file": "fixtures/invalid-unknown-schema-version.json",
+      "valid": false,
+      "reason": "meta.schema_version is not a version this SDK supports"
+    },
+    {
+      "name": "invalid-missing-urn",
+      "file": "fixtures/invalid-missing-urn.json",
+      "valid": false,
+      "reason": "no 'job' or 'urn' — the message has no identity"
+    }
+  ]
+}

babelqueue-0.4.0/tests/conformance/schema/message-envelope.schema.json

@@ -0,0 +1,110 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://babelqueue.com/contracts/message-envelope.schema.json",
+  "title": "BabelQueueMessageEnvelope",
+  "description": "The canonical, language-agnostic BabelQueue wire envelope (schema_version 1). This schema is authoritative alongside contracts/message-envelope.md.",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["job", "trace_id", "data", "meta", "attempts"],
+  "properties": {
+    "job": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The message URN — language-agnostic identity. Canonical producer field name. Consumers also accept 'urn' as an inbound alias. Never a class name.",
+      "examples": ["urn:babel:orders:created", "urn:babel:orders:invoice.requested"]
+    },
+    "urn": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Inbound alias for 'job'. Accepted by consumers for interoperability; producers SHOULD emit 'job'."
+    },
+    "trace_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Cross-service correlation id. Generated by the first producer, preserved and forwarded unchanged by every SDK across every hop."
+    },
+    "data": {
+      "type": "object",
+      "description": "Pure, JSON-encodable business payload. No language-specific types. Numbers/time/binary per contracts/message-envelope.md section 6.",
+      "additionalProperties": true
+    },
+    "meta": {
+      "type": "object",
+      "description": "Producer-set, immutable descriptive metadata.",
+      "additionalProperties": true,
+      "required": ["id", "queue", "lang", "schema_version", "created_at"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "Unique id for THIS message (distinct from trace_id)."
+        },
+        "queue": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Logical queue name (not the broker key)."
+        },
+        "lang": {
+          "type": "string",
+          "enum": ["php", "go", "python", "java", "dotnet", "node"],
+          "description": "Producer language tag."
+        },
+        "schema_version": {
+          "type": "integer",
+          "const": 1,
+          "description": "Envelope schema version. Consumers MUST reject versions they do not support."
+        },
+        "created_at": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Production time as Unix epoch MILLISECONDS, UTC."
+        }
+      }
+    },
+    "attempts": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Top-level transport retry counter, mutated by the broker/worker. Deliberately kept OUT of the immutable meta block."
+    },
+    "dead_letter": {
+      "type": "object",
+      "description": "Optional. Present ONLY on messages sitting on a dead-letter queue (ADR-0009). Additive, so it does not change schema_version. Normal consumers ignore it.",
+      "additionalProperties": true,
+      "required": ["reason", "failed_at", "original_queue", "attempts"],
+      "properties": {
+        "reason": {
+          "type": "string",
+          "enum": ["failed", "unknown_urn", "poison"],
+          "description": "Why the message was dead-lettered."
+        },
+        "error": {
+          "type": ["string", "null"],
+          "description": "Human-readable error message, if any."
+        },
+        "exception": {
+          "type": ["string", "null"],
+          "description": "Producer-language exception/type name, if any (informational, language-specific)."
+        },
+        "failed_at": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Dead-letter time as Unix epoch milliseconds, UTC."
+        },
+        "original_queue": {
+          "type": "string",
+          "description": "The queue the message was consumed from before dead-lettering."
+        },
+        "attempts": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Delivery attempts made before dead-lettering."
+        },
+        "lang": {
+          "type": "string",
+          "enum": ["php", "go", "python", "java", "dotnet", "node"],
+          "description": "Language of the SDK that dead-lettered the message."
+        }
+      }
+    }
+  }
+}

babelqueue-0.4.0/tests/fixtures/dead-lettered.json

@@ -0,0 +1,24 @@
+{
+  "job": "urn:babel:orders:created",
+  "trace_id": "7b3f9c2a-e41d-4f88-9b2a-1c0d5e6f7a8b",
+  "data": {
+    "order_id": 1042
+  },
+  "meta": {
+    "id": "f1e2d3c4-b5a6-4789-90ab-cdef01234567",
+    "queue": "orders",
+    "lang": "php",
+    "schema_version": 1,
+    "created_at": 1749132727000
+  },
+  "attempts": 3,
+  "dead_letter": {
+    "reason": "failed",
+    "error": "Payment gateway timeout",
+    "exception": "App\\Exceptions\\GatewayTimeout",
+    "failed_at": 1749132730000,
+    "original_queue": "orders",
+    "attempts": 3,
+    "lang": "php"
+  }
+}

babelqueue-0.4.0/tests/fixtures/order-created.json

@@ -0,0 +1,15 @@
+{
+  "job": "urn:babel:orders:created",
+  "trace_id": "7b3f9c2a-e41d-4f88-9b2a-1c0d5e6f7a8b",
+  "data": {
+    "order_id": 1042
+  },
+  "meta": {
+    "id": "f1e2d3c4-b5a6-4789-90ab-cdef01234567",
+    "queue": "orders",
+    "lang": "php",
+    "schema_version": 1,
+    "created_at": 1749132727000
+  },
+  "attempts": 0
+}

babelqueue-0.4.0/tests/test_conformance.py

@@ -0,0 +1,58 @@
+"""Runs the shared cross-SDK conformance suite (vendored under tests/conformance/).
+
+The same manifest + fixtures are run by every BabelQueue SDK; passing here proves
+this SDK reads/writes the canonical envelope identically to the others.
+"""
+
+from __future__ import annotations
+
+import json
+import unittest
+from pathlib import Path
+
+from babelqueue import EnvelopeCodec
+
+SUITE = Path(__file__).parent / "conformance"
+MANIFEST = json.loads((SUITE / "manifest.json").read_text(encoding="utf-8"))
+
+
+class ConformanceTest(unittest.TestCase):
+    def test_suite_is_present(self) -> None:
+        self.assertEqual(MANIFEST["schema_version"], 1)
+        self.assertGreaterEqual(len(MANIFEST["cases"]), 6)
+
+    def test_cases(self) -> None:
+        for case in MANIFEST["cases"]:
+            with self.subTest(case=case["name"]):
+                raw = (SUITE / case["file"]).read_text(encoding="utf-8")
+                env = EnvelopeCodec.decode(raw)
+                self.assertNotEqual(env, {}, "fixture must decode")
+
+                if not case["valid"]:
+                    self.assertFalse(
+                        EnvelopeCodec.accepts(env),
+                        f"{case['name']} must be rejected: {case.get('reason')}",
+                    )
+                    continue
+
+                expect = case["expect"]
+                self.assertTrue(EnvelopeCodec.accepts(env), f"{case['name']} must be accepted")
+                self.assertEqual(EnvelopeCodec.urn(env), expect["urn"])
+                self.assertEqual(env["attempts"], expect["attempts"])
+                self.assertEqual(env["meta"]["lang"], expect["lang"])
+                self.assertEqual(env["meta"]["schema_version"], expect["schema_version"])
+
+                if "data" in expect:
+                    self.assertEqual(env["data"], expect["data"])
+
+                if "dead_letter" in expect:
+                    for key, value in expect["dead_letter"].items():
+                        self.assertEqual(env["dead_letter"][key], value)
+
+                # Per-message fields must be present (not asserted by value).
+                self.assertIn("id", env["meta"])
+                self.assertTrue(env["trace_id"])
+
+
+if __name__ == "__main__":
+    unittest.main()