velocity-python 0.1.57__tar.gz → 0.1.58__tar.gz

{velocity_python-0.1.57 → velocity_python-0.1.58}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: velocity-python
-Version: 0.1.57
+Version: 0.1.58
 Summary: A rapid application development library for interfacing with data storage
 Author-email: Velocity Team <info@codeclubs.org>
 License-Expression: MIT

{velocity_python-0.1.57 → velocity_python-0.1.58}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "velocity-python"
-version = "0.1.57"
+version = "0.1.58"
 authors = [
   { name="Velocity Team", email="info@codeclubs.org" },
 ]

{velocity_python-0.1.57 → velocity_python-0.1.58}/src/velocity/__init__.py

@@ -1,4 +1,4 @@
-__version__ = version = "0.1.57"
+__version__ = version = "0.1.58"
 
 import importlib as _importlib
 

{velocity_python-0.1.57 → velocity_python-0.1.58}/src/velocity/aws/assets/backfill.py

@@ -70,7 +70,16 @@ def backfill_asset_records(
     bucket: str,
     objects: Iterable[Mapping[str, Any]],
     head_loader: HeadLoader | None = None,
+    dry_run: bool = False,
 ) -> tuple[list[AssetRecord], AssetBackfillSummary]:
+    """Register missing S3 objects as ``images`` rows.
+
+    When ``dry_run`` is True no rows are written: the function still scans,
+    checks for existing rows, and builds the candidate records, and the returned
+    summary's ``inserted`` count reflects how many rows *would* be created. The
+    returned asset list holds the normalized would-be records. This lets a
+    runbook or the admin button preview a backfill before committing it.
+    """
     inserted_assets: list[AssetRecord] = []
     scanned = 0
     inserted = 0
@@ -91,8 +100,11 @@ def backfill_asset_records(
         if not row:
             skipped_unsupported += 1
             continue
-        tx.table("images").upsert(row, {"key": row["key"]})
         inserted += 1
+        if dry_run:
+            inserted_assets.append(normalize_asset_record(row))
+            continue
+        tx.table("images").upsert(row, {"key": row["key"]})
         stored = tx.table("images").find({"key": row["key"]})
         inserted_assets.append(normalize_asset_record(stored.to_dict() if stored else row))
 

{velocity_python-0.1.57 → velocity_python-0.1.58}/src/velocity_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: velocity-python
-Version: 0.1.57
+Version: 0.1.58
 Summary: A rapid application development library for interfacing with data storage
 Author-email: Velocity Team <info@codeclubs.org>
 License-Expression: MIT

{velocity_python-0.1.57 → velocity_python-0.1.58}/tests/test_assets_service.py

@@ -299,6 +299,43 @@ def test_backfill_asset_records_skips_existing_and_thumbnail_objects():
     assert summary.skipped_unsupported == 1
 
 
+def test_backfill_asset_records_dry_run_reports_without_writing():
+    tx = FakeTx(
+        [
+            {
+                "sys_id": "img-1",
+                "bucket": "donate.resources",
+                "key": "client-a/existing.png",
+                "url": "https://donate.resources.s3.amazonaws.com/client-a/existing.png",
+                "public": True,
+            }
+        ]
+    )
+    objects = [
+        {"Key": "client-a/existing.png", "Size": 10, "ETag": '"a"'},
+        {"Key": "client-a/new.png", "Size": 11, "ETag": '"b"'},
+        {"Key": "client-a/new-thumb.png", "Size": 12, "ETag": '"c"'},
+    ]
+    rows_before = len(tx.images.rows)
+
+    inserted, summary = backfill_asset_records(
+        tx,
+        bucket="donate.resources",
+        objects=objects,
+        dry_run=True,
+    )
+
+    # Same accounting as a real run...
+    assert summary.scanned == 3
+    assert summary.inserted == 1
+    assert summary.skipped_existing == 1
+    assert summary.skipped_unsupported == 1
+    assert len(inserted) == 1
+    assert inserted[0].key == "client-a/new.png"
+    # ...but nothing was actually written.
+    assert len(tx.images.rows) == rows_before
+
+
 def _matches(row, where):
     for key, value in where.items():
         if key == "!%key":