aws-python-helper 1.9.0__tar.gz → 1.9.1__tar.gz

{aws_python_helper-1.9.0 → aws_python_helper-1.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-python-helper
-Version: 1.9.0
+Version: 1.9.1
 Summary: AWS Python Helper Framework
 Author-email: Fabian Claros <neufabiae@gmail.com>
 License-Expression: MIT

{aws_python_helper-1.9.0 → aws_python_helper-1.9.1}/aws_python_helper/repository/audit.py

@@ -124,6 +124,23 @@ def _merge_into_set(update: Dict[str, Any], values: Dict[str, Any], operator: st
         section.setdefault(key, value)
 
 
+def _written_elsewhere(update: Dict[str, Any], key: str, operator: str) -> bool:
+    """Si otro operador de esta misma actualización ya escribe ese campo.
+
+    Mongo rechaza el update entero si dos operadores tocan la misma ruta —
+    `$set: {status}` junto a `$setOnInsert: {status}` da "would create a
+    conflict at 'status'" — y el sello no tiene por qué ser el que lo provoque.
+    Si el llamador ya escribe el campo, el insert va a quedar con su valor, así
+    que el sello ahí sobra.
+    """
+    for other, section in update.items():
+        if other == operator or not other.startswith('$') or not isinstance(section, dict):
+            continue
+        if key in section:
+            return True
+    return False
+
+
 def stamp_update(
     update: Union[Dict[str, Any], List[Dict[str, Any]]],
     upsert: bool = False,
@@ -164,6 +181,11 @@ def stamp_update(
         born = {CREATED_AT: now, CREATED_BY: who}
         if statuses:
             born[STATUS] = default_status or statuses[0]
+        born = {
+            key: value
+            for key, value in born.items()
+            if not _written_elsewhere(update, key, '$setOnInsert')
+        }
         _merge_into_set(update, born, '$setOnInsert')
     return update
 

{aws_python_helper-1.9.0 → aws_python_helper-1.9.1}/aws_python_helper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-python-helper
-Version: 1.9.0
+Version: 1.9.1
 Summary: AWS Python Helper Framework
 Author-email: Fabian Claros <neufabiae@gmail.com>
 License-Expression: MIT

{aws_python_helper-1.9.0 → aws_python_helper-1.9.1}/aws_python_helper.egg-info/SOURCES.txt

@@ -55,4 +55,5 @@ aws_python_helper/sqs/handler.py
 aws_python_helper/utils/__init__.py
 aws_python_helper/utils/json_encoder.py
 aws_python_helper/utils/response.py
-aws_python_helper/utils/serializer.py
+aws_python_helper/utils/serializer.py
+tests/test_audit_stamp.py

{aws_python_helper-1.9.0 → aws_python_helper-1.9.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aws-python-helper"
-version = "1.9.0"
+version = "1.9.1"
 description = "AWS Python Helper Framework"
 readme = "README.md"
 requires-python = ">=3.9"

aws_python_helper-1.9.1/tests/test_audit_stamp.py

@@ -0,0 +1,88 @@
+"""What the audit stamp must never do to a write.
+
+Runs on its own, no dependencies:
+
+    python tests/test_audit_stamp.py
+
+These are here because the stamp broke a write in production once: an upsert
+that set `status` itself collided with the `$setOnInsert` the stamp added, and
+Mongo refused the whole update with "would create a conflict at 'status'". It
+failed at runtime, on one endpoint, in a log nobody was reading.
+"""
+
+import os
+import sys
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+from aws_python_helper.repository.audit import stamp_update  # noqa: E402
+
+STATUSES = ["active", "inactive"]
+
+failures = []
+
+
+def check(label, condition, detail=""):
+    mark = "ok  " if condition else "FAIL"
+    print(f"  {mark} {label}{'  ' + detail if detail else ''}")
+    if not condition:
+        failures.append(label)
+
+
+def conflicts(update):
+    """Los campos que dos operadores de un mismo update escriben a la vez.
+
+    Es lo que Mongo rechaza, y rechaza el update entero: no escribe nada.
+    """
+    sections = [
+        (name, section) for name, section in update.items()
+        if name.startswith("$") and isinstance(section, dict)
+    ]
+    clash = set()
+    for index, (_, first) in enumerate(sections):
+        for _, second in sections[index + 1:]:
+            clash |= set(first) & set(second)
+    return clash
+
+
+print("no two operators may write the same path")
+for label, update in [
+    ("upsert that sets status itself", {"$set": {"name": "ct", "status": "active"}}),
+    ("upsert that sets created_at itself", {"$set": {"created_at": "fixed"}}),
+    ("upsert that sets created_by itself", {"$set": {"created_by": {"name": "x"}}}),
+    ("plain upsert", {"$set": {"name": "ct"}}),
+    ("upsert with $inc alongside", {"$set": {"name": "ct"}, "$inc": {"hits": 1}}),
+]:
+    result = stamp_update(dict(update), upsert=True, statuses=STATUSES, default_status="active")
+    found = conflicts(result)
+    check(label, not found, f"conflicts={sorted(found)}" if found else "")
+
+print("\nthe stamp is still complete when nothing conflicts")
+result = stamp_update({"$set": {"name": "ct"}}, upsert=True, statuses=STATUSES, default_status="active")
+check("status on insert", result["$setOnInsert"].get("status") == "active")
+check("created_at on insert", "created_at" in result["$setOnInsert"])
+check("created_by on insert", "created_by" in result["$setOnInsert"])
+check("updated_at always", "updated_at" in result["$set"])
+
+print("\nthe caller's own value wins")
+result = stamp_update({"$set": {"status": "inactive"}}, upsert=True, statuses=STATUSES, default_status="active")
+check("status stays what the caller set", result["$set"]["status"] == "inactive")
+check("no default forced on top", "status" not in result.get("$setOnInsert", {}))
+
+print("\nwithout upsert there is no insert stamp")
+result = stamp_update({"$set": {"status": "inactive"}}, upsert=False, statuses=STATUSES)
+check("no $setOnInsert", "$setOnInsert" not in result)
+
+print("\nwithout a vocabulary no status is invented")
+result = stamp_update({"$set": {"name": "ct"}}, upsert=True, statuses=None)
+check("no status", "status" not in result.get("$setOnInsert", {}))
+
+print("\na pipeline update takes stages, not operators")
+result = stamp_update([{"$set": {"name": "ct"}}], upsert=True, statuses=STATUSES)
+check("still a list", isinstance(result, list))
+check("stamp appended last", result[-1]["$set"].get("updated_at") is not None)
+
+if failures:
+    print(f"\n{len(failures)} failed: {failures}")
+    raise SystemExit(1)
+print("\nall good")