metabase-sync 0.2.0__tar.gz → 0.2.2__tar.gz

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/CHANGELOG.md

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.2] — 2026-07-16
+
+### Fixed
+
+- **Export no longer persists `lib/uuid` (and sibling server bookkeeping)
+  inside queries.** Metabase regenerates these MBQL5 values server-side, so
+  storing them made re-exports rewrite otherwise-unchanged cards forever. The
+  diff already ignored them; writes (export and apply write-backs) now strip
+  them from `dataset_query` and `template_tags` too. The first export after
+  upgrading removes them from existing state once.
+
+### Testing
+
+- Unit coverage that written card files carry no `lib/uuid` in either form
+  (`test_legacy_query.py`); both integration suites (pinned v0.62.2 and
+  v0.55.16) verified.
+
+## [0.2.1] — 2026-07-16
+
+### Fixed
+
+- **Pulses no longer plan a perpetual `disable_links: null → False` update on
+  Metabase <= v0.55.** Those versions return `disable_links` as null, which
+  the 0.2.0 pulse diff compared against the default. A null remote value is
+  never diffed against the default, and a null on disk (state exported from
+  such a version) is sent as false.
+
+### Testing
+
+- Unit coverage for the null-remote case (`test_pulse_diff.py`); the full
+  integration suite verified against Metabase v0.55.16 and the pinned
+  v0.62.2.
+
 ## [0.2.0] — 2026-07-16
 
 Minor (not patch) because output formatting changes: the first export after

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: metabase-sync
-Version: 0.2.0
+Version: 0.2.2
 Summary: Metabase as code: export, plan, and apply dashboards, cards, collections, snippets and pulses via the Metabase REST API.
 Project-URL: Homepage, https://github.com/novucs/metabase-sync
 Project-URL: Repository, https://github.com/novucs/metabase-sync

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "metabase-sync"
-version = "0.2.0"
+version = "0.2.2"
 description = "Metabase as code: export, plan, and apply dashboards, cards, collections, snippets and pulses via the Metabase REST API."
 readme = { file = "README.md", content-type = "text/markdown" }
 authors = [{ name = "novucs" }]

metabase_sync-0.2.2/src/metabase_sync/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.2"

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/src/metabase_sync/apply/_cards.py

@@ -18,7 +18,7 @@ from pathlib import Path
 from typing import Any
 
 from metabase_sync.plan import Change
-from metabase_sync.serialize.canon import CARD, canonical
+from metabase_sync.serialize.canon import CARD, canonical, strip_query_volatile
 from metabase_sync.serialize.cards import read_card_file
 from metabase_sync.serialize.yamlio import write_frontmatter_sql, write_yaml
 
@@ -251,10 +251,17 @@ def _assert_query_persisted(
 def _rewrite_card_file(
     path: Path, fm: dict[str, Any], body: str | None, gui_query: dict[str, Any] | None
 ) -> None:
+    if "template_tags" in fm:
+        fm = fm | {"template_tags": strip_query_volatile(fm["template_tags"])}
     if body is not None:
         write_frontmatter_sql(path, canonical(fm, CARD), body)
     else:
-        write_yaml(path, canonical(fm | {"dataset_query": gui_query or {}}, CARD))
+        write_yaml(
+            path,
+            canonical(
+                fm | {"dataset_query": strip_query_volatile(gui_query or {})}, CARD
+            ),
+        )
 
 
 # --- diff ---------------------------------------------------------------------

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/src/metabase_sync/apply/_pulses.py

@@ -119,15 +119,16 @@ def _pulse_diffs(
     diffs = diff_fields(
         desired,
         remote,
-        (
-            "name",
-            "collection_id",
-            "dashboard_id",
-            "skip_if_empty",
-            "disable_links",
-            "archived",
-        ),
+        ("name", "collection_id", "dashboard_id", "skip_if_empty", "archived"),
     )
+    # Metabase <= v0.55 returns disable_links as null; never diff the default
+    # against it.
+    if remote.get("disable_links") is not None and desired.get(
+        "disable_links"
+    ) != remote.get("disable_links"):
+        diffs.append(
+            ("disable_links", remote.get("disable_links"), desired.get("disable_links"))
+        )
     diffs.extend(diff_container_fields(desired, remote, ("parameters",)))
 
     desired_cards = [_card_projection(c) for c in desired.get("cards") or []]
@@ -235,8 +236,9 @@ def _build_pulse_payload(
         "collection_id": collection_id,
         "dashboard_id": dashboard_id,
         "skip_if_empty": doc.get("skip_if_empty", False),
-        "disable_links": doc.get("disable_links", False),
-        "archived": doc.get("archived", False),
+        # `or False`: state exported from v0.55 stores an explicit null.
+        "disable_links": doc.get("disable_links") or False,
+        "archived": doc.get("archived") or False,
         "parameters": doc.get("parameters", []),
         "cards": cards,
         "channels": channels,

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/src/metabase_sync/apply/_shared.py

@@ -15,6 +15,7 @@ from typing import Any, Literal
 from metabase_sync.client import MetabaseClient
 from metabase_sync.diff import RemoteIndex
 from metabase_sync.plan import Plan, diff_summary
+from metabase_sync.serialize.canon import QUERY_VOLATILE_KEYS
 
 Mode = Literal["plan", "apply"]
 
@@ -86,7 +87,7 @@ def resolve_card_path(
 # --- dataset_query normalisation (used by cards diff) ---------------------------
 
 
-_VOLATILE_KEYS = frozenset({"info", "lib/uuid", "lib.convert/converted?"})
+_VOLATILE_KEYS = QUERY_VOLATILE_KEYS
 
 
 def normalize_dataset_query(dq: dict[str, Any]) -> dict[str, Any]:

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/src/metabase_sync/serialize/canon.py

@@ -97,6 +97,24 @@ DASHBOARD_CHILDREN = {"tabs": TAB, "dashcards": DASHCARD}
 PULSE_CHILDREN = {"cards": PULSE_CARD, "channels": CHANNEL}
 
 
+# Server-regenerated bookkeeping inside query structures (dataset_query,
+# template_tags). Never persisted and never diffed; scoped to queries because
+# these words can be legitimate keys in user content elsewhere.
+QUERY_VOLATILE_KEYS = frozenset({"info", "lib/uuid", "lib.convert/converted?"})
+
+
+def strip_query_volatile(value: Any) -> Any:
+    if isinstance(value, dict):
+        return {
+            k: strip_query_volatile(v)
+            for k, v in value.items()
+            if k not in QUERY_VOLATILE_KEYS
+        }
+    if isinstance(value, list):
+        return [strip_query_volatile(item) for item in value]
+    return value
+
+
 def canonical(
     doc: dict[str, Any],
     template: tuple[str, ...],

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/src/metabase_sync/serialize/cards.py

@@ -28,7 +28,7 @@ from pathlib import Path
 from typing import Any
 
 from metabase_sync.models import Card
-from metabase_sync.serialize.canon import CARD, canonical
+from metabase_sync.serialize.canon import CARD, canonical, strip_query_volatile
 from metabase_sync.serialize.paths import disambiguate, slugify
 from metabase_sync.serialize.yamlio import (
     load_yaml,
@@ -80,7 +80,7 @@ def write_card(path: Path, card: Card, db_name_by_id: dict[int, str]) -> None:
     if native is not None:
         body, template_tags = native
         frontmatter = _common_frontmatter(card, db_name) | {
-            "template_tags": template_tags,
+            "template_tags": strip_query_volatile(template_tags),
             **extra,
         }
         write_frontmatter_sql(path, canonical(frontmatter, CARD), body)
@@ -91,7 +91,7 @@ def write_card(path: Path, card: Card, db_name_by_id: dict[int, str]) -> None:
         legacy = _legacy_dict(card)
         dataset_query = legacy if legacy else dict(card.dataset_query)
         doc = _common_frontmatter(card, db_name) | {
-            "dataset_query": dataset_query,
+            "dataset_query": strip_query_volatile(dataset_query),
             **extra,
         }
         write_yaml(path, canonical(doc, CARD))

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/tests/test_legacy_query.py

@@ -208,6 +208,59 @@ def test_gui_card_round_trip_mbql5_form(tmp_path: Path):
     }
 
 
+def test_export_strips_volatile_lib_uuid(tmp_path: Path):
+    """Metabase regenerates lib/uuid on every save; persisting them makes
+    every export rewrite otherwise-unchanged cards. Written files must carry
+    none, in the GUI dataset_query or in native template_tags dimensions."""
+    legacy = json.dumps(
+        {
+            "lib/type": "mbql/query",
+            "database": 2,
+            "stages": [
+                {
+                    "lib/type": "mbql.stage/mbql",
+                    "lib/uuid": "aaaa-1111",
+                    "source-table": 2,
+                }
+            ],
+        }
+    )
+    gui_card = _make_native_card(name="GUI", legacy_query=legacy, display="bar")
+    gui_path = tmp_path / "card.yaml"
+    write_card(gui_path, gui_card, db_name_by_id={2: "bigquery"})
+    _fm, _body, gui = read_card_file(gui_path)
+    assert "lib/uuid" not in gui_path.read_text()
+    assert gui["stages"][0]["lib/type"] == "mbql.stage/mbql"
+
+    native_legacy = json.dumps(
+        {
+            "type": "native",
+            "database": 2,
+            "native": {
+                "query": "SELECT {{d}}",
+                "template-tags": {
+                    "d": {
+                        "type": "dimension",
+                        "name": "d",
+                        "dimension": [
+                            "field",
+                            {"lib/uuid": "bbbb-2222", "base-type": "type/Date"},
+                            8589,
+                        ],
+                    }
+                },
+            },
+        }
+    )
+    native_card = _make_native_card(legacy_query=native_legacy)
+    native_path = tmp_path / "card.sql"
+    write_card(native_path, native_card, db_name_by_id={2: "bigquery"})
+    assert "lib/uuid" not in native_path.read_text()
+    fm, body, _gui = read_card_file(native_path)
+    assert body == "SELECT {{d}}"
+    assert fm["template_tags"]["d"]["dimension"][2] == 8589
+
+
 def test_gui_card_backwards_compat_old_on_disk_format(tmp_path: Path):
     """Files written by an earlier pre-release of the tool stored only the
     classic `query` sub-dict at top level. read_card_file lifts them into the

{metabase_sync-0.2.0 → metabase_sync-0.2.2}/tests/test_pulse_diff.py

@@ -110,3 +110,9 @@ def test_flags_and_parameters_detected():
     desired = _desired(disable_links=True, archived=True, parameters=[{"id": "p1"}])
     fields = {f for f, _b, _a in _pulse_diffs(desired, _remote())}
     assert {"disable_links", "archived", "parameters"} <= fields
+
+
+def test_null_remote_disable_links_does_not_diff():
+    # Metabase v0.55 returns disable_links as null; the default must not
+    # plan an update forever against it.
+    assert _pulse_diffs(_desired(), _remote(disable_links=None)) == []

metabase_sync-0.2.0/src/metabase_sync/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"