Skip to content

fix(gooddata-sdk): keep isHiddenFromKda on declarative metrics #1891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tychtjan merged 1 commit into from
Oct 21, 2026
Merged

fix(gooddata-sdk): keep isHiddenFromKda on declarative metrics #1891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...data_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,8 @@ def client_class() -> type[DeclarativeFilterContext]:

@define(kw_only=True)
class CatalogDeclarativeMetric(CatalogAnalyticsBase):
is_hidden_from_kda: bool | None = None

@staticmethod
def client_class() -> type[DeclarativeMetric]:
return DeclarativeMetric
Expand Down
34 changes: 34 additions & 0 deletions packages/gooddata-sdk/tests/catalog/unit_tests/test_declarative_analytics_metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# (C) 2026 GoodData Corporation
"""Unit test: a metric's ``isHiddenFromKda`` survives the declarative round trip."""

from __future__ import annotations

from pathlib import Path

import pytest
from gooddata_sdk.catalog.workspace.declarative_model.workspace.analytics_model.analytics_model import (
CatalogDeclarativeAnalyticsLayer,
)

_METRIC = {"id": "bmk_w_fraud_charged_back", "title": "BMK", "content": {"format": "#,##0", "maql": "SELECT 1"}}


@pytest.mark.parametrize(
("extra", "expected"),
[
({"isHiddenFromKda": True}, True),
({"isHiddenFromKda": False}, False),
({}, None),
],
ids=["hidden", "explicit-visible", "absent"],
)
def test_declarative_metric_is_hidden_from_kda_survives_round_trip(
tmp_path: Path, extra: dict, expected: bool | None
) -> None:
layer = CatalogDeclarativeAnalyticsLayer.from_dict({"metrics": [{**_METRIC, **extra}]})

layer.store_to_disk(tmp_path)
reloaded = CatalogDeclarativeAnalyticsLayer.load_from_disk(tmp_path)

assert reloaded.metrics[0].is_hidden_from_kda is expected
assert reloaded.to_api().to_dict(camel_case=True)["metrics"][0] == {**_METRIC, **extra}
Loading