8 Commits
Author SHA1 Message Date
zemion 1f338cae70 fix(ui): align contextual documentation with headings
Verified with the coordinated workspace changes by devkit full run
2026-09-08T225814-186389-0000-3e3ed7cd (all seven phases passed).
This shared UI pass does not mark the individual module reviews complete.
2026-09-09 02:03:41 +02:00
zemion 9d067f1bad fix(datasources): preserve governed CSV originals and fresh detail state
Module Package Release / publish-packages (push) Successful in 12s
Release v0.1.26. Coordinated integrity review: GovOPlaN/govoplan-core#298.
2026-09-08 12:19:38 +02:00
zemion 8b8c6c548e fix(packaging): expose immutable WebUI Git package for v0.1.25
Module Package Release / publish-packages (push) Successful in 11s
2026-09-08 02:06:09 +02:00
zemion 930302b535 Release govoplan-datasources v0.1.25: unify interface contracts and documentation 2026-09-08 01:32:31 +02:00
zemion ad8235028f fix(webui): bind retention controls to help
Module Package Release / publish-packages (push) Successful in 12s
2026-08-24 11:36:37 +02:00
zemion 62970d6374 docs: complete German structured documentation
Module Package Release / publish-packages (push) Successful in 11s
2026-08-24 01:15:33 +02:00
zemion 6b1c0ca786 docs(datasources): complete German reference coverage
Module Package Release / publish-packages (push) Successful in 12s
2026-08-23 20:19:14 +02:00
zemion 7a7654cc0f feat(datasources): govern approvals and retention
Module Package Release / publish-packages (push) Successful in 11s
2026-08-22 19:37:44 +02:00
32 changed files with 3893 additions and 131 deletions
+30 -2
View File
@@ -38,6 +38,14 @@ promotion preserves the exact policy hash and validation result in immutable
materialization provenance. The supported contract is documented in
[docs/QUALITY_POLICY.md](docs/QUALITY_POLICY.md).
The same lifecycle contract can require an attributable, separated approval
quorum before a stage or cached refresh becomes current. Versioned retention
rules cover transient stages, ordinary materializations, and frozen evidence.
Retention remains an explicit preview-and-apply operation: current revisions,
legal holds, pending approvals, and publication evidence are blocked, while
every decision, promotion, and disposition is preserved in hash-chained local
evidence even when the optional Audit, Access, or Policy modules are absent.
The contracts already model database, HTTP/REST, directory, file, feed,
document, binary, directory, and stream sources so providers can be added
without changing consumers. Storage modules contribute artifact backends
@@ -49,7 +57,8 @@ See [docs/CONCEPT.md](docs/CONCEPT.md) for ownership and lifecycle details.
## Data-subject requests
Datasources publishes `privacy.dsar.datasources` for exact catalogue,
governance-reference, materialization, payload, stage, and publication
governance-reference, materialization, payload, stage, publication, and
lifecycle-evidence
references and for minimized operator attribution. It never exports connector
references, locators, credentials, arbitrary rows, schemas, validation
samples, metadata, provenance bodies, checkpoints, replay material, or hashes.
@@ -57,6 +66,25 @@ The module does not guess subject identity by scanning schema-dependent tabular
payloads; the authoritative source module locates and corrects those facts.
Unpromoted stages and unreferenced payloads can be deleted idempotently.
Published or referenced state, immutable materializations, governance evidence,
Published or referenced state, immutable materializations, lifecycle evidence,
governance evidence,
holds, and operator attribution require data-steward review. Dataflow and
Reporting derivatives must be refreshed after the source correction.
## Git-source WebUI package
The repository root exposes `@govoplan/datasources-webui` for Git-tagged release
dependencies. It mirrors the owning `webui/package.json` version, public
TypeScript/CSS exports and peer requirements, with entry paths under
`webui/src`. Consumers provide the shared Core/React peers; the facade runs no
development or install scripts. The source archive contains `webui/src`, this
README and any repository license file. Run module development checks from `webui/`; Python
installation remains governed by `pyproject.toml`.
Das Repository stellt `@govoplan/datasources-webui` am Wurzelpfad für versionierte
Git-Abhängigkeiten bereit. Version, öffentliche TypeScript-/CSS-Exporte und
Peer-Anforderungen entsprechen `webui/package.json`; die Einstiegspfade liegen
unter `webui/src`. Gemeinsame Core-/React-Peers stellt die einbindende Anwendung
bereit. Die Fassade führt keine Entwicklungs- oder Installationsskripte aus.
Entwicklungsprüfungen bleiben in `webui/`, die Python-Installation weiterhin in
`pyproject.toml` definiert.
+15
View File
@@ -88,6 +88,21 @@ The first slice stores bounded tabular JSON/CSV stages. Future providers may
stage file references, object-store blobs, directory snapshots, or streaming
checkpoints through the same lifecycle contract.
Valid stages may be subject to a versioned local approval policy. Required
quorums keep the stage non-consumable, enforce distinct attributable actors and
optional creator/approver separation, and bind every decision to exact policy
and subject hashes. Cached refreshes use this same staging path when approval is
required. An installation without separate Access or Policy modules retains
safe local scope and policy defaults; optional modules do not manufacture an
approval from configuration metadata.
Retention policy separately defines durations for stages, ordinary
materializations, and frozen evidence. Administrators receive a deterministic
plan before applying any disposition. Holds, current state, pending decisions,
and publication evidence are blockers. Payload disposal preserves a minimized
materialization tombstone and hash-chained lifecycle evidence, so chronological
authority and policy proof survive the configured content-retention boundary.
## Consumer Contract
Consumers request:
+56 -3
View File
@@ -116,6 +116,59 @@ replace the Datasource's current state. Valid warnings produce
catalogue side effect. These terminal states are preserved for Dataflow and
Workflow handoffs instead of being collapsed into generic success.
Approval authority, approval expiry, and retention/deletion execution remain
separate work under `govoplan-datasources#2`. Until those contracts are added,
no JSON flag is treated as an approval and no stage is deleted automatically.
## Promotion approval
Approval is a separate deterministic contract in
`governance.approval_policy`:
```json
{
"version": "monthly-promotion-v2",
"required": true,
"required_approvals": 2,
"separation_of_duties": true,
"expires_after_hours": 72,
"policy_ref": "policy:monthly-register-promotion"
}
```
A valid stage enters `awaiting_approval` instead of `ready`. Each decision is
bound to the stage fingerprint, quality-policy hash, normalized approval-policy
hash, actor authority, reason, and expiry. Actors are distinct and the stage
creator cannot approve when separation of duties is enabled. The exact quorum
snapshot and hash-chained evidence are copied into materialization provenance.
A changed target policy or staged subject requires a new stage; request JSON
cannot claim that an approval occurred.
Cached origins use `POST /datasources/{id}/refresh/stage` when approval is
required. Direct refresh then fails closed, so connector content cannot become
current before the staged validation and approval quorum succeed.
## Retention
Retention is independently configured in `governance.retention_policy`:
```json
{
"version": "register-retention-v3",
"enabled": true,
"stage_days": 30,
"materialization_days": 365,
"frozen_evidence_days": 3650,
"policy_ref": "policy:register-retention"
}
```
Durations are optional; omitting a class retains it indefinitely. Empty or
disabled local policy never deletes content. An administrator first requests a
read-only plan. The plan includes all due targets, policy versions and hashes,
eligibility dates, blockers, and one hash over the complete preview. Applying
retention accepts only targets from the unchanged plan.
Pending approvals, current materializations, legal holds, and materializations
referenced by producer publications are blocked. Eligible stages are deleted.
Eligible materialization payload rows are purged while the revision retains its
schema, provenance, row/byte counts, payload checksum, disposition metadata,
and immutable hash-chained lifecycle evidence. Frozen evidence is eligible only
when `frozen_evidence_days` is explicitly configured. No hidden scheduler or
arbitrary Policy/Access flag performs deletion.
+34
View File
@@ -0,0 +1,34 @@
{
"name": "@govoplan/datasources-webui",
"version": "0.1.26",
"private": true,
"type": "module",
"main": "webui/src/index.ts",
"module": "webui/src/index.ts",
"types": "webui/src/index.ts",
"exports": {
".": {
"types": "./webui/src/index.ts",
"import": "./webui/src/index.ts"
},
"./styles/datasources.css": "./webui/src/styles/datasources.css"
},
"peerDependencies": {
"@govoplan/core-webui": "^0.1.46",
"lucide-react": "^1.23.0",
"react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20",
"react-router": ">=8.3.0 <9",
"typescript": "^5.7.2"
},
"peerDependenciesMeta": {
"@govoplan/core-webui": {
"optional": true
}
},
"files": [
"webui/src",
"README.md",
"LICENSE"
]
}
+2 -2
View File
@@ -4,13 +4,13 @@ build-backend = "setuptools.build_meta"
[project]
name = "govoplan-datasources"
version = "0.1.20"
version = "0.1.26"
description = "Governed datasource catalogue, staging, and materialization lifecycle for GovOPlaN."
readme = "README.md"
requires-python = ">=3.12"
license = "AGPL-3.0-or-later"
authors = [{ name = "GovOPlaN" }]
dependencies = ["govoplan-core>=0.1.20"]
dependencies = ["govoplan-core>=0.1.46"]
[tool.setuptools.packages.find]
where = ["src"]
+1 -1
View File
@@ -1,3 +1,3 @@
"""GovOPlaN Datasources module."""
__version__ = "0.1.20"
__version__ = "0.1.26"
+71
View File
@@ -0,0 +1,71 @@
"""Durable CSV source fidelity; no preview retention or catalogue content."""
from collections.abc import Mapping, Sequence
from govoplan_core.core.datasources import DatasourceValidationError
from govoplan_core.core.tabular_sources import (
TabularCsvSource,
TabularSourceError,
csv_source_payload,
parse_tabular_csv,
verified_csv_source_text,
csv_projection_matches,
)
from govoplan_datasources.backend.tabular import (
MAX_STAGE_BYTES,
MAX_STAGE_ROWS,
normalize_rows,
parse_csv_rows,
)
def prepare_csv_source(
source: TabularCsvSource | None, rows: Sequence[Mapping[str, object]]
) -> dict[str, object] | None:
if source is None:
return None
try:
payload = csv_source_payload(source, max_bytes=MAX_STAGE_BYTES)
if source.parser_profile == "core.csv.v1":
expected = parse_tabular_csv(
source.text,
delimiter=source.delimiter,
value_mode=source.value_mode,
max_rows=MAX_STAGE_ROWS,
max_bytes=MAX_STAGE_BYTES,
)
elif source.parser_profile == "datasources.csv.v1":
expected = parse_csv_rows(
source.text, delimiter=source.delimiter, value_mode=source.value_mode
)
else:
raise DatasourceValidationError("Unsupported original CSV parser profile.")
if not csv_projection_matches(normalize_rows(expected), rows):
raise DatasourceValidationError(
"Stage rows do not match their original CSV source and parsing mode."
)
return payload
except TabularSourceError as exc:
raise DatasourceValidationError(str(exc)) from exc
def verify_stage_csv(
payload: Mapping[str, object] | None, rows: Sequence[Mapping[str, object]]
) -> None:
if payload is None:
return
try:
text = verified_csv_source_text(payload)
prepare_csv_source(
TabularCsvSource(
text=text,
delimiter=payload["delimiter"],
value_mode=payload["value_mode"],
parser_profile=payload["parser_profile"],
),
rows,
)
except (KeyError, TypeError, TabularSourceError) as exc:
raise DatasourceValidationError(
"Original CSV source evidence is invalid."
) from exc
@@ -126,6 +126,12 @@ class DatasourceRecord(Base, TimestampMixin):
quality_policy: Mapped[dict[str, Any]] = mapped_column(
JSON, default=dict, nullable=False
)
approval_policy: Mapped[dict[str, Any]] = mapped_column(
JSON, default=dict, nullable=False
)
retention_policy: Mapped[dict[str, Any]] = mapped_column(
JSON, default=dict, nullable=False
)
known_limits: Mapped[list[str]] = mapped_column(JSON, default=list, nullable=False)
correction_procedure_ref: Mapped[str | None] = mapped_column(
String(500), nullable=True
@@ -239,6 +245,7 @@ class DatasourceMaterializationRecord(Base, TimestampMixin):
# Kept nullable-in-practice for rolling upgrades. New materializations use
# immutable payload rows and leave this legacy field empty.
rows: Mapped[list[dict[str, Any]]] = mapped_column(JSON, default=list, nullable=False)
csv_source_: Mapped[dict[str, Any] | None] = mapped_column("csv_source", JSON, nullable=True, deferred=True)
fingerprint: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
row_count: Mapped[int] = mapped_column(Integer, nullable=False)
byte_count: Mapped[int] = mapped_column(Integer, nullable=False)
@@ -266,6 +273,15 @@ class DatasourceMaterializationRecord(Base, TimestampMixin):
default=dict,
nullable=False,
)
disposed_at: Mapped[datetime | None] = mapped_column(
DateTime(timezone=True), nullable=True, index=True
)
disposition_: Mapped[dict[str, Any]] = mapped_column(
"disposition",
JSON,
default=dict,
nullable=False,
)
created_by: Mapped[str | None] = mapped_column(String(255), nullable=True, index=True)
datasource: Mapped[DatasourceRecord] = relationship(back_populates="materializations")
@@ -390,6 +406,7 @@ class DatasourceStageRecord(Base, TimestampMixin):
nullable=False,
)
rows: Mapped[list[dict[str, Any]]] = mapped_column(JSON, default=list, nullable=False)
csv_source_: Mapped[dict[str, Any] | None] = mapped_column("csv_source", JSON, nullable=True, deferred=True)
fingerprint: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
row_count: Mapped[int] = mapped_column(Integer, nullable=False)
byte_count: Mapped[int] = mapped_column(Integer, nullable=False)
@@ -417,6 +434,12 @@ class DatasourceStageRecord(Base, TimestampMixin):
default=dict,
nullable=False,
)
approval_: Mapped[dict[str, Any]] = mapped_column(
"approval",
JSON,
default=dict,
nullable=False,
)
promoted_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
promoted_materialization_id: Mapped[str | None] = mapped_column(
String(36),
@@ -483,7 +506,49 @@ class DatasourcePublicationRecord(Base, TimestampMixin):
)
class DatasourceLifecycleEvidenceRecord(Base):
__tablename__ = "datasource_lifecycle_evidence"
__table_args__ = (
UniqueConstraint(
"tenant_id",
"event_hash",
name="uq_datasource_lifecycle_evidence_hash",
),
Index(
"ix_datasource_lifecycle_evidence_subject",
"tenant_id",
"subject_ref",
"occurred_at",
),
Index(
"ix_datasource_lifecycle_evidence_event",
"tenant_id",
"event_type",
"occurred_at",
),
)
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
subject_ref: Mapped[str] = mapped_column(String(160), nullable=False, index=True)
event_type: Mapped[str] = mapped_column(String(80), nullable=False, index=True)
occurred_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), nullable=False)
actor_ref: Mapped[str | None] = mapped_column(String(255), nullable=True, index=True)
policy_version: Mapped[str | None] = mapped_column(String(120), nullable=True)
policy_hash: Mapped[str | None] = mapped_column(String(64), nullable=True)
subject_digest: Mapped[str] = mapped_column(String(64), nullable=False)
previous_event_hash: Mapped[str | None] = mapped_column(String(64), nullable=True)
event_hash: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
details_: Mapped[dict[str, Any]] = mapped_column(
"details",
JSON,
default=dict,
nullable=False,
)
__all__ = [
"DatasourceLifecycleEvidenceRecord",
"DatasourceMaterializationRecord",
"DatasourcePayloadRecord",
"DatasourcePayloadRowRecord",
@@ -17,6 +17,7 @@ from govoplan_core.core.dsar import (
)
from govoplan_datasources.backend.db.models import (
DatasourceGovernanceReferenceRecord,
DatasourceLifecycleEvidenceRecord,
DatasourceMaterializationRecord,
DatasourcePayloadRecord,
DatasourcePublicationRecord,
@@ -35,6 +36,7 @@ _DIRECT_ALIASES = {
"payload_id": ("datasources.payload",),
"stage_id": ("datasources.stage",),
"publication_id": ("datasources.publication",),
"lifecycle_evidence_id": ("datasources.lifecycle_evidence",),
}
_RESOURCE_MODELS = {
"datasource": DatasourceRecord,
@@ -43,6 +45,7 @@ _RESOURCE_MODELS = {
"datasource_payload": DatasourcePayloadRecord,
"datasource_stage": DatasourceStageRecord,
"datasource_publication": DatasourcePublicationRecord,
"datasource_lifecycle_evidence": DatasourceLifecycleEvidenceRecord,
}
@@ -284,6 +287,10 @@ def _direct_matches(
DatasourcePublicationRecord,
"datasource_publication",
),
"lifecycle_evidence_id": (
DatasourceLifecycleEvidenceRecord,
"datasource_lifecycle_evidence",
),
}[selector]
row = _one(
session,
@@ -421,6 +428,11 @@ def _canonical_matches(
DatasourcePublicationRecord.created_by.in_(actor_ids),
"datasource_publication",
),
(
DatasourceLifecycleEvidenceRecord,
DatasourceLifecycleEvidenceRecord.actor_ref.in_(actor_ids),
"datasource_lifecycle_evidence",
),
)
matches: list[_Match] = []
for model, condition, resource_type in specs:
@@ -472,6 +484,8 @@ def _direct_category(session: Session, resource_type: str, row: Any) -> str:
)
if not referenced:
return "unreferenced_datasource_payload"
if resource_type == "datasource_lifecycle_evidence":
return "datasource_operator_attribution"
return {
"datasource": "datasource_configuration",
"datasource_governance_reference": "datasource_governance_configuration",
@@ -479,6 +493,7 @@ def _direct_category(session: Session, resource_type: str, row: Any) -> str:
"datasource_payload": "referenced_datasource_payload",
"datasource_stage": "promoted_datasource_stage",
"datasource_publication": "immutable_datasource_publication",
"datasource_lifecycle_evidence": "datasource_operator_attribution",
}[resource_type]
@@ -498,6 +513,22 @@ def _root_datasource_ids(session: Session, match: _Match) -> set[str]:
)
.all()
}
if match.resource_type == "datasource_lifecycle_evidence":
if row.subject_ref.startswith("datasource:"):
return {row.subject_ref.removeprefix("datasource:")}
if row.subject_ref.startswith("stage:"):
stage = session.get(
DatasourceStageRecord,
row.subject_ref.removeprefix("stage:"),
)
return {stage.target_datasource_id} if stage and stage.target_datasource_id else set()
if row.subject_ref.startswith("materialization:"):
materialization = session.get(
DatasourceMaterializationRecord,
row.subject_ref.removeprefix("materialization:"),
)
return {materialization.datasource_id} if materialization else set()
return set()
return {row.datasource_id}
@@ -505,7 +536,7 @@ def _correlates(match: _Match, actor_ids: tuple[str, ...]) -> bool:
row = match.row
return any(
str(getattr(row, field, "") or "") in actor_ids
for field in ("created_by", "updated_by")
for field in ("created_by", "updated_by", "actor_ref")
)
@@ -521,6 +552,7 @@ def _directly_targets(selectors: _Selectors, match: _Match) -> bool:
"datasource_payload": ("payload_id", "id"),
"datasource_stage": ("stage_id", "id"),
"datasource_publication": ("publication_id", "id"),
"datasource_lifecycle_evidence": ("lifecycle_evidence_id", "id"),
}[match.resource_type]
value = _strip_prefix(selectors.direct.get(selector, ""))
if value == str(getattr(row, field)):
@@ -540,6 +572,12 @@ def _root_datasource_ids_for_row(match: _Match) -> set[str]:
return {row.target_datasource_id} if row.target_datasource_id else set()
if match.resource_type == "datasource_payload":
return set()
if match.resource_type == "datasource_lifecycle_evidence":
return (
{row.subject_ref.removeprefix("datasource:")}
if row.subject_ref.startswith("datasource:")
else set()
)
return {row.datasource_id}
@@ -605,6 +643,13 @@ def _record_data(resource_type: str, row: Any) -> dict[str, object]:
"created_at": _iso(row.created_at),
"updated_at": _iso(row.updated_at),
}
if resource_type == "datasource_lifecycle_evidence":
return {
"subject_ref": row.subject_ref,
"event_type": row.event_type,
"policy_version": row.policy_version,
"occurred_at": _iso(row.occurred_at),
}
if resource_type == "datasource_governance_reference":
return {"relation": row.relation}
if resource_type == "datasource_materialization":
@@ -700,7 +745,13 @@ def _title(resource_type: str) -> str:
def _observed_at(row: Any) -> datetime | None:
for field in ("promoted_at", "source_timestamp", "updated_at", "created_at"):
for field in (
"promoted_at",
"source_timestamp",
"occurred_at",
"updated_at",
"created_at",
):
value = getattr(row, field, None)
if isinstance(value, datetime):
return _aware(value)
@@ -0,0 +1,75 @@
"""German translations for public structured documentation metadata."""
from __future__ import annotations
from typing import Any
GERMAN_STRUCTURED_TRANSLATIONS: dict[str, dict[str, Any]] = {'datasources.approval-and-retention': {'limitations': ['Die Ausführung der Retention ist explizit '
'und plangebunden; dieses Modul führt '
'keinen versteckten Löschplan aus.',
'Disponierte '
'Materialisierungsaufzeichnungen behalten '
'minimierte Schema- und Herkunftsmetadaten '
'bei, während ihre Nutzdatenzeilen '
'entfernt werden.']},
'datasources.quality-gates': {'limitations': ['Referenzregeln verwenden derzeit einen begrenzten '
'eingebetteten Wertsatz, anstatt eine andere '
'geschützte Datenquelle zu lesen.',
'Genehmigungen sind modullokale '
'Lebenszyklusnachweise; die Installation eines '
'separaten Genehmigungsmoduls ändert nicht '
'stillschweigend die konfigurierte '
'Datenquellenrichtlinie.',
'Die Aufbewahrung erfolgt nie automatisch: Ein '
'Administrator muss eine Vorschau eines aktuellen '
'Plans anzeigen und ausdrücklich berechtigte Ziele '
'anwenden.',
'Artefaktbytes bleiben im Besitz ihres '
'Payload-Backends; Datasources speichert einen '
'unveränderlichen Referenz- und '
'Integritätsnachweis.']},
'datasources.reference.fields-and-consequences': {'consequence_classes': {'freeze': 'Erstellt '
'einen '
'gekennzeichneten '
'unveränderlichen '
'Zustand für '
'reproduzierbare '
'Verbraucher '
'und '
'Nachweise.',
'promote': 'Erstellt '
'oder '
'aktualisiert '
'eine '
'geregelte '
'Datenquelle '
'und fügt '
'eine '
'unveränderliche '
'Materialisierungsrevision '
'hinzu.',
'refresh': 'Leset den '
'zwischengespeicherten '
'Ursprung '
'und fügt '
'eine neue '
'unveränderliche '
'Materialisierungsrevision '
'hinzu.',
'retire': 'Verhindert '
'eine neue '
'Auswahl, '
'während die '
'Referenzen '
'für die '
'Materialisierung '
'beibehalten '
'werden.'}},
'datasources.visibility': {'limitations': ['Zeilenfilter unterstützen deterministische Gleichheit '
'oder Mitgliedschaft gegen Hauptansprüche; '
'willkürliche Ausdrücke werden nicht ausgeführt.',
'Live-gefilterte Vorschauen scannen maximal 10.000 '
'Ursprungszeilen und legen eine strukturierte '
'Einschränkungsdiagnose offen, wenn der Ursprung '
'größer ist.']}}
@@ -0,0 +1,723 @@
from __future__ import annotations
import hashlib
import json
from collections.abc import Mapping, Sequence
from dataclasses import dataclass
from datetime import UTC, datetime, timedelta
from sqlalchemy import func, select
from sqlalchemy.orm import Session
from govoplan_core.core.datasources import DatasourceValidationError
from govoplan_core.db.base import utcnow
from govoplan_datasources.backend.db.models import (
DatasourceLifecycleEvidenceRecord,
DatasourceMaterializationRecord,
DatasourcePublicationRecord,
DatasourceRecord,
DatasourceStageRecord,
)
@dataclass(frozen=True, slots=True)
class RetentionCandidate:
ref: str
kind: str
datasource_ref: str | None
disposition: str
eligible_at: datetime
eligible: bool
blockers: tuple[str, ...]
policy_version: str
policy_hash: str
def to_dict(self) -> dict[str, object]:
return {
"ref": self.ref,
"kind": self.kind,
"datasource_ref": self.datasource_ref,
"disposition": self.disposition,
"eligible_at": _as_utc(self.eligible_at).isoformat(),
"eligible": self.eligible,
"blockers": list(self.blockers),
"policy_version": self.policy_version,
"policy_hash": self.policy_hash,
}
@dataclass(frozen=True, slots=True)
class RetentionPlan:
as_of: datetime
plan_hash: str
candidates: tuple[RetentionCandidate, ...]
def canonical_hash(value: object) -> str:
encoded = json.dumps(
value,
sort_keys=True,
separators=(",", ":"),
ensure_ascii=True,
default=str,
)
return hashlib.sha256(encoded.encode("utf-8")).hexdigest()
def normalize_approval_policy(value: Mapping[str, object] | None) -> dict[str, object]:
source = dict(value or {})
version = str(source.get("version") or "1").strip()
if not version:
raise DatasourceValidationError("Approval policy version is required.")
required = _boolean(source.get("required", False), label="required")
required_approvals = _bounded_integer(
source.get("required_approvals", 1),
label="required_approvals",
minimum=1,
maximum=5,
)
separation = _boolean(
source.get("separation_of_duties", True),
label="separation_of_duties",
)
expires_after_hours = source.get("expires_after_hours")
expiry = (
None
if expires_after_hours is None
else _bounded_integer(
expires_after_hours,
label="expires_after_hours",
minimum=1,
maximum=8_760,
)
)
policy_ref = _optional_text(source.get("policy_ref"))
return {
"version": version,
"required": required,
"required_approvals": required_approvals,
"separation_of_duties": separation,
"expires_after_hours": expiry,
"policy_ref": policy_ref,
}
def normalize_retention_policy(value: Mapping[str, object] | None) -> dict[str, object]:
source = dict(value or {})
version = str(source.get("version") or "1").strip()
if not version:
raise DatasourceValidationError("Retention policy version is required.")
enabled = _boolean(source.get("enabled", False), label="enabled")
durations = {
key: _optional_duration(source.get(key), label=key)
for key in (
"stage_days",
"materialization_days",
"frozen_evidence_days",
)
}
if enabled and all(value is None for value in durations.values()):
raise DatasourceValidationError(
"Enabled retention policy requires at least one retention duration."
)
return {
"version": version,
"enabled": enabled,
**durations,
"policy_ref": _optional_text(source.get("policy_ref")),
}
def initialize_stage_approval(
stage: DatasourceStageRecord,
*,
created_at: datetime | None = None,
) -> dict[str, object]:
policy = normalize_approval_policy(
_mapping(stage.governance_).get("approval_policy")
if isinstance(_mapping(stage.governance_).get("approval_policy"), Mapping)
else None
)
now = _as_utc(created_at or utcnow())
expiry_hours = policy["expires_after_hours"]
expires_at = (
now + timedelta(hours=int(expiry_hours))
if isinstance(expiry_hours, int)
else None
)
approval = {
"state": "pending" if policy["required"] else "not_required",
"policy": policy,
"policy_hash": canonical_hash(policy),
"subject_digest": stage_subject_digest(stage, policy=policy),
"required_approvals": policy["required_approvals"],
"approval_count": 0,
"expires_at": expires_at.isoformat() if expires_at else None,
"approvals": [],
}
stage.approval_ = approval
if stage.validation_.get("valid") is True:
stage.state = "awaiting_approval" if policy["required"] else "ready"
return approval
def decide_stage(
stage: DatasourceStageRecord,
*,
actor_ref: str,
actor_scopes: Sequence[str],
decision: str,
reason: str,
expected_policy_hash: str,
expected_subject_digest: str,
now: datetime | None = None,
) -> tuple[dict[str, object], bool]:
approval = dict(stage.approval_ or {})
if approval.get("policy_hash") != expected_policy_hash:
raise DatasourceValidationError(
"The approval policy changed; reload the stage before deciding."
)
if approval.get("subject_digest") != expected_subject_digest:
raise DatasourceValidationError(
"The staged content changed; reload the stage before deciding."
)
policy = normalize_approval_policy(_mapping(approval.get("policy")))
if not policy["required"]:
raise DatasourceValidationError("This stage does not require approval.")
if stage.state not in {"awaiting_approval", "ready"}:
raise DatasourceValidationError("This stage no longer accepts approval decisions.")
if policy["separation_of_duties"] and stage.created_by == actor_ref:
raise DatasourceValidationError(
"The stage creator cannot approve this stage under separation of duties."
)
decided_at = _as_utc(now or utcnow())
expires_at = _optional_datetime(approval.get("expires_at"))
if expires_at is not None and decided_at > expires_at:
approval["state"] = "expired"
stage.approval_ = approval
stage.state = "awaiting_approval"
raise DatasourceValidationError(
"The approval window expired; create a new stage for a fresh decision."
)
decisions = [dict(item) for item in _mapping_sequence(approval.get("approvals"))]
existing = next(
(item for item in decisions if item.get("actor_ref") == actor_ref),
None,
)
if existing is not None:
if existing.get("decision") == decision:
return approval, True
raise DatasourceValidationError(
"This approver already recorded a different decision."
)
cleaned_reason = reason.strip()
if not cleaned_reason:
raise DatasourceValidationError("An approval decision reason is required.")
decisions.append(
{
"actor_ref": actor_ref,
"decision": decision,
"reason": cleaned_reason,
"decided_at": decided_at.isoformat(),
"authority_scopes": sorted(set(actor_scopes)),
}
)
approved = sum(item.get("decision") == "approve" for item in decisions)
approval.update(
{
"approvals": decisions,
"approval_count": approved,
"state": (
"rejected"
if decision == "reject"
else (
"approved"
if approved >= int(policy["required_approvals"])
else "pending"
)
),
}
)
stage.approval_ = approval
stage.state = "rejected" if decision == "reject" else (
"ready"
if approval["state"] == "approved"
else "awaiting_approval"
)
return approval, False
def ensure_stage_approval_current(
stage: DatasourceStageRecord,
*,
current_policy: Mapping[str, object] | None,
) -> None:
approval = _mapping(stage.approval_)
stage_policy = normalize_approval_policy(_mapping(approval.get("policy")))
effective = normalize_approval_policy(current_policy)
if canonical_hash(effective) != approval.get("policy_hash"):
raise DatasourceValidationError(
"The approval policy changed after staging; create a new stage."
)
if stage_policy["required"] and approval.get("state") != "approved":
raise DatasourceValidationError("The stage has not reached its approval quorum.")
if approval.get("subject_digest") != stage_subject_digest(stage, policy=stage_policy):
raise DatasourceValidationError(
"The staged evidence changed after approval; create a new stage."
)
def stage_subject_digest(
stage: DatasourceStageRecord,
*,
policy: Mapping[str, object] | None = None,
) -> str:
return canonical_hash(
{
"stage_ref": _stage_ref(stage.id),
"target_datasource_ref": (
_datasource_ref(stage.target_datasource_id)
if stage.target_datasource_id
else None
),
"source_name": stage.source_name,
"mode": stage.mode,
"shape": stage.shape,
"fingerprint": stage.fingerprint,
"validation_policy_hash": stage.validation_.get("policy_hash"),
"approval_policy": dict(policy or {}),
**({"csv_source": {
key: stage.csv_source_.get(key)
for key in ("sha256", "byte_count", "delimiter", "value_mode", "parser_profile")
}} if stage.csv_source_ is not None else {}),
}
)
def record_lifecycle_evidence(
session: Session,
*,
tenant_id: str,
subject_ref: str,
event_type: str,
actor_ref: str | None,
subject_digest: str,
details: Mapping[str, object],
policy_version: str | None = None,
policy_hash: str | None = None,
occurred_at: datetime | None = None,
) -> DatasourceLifecycleEvidenceRecord:
happened = _as_utc(occurred_at or utcnow())
previous_hash = session.scalar(
select(DatasourceLifecycleEvidenceRecord.event_hash)
.where(
DatasourceLifecycleEvidenceRecord.tenant_id == tenant_id,
DatasourceLifecycleEvidenceRecord.subject_ref == subject_ref,
)
.order_by(
DatasourceLifecycleEvidenceRecord.occurred_at.desc(),
DatasourceLifecycleEvidenceRecord.id.desc(),
)
.limit(1)
)
payload = {
"tenant_id": tenant_id,
"subject_ref": subject_ref,
"event_type": event_type,
"occurred_at": happened.isoformat(),
"actor_ref": actor_ref,
"policy_version": policy_version,
"policy_hash": policy_hash,
"subject_digest": subject_digest,
"previous_event_hash": previous_hash,
"details": dict(details),
}
item = DatasourceLifecycleEvidenceRecord(
tenant_id=tenant_id,
subject_ref=subject_ref,
event_type=event_type,
occurred_at=happened,
actor_ref=actor_ref,
policy_version=policy_version,
policy_hash=policy_hash,
subject_digest=subject_digest,
previous_event_hash=previous_hash,
event_hash=canonical_hash(payload),
details_=dict(details),
)
session.add(item)
session.flush()
return item
def list_lifecycle_evidence(
session: Session,
*,
tenant_id: str,
subject_ref: str | None = None,
limit: int = 200,
) -> tuple[DatasourceLifecycleEvidenceRecord, ...]:
statement = select(DatasourceLifecycleEvidenceRecord).where(
DatasourceLifecycleEvidenceRecord.tenant_id == tenant_id
)
if subject_ref:
statement = statement.where(
DatasourceLifecycleEvidenceRecord.subject_ref == subject_ref
)
statement = statement.order_by(
DatasourceLifecycleEvidenceRecord.occurred_at.desc(),
DatasourceLifecycleEvidenceRecord.id.desc(),
).limit(max(1, min(limit, 500)))
return tuple(session.scalars(statement))
def build_retention_plan(
session: Session,
*,
tenant_id: str,
as_of: datetime,
) -> RetentionPlan:
effective_at = _as_utc(as_of)
candidates: list[RetentionCandidate] = []
stages = session.scalars(
select(DatasourceStageRecord).where(
DatasourceStageRecord.tenant_id == tenant_id
)
)
for stage in stages:
policy = normalize_retention_policy(
_mapping(_mapping(stage.governance_).get("retention_policy"))
)
duration = policy.get("stage_days")
if not policy["enabled"] or not isinstance(duration, int):
continue
eligible_at = _as_utc(stage.created_at) + timedelta(days=duration)
if eligible_at > effective_at:
continue
blockers = (
("pending_approval",)
if stage.state == "awaiting_approval"
else ()
)
candidates.append(
RetentionCandidate(
ref=_stage_ref(stage.id),
kind="stage",
datasource_ref=(
_datasource_ref(stage.target_datasource_id)
if stage.target_datasource_id
else None
),
disposition="delete_stage",
eligible_at=eligible_at,
eligible=not blockers,
blockers=blockers,
policy_version=str(policy["version"]),
policy_hash=canonical_hash(policy),
)
)
materializations = session.execute(
select(DatasourceMaterializationRecord, DatasourceRecord)
.join(DatasourceRecord, DatasourceRecord.id == DatasourceMaterializationRecord.datasource_id)
.where(DatasourceMaterializationRecord.tenant_id == tenant_id)
)
for materialization, datasource in materializations:
if materialization.disposed_at is not None:
continue
snapshot = _mapping(materialization.governance_snapshot_)
policy = normalize_retention_policy(
_mapping(snapshot.get("retention_policy"))
)
duration_key = (
"frozen_evidence_days"
if materialization.frozen_at is not None
else "materialization_days"
)
duration = policy.get(duration_key)
if not policy["enabled"] or not isinstance(duration, int):
continue
eligible_at = _as_utc(materialization.created_at) + timedelta(days=duration)
if eligible_at > effective_at:
continue
blockers: list[str] = []
if datasource.current_materialization_id == materialization.id:
blockers.append("current_materialization")
if tuple(snapshot.get("hold_refs") or ()):
blockers.append("legal_hold")
publication_count = session.scalar(
select(func.count(DatasourcePublicationRecord.id)).where(
DatasourcePublicationRecord.materialization_id == materialization.id
)
)
if publication_count:
blockers.append("publication_evidence")
candidates.append(
RetentionCandidate(
ref=_materialization_ref(materialization.id),
kind="materialization",
datasource_ref=_datasource_ref(datasource.id),
disposition="purge_materialization_payload",
eligible_at=eligible_at,
eligible=not blockers,
blockers=tuple(blockers),
policy_version=str(policy["version"]),
policy_hash=canonical_hash(policy),
)
)
ordered = tuple(sorted(candidates, key=lambda item: (item.kind, item.ref)))
plan_payload = {
"tenant_id": tenant_id,
"as_of": effective_at.isoformat(),
"candidates": [item.to_dict() for item in ordered],
}
return RetentionPlan(
as_of=effective_at,
plan_hash=canonical_hash(plan_payload),
candidates=ordered,
)
def apply_retention_plan(
session: Session,
*,
tenant_id: str,
actor_ref: str,
plan: RetentionPlan,
target_refs: Sequence[str],
) -> tuple[tuple[str, ...], tuple[str, ...]]:
by_ref = {item.ref: item for item in plan.candidates}
requested = tuple(dict.fromkeys(target_refs))
missing = [ref for ref in requested if ref not in by_ref]
if missing:
raise DatasourceValidationError(
f"Retention targets are not in the current plan: {', '.join(missing)}."
)
blocked = [ref for ref in requested if not by_ref[ref].eligible]
if blocked:
raise DatasourceValidationError(
f"Retention targets have active blockers: {', '.join(blocked)}."
)
disposed: list[str] = []
evidence_hashes: list[str] = []
for ref in requested:
candidate = by_ref[ref]
if candidate.kind == "stage":
stage = _stage_by_ref(session, tenant_id=tenant_id, ref=ref)
digest = stage_subject_digest(
stage,
policy=normalize_approval_policy(
_mapping(_mapping(stage.approval_).get("policy"))
),
)
evidence = record_lifecycle_evidence(
session,
tenant_id=tenant_id,
subject_ref=ref,
event_type="retention.stage_deleted",
actor_ref=actor_ref,
subject_digest=digest,
policy_version=candidate.policy_version,
policy_hash=candidate.policy_hash,
details={
"plan_hash": plan.plan_hash,
"disposition": candidate.disposition,
"validation_policy_hash": stage.validation_.get("policy_hash"),
"approval_policy_hash": stage.approval_.get("policy_hash"),
},
occurred_at=plan.as_of,
)
evidence_hashes.append(evidence.event_hash)
session.delete(stage)
else:
materialization = _materialization_by_ref(
session,
tenant_id=tenant_id,
ref=ref,
)
payload = materialization.payload
subject_digest = canonical_hash(
{
"ref": ref,
"fingerprint": materialization.fingerprint,
"payload_checksum": materialization.payload_checksum,
"revision": materialization.revision,
}
)
evidence = record_lifecycle_evidence(
session,
tenant_id=tenant_id,
subject_ref=ref,
event_type="retention.materialization_payload_purged",
actor_ref=actor_ref,
subject_digest=subject_digest,
policy_version=candidate.policy_version,
policy_hash=candidate.policy_hash,
details={
"plan_hash": plan.plan_hash,
"disposition": candidate.disposition,
"payload_checksum": materialization.payload_checksum,
"row_count": materialization.row_count,
"byte_count": materialization.byte_count,
"frozen": materialization.frozen_at is not None,
},
occurred_at=plan.as_of,
)
evidence_hashes.append(evidence.event_hash)
materialization.payload_id = None
materialization.rows = []
materialization.csv_source_ = None
materialization.state = "disposed"
materialization.disposed_at = plan.as_of
materialization.disposition_ = {
"plan_hash": plan.plan_hash,
"policy_version": candidate.policy_version,
"policy_hash": candidate.policy_hash,
"actor_ref": actor_ref,
"evidence_hash": evidence.event_hash,
"payload_checksum": materialization.payload_checksum,
}
session.flush()
if payload is not None:
remaining = session.scalar(
select(func.count(DatasourceMaterializationRecord.id)).where(
DatasourceMaterializationRecord.payload_id == payload.id
)
)
if not remaining:
session.delete(payload)
disposed.append(ref)
session.flush()
return tuple(disposed), tuple(evidence_hashes)
def _stage_by_ref(
session: Session,
*,
tenant_id: str,
ref: str,
) -> DatasourceStageRecord:
item = session.scalar(
select(DatasourceStageRecord).where(
DatasourceStageRecord.id == _ref_id(ref, "stage"),
DatasourceStageRecord.tenant_id == tenant_id,
)
)
if item is None:
raise DatasourceValidationError("Datasource stage is no longer available.")
return item
def _materialization_by_ref(
session: Session,
*,
tenant_id: str,
ref: str,
) -> DatasourceMaterializationRecord:
item = session.scalar(
select(DatasourceMaterializationRecord).where(
DatasourceMaterializationRecord.id == _ref_id(ref, "materialization"),
DatasourceMaterializationRecord.tenant_id == tenant_id,
)
)
if item is None:
raise DatasourceValidationError(
"Datasource materialization is no longer available."
)
return item
def _mapping(value: object) -> Mapping[str, object]:
return value if isinstance(value, Mapping) else {}
def _mapping_sequence(value: object) -> tuple[Mapping[str, object], ...]:
if not isinstance(value, Sequence) or isinstance(value, (str, bytes)):
return ()
return tuple(item for item in value if isinstance(item, Mapping))
def _boolean(value: object, *, label: str) -> bool:
if not isinstance(value, bool):
raise DatasourceValidationError(f"Approval or retention {label} must be boolean.")
return value
def _bounded_integer(
value: object,
*,
label: str,
minimum: int,
maximum: int,
) -> int:
if isinstance(value, bool) or not isinstance(value, int):
raise DatasourceValidationError(f"Policy {label} must be an integer.")
if value < minimum or value > maximum:
raise DatasourceValidationError(
f"Policy {label} must be between {minimum} and {maximum}."
)
return value
def _optional_duration(value: object, *, label: str) -> int | None:
if value is None:
return None
return _bounded_integer(value, label=label, minimum=1, maximum=36_500)
def _optional_text(value: object) -> str | None:
text = str(value or "").strip()
return text or None
def _optional_datetime(value: object) -> datetime | None:
if not value:
return None
if isinstance(value, datetime):
return _as_utc(value)
try:
return _as_utc(datetime.fromisoformat(str(value)))
except ValueError as exc:
raise DatasourceValidationError("Approval expiry is invalid.") from exc
def _as_utc(value: datetime) -> datetime:
if value.tzinfo is None:
return value.replace(tzinfo=UTC)
return value.astimezone(UTC)
def _ref_id(ref: str, prefix: str) -> str:
expected = f"{prefix}:"
if not ref.startswith(expected) or not ref.removeprefix(expected).strip():
raise DatasourceValidationError(f"Invalid {prefix} reference.")
return ref.removeprefix(expected)
def _stage_ref(value: str) -> str:
return f"stage:{value}"
def _datasource_ref(value: str) -> str:
return f"datasource:{value}"
def _materialization_ref(value: str) -> str:
return f"materialization:{value}"
__all__ = [
"RetentionCandidate",
"RetentionPlan",
"apply_retention_plan",
"build_retention_plan",
"canonical_hash",
"decide_stage",
"ensure_stage_approval_current",
"initialize_stage_approval",
"list_lifecycle_evidence",
"normalize_approval_policy",
"normalize_retention_policy",
"record_lifecycle_evidence",
"stage_subject_digest",
]
+321 -8
View File
@@ -1,5 +1,8 @@
from __future__ import annotations
from govoplan_core.core.modules import with_documentation_structured_translations
from govoplan_datasources.backend.german_structured_documentation import GERMAN_STRUCTURED_TRANSLATIONS
from pathlib import Path
from govoplan_core.core.access import (
@@ -21,6 +24,7 @@ from govoplan_core.core.module_guards import (
)
from govoplan_core.core.modules import (
CapabilityDocumentation,
DocumentationCondition,
DocumentationLink,
DocumentationTopic,
FrontendModule,
@@ -55,6 +59,7 @@ from govoplan_datasources.backend.service import (
ADMIN_SCOPE,
CATALOGUE_READ_SCOPE,
SOURCE_WRITE_SCOPE,
STAGE_APPROVE_SCOPE,
STAGE_WRITE_SCOPE,
SqlDatasourceProvider,
)
@@ -63,7 +68,7 @@ from govoplan_datasources.backend.payloads import ExternalArtifactPayloadBackend
MODULE_ID = "datasources"
MODULE_NAME = "Datasources"
MODULE_VERSION = "0.1.20"
MODULE_VERSION = "0.1.26"
DATASOURCE_INTERFACE_VERSION = "0.2.0"
ARCHITECTURE = ModuleArchitectureDeclaration(
@@ -149,6 +154,11 @@ PERMISSIONS = (
"Stage datasource content",
"Upload, validate, inspect, and promote bounded datasource stages.",
),
_permission(
STAGE_APPROVE_SCOPE,
"Approve datasource promotion",
"Review staged validation evidence and record an attributable promotion decision.",
),
_permission(
ADMIN_SCOPE,
"Administer datasources",
@@ -167,6 +177,12 @@ ROLE_TEMPLATES = (
STAGE_WRITE_SCOPE,
),
),
RoleTemplate(
slug="datasource_approver",
name="Datasource approver",
description="Independently approve or reject governed datasource stages.",
permissions=(CATALOGUE_READ_SCOPE, STAGE_APPROVE_SCOPE),
),
RoleTemplate(
slug="datasource_reader",
name="Datasource reader",
@@ -235,6 +251,14 @@ def _tenant_summary(session, tenant_id: str) -> dict[str, int]:
)
.count()
),
"datasource_stages_awaiting_approval": (
session.query(datasource_models.DatasourceStageRecord)
.filter(
datasource_models.DatasourceStageRecord.tenant_id == tenant_id,
datasource_models.DatasourceStageRecord.state == "awaiting_approval",
)
.count()
),
}
@@ -390,6 +414,20 @@ manifest = ModuleManifest(
label="Datasource preview and materializations",
order=50,
),
ViewSurface(
id="datasources.lifecycle-evidence",
module_id=MODULE_ID,
kind="section",
label="Datasource lifecycle evidence",
order=60,
),
ViewSurface(
id="datasources.retention",
module_id=MODULE_ID,
kind="action",
label="Datasource retention preview and apply",
order=70,
),
),
),
route_factory=_router,
@@ -421,6 +459,7 @@ manifest = ModuleManifest(
script_location=str(Path(__file__).with_name("migrations") / "versions"),
retirement_supported=True,
retirement_provider=drop_table_retirement_provider(
datasource_models.DatasourceLifecycleEvidenceRecord,
datasource_models.DatasourcePublicationRecord,
datasource_models.DatasourceStageRecord,
datasource_models.DatasourceMaterializationRecord,
@@ -436,6 +475,7 @@ manifest = ModuleManifest(
),
uninstall_guard_providers=(
persistent_table_uninstall_guard(
datasource_models.DatasourceLifecycleEvidenceRecord,
datasource_models.DatasourceRecord,
datasource_models.DatasourceMaterializationRecord,
datasource_models.DatasourcePayloadRecord,
@@ -447,12 +487,97 @@ manifest = ModuleManifest(
),
architecture=ARCHITECTURE,
documentation=(
DocumentationTopic(
id="datasources.csv-source-fidelity",
title="CSV input fidelity, original export and retention",
summary="Keep original upload text alongside durable stages and immutable materializations without bypassing visibility or retention.",
body=(
"New CSV upload dialogs default to Preserve text; values remain strings, including whitespace, exact decimal digits, large identifiers and explicit empty records. Infer types (legacy) is an explicit compatibility option. "
"Existing API calls without csv_value_mode retain their legacy behavior. The API accepts text or legacy_typed; parsed headers are normalized, and malformed text-mode row shapes are rejected. "
"Durable CSV stages retain the original supplied UTF-8 text separately from metadata, bind it to the exact scalar types and values of the parsed rows, and include source evidence in approval. Promotion and freezing preserve the original with the corresponding immutable materialization. This does not persist preview rows. "
"Original text and rows each have a 5 MB limit; there are at most 10,000 rows. Each stage/materialization, including a frozen copy, can retain up to 5 MB of original text plus serialization and metadata storage overhead. "
"GET /api/v1/datasources/{datasource_id}/materializations/{materialization_id}/original-csv is an audited, uncached attachment export for current datasources:source:admin authority. "
"Current and historical visibility and policy-provider decisions still apply. Any row filter or denied field prevents raw export, even for an administrator; use governed row previews instead. No raw input is returned in catalogue, stage or history DTOs. "
"Freezing verifies the existing original evidence before copying and retains inherited access restrictions; the original may carry at most 32 distinct governance snapshots, with explicit rejection beyond that limit. "
"Original text is checksum-verified and follows the same governed retention as its stage/materialization. Stage deletion removes its original; materialization payload disposal also clears that original while retaining audit evidence. "
"No original is invented for historical imports. Missing or disposed originals are reported unavailable. Export preserves the API's supplied text as UTF-8, including unsanitized spreadsheet formulas, and is not a reconstruction of an earlier file encoding."
),
layer="always", documentation_types=("user", "admin"), audience=("user", "module_admin", "operator"), order=8,
translations={"de": {
"title": "CSV-Original, genauer Import und Aufbewahrung",
"summary": "Originaltext mit dauerhaften Staging-Ständen und Materialisierungen erhalten, ohne Sichtbarkeit oder Aufbewahrung zu umgehen.",
"body": (
"Neue CSV-Importdialoge wählen standardmäßig Text erhalten: Werte einschließlich Leerzeichen, genauer Dezimalstellen, großer Kennungen und ausdrücklich leerer Datensätze bleiben Zeichenketten. Typen ableiten (bisheriges Verhalten) ist eine ausdrückliche Kompatibilitätsoption. "
"Bestehende API-Aufrufe ohne csv_value_mode bleiben unverändert; unterstützt werden text und legacy_typed. Überschriften werden normalisiert, fehlerhafte Zeilenformen im Textmodus abgelehnt. "
"Dauerhafte CSV-Staging-Stände speichern den gelieferten UTF-8-Originaltext getrennt von Metadaten, prüfen genaue Typen und Werte der abgeleiteten Zeilen und binden den Quellnachweis in die Freigabe ein. Übernahme und Einfrieren erhalten das Original bei der jeweiligen unveränderlichen Materialisierung. Vorschauzeilen werden dadurch nicht gespeichert. "
"Original und Zeilen sind jeweils auf 5 MB und die Tabelle auf 10.000 Zeilen begrenzt. Pro Staging-Stand oder Materialisierung einschließlich eingefrorener Kopien werden bis zu 5 MB Originaltext zuzüglich Speicher für Serialisierung und Metadaten aufbewahrt. "
"GET /api/v1/datasources/{datasource_id}/materializations/{materialization_id}/original-csv liefert einen protokollierten, nicht zwischengespeicherten Download mit aktuellem Recht datasources:source:admin. "
"Aktuelle und historische Sichtbarkeit sowie externe Richtlinienentscheidungen gelten weiterhin. Jeder Zeilenfilter oder ein nicht freigegebenes Feld verhindert den Originalexport auch für die Administration; verwenden Sie dann die gesteuerte Zeilenvorschau. Katalog, Staging- und Verlaufsantworten enthalten keinen Originaltext. "
"Einfrieren prüft den vorhandenen Originalnachweis vor dem Kopieren und erhält geerbte Zugriffsbeschränkungen. Höchstens 32 unterschiedliche Richtlinienstände dürfen ein Original begleiten; darüber hinaus wird ausdrücklich abgewiesen. "
"Prüfsummen werden vor dem Export geprüft. Das Original folgt der gesteuerten Aufbewahrung: Löschen eines Staging-Stands entfernt dessen Original; Entsorgung einer Materialisierung entfernt auch deren Original, behält aber Auditnachweise. "
"Für historische Importe wird kein Original erfunden. Fehlende oder entsorgte Originale werden als nicht verfügbar gemeldet. Der Download erhält den an die API gelieferten Text als UTF-8 einschließlich unveränderter Tabellenformeln, nicht eine frühere Dateikodierung."
),
}},
),
DocumentationTopic(
id="datasources.detail-freshness",
title="Preview and revision history after a datasource change",
summary="Reload the selected datasource details even when its catalogue reference stays the same.",
body=(
"After a successful catalogue reload, the selected datasource preview and materialization history are read again. "
"This includes manual Reload and reloads following refresh, freezing, stage promotion or governance changes, even when the selected reference or current materialization is unchanged. "
"While reloading, previous rows and history are not presented as the newly selected or updated datasource. "
"An older request cannot replace results for a newer selection, reload or authentication context. "
"Callbacks retained from an earlier authorization context cannot start a new reload or change success/error messages and selection. "
"After a real identity, credential or permission change, the old catalogue is hidden until the new context has loaded it; open dialog inputs are reset to avoid carrying drafts into another authorization context. "
"Cosmetic profile changes and ordinary refreshes with equivalent authority do not reset dialogs or trigger duplicate detail reads. "
"Preview and history are independent reads: a preview failure can still leave authorized history available. "
"Live datasource previews may read the provider through the existing bounded, authorized preview API; this is not background polling or automatic source refresh. "
"Rows are not normalized, reordered or persisted by this display update. Snapshot immutability, retention rules and all server-side permission checks remain unchanged."
),
layer="always", documentation_types=("user", "admin"), audience=("user", "module_admin", "operator"), order=6,
translations={"de": {
"title": "Vorschau und Revisionsverlauf nach einer Datenquellenänderung",
"summary": "Details der ausgewählten Datenquelle auch bei unverändertem Katalogverweis neu laden.",
"body": (
"Nach erfolgreichem Neuladen des Katalogs werden Vorschau und Materialisierungsverlauf der ausgewählten Datenquelle erneut abgerufen. "
"Dies gilt für Neu laden sowie für das Neuladen nach Aktualisierung, Einfrieren, Staging-Übernahme oder Governance-Änderungen, auch wenn Auswahlverweis oder aktuelle Materialisierung gleich bleiben. "
"Während des Neuladens werden bisherige Zeilen und Verläufe nicht als neue Auswahl oder aktualisierte Datenquelle dargestellt. "
"Eine ältere Anfrage kann Ergebnisse einer neueren Auswahl, eines neueren Abrufs oder eines geänderten Authentifizierungskontexts nicht ersetzen. "
"Rückrufe eines früheren Berechtigungskontexts starten keinen neuen Abruf und ändern weder Erfolgs-/Fehlermeldungen noch die Auswahl. "
"Nach einem tatsächlichen Identitäts-, Zugangsdaten- oder Rechtewechsel bleibt der alte Katalog verborgen, bis er im neuen Kontext geladen wurde; offene Dialogeingaben werden zurückgesetzt, damit Entwürfe nicht in einen anderen Berechtigungskontext gelangen. "
"Rein optische Profiländerungen und gewöhnliche Aktualisierungen mit gleichwertigen Rechten setzen Dialoge nicht zurück und lösen keine doppelten Detailabrufe aus. "
"Vorschau und Verlauf sind getrennte Lesezugriffe: Bei einem Vorschaufehler kann ein berechtigter Verlauf weiterhin verfügbar sein. "
"Vorschauen lebender Datenquellen können den Anbieter über die bestehende begrenzte und berechtigungsgeprüfte Vorschau-API lesen; dies ist weder Hintergrund-Polling noch eine automatische Quellenaktualisierung. "
"Die Anzeigeaktualisierung normalisiert, sortiert oder speichert keine Zeilen dauerhaft. Unveränderlichkeit von Snapshots, Aufbewahrungsregeln und sämtliche serverseitigen Rechteprüfungen bleiben erhalten."
),
}},
),
DocumentationTopic(
id="datasources.workspace-layout",
title="Datasources workspace actions",
summary="Find collection-wide commands in their consistent workspace position.",
body="Open the documentation book beside Data for workspace guidance; field documentation stays "
"beside the relevant label. "
"Reload and Add datasource or stage use the persistent full-width workspace header at the upper right; Reload sits immediately before creation. Selecting a record, changing filters, or opening an editor does not move these collection-wide commands into the left pane. Catalogue, staging, and origin filters remain in the collection pane. Snapshot and freeze actions remain with their selected resource. Existing permissions, disabled-state rules, and unsaved-change guards still apply. Administrators configure authority through the existing permission system; no new permission or automatic operation is introduced.",
layer="static",
documentation_types=("user", "admin"),
audience=("user", "module_admin", "operator"),
order=5,
translations={"de": {
"title": "Datenquellen: Aktionen im Arbeitsbereich",
"summary": "Sammlungsweite Aktionen an ihrer einheitlichen Position im Arbeitsbereich finden.",
"body": "Öffnen Sie das Dokumentationsbuch neben Daten für Hinweise zum Arbeitsbereich; "
"Felddokumentation bleibt neben der jeweiligen Feldbezeichnung. "
"Neu laden und Datenquelle oder Staging hinzufügen stehen oben rechts in der dauerhaft sichtbaren, arbeitsbereichsweiten Leiste; Neu laden steht unmittelbar vor dem Anlegen. Auswahl, Filterwechsel und Bearbeitung verschieben diese sammlungsweiten Aktionen nicht in den linken Bereich. Katalog-, Staging- und Herkunftsfilter bleiben im Sammlungsbereich. Snapshot- und Einfrieraktionen bleiben bei der ausgewählten Ressource. Bestehende Berechtigungen, Deaktivierungsregeln und der Schutz ungespeicherter Änderungen gelten weiterhin. Administratoren konfigurieren Rechte im bestehenden Berechtigungssystem; es entstehen weder neue Rechte noch automatische Vorgänge.",
}},
),
DocumentationTopic(
id="datasources.data-subject-requests",
title="Datasources data-subject requests",
summary="Identify governed datasource copies while preserving credential, payload, and immutable-evidence boundaries.",
body=(
"Datasources matches exact tenant-scoped catalogue, governance-reference, materialization, payload, stage, and publication identifiers plus minimized account, identity, or membership operator attribution. DSAR results never copy connector/provider references, locators, credentials, arbitrary rows, schemas, validation samples, metadata, provenance bodies, checkpoints, idempotency material, or hashes. Arbitrary tabular payloads are not scanned for identifiers because that would be incomplete, schema-dependent, and liable to disclose unrelated people; the authoritative source module must locate and correct subject facts. "
"Datasources matches exact tenant-scoped catalogue, governance-reference, materialization, payload, stage, publication, and lifecycle-evidence identifiers plus minimized account, identity, or membership operator attribution. DSAR results never copy connector/provider references, locators, credentials, arbitrary rows, schemas, validation samples, metadata, provenance bodies, checkpoints, idempotency material, or hashes. Arbitrary tabular payloads are not scanned for identifiers because that would be incomplete, schema-dependent, and liable to disclose unrelated people; the authoritative source module must locate and correct subject facts. "
"An unpromoted stage or unreferenced payload can be deleted idempotently. Published catalogue state, promoted stages, referenced payloads, immutable materializations, governance references, publications, holds, and operator attribution require data-steward review and source correction. Downstream Dataflow and Reporting outputs must be refreshed after correction."
),
layer="configured",
@@ -460,6 +585,27 @@ manifest = ModuleManifest(
audience=("user", "operator", "module_admin", "data_steward", "auditor"),
related_modules=("core", "connectors", "dataflow", "reporting"),
order=69,
translations={
"de": {
"title": "Betroffenenanfragen für Datenquellen",
"summary": (
"Gesteuerte Datenquellenkopien identifizieren und dabei Grenzen für Zugangsdaten, Nutzdaten und unveränderliche "
"Nachweise wahren."
),
"body": (
"Datasources gleicht exakte mandantenbezogene Kennungen für Katalog, Governance-Verweis, Materialisierung, Nutzdaten, "
"Stufe, Veröffentlichung und Lebenszyklusnachweis sowie minimierte Betriebszuordnungen zu Konto, Identität oder "
"Mitgliedschaft ab. DSAR-Ergebnisse kopieren niemals Connector-/Providerverweise, Speicherorte, Zugangsdaten, beliebige "
"Zeilen, Schemata, Validierungsstichproben, Metadaten, Herkunftstexte, Checkpoints, Idempotenzmaterial oder Hashes. "
"Beliebige tabellarische Nutzdaten werden nicht nach Kennungen durchsucht, weil dies unvollständig und schemaabhängig wäre "
"und Daten unbeteiligter Personen offenlegen könnte; das maßgebliche Quellmodul muss Betroffenenmerkmale finden und "
"korrigieren. Eine nicht hochgestufte Stufe oder nicht referenzierte Nutzdaten können idempotent gelöscht werden. "
"Veröffentlichter Katalogzustand, hochgestufte Stufen, referenzierte Nutzdaten, unveränderliche Materialisierungen, "
"Governance-Verweise, Veröffentlichungen, Sperren und Betriebszuordnungen erfordern die Prüfung durch Data Stewards und "
"eine Korrektur an der Quelle. Nach der Korrektur müssen nachgelagerte Dataflow- und Reporting-Ausgaben aktualisiert werden."
),
}
},
metadata={
"seed": True,
"help_contexts": [
@@ -505,6 +651,28 @@ manifest = ModuleManifest(
"search",
),
order=70,
translations={
"de": {
"title": "Lebenszyklus einer Datenquelle",
"summary": (
"Gesteuerte Live-, Cache- und statische Daten-/Registereinträge mit Staging, eingefrorenen Zuständen, Herkunft und "
"institutionellem Eigentumskontext."
),
"body": (
"Datasources ist der providerneutrale Katalog für Dataflow, Workflow, Reporting und richtlinienbewusste Module. Statische "
"Daten werden vor der Hochstufung bereitgestellt. Cache-Daten aktualisieren Connector-Ursprünge in unveränderliche "
"Materialisierungen. Live-Daten werden über einen Connector gelesen und können für reproduzierbare Nachweise eingefroren "
"werden. Connectors besitzt Protokolle und Zugangsdaten; Datasources besitzt Datenidentität, Herkunft, Lebenszyklus, "
"Lesesemantik und den typisierten Governance-Katalog für Hoheit, Zweck, Qualität, Aktualität, Klassifikation, Korrektur "
"sowie abhängige Services, Flows, Berichte, Kontrollen und Entscheidungen. Für Live-Vorschauen bewahrt es Quellmodus, "
"strukturierten Gesundheitszustand, deklarierte Pushdown-Unterstützung und wirksame Zeilen-, Byte- und Zeitgrenzen. "
"Sichtbarkeit von Governance-Metadaten gewährt keinen Zugriff auf geschützte Zeilen. Ist Search aktiviert, indiziert das "
"Modul nur begrenzte Katalogbezeichnungen und governance-sichere Facetten und prüft vor einem Treffer die aktuelle "
"Katalogberechtigung erneut. Zeilen, Schemata, Connector-Verweise, Zugangsdaten, beliebige Metadaten und Herkunft werden "
"niemals in den Suchindex kopiert."
),
}
},
metadata={
"seed": True,
"help_contexts": [
@@ -524,8 +692,8 @@ manifest = ModuleManifest(
"Authority mode states whether GovOPlaN, an external system, a synchronized projection, an overlay, or a linked reference "
"controls the data. The authoritative source, owner, steward, responsible organization/function, schema owner, privacy "
"profile, retention policy, transfer agreement, legal basis, holds, correction procedure, purposes, official keys, and "
"known limits provide discoverable institutional context. A retention-policy reference identifies the owning Policy rule; it "
"does not itself delete materializations, override legal holds, or prove that a scheduler is active. A transfer-agreement "
"known limits provide discoverable institutional context. A retention-policy reference identifies an owning external Policy rule, while "
"the local versioned retention contract controls previewable stage and payload disposition. Retention never overrides legal holds, the current materialization, or publication evidence. A transfer-agreement "
"reference records the governed agreement for external exchange; it does not grant connector credentials, recipient access, "
"or authority to export classified rows. Freshness and quality policies are typed JSON contracts retained "
"with materialization evidence. Datasources enforces the declared bounded tabular stage rules and schema policy; origin-specific "
@@ -544,6 +712,30 @@ manifest = ModuleManifest(
"risk_compliance",
),
order=71,
translations={
"de": {
"title": "Datenhoheit und Governance einer Datenquelle",
"summary": (
"Erläutern, wer Datenbedeutung, Hoheit, Korrektur, Datenschutz, Qualität, Aktualität, Aufbewahrung und abhängige "
"Verwendungen verantwortet."
),
"body": (
"Der Hoheitsmodus gibt an, ob GovOPlaN, ein externes System, eine synchronisierte Projektion, ein Overlay oder ein "
"verknüpfter Verweis die Daten steuert. Maßgebliche Quelle, Eigentum, Data Steward, verantwortliche Organisation/Funktion, "
"Schemaeigentum, Datenschutzprofil, Aufbewahrungsrichtlinie, Übermittlungsvereinbarung, Rechtsgrundlage, Sperren, "
"Korrekturverfahren, Zwecke, amtliche Schlüssel und bekannte Grenzen bilden den auffindbaren institutionellen Kontext. "
"Ein Aufbewahrungsrichtlinienverweis bezeichnet eine externe Regel im Eigentum von Policy; der lokale versionierte "
"Aufbewahrungsvertrag steuert die vorschaufähige Behandlung von Stufen und Nutzdaten. Aufbewahrung überstimmt niemals "
"gesetzliche Sperren, die aktuelle Materialisierung oder Veröffentlichungsnachweise. Ein Verweis auf eine "
"Übermittlungsvereinbarung dokumentiert die gesteuerte Vereinbarung für externen Austausch; er gewährt weder "
"Connector-Zugangsdaten noch Empfängerzugriff oder Befugnis zum Export klassifizierter Zeilen. Aktualitäts- und "
"Qualitätsrichtlinien sind typisierte JSON-Verträge, die mit Materialisierungsnachweisen aufbewahrt werden. Datasources "
"setzt die deklarierten begrenzten Regeln für tabellarische Stufen und die Schemarichtlinie durch; ursprungs- oder "
"verbraucherspezifische Kontrollen verbleiben beim Provider oder der nutzenden Kontrolle, die Unterstützung erklärt. "
"Metadatensichtbarkeit gewährt niemals Zeilenzugriff."
),
}
},
metadata={
"seed": True,
"help_contexts": [
@@ -576,6 +768,30 @@ manifest = ModuleManifest(
audience=("operator", "module_admin", "data_steward", "auditor"),
related_modules=("policy", "access", "audit", "connectors"),
order=72,
translations={
"de": {
"title": "Sichtbarkeit von Datenquellen und Feldern",
"summary": (
"Kontrollen für Quelle, Materialisierung, Feld und Zeile anwenden, bevor geschützte Zeilen Datasources verlassen."
),
"body": (
"Eine lokale Sichtbarkeitsrichtlinie kann Auffinden und Lesen nach Konto, Mitgliedschaft, Identität, Gruppe, Rolle, "
"Dienstkonto oder Authentifizierungsmethode einschränken. Materialisierungs-ACLs schützen zusätzlich aktuelle und "
"eingefrorene Revisionen. Feldregeln klassifizieren ein Feld und ersetzen seinen Wert durch null oder lassen es weg, "
"sofern keine passende Erlaubnis-ACL vorliegt. Zeilenfilter vergleichen ein konfiguriertes Feld mit Konto-, "
"Mitgliedschafts-, Identitäts-, Dienstkonto-, Gruppen-, Rollen- oder Funktionszuweisungsmerkmalen der Hauptperson; alle "
"konfigurierten Filter und Richtlinienebenen müssen eine Zeile erlauben. Datasources wendet diese Kontrollen an, bevor "
"Zeilen die Providergrenze verlassen, und liefert einen undurchsichtigen Fingerabdruck der erlaubten Ansicht, gebunden an "
"Basisrevision, wirksame Richtlinien und relevante Hauptpersonenmerkmale. Verweigerte und gefilterte Lesevorgänge erzeugen "
"Auditnachweise mit Ergebnissen und Richtliniendiagnosen, niemals geschützten Werten, Provider-Speicherorten, beliebigen "
"Metadaten oder Herkunftstexten. Ein optionaler Zugriffsrichtlinienverweis delegiert hierarchische Ebenen an Policy, das "
"lokales Verhalten nur verschärfen kann. Eine nicht auflösbare Referenz, ein nicht verfügbarer konfigurierter Provider oder "
"eine fehlerhafte Richtlinie schließt sicher. Ohne Policy und ohne Referenz bleibt die lokale Richtlinie vollständig "
"nutzbar. Eingefrorene Lesevorgänge setzen die aktuelle lokale Richtlinie gemeinsam mit einer getrennten einschränkenden "
"Richtlinie aus dem eingefrorenen Governance-Snapshot durch."
),
}
},
metadata={
"seed": True,
"help_contexts": [
@@ -603,8 +819,7 @@ manifest = ModuleManifest(
"durable provider-neutral artifact reference with a pinned locator, SHA-256 checksum, declared schema, fingerprint, and size. "
"The configured payload backend verifies the artifact and provides bounded reads. Content-level rules require checksum- and "
"policy-bound producer evidence; absent evidence creates an immutable review-required materialization without changing the "
"Datasource's current state. Warning and review-required outcomes are preserved for Workflow handoffs. Approval and retention execution "
"are not inferred from arbitrary JSON flags and remain separate governed lifecycle work."
"Datasource's current state. Warning and review-required outcomes are preserved for Workflow handoffs. Versioned approval policy can require an attributable, separated quorum before a stage or refresh becomes current; retention uses a fresh, hashed preview before any explicit administrator apply."
),
layer="available",
documentation_types=("admin", "user"),
@@ -624,6 +839,31 @@ manifest = ModuleManifest(
"workflow_engine",
),
order=73,
translations={
"de": {
"title": "Bereitgestellte und erzeugte Datenquellenrevisionen validieren",
"summary": (
"Deterministische Qualitätsregeln und Schemerichtlinien anwenden, bevor bereitgestellte oder erzeugte Daten nutzbar werden."
),
"body": (
"Tabellarische Stufen prüfen konfigurierte Zeilenanzahl, Pflichtfelder, Feldform, Nullbarkeit, Eindeutigkeit, Zahlenbereiche "
"und begrenzte Referenzmengen. Fehler halten die Stufe prüfbar, blockieren aber die Hochstufung; Warnungen bleiben sichtbar "
"und erlauben eine ausdrückliche Hochstufung. Aktualisierungen vergleichen das erkannte Schema mit dem aktuellen Ziel und "
"klassifizieren jede Änderung als kompatibel, Warnung oder brechend. Diagnosen zeigen Anzahlen und begrenzte Zeilennummern, "
"niemals Feldwerte. Richtlinienversion und -hash, Diagnosen und Schemadifferenz werden bei erfolgreicher Hochstufung in die "
"unveränderliche Materialisierungsherkunft kopiert. Eine Provider-Veröffentlichung wendet dasselbe Gate vor jeder "
"Katalogwirkung an, bewahrt Validierungsnachweise an der unveränderlichen Ausgaberevision, serialisiert die "
"Veröffentlichungsidentität über PostgreSQL-Worker und sendet ein transaktionales Abschlussereignis. Große Ausgaben können "
"stattdessen einen dauerhaften providerneutralen Artefaktverweis mit festgelegtem Speicherort, SHA-256-Prüfsumme, Schema, "
"Fingerabdruck und Größe liefern. Das konfigurierte Nutzdaten-Backend prüft das Artefakt und stellt begrenzte Lesevorgänge "
"bereit. Inhaltsregeln verlangen prüfsummen- und richtliniengebundene Provider-Nachweise; fehlen sie, entsteht eine "
"unveränderliche prüfpflichtige Materialisierung, ohne den aktuellen Zustand der Datenquelle zu verändern. Warnungen und "
"Prüfpflicht bleiben für Workflow-Übergaben erhalten. Eine versionierte Freigaberichtlinie kann ein zurechenbares, "
"getrenntes Quorum verlangen, bevor eine Stufe oder Aktualisierung aktuell wird; Aufbewahrung verwendet vor jeder "
"ausdrücklichen administrativen Anwendung eine frische gehashte Vorschau."
),
}
},
metadata={
"seed": True,
"help_contexts": [
@@ -634,7 +874,8 @@ manifest = ModuleManifest(
],
"limitations": [
"Referential rules currently use a bounded embedded value set rather than reading another protected Datasource.",
"Approval authority and automatic retention execution are not part of the current stage contract.",
"Approvals are module-local lifecycle evidence; installing a separate Approvals module does not silently change configured datasource policy.",
"Retention is never automatic: an administrator must preview a current plan and explicitly apply eligible targets.",
"Artifact bytes remain owned by their payload backend; Datasources stores an immutable reference and integrity evidence.",
],
},
@@ -647,7 +888,7 @@ manifest = ModuleManifest(
"A Datasource key is the stable catalogue identity used by consumers. Live mode reads through an available origin; cached "
"mode refreshes an origin into immutable revisions; static mode promotes uploaded content from staging. Stages are bounded, "
"inspectable, and non-consumable until promoted. Promotion creates or updates a governed Datasource and appends an immutable "
"materialization. Refresh appends a new cached revision without rewriting older evidence. Freeze labels an immutable, "
"materialization. When approval is configured, a refresh first creates a non-consumable stage and only an approved quorum permits promotion. Freeze labels an immutable, "
"addressable state for reproducible execution. Retirement removes the Datasource from new definitions while retained "
"materialization references remain governed. Connector absence disables origin registration but leaves local catalogue and "
"staging behavior available."
@@ -663,7 +904,24 @@ manifest = ModuleManifest(
"audit",
),
order=74,
translations={
"de": {
"title": "Datenquellenfelder und Folgen des Lebenszyklus",
"summary": "Semantik von Live-, Cache- und statischem Modus, Staging, Hochstufung, Aktualisierung, Einfrieren und Stilllegung.",
"body": (
"Der Schlüssel einer Datenquelle ist ihre stabile Katalogidentität für Verbraucher. Live-Modus liest über einen "
"verfügbaren Ursprung, Cache-Modus aktualisiert einen Ursprung in unveränderliche Revisionen und statischer Modus stuft "
"hochgeladene Inhalte aus dem Staging hoch. Stufen sind begrenzt, prüfbar und vor der Hochstufung nicht nutzbar. Die "
"Hochstufung legt eine gesteuerte Datenquelle an oder aktualisiert sie und ergänzt eine unveränderliche Materialisierung. "
"Ist eine Freigabe konfiguriert, erzeugt eine Aktualisierung zunächst eine nicht nutzbare Stufe; nur ein bestätigtes Quorum "
"erlaubt die Hochstufung. Einfrieren kennzeichnet einen unveränderlichen adressierbaren Zustand für reproduzierbare "
"Ausführung. Eine Stilllegung entfernt die Datenquelle aus neuen Definitionen, während erhaltene Materialisierungsverweise "
"gesteuert bleiben. Fehlt Connectors, ist die Ursprungsregistrierung deaktiviert; lokaler Katalog und Staging bleiben nutzbar."
),
}
},
metadata={
"kind": "reference",
"seed": True,
"help_contexts": [
"datasources.field.origin",
@@ -682,7 +940,62 @@ manifest = ModuleManifest(
},
},
),
DocumentationTopic(
id="datasources.approval-and-retention",
title="Approve promotions and apply retention safely",
summary="Require separated datasource decisions and preview retention consequences before disposing staged or materialized payloads.",
body=(
"A versioned approval policy can require one to five distinct approvals before a valid stage becomes ready. The stage creator cannot approve when separation of duties is enabled. Decisions are bound to the exact stage fingerprint, quality-policy hash, approval-policy hash, actor authority, reason, and expiry; a changed policy or staged subject invalidates promotion. Cached refreshes use the same stage path whenever approval is required. "
"A versioned retention policy independently sets durations for stages, ordinary materializations, and frozen evidence. Preview returns a hashed plan with every due target and blocker. Current materializations, legal holds, pending approvals, and producer-publication evidence cannot be disposed. Applying the unchanged plan deletes eligible transient stages or purges materialization payload rows while retaining minimized schema/provenance, checksum, disposition, and hash-chained lifecycle evidence. Empty local policies disable both gates, so the module remains usable without Access or Policy; installed modules may tighten access but do not manufacture approval claims."
),
layer="available",
documentation_types=("admin", "user"),
audience=("operator", "module_admin", "data_steward", "auditor"),
conditions=(
DocumentationCondition(
any_scopes=(
STAGE_WRITE_SCOPE,
STAGE_APPROVE_SCOPE,
ADMIN_SCOPE,
)
),
),
related_modules=("access", "audit", "policy", "workflow_engine"),
order=75,
translations={
"de": {
"title": "Freigaben erteilen und Aufbewahrung sicher anwenden",
"summary": "Getrennte Entscheidungen für Datenquellen verlangen und Folgen der Aufbewahrung vor dem Löschen von Stufen oder Nutzdaten prüfen.",
"body": (
"Eine versionierte Freigaberichtlinie kann ein bis fünf verschiedene Freigaben verlangen, bevor eine gültige Stufe bereit ist. Bei aktivierter Funktionstrennung darf die erstellende Person nicht selbst freigeben. Entscheidungen sind an Fingerabdruck, Qualitäts- und Freigaberichtlinien-Hash, Berechtigung, Begründung und Ablaufzeit gebunden; geänderte Richtlinien oder Inhalte verhindern die Übernahme. Zwischengespeicherte Aktualisierungen nutzen bei Freigabepflicht denselben Stufenweg. "
"Eine getrennte Aufbewahrungsrichtlinie legt Fristen für Stufen, gewöhnliche Materialisierungen und eingefrorene Nachweise fest. Die Vorschau liefert einen gehashten Plan mit fälligen Zielen und Sperrgründen. Aktuelle Materialisierungen, rechtliche Sperren, offene Freigaben und Veröffentlichungsnachweise dürfen nicht entfernt werden. Beim Anwenden des unveränderten Plans werden nur zulässige Stufen oder Nutzdaten gelöscht; minimierte Metadaten, Prüfsummen, Dispositionsangaben und hashverkettete Lebenszyklusnachweise bleiben erhalten. Leere lokale Richtlinien deaktivieren beide Schranken, sodass das Modul ohne Access oder Policy nutzbar bleibt."
),
}
},
metadata={
"seed": True,
"kind": "workflow",
"help_contexts": [
"datasources.staging.approval",
"datasources.action.approve",
"datasources.action.reject",
"datasources.field.approval-policy",
"datasources.field.retention-policy-contract",
"datasources.lifecycle-evidence",
"datasources.retention",
],
"limitations": [
"Retention execution is explicit and plan-bound; this module does not run a hidden deletion scheduler.",
"Disposed materialization records retain minimized schema and provenance metadata while their payload rows are removed.",
],
},
),
),
)
manifest = with_documentation_structured_translations(
manifest, locale="de", translations=GERMAN_STRUCTURED_TRANSLATIONS
)
@@ -0,0 +1,142 @@
"""v0.1.21 datasource lifecycle governance
Revision ID: d1a7c3e9f5b2
Revises: c9e3a6f1d4b8
Create Date: 2026-08-22 20:00:00.000000
"""
from __future__ import annotations
from alembic import op
import sqlalchemy as sa
revision = "d1a7c3e9f5b2"
down_revision = "c9e3a6f1d4b8"
branch_labels = None
depends_on = None
def upgrade() -> None:
op.add_column(
"datasource_catalogue",
sa.Column(
"approval_policy",
sa.JSON(),
server_default=sa.text("'{}'"),
nullable=False,
),
)
op.add_column(
"datasource_catalogue",
sa.Column(
"retention_policy",
sa.JSON(),
server_default=sa.text("'{}'"),
nullable=False,
),
)
op.add_column(
"datasource_stages",
sa.Column(
"approval",
sa.JSON(),
server_default=sa.text("'{}'"),
nullable=False,
),
)
op.add_column(
"datasource_materializations",
sa.Column("disposed_at", sa.DateTime(timezone=True), nullable=True),
)
op.add_column(
"datasource_materializations",
sa.Column(
"disposition",
sa.JSON(),
server_default=sa.text("'{}'"),
nullable=False,
),
)
op.create_index(
"ix_datasource_materializations_disposed_at",
"datasource_materializations",
["disposed_at"],
unique=False,
)
op.create_table(
"datasource_lifecycle_evidence",
sa.Column("id", sa.String(length=36), nullable=False),
sa.Column("tenant_id", sa.String(length=36), nullable=False),
sa.Column("subject_ref", sa.String(length=160), nullable=False),
sa.Column("event_type", sa.String(length=80), nullable=False),
sa.Column("occurred_at", sa.DateTime(timezone=True), nullable=False),
sa.Column("actor_ref", sa.String(length=255), nullable=True),
sa.Column("policy_version", sa.String(length=120), nullable=True),
sa.Column("policy_hash", sa.String(length=64), nullable=True),
sa.Column("subject_digest", sa.String(length=64), nullable=False),
sa.Column("previous_event_hash", sa.String(length=64), nullable=True),
sa.Column("event_hash", sa.String(length=64), nullable=False),
sa.Column("details", sa.JSON(), nullable=False),
sa.PrimaryKeyConstraint("id"),
sa.UniqueConstraint(
"tenant_id",
"event_hash",
name="uq_datasource_lifecycle_evidence_hash",
),
)
op.create_index(
"ix_datasource_lifecycle_evidence_tenant_id",
"datasource_lifecycle_evidence",
["tenant_id"],
unique=False,
)
op.create_index(
"ix_datasource_lifecycle_evidence_subject_ref",
"datasource_lifecycle_evidence",
["subject_ref"],
unique=False,
)
op.create_index(
"ix_datasource_lifecycle_evidence_event_type",
"datasource_lifecycle_evidence",
["event_type"],
unique=False,
)
op.create_index(
"ix_datasource_lifecycle_evidence_actor_ref",
"datasource_lifecycle_evidence",
["actor_ref"],
unique=False,
)
op.create_index(
"ix_datasource_lifecycle_evidence_event_hash",
"datasource_lifecycle_evidence",
["event_hash"],
unique=False,
)
op.create_index(
"ix_datasource_lifecycle_evidence_subject",
"datasource_lifecycle_evidence",
["tenant_id", "subject_ref", "occurred_at"],
unique=False,
)
op.create_index(
"ix_datasource_lifecycle_evidence_event",
"datasource_lifecycle_evidence",
["tenant_id", "event_type", "occurred_at"],
unique=False,
)
def downgrade() -> None:
op.drop_table("datasource_lifecycle_evidence")
op.drop_index(
"ix_datasource_materializations_disposed_at",
table_name="datasource_materializations",
)
op.drop_column("datasource_materializations", "disposition")
op.drop_column("datasource_materializations", "disposed_at")
op.drop_column("datasource_stages", "approval")
op.drop_column("datasource_catalogue", "retention_policy")
op.drop_column("datasource_catalogue", "approval_policy")
@@ -0,0 +1,24 @@
"""Preserve original CSV for new durable imports, separate from catalogue DTOs."""
from alembic import op
import sqlalchemy as sa
revision = "e2b8d4a0f6c3"
down_revision = "d1a7c3e9f5b2"
branch_labels = None
depends_on = None
def upgrade() -> None:
op.add_column(
"datasource_stages", sa.Column("csv_source", sa.JSON(), nullable=True)
)
op.add_column(
"datasource_materializations", sa.Column("csv_source", sa.JSON(), nullable=True)
)
def downgrade() -> None:
for table in ("datasource_materializations", "datasource_stages"):
with op.batch_alter_table(table) as batch:
batch.drop_column("csv_source")
+248 -2
View File
@@ -3,8 +3,9 @@ from __future__ import annotations
import hashlib
import json
from collections.abc import Mapping
from datetime import UTC, datetime
from fastapi import APIRouter, Depends, HTTPException, Query, status
from fastapi import APIRouter, Depends, HTTPException, Query, Response, status
from sqlalchemy.orm import Session
from govoplan_core.audit.logging import audit_event
@@ -24,12 +25,15 @@ from govoplan_core.core.datasources import (
datasource_origins,
)
from govoplan_core.db.session import get_session
from govoplan_core.core.tabular_sources import TabularCsvSource
from govoplan_datasources.backend.runtime import get_registry
from govoplan_datasources.backend.schemas import (
DatasourceFieldResponse,
DatasourceFreezeRequest,
DatasourceGovernancePayload,
DatasourceGovernanceUpdateRequest,
DatasourceLifecycleEvidenceListResponse,
DatasourceLifecycleEvidenceResponse,
DatasourceListResponse,
DatasourceMaterializationListResponse,
DatasourceMaterializationResponse,
@@ -41,8 +45,13 @@ from govoplan_datasources.backend.schemas import (
DatasourcePreviewDiagnosticResponse,
DatasourcePreviewResponse,
DatasourceResponse,
DatasourceRetentionApplyRequest,
DatasourceRetentionApplyResponse,
DatasourceRetentionCandidateResponse,
DatasourceRetentionPlanResponse,
DatasourceRetireResponse,
DatasourceStageCreateRequest,
DatasourceStageDecisionRequest,
DatasourceStageListResponse,
DatasourceStagePromoteRequest,
DatasourceStagePromoteResponse,
@@ -52,6 +61,7 @@ from govoplan_datasources.backend.service import (
ADMIN_SCOPE,
CATALOGUE_READ_SCOPE,
SOURCE_WRITE_SCOPE,
STAGE_APPROVE_SCOPE,
STAGE_WRITE_SCOPE,
SqlDatasourceProvider,
)
@@ -194,7 +204,7 @@ def api_create_stage(
rows = (
tuple(payload.rows or ())
if payload.format == "json"
else parse_csv_rows(payload.csv_text or "", delimiter=payload.delimiter)
else parse_csv_rows(payload.csv_text or "", delimiter=payload.delimiter, value_mode=payload.csv_value_mode)
)
stage = _provider().create_stage(
session,
@@ -216,6 +226,12 @@ def api_create_stage(
},
metadata=payload.metadata,
governance=_governance(payload.governance),
csv_source=(TabularCsvSource(
text=payload.csv_text or "",
delimiter=payload.delimiter,
value_mode=payload.csv_value_mode,
parser_profile="datasources.csv.v1",
) if payload.format == "csv" else None),
),
)
except DatasourceError as exc:
@@ -236,6 +252,56 @@ def api_create_stage(
"schema_classification": _safe_mapping(
stage.validation.get("schema_change")
).get("classification"),
"approval_state": stage.approval.get("state"),
"approval_policy_hash": stage.approval.get("policy_hash"),
},
)
session.commit()
return _stage_response(stage)
@router.post(
"/stages/{stage_id}/decision",
response_model=DatasourceStageResponse,
)
def api_decide_stage(
stage_id: str,
payload: DatasourceStageDecisionRequest,
session: Session = Depends(get_session),
principal: ApiPrincipal = Depends(get_api_principal),
) -> DatasourceStageResponse:
_require_any_scope(principal, STAGE_APPROVE_SCOPE, ADMIN_SCOPE)
try:
stage, evidence_hash, replayed = _provider().decide_stage(
session,
principal,
stage_ref=f"stage:{stage_id}",
decision=payload.decision,
reason=payload.reason,
expected_policy_hash=payload.expected_policy_hash,
expected_subject_digest=payload.expected_subject_digest,
)
except DatasourceError as exc:
raise _http_error(exc) from exc
action = (
"datasources.stage.approved"
if payload.decision == "approve"
else "datasources.stage.rejected"
)
_audit(
session,
principal,
action=action,
object_type="datasource_stage",
object_id=stage.ref,
details={
"decision": payload.decision,
"resulting_state": stage.state,
"approval_count": stage.approval.get("approval_count"),
"required_approvals": stage.approval.get("required_approvals"),
"policy_hash": stage.approval.get("policy_hash"),
"evidence_hash": evidence_hash,
"replayed": replayed,
},
)
session.commit()
@@ -277,6 +343,12 @@ def api_promote_stage(
"quality_policy_hash": _safe_mapping(
materialization.provenance.get("stage_validation")
).get("policy_hash"),
"approval_policy_hash": _safe_mapping(
materialization.provenance.get("stage_approval")
).get("policy_hash"),
"promotion_evidence_hash": materialization.provenance.get(
"promotion_evidence_hash"
),
},
)
session.commit()
@@ -286,6 +358,100 @@ def api_promote_stage(
)
@router.get(
"/lifecycle-evidence",
response_model=DatasourceLifecycleEvidenceListResponse,
)
def api_list_lifecycle_evidence(
subject_ref: str | None = Query(default=None, max_length=160),
limit: int = Query(default=200, ge=1, le=500),
session: Session = Depends(get_session),
principal: ApiPrincipal = Depends(get_api_principal),
) -> DatasourceLifecycleEvidenceListResponse:
_require_any_scope(principal, CATALOGUE_READ_SCOPE, ADMIN_SCOPE)
try:
rows = _provider().list_lifecycle_evidence(
session,
principal,
subject_ref=subject_ref,
limit=limit,
)
except DatasourceError as exc:
raise _http_error(exc) from exc
return DatasourceLifecycleEvidenceListResponse(
evidence=[_evidence_response(item) for item in rows]
)
@router.get(
"/retention/plan",
response_model=DatasourceRetentionPlanResponse,
)
def api_preview_retention(
as_of: datetime | None = Query(default=None),
session: Session = Depends(get_session),
principal: ApiPrincipal = Depends(get_api_principal),
) -> DatasourceRetentionPlanResponse:
_require_any_scope(principal, ADMIN_SCOPE)
effective_at = as_of or datetime.now(UTC)
try:
plan = _provider().preview_retention(
session,
principal,
as_of=effective_at,
)
except DatasourceError as exc:
raise _http_error(exc) from exc
return DatasourceRetentionPlanResponse(
as_of=plan.as_of.isoformat(),
plan_hash=plan.plan_hash,
candidates=[
DatasourceRetentionCandidateResponse(**item.to_dict())
for item in plan.candidates
],
)
@router.post(
"/retention/apply",
response_model=DatasourceRetentionApplyResponse,
)
def api_apply_retention(
payload: DatasourceRetentionApplyRequest,
session: Session = Depends(get_session),
principal: ApiPrincipal = Depends(get_api_principal),
) -> DatasourceRetentionApplyResponse:
_require_any_scope(principal, ADMIN_SCOPE)
try:
disposed, evidence_hashes = _provider().apply_retention(
session,
principal,
as_of=payload.as_of,
plan_hash=payload.plan_hash,
target_refs=payload.target_refs,
)
except DatasourceError as exc:
raise _http_error(exc) from exc
_audit(
session,
principal,
action="datasources.retention.applied",
object_type="datasource_retention_plan",
object_id=payload.plan_hash,
details={
"as_of": payload.as_of.isoformat(),
"disposed_refs": list(disposed),
"evidence_hashes": list(evidence_hashes),
},
)
session.commit()
return DatasourceRetentionApplyResponse(
plan_hash=payload.plan_hash,
disposed_refs=list(disposed),
evidence_hashes=list(evidence_hashes),
)
@router.get("", response_model=DatasourceListResponse)
def api_list_datasources(
query: str = Query(default="", max_length=200),
@@ -470,6 +636,27 @@ def api_list_materializations(
)
@router.get("/{datasource_id}/materializations/{materialization_id}/original-csv")
def api_original_csv(
datasource_id: str,
materialization_id: str,
session: Session = Depends(get_session),
principal: ApiPrincipal = Depends(get_api_principal),
) -> Response:
_require_any_scope(principal, ADMIN_SCOPE)
try:
text = _provider().original_csv(
session, principal,
datasource_ref=f"datasource:{datasource_id}",
materialization_ref=f"materialization:{materialization_id}",
)
except DatasourceError as exc:
raise _http_error(exc) from exc
_audit(session, principal, action="datasources.original_csv.exported", object_type="datasource_materialization", object_id=f"materialization:{materialization_id}", details={"datasource_ref": f"datasource:{datasource_id}", "sha256": hashlib.sha256(text.encode("utf-8")).hexdigest()})
session.commit()
return Response(content=text.encode("utf-8"), media_type="text/csv; charset=utf-8", headers={"Content-Disposition": 'attachment; filename="original.csv"', "Cache-Control": "no-store"})
@router.post(
"/{datasource_id}/refresh",
response_model=DatasourceStagePromoteResponse,
@@ -507,6 +694,46 @@ def api_refresh_datasource(
)
@router.post(
"/{datasource_id}/refresh/stage",
response_model=DatasourceStageResponse,
status_code=status.HTTP_201_CREATED,
)
def api_prepare_refresh(
datasource_id: str,
session: Session = Depends(get_session),
principal: ApiPrincipal = Depends(get_api_principal),
) -> DatasourceStageResponse:
_require_any_scope(
principal,
SOURCE_WRITE_SCOPE,
STAGE_WRITE_SCOPE,
ADMIN_SCOPE,
)
try:
stage = _provider().prepare_refresh(
session,
principal,
datasource_ref=f"datasource:{datasource_id}",
)
except DatasourceError as exc:
raise _http_error(exc) from exc
_audit(
session,
principal,
action="datasources.refresh.staged",
object_type="datasource_stage",
object_id=stage.ref,
details={
"datasource_ref": stage.target_datasource_ref,
"approval_state": stage.approval.get("state"),
"quality_policy_hash": stage.validation.get("policy_hash"),
},
)
session.commit()
return _stage_response(stage)
@router.post(
"/{datasource_id}/freeze",
response_model=DatasourceMaterializationResponse,
@@ -635,6 +862,8 @@ def _materialization_response(
item.source_timestamp.isoformat() if item.source_timestamp else None
),
created_at=item.created_at.isoformat() if item.created_at else None,
disposed_at=item.disposed_at.isoformat() if item.disposed_at else None,
disposition=dict(item.disposition),
provenance=dict(item.provenance),
metadata=dict(item.metadata),
governance=item.governance.to_dict(),
@@ -664,6 +893,7 @@ def _stage_response(item: DatasourceStage) -> DatasourceStageResponse:
row_count=item.row_count,
byte_count=item.byte_count,
validation=dict(item.validation),
approval=dict(item.approval),
created_at=item.created_at.isoformat() if item.created_at else None,
promoted_at=item.promoted_at.isoformat() if item.promoted_at else None,
promoted_materialization_ref=item.promoted_materialization_ref,
@@ -719,6 +949,22 @@ def _origin_response(item: DatasourceOrigin) -> DatasourceOriginResponse:
)
def _evidence_response(item) -> DatasourceLifecycleEvidenceResponse:
return DatasourceLifecycleEvidenceResponse(
ref=f"lifecycle-evidence:{item.id}",
subject_ref=item.subject_ref,
event_type=item.event_type,
occurred_at=item.occurred_at.isoformat(),
actor_ref=item.actor_ref,
policy_version=item.policy_version,
policy_hash=item.policy_hash,
subject_digest=item.subject_digest,
previous_event_hash=item.previous_event_hash,
event_hash=item.event_hash,
details=dict(item.details_),
)
def _governance(
payload: DatasourceGovernancePayload | None,
) -> DatasourceGovernance | None:
@@ -1,5 +1,6 @@
from __future__ import annotations
from datetime import datetime
from typing import Any, Literal
from pydantic import BaseModel, Field, model_validator
@@ -50,6 +51,8 @@ class DatasourceGovernancePayload(BaseModel):
transfer_agreement_ref: str | None = Field(default=None, max_length=500)
freshness_policy: dict[str, Any] = Field(default_factory=dict)
quality_policy: dict[str, Any] = Field(default_factory=dict)
approval_policy: dict[str, Any] = Field(default_factory=dict)
retention_policy: dict[str, Any] = Field(default_factory=dict)
known_limits: list[str] = Field(default_factory=list, max_length=100)
correction_procedure_ref: str | None = Field(default=None, max_length=500)
affected_refs: list[str] = Field(default_factory=list, max_length=250)
@@ -116,6 +119,8 @@ class DatasourceMaterializationResponse(BaseModel):
frozen_label: str | None
source_timestamp: str | None
created_at: str | None
disposed_at: str | None
disposition: dict[str, Any]
provenance: dict[str, Any]
metadata: dict[str, Any]
governance: DatasourceGovernancePayload
@@ -181,6 +186,7 @@ class DatasourceStageResponse(BaseModel):
row_count: int | None
byte_count: int | None
validation: DatasourceStageValidationResponse
approval: dict[str, Any]
created_at: str | None
promoted_at: str | None
promoted_materialization_ref: str | None
@@ -203,6 +209,7 @@ class DatasourceStageCreateRequest(BaseModel):
format: Literal["json", "csv"] = "json"
rows: list[dict[str, Any]] | None = Field(default=None, max_length=10_000)
csv_text: str | None = Field(default=None, max_length=5_000_000)
csv_value_mode: Literal["legacy_typed", "text"] = "legacy_typed"
delimiter: Literal[",", ";", "\t", "|"] = ","
target_datasource_ref: str | None = None
provenance: dict[str, Any] = Field(default_factory=dict)
@@ -223,6 +230,61 @@ class DatasourceStagePromoteRequest(BaseModel):
frozen_label: str | None = Field(default=None, max_length=300)
class DatasourceStageDecisionRequest(BaseModel):
decision: Literal["approve", "reject"]
reason: str = Field(min_length=1, max_length=2_000)
expected_policy_hash: str = Field(min_length=64, max_length=64)
expected_subject_digest: str = Field(min_length=64, max_length=64)
class DatasourceLifecycleEvidenceResponse(BaseModel):
ref: str
subject_ref: str
event_type: str
occurred_at: str
actor_ref: str | None
policy_version: str | None
policy_hash: str | None
subject_digest: str
previous_event_hash: str | None
event_hash: str
details: dict[str, Any]
class DatasourceLifecycleEvidenceListResponse(BaseModel):
evidence: list[DatasourceLifecycleEvidenceResponse]
class DatasourceRetentionCandidateResponse(BaseModel):
ref: str
kind: Literal["stage", "materialization"]
datasource_ref: str | None
disposition: Literal["delete_stage", "purge_materialization_payload"]
eligible_at: str
eligible: bool
blockers: list[str]
policy_version: str
policy_hash: str
class DatasourceRetentionPlanResponse(BaseModel):
as_of: str
plan_hash: str
candidates: list[DatasourceRetentionCandidateResponse]
class DatasourceRetentionApplyRequest(BaseModel):
as_of: datetime
plan_hash: str = Field(min_length=64, max_length=64)
target_refs: list[str] = Field(min_length=1, max_length=500)
class DatasourceRetentionApplyResponse(BaseModel):
plan_hash: str
disposed_refs: list[str]
evidence_hashes: list[str]
class DatasourceStagePromoteResponse(BaseModel):
datasource: DatasourceResponse
materialization: DatasourceMaterializationResponse
+339 -7
View File
@@ -5,6 +5,7 @@ import json
import re
from collections.abc import Mapping, Sequence
from dataclasses import dataclass, replace
from datetime import datetime
from typing import Any, cast
from sqlalchemy import exists, func, or_, select, text
@@ -38,6 +39,8 @@ from govoplan_core.core.datasources import (
datasource_visibility_policy_provider,
)
from govoplan_core.db.base import utcnow
from govoplan_core.core.tabular_sources import csv_source_summary, verified_csv_source_text, TabularSourceError
from govoplan_datasources.backend.csv_sources import prepare_csv_source, verify_stage_csv
from govoplan_datasources.backend.db.models import (
DatasourceGovernanceReferenceRecord,
DatasourceMaterializationRecord,
@@ -46,6 +49,18 @@ from govoplan_datasources.backend.db.models import (
DatasourceRecord,
DatasourceStageRecord,
)
from govoplan_datasources.backend.governance import (
RetentionPlan,
apply_retention_plan,
build_retention_plan,
decide_stage,
ensure_stage_approval_current,
initialize_stage_approval,
list_lifecycle_evidence,
normalize_approval_policy,
normalize_retention_policy,
record_lifecycle_evidence,
)
from govoplan_datasources.backend.payloads import (
DatasourcePayloadBackend,
PayloadBackendRegistry,
@@ -77,6 +92,7 @@ from govoplan_datasources.backend.visibility import (
CATALOGUE_READ_SCOPE = "datasources:catalogue:read"
SOURCE_WRITE_SCOPE = "datasources:source:write"
STAGE_WRITE_SCOPE = "datasources:stage:write"
STAGE_APPROVE_SCOPE = "datasources:stage:approve"
ADMIN_SCOPE = "datasources:source:admin"
@@ -457,6 +473,40 @@ class SqlDatasourceProvider:
)
return result
def original_csv(
self,
session: object,
principal: object,
*,
datasource_ref: str,
materialization_ref: str,
) -> str:
"""Export original input only to admins with unrestricted current/history visibility."""
db, api_principal = _context(session, principal, ADMIN_SCOPE)
item = _required_datasource(db, tenant_id=api_principal.tenant_id, datasource_ref=datasource_ref)
request = DatasourceReadRequest(datasource_ref=datasource_ref, materialization_ref=materialization_ref)
materialization = _selected_materialization(db, item=item, request=request)
if materialization is None or materialization.disposed_at is not None:
raise DatasourceUnavailableError("Original CSV source is unavailable or was disposed under retention policy.")
if materialization.csv_source_ is None:
raise DatasourceNotFoundError("Original CSV was not retained for this materialization; historical typed rows cannot reconstruct it.")
try:
original = verified_csv_source_text(materialization.csv_source_, expected_summary=materialization.metadata_.get("csv_source") or {})
except TabularSourceError as exc:
raise DatasourceUnavailableError(str(exc)) from exc
history = materialization.csv_source_.get("governance_history", [])
if not isinstance(history, list) or len(history) > 32 or any(not isinstance(value, Mapping) for value in history):
raise DatasourceAccessError("Original CSV inherited governance is invalid.")
for snapshot in (None, materialization.governance_snapshot_, *history):
plan = self._visibility_plan(
db, api_principal, item=item, request=request, materialized=True,
schema=_fields(materialization.schema_),
governance_override=DatasourceGovernance.from_mapping(snapshot) if snapshot is not None else None,
)
if plan.row_filters or any(not rule.allowed for rule in plan.field_rules):
raise DatasourceAccessError("Original CSV export requires unrestricted row and field visibility; use the governed row preview instead.")
return original
def _read_materialized(
self,
session: Session,
@@ -480,6 +530,10 @@ class SqlDatasourceProvider:
else "This datasource has no materialized state."
)
raise DatasourceUnavailableError(message)
if materialization.disposed_at is not None:
raise DatasourceUnavailableError(
"This materialization payload was disposed under its retention policy."
)
source_schema = _fields(materialization.schema_)
snapshot_governance = DatasourceGovernance.from_mapping(
materialization.governance_snapshot_
@@ -714,6 +768,9 @@ class SqlDatasourceProvider:
)
)
rows = normalize_rows(stage.rows)
if stage.csv_source is not None and "csv_source" in stage.metadata:
raise DatasourceValidationError("csv_source metadata is reserved for verified CSV import evidence.")
csv_payload = prepare_csv_source(stage.csv_source, rows)
schema = infer_schema(rows)
governance = replace(
governance,
@@ -721,6 +778,8 @@ class SqlDatasourceProvider:
governance.visibility_policy,
schema=schema,
),
approval_policy=normalize_approval_policy(governance.approval_policy),
retention_policy=normalize_retention_policy(governance.retention_policy),
)
fingerprint = fingerprint_rows(rows, schema)
validation = validate_stage(
@@ -738,7 +797,7 @@ class SqlDatasourceProvider:
kind=stage.kind,
mode=stage.mode,
shape=stage.shape,
state="ready" if validation["valid"] else "invalid",
state="invalid",
provider=_clean_optional(stage.provider),
provider_ref=_clean_optional(stage.provider_ref),
schema_=[field_payload(field) for field in schema],
@@ -748,14 +807,101 @@ class SqlDatasourceProvider:
byte_count=encoded_size(rows),
validation_=validation,
provenance_=dict(stage.provenance),
metadata_=dict(stage.metadata),
metadata_={
**dict(stage.metadata),
**({"csv_source": csv_source_summary(csv_payload)} if csv_payload is not None else {}),
},
csv_source_=csv_payload,
governance_=governance.to_dict(),
created_by=_actor_id(api_principal),
)
db.add(item)
db.flush()
approval = initialize_stage_approval(item, created_at=item.created_at)
record_lifecycle_evidence(
db,
tenant_id=api_principal.tenant_id,
subject_ref=_stage_ref(item.id),
event_type="stage.validated",
actor_ref=_actor_id(api_principal),
subject_digest=str(approval["subject_digest"]),
policy_version=str(validation.get("policy_version") or "1"),
policy_hash=str(validation.get("policy_hash") or ""),
details={
"validation_valid": validation.get("valid"),
"schema_classification": (
validation.get("schema_change", {}).get("classification")
if isinstance(validation.get("schema_change"), Mapping)
else None
),
"approval_required": approval.get("state") != "not_required",
"approval_policy_hash": approval.get("policy_hash"),
},
occurred_at=item.created_at,
)
db.flush()
return _stage_dto(item)
def decide_stage(
self,
session: object,
principal: object,
*,
stage_ref: str,
decision: str,
reason: str,
expected_policy_hash: str,
expected_subject_digest: str,
) -> tuple[DatasourceStage, str | None, bool]:
db, api_principal = _context(session, principal, STAGE_APPROVE_SCOPE)
actor_ref = _actor_id(api_principal)
if actor_ref is None:
raise DatasourceValidationError(
"An attributable account is required for datasource approval."
)
stage = _required_stage(
db,
tenant_id=api_principal.tenant_id,
stage_ref=stage_ref,
for_update=True,
)
approval, replayed = decide_stage(
stage,
actor_ref=actor_ref,
actor_scopes=tuple(api_principal.scopes),
decision=decision,
reason=reason,
expected_policy_hash=expected_policy_hash,
expected_subject_digest=expected_subject_digest,
)
evidence_hash = None
if not replayed:
policy = approval.get("policy")
policy_mapping = policy if isinstance(policy, Mapping) else {}
evidence = record_lifecycle_evidence(
db,
tenant_id=api_principal.tenant_id,
subject_ref=_stage_ref(stage.id),
event_type=(
"stage.approved" if decision == "approve" else "stage.rejected"
),
actor_ref=actor_ref,
subject_digest=str(approval["subject_digest"]),
policy_version=str(policy_mapping.get("version") or "1"),
policy_hash=str(approval["policy_hash"]),
details={
"decision": decision,
"reason": reason.strip(),
"approval_count": approval.get("approval_count"),
"required_approvals": approval.get("required_approvals"),
"resulting_state": approval.get("state"),
"authority_scopes": sorted(api_principal.scopes),
},
)
evidence_hash = evidence.event_hash
db.flush()
return _stage_dto(stage), evidence_hash, replayed
def promote_stage(
self,
session: object,
@@ -777,6 +923,7 @@ class SqlDatasourceProvider:
)
if stage.state != "ready":
raise DatasourceValidationError("Only ready stages can be promoted.")
verify_stage_csv(stage.csv_source_, stage.rows)
datasource = (
db.get(DatasourceRecord, stage.target_datasource_id)
if stage.target_datasource_id
@@ -787,6 +934,15 @@ class SqlDatasourceProvider:
or datasource.deleted_at is not None
):
datasource = None
current_governance = (
_datasource_governance(datasource)
if datasource is not None
else DatasourceGovernance.from_mapping(stage.governance_)
)
ensure_stage_approval_current(
stage,
current_policy=current_governance.approval_policy,
)
if datasource is None:
_ensure_source_name_available(
db,
@@ -845,16 +1001,90 @@ class SqlDatasourceProvider:
**dict(stage.provenance_),
"stage_ref": _stage_ref(stage.id),
"stage_validation": dict(stage.validation_),
"stage_approval": dict(stage.approval_),
},
metadata=dict(stage.metadata_),
csv_source=stage.csv_source_,
set_current=True,
)
stage.state = "promoted"
stage.promoted_at = utcnow()
stage.promoted_materialization_id = materialization.id
approval_policy = stage.approval_.get("policy")
policy_mapping = (
approval_policy if isinstance(approval_policy, Mapping) else {}
)
promotion_evidence = record_lifecycle_evidence(
db,
tenant_id=api_principal.tenant_id,
subject_ref=_stage_ref(stage.id),
event_type="stage.promoted",
actor_ref=_actor_id(api_principal),
subject_digest=str(stage.approval_.get("subject_digest") or ""),
policy_version=str(policy_mapping.get("version") or "1"),
policy_hash=str(stage.approval_.get("policy_hash") or ""),
details={
"datasource_ref": _datasource_ref(datasource.id),
"materialization_ref": _materialization_ref(materialization.id),
"revision": materialization.revision,
"quality_policy_hash": stage.validation_.get("policy_hash"),
"approval_count": stage.approval_.get("approval_count"),
},
)
materialization.provenance_ = {
**dict(materialization.provenance_),
"promotion_evidence_hash": promotion_evidence.event_hash,
}
db.flush()
return _datasource_dto(datasource), _materialization_dto(materialization)
def prepare_refresh(
self,
session: object,
principal: object,
*,
datasource_ref: str,
) -> DatasourceStage:
db, api_principal = _context(session, principal, SOURCE_WRITE_SCOPE)
item = _required_datasource(
db,
tenant_id=api_principal.tenant_id,
datasource_ref=datasource_ref,
)
if item.mode != "cached" or not item.provider_ref:
raise DatasourceValidationError(
"Only cached connector-backed datasources can prepare a refresh."
)
rows, origin = self._read_origin_all(
db,
api_principal,
origin_ref=item.provider_ref,
)
return self.create_stage(
db,
api_principal,
stage=DatasourceStageInput(
name=item.name,
source_name=item.source_name,
description=item.description,
kind=cast(Any, item.kind),
mode="cached",
shape=cast(Any, item.shape),
rows=tuple(rows),
target_datasource_ref=_datasource_ref(item.id),
provider=item.provider,
provider_ref=item.provider_ref,
provenance={
"created_via": "datasources.refresh",
"origin_ref": origin.ref,
"origin_fingerprint": origin.fingerprint,
"origin_schema_version": origin.schema_version,
},
metadata=dict(item.metadata_),
governance=_datasource_governance(item),
),
)
def register_origin(
self,
session: object,
@@ -973,6 +1203,13 @@ class SqlDatasourceProvider:
raise DatasourceValidationError(
"Only cached connector-backed datasources can be refreshed."
)
approval_policy = normalize_approval_policy(
_datasource_governance(item).approval_policy
)
if approval_policy["required"]:
raise DatasourceValidationError(
"This datasource requires an approved refresh stage before it can become current."
)
rows, origin = self._read_origin_all(
db,
api_principal,
@@ -988,6 +1225,68 @@ class SqlDatasourceProvider:
)
return _datasource_dto(item), _materialization_dto(materialization)
def preview_retention(
self,
session: object,
principal: object,
*,
as_of: datetime,
) -> RetentionPlan:
db, api_principal = _context(session, principal, ADMIN_SCOPE)
return build_retention_plan(
db,
tenant_id=api_principal.tenant_id,
as_of=as_of,
)
def apply_retention(
self,
session: object,
principal: object,
*,
as_of: datetime,
plan_hash: str,
target_refs: Sequence[str],
) -> tuple[tuple[str, ...], tuple[str, ...]]:
db, api_principal = _context(session, principal, ADMIN_SCOPE)
actor_ref = _actor_id(api_principal)
if actor_ref is None:
raise DatasourceValidationError(
"An attributable account is required for retention execution."
)
plan = build_retention_plan(
db,
tenant_id=api_principal.tenant_id,
as_of=as_of,
)
if plan.plan_hash != plan_hash:
raise DatasourceValidationError(
"The retention plan changed; preview it again before applying."
)
return apply_retention_plan(
db,
tenant_id=api_principal.tenant_id,
actor_ref=actor_ref,
plan=plan,
target_refs=target_refs,
)
def list_lifecycle_evidence(
self,
session: object,
principal: object,
*,
subject_ref: str | None = None,
limit: int = 200,
):
db, api_principal = _context(session, principal, CATALOGUE_READ_SCOPE)
return list_lifecycle_evidence(
db,
tenant_id=api_principal.tenant_id,
subject_ref=subject_ref,
limit=limit,
)
def freeze_datasource(
self,
session: object,
@@ -1029,6 +1328,11 @@ class SqlDatasourceProvider:
raise DatasourceUnavailableError(
"The datasource has no current state to freeze."
)
if current.csv_source_ is not None:
try:
verified_csv_source_text(current.csv_source_, expected_summary=current.metadata_.get("csv_source") or {})
except TabularSourceError as exc:
raise DatasourceUnavailableError(str(exc)) from exc
current_payload = payload_for_materialization(db, current)
materialization = _append_materialization(
db,
@@ -1041,6 +1345,8 @@ class SqlDatasourceProvider:
frozen=True,
frozen_label=label,
source_timestamp=current.source_timestamp,
csv_source=current.csv_source_,
csv_source_governance=current.governance_snapshot_,
provenance={
**dict(current.provenance_),
"frozen_from": _materialization_ref(current.id),
@@ -1296,8 +1602,9 @@ class SqlDatasourceProvider:
schema: Sequence[DatasourceField],
action: str = "read",
additional_policies: Sequence[Mapping[str, object]] = (),
governance_override: DatasourceGovernance | None = None,
) -> VisibilityPlan:
governance = _datasource_governance(item)
governance = governance_override or _datasource_governance(item)
policies: list[Mapping[str, object]] = []
if governance.visibility_policy:
policies.append(governance.visibility_policy)
@@ -1512,6 +1819,8 @@ def _append_materialization(
set_current: bool,
reusable_payload: DatasourcePayloadRecord | None = None,
state: str = "published",
csv_source: Mapping[str, object] | None = None,
csv_source_governance: Mapping[str, object] | None = None,
) -> DatasourceMaterializationRecord:
datasource = _lock_datasource_for_materialization(session, datasource)
revision = _allocate_materialization_revision(session, datasource)
@@ -1534,6 +1843,18 @@ def _append_materialization(
datasource,
schema,
)
csv_payload = dict(csv_source) if csv_source is not None else None
if csv_payload is not None:
history = csv_payload.get("governance_history", [])
if not isinstance(history, list) or any(not isinstance(value, Mapping) for value in history):
raise DatasourceValidationError("Original CSV inherited governance is invalid.")
history = [dict(value) for value in history]
for snapshot in (csv_source_governance, _datasource_governance(datasource).to_dict()):
if snapshot is not None and dict(snapshot) not in history:
history.append(dict(snapshot))
if len(history) > 32:
raise DatasourceValidationError("Original CSV governance history exceeds the safe copy limit; review the source before creating a new stage.")
csv_payload["governance_history"] = history
materialization = DatasourceMaterializationRecord(
tenant_id=datasource.tenant_id,
datasource_id=datasource.id,
@@ -1544,6 +1865,7 @@ def _append_materialization(
payload_id=payload.id,
payload_checksum=payload.checksum,
rows=[],
csv_source_=csv_payload,
fingerprint=fingerprint,
row_count=payload.row_count,
byte_count=payload.byte_count,
@@ -1551,7 +1873,7 @@ def _append_materialization(
frozen_label=_clean_optional(frozen_label),
source_timestamp=source_timestamp,
provenance_=dict(provenance or {}),
metadata_=dict(metadata or {}),
metadata_={**dict(metadata or {}), **({"csv_source": csv_source_summary(csv_payload)} if csv_payload is not None else {})},
governance_snapshot_=_datasource_governance(datasource).to_dict(),
created_by=actor_id,
)
@@ -1741,16 +2063,18 @@ def _required_stage(
*,
tenant_id: str,
stage_ref: str,
for_update: bool = False,
) -> DatasourceStageRecord:
stage_id = _strip_ref(stage_ref, "stage:")
if stage_id is None:
raise DatasourceNotFoundError("Datasource stage not found.")
item = session.scalar(
select(DatasourceStageRecord).where(
statement = select(DatasourceStageRecord).where(
DatasourceStageRecord.id == stage_id,
DatasourceStageRecord.tenant_id == tenant_id,
)
)
if for_update:
statement = statement.with_for_update()
item = session.scalar(statement)
if item is None:
raise DatasourceNotFoundError("Datasource stage not found.")
return item
@@ -1817,6 +2141,8 @@ def _datasource_governance(item: DatasourceRecord) -> DatasourceGovernance:
"transfer_agreement_ref": item.transfer_agreement_ref,
"freshness_policy": item.freshness_policy,
"quality_policy": item.quality_policy,
"approval_policy": item.approval_policy,
"retention_policy": item.retention_policy,
"known_limits": item.known_limits,
"correction_procedure_ref": item.correction_procedure_ref,
"affected_refs": item.affected_refs,
@@ -1855,6 +2181,8 @@ def _apply_datasource_governance(
item.transfer_agreement_ref = governance.transfer_agreement_ref
item.freshness_policy = dict(governance.freshness_policy)
item.quality_policy = dict(governance.quality_policy)
item.approval_policy = normalize_approval_policy(governance.approval_policy)
item.retention_policy = normalize_retention_policy(governance.retention_policy)
item.known_limits = list(governance.known_limits)
item.correction_procedure_ref = governance.correction_procedure_ref
item.affected_refs = list(governance.affected_refs)
@@ -1922,6 +2250,8 @@ def _materialization_dto(
frozen_label=item.frozen_label,
source_timestamp=item.source_timestamp,
created_at=item.created_at,
disposed_at=item.disposed_at,
disposition=dict(item.disposition_),
provenance=dict(item.provenance_),
metadata=dict(item.metadata_),
governance=DatasourceGovernance.from_mapping(item.governance_snapshot_),
@@ -1947,6 +2277,7 @@ def _stage_dto(item: DatasourceStageRecord) -> DatasourceStage:
row_count=item.row_count,
byte_count=item.byte_count,
validation=dict(item.validation_),
approval=dict(item.approval_),
created_at=item.created_at,
promoted_at=item.promoted_at,
promoted_materialization_ref=(
@@ -2689,6 +3020,7 @@ __all__ = [
"ADMIN_SCOPE",
"CATALOGUE_READ_SCOPE",
"SOURCE_WRITE_SCOPE",
"STAGE_APPROVE_SCOPE",
"STAGE_WRITE_SCOPE",
"SqlDatasourceProvider",
]
+18 -37
View File
@@ -10,6 +10,8 @@ from decimal import Decimal
from typing import Any
from govoplan_core.core.datasources import DatasourceField, DatasourceValidationError
from govoplan_core.core.tabular_sources import CsvValueMode, TabularSourceError, parse_tabular_csv
from govoplan_core.core.tabular_sources import infer_tabular_schema, tabular_type_name as _type_name
MAX_STAGE_ROWS = 10_000
@@ -36,10 +38,22 @@ def parse_csv_rows(
csv_text: str,
*,
delimiter: str = ",",
value_mode: CsvValueMode = "legacy_typed",
) -> tuple[dict[str, Any], ...]:
if delimiter not in {",", ";", "\t", "|"}:
raise DatasourceValidationError("Unsupported CSV delimiter.")
if len(csv_text.encode("utf-8")) > MAX_STAGE_BYTES:
if value_mode == "text":
try:
return normalize_rows(parse_tabular_csv(csv_text, delimiter=delimiter, value_mode="text", max_rows=MAX_STAGE_ROWS, max_bytes=MAX_STAGE_BYTES))
except TabularSourceError as exc:
raise DatasourceValidationError(str(exc)) from exc
if value_mode != "legacy_typed":
raise DatasourceValidationError("Unsupported CSV value mode.")
try:
encoded_text = csv_text.encode("utf-8")
except UnicodeError as exc:
raise DatasourceValidationError("CSV input must be valid Unicode encodable as UTF-8.") from exc
if len(encoded_text) > MAX_STAGE_BYTES:
raise DatasourceValidationError(
f"Staging is limited to {MAX_STAGE_BYTES // 1_000_000} MB."
)
@@ -58,6 +72,8 @@ def parse_csv_rows(
raise DatasourceValidationError("CSV headers must be unique.")
rows: list[dict[str, object]] = []
for line_number, values in enumerate(reader, start=2):
if len(rows) >= MAX_STAGE_ROWS:
raise DatasourceValidationError(f"Staging is limited to {MAX_STAGE_ROWS:,} rows.")
if len(values) != len(header):
raise DatasourceValidationError(
f"CSV row {line_number} has {len(values)} values; expected {len(header)}."
@@ -76,26 +92,7 @@ def parse_csv_rows(
def infer_schema(
rows: Sequence[Mapping[str, object]],
) -> tuple[DatasourceField, ...]:
names: list[str] = []
for row in rows:
for name in row:
if name not in names:
names.append(name)
result: list[DatasourceField] = []
for name in names:
values = [row.get(name) for row in rows]
concrete = [value for value in values if value is not None]
data_type = _type_name(concrete[0]) if concrete else "unknown"
if any(_type_name(value) != data_type for value in concrete[1:]):
data_type = "mixed"
result.append(
DatasourceField(
name=name,
data_type=data_type,
nullable=len(concrete) != len(values),
)
)
return tuple(result)
return tuple(DatasourceField(name=column.name, data_type=column.data_type, nullable=column.nullable) for column in infer_tabular_schema(rows, type_name=_type_name))
def fingerprint_rows(
@@ -168,22 +165,6 @@ def _json_value(value: object) -> object:
raise TypeError(f"{type(value).__name__} is not JSON serializable")
def _type_name(value: object) -> str:
if isinstance(value, bool):
return "boolean"
if isinstance(value, int):
return "integer"
if isinstance(value, (float, Decimal)):
return "number"
if isinstance(value, str):
return "string"
if isinstance(value, list):
return "array"
if isinstance(value, dict):
return "object"
return type(value).__name__.lower()
def _csv_value(value: str) -> object:
cleaned = value.strip()
if not cleaned:
+49
View File
@@ -20,6 +20,7 @@ from govoplan_core.privacy.dsar_workflow import (
)
from govoplan_datasources.backend.db.models import (
DatasourceGovernanceReferenceRecord,
DatasourceLifecycleEvidenceRecord,
DatasourceMaterializationRecord,
DatasourcePayloadRecord,
DatasourcePayloadRowRecord,
@@ -382,6 +383,54 @@ class DatasourcesDsarProviderTests(unittest.TestCase):
self.assertEqual((), wrong_tenant)
self.assertEqual((), conflict)
def test_lifecycle_evidence_is_minimized_and_immutable(self) -> None:
evidence = DatasourceLifecycleEvidenceRecord(
id="evidence-1",
tenant_id="tenant-1",
subject_ref="datasource:datasource-1",
event_type="retention.applied",
occurred_at=NOW,
actor_ref="account-1",
policy_version="retention-v1",
policy_hash="1" * 64,
subject_digest="2" * 64,
event_hash="3" * 64,
details_={"secret": SECRET},
)
self.session.add(evidence)
self.session.commit()
exact_subject = DsarSubjectRef(
external_references={
"datasources.lifecycle_evidence": "evidence-1",
}
)
exact = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=exact_subject,
)
self.assertEqual(1, len(exact))
self.assertEqual("datasource_operator_attribution", exact[0].category)
self.assertNotIn(SECRET, json.dumps(exact[0].to_dict()))
actions = self.provider.plan_erasure(
self.session,
tenant_id="tenant-1",
subject=exact_subject,
records=exact,
)
self.assertEqual({"retain"}, {action.kind for action in actions})
canonical = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(account_id="account-1"),
)
self.assertIn(
"datasource_lifecycle_evidence",
{record.resource_type for record in canonical},
)
def test_transient_deletion_is_safe_and_idempotent(self) -> None:
subject = DsarSubjectRef(
external_references={
+23 -2
View File
@@ -6,6 +6,14 @@ from govoplan_datasources.backend.manifest import manifest
class DatasourcesInterfaceDocumentationContractTests(unittest.TestCase):
def test_all_static_topics_have_complete_german_content(self) -> None:
for topic in manifest.documentation:
german = (topic.translations or {}).get("de", {})
self.assertEqual({"title", "summary", "body"}, set(german), topic.id)
self.assertTrue(
all(str(value).strip() for value in german.values()), topic.id
)
def test_route_and_surfaces_remain_declared(self) -> None:
frontend = manifest.frontend
self.assertIsNotNone(frontend)
@@ -18,6 +26,8 @@ class DatasourcesInterfaceDocumentationContractTests(unittest.TestCase):
"datasources.origins",
"datasources.governance",
"datasources.preview",
"datasources.lifecycle-evidence",
"datasources.retention",
},
{item.id for item in frontend.view_surfaces}, # type: ignore[union-attr]
)
@@ -29,10 +39,15 @@ class DatasourcesInterfaceDocumentationContractTests(unittest.TestCase):
quality = topics["datasources.quality-gates"]
visibility = topics["datasources.visibility"]
reference = topics["datasources.reference.fields-and-consequences"]
lifecycle_controls = topics["datasources.approval-and-retention"]
self.assertIn("datasources.staging", lifecycle.metadata["help_contexts"])
self.assertIn("datasources.field.authority-mode", governance.metadata["help_contexts"])
self.assertIn("datasources.staging.validation", quality.metadata["help_contexts"])
self.assertIn(
"datasources.field.authority-mode", governance.metadata["help_contexts"]
)
self.assertIn(
"datasources.staging.validation", quality.metadata["help_contexts"]
)
self.assertIn(
"datasources.field.visibility-policy",
visibility.metadata["help_contexts"],
@@ -43,6 +58,12 @@ class DatasourcesInterfaceDocumentationContractTests(unittest.TestCase):
self.assertIn("datasources.action.promote", reference.metadata["help_contexts"])
self.assertIn("freeze", reference.metadata["consequence_classes"])
self.assertIn("retire", reference.metadata["consequence_classes"])
self.assertEqual("reference", reference.metadata["kind"])
self.assertIn(
"datasources.action.approve", lifecycle_controls.metadata["help_contexts"]
)
self.assertIn("hash-chained lifecycle evidence", lifecycle_controls.body)
self.assertTrue(lifecycle_controls.translations["de"]["body"])
if __name__ == "__main__":
+90
View File
@@ -1,6 +1,10 @@
from __future__ import annotations
import unittest
from dataclasses import replace
from unittest.mock import patch
from fastapi import HTTPException
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
@@ -24,6 +28,9 @@ from govoplan_core.core.datasources import (
DatasourceValidationError,
)
from govoplan_core.core.tabular_sources import (
TabularCsvSource,
parse_tabular_csv,
csv_source_payload,
TabularPreviewDiagnostic,
TabularPushdown,
TabularSourceHealth,
@@ -31,6 +38,7 @@ from govoplan_core.core.tabular_sources import (
from govoplan_core.db.base import Base, utcnow
from govoplan_datasources.backend.db.models import (
DatasourceGovernanceReferenceRecord,
DatasourceLifecycleEvidenceRecord,
DatasourceMaterializationRecord,
DatasourcePayloadRecord,
DatasourcePayloadRowRecord,
@@ -39,6 +47,7 @@ from govoplan_datasources.backend.db.models import (
DatasourceStageRecord,
)
from govoplan_datasources.backend.service import (
ADMIN_SCOPE,
CATALOGUE_READ_SCOPE,
SOURCE_WRITE_SCOPE,
STAGE_WRITE_SCOPE,
@@ -226,6 +235,7 @@ class DatasourceLifecycleTests(unittest.TestCase):
tables=[
DatasourceRecord.__table__,
DatasourceGovernanceReferenceRecord.__table__,
DatasourceLifecycleEvidenceRecord.__table__,
DatasourcePayloadRecord.__table__,
DatasourcePayloadRowRecord.__table__,
DatasourceMaterializationRecord.__table__,
@@ -248,6 +258,7 @@ class DatasourceLifecycleTests(unittest.TestCase):
Base.metadata.drop_all(
self.engine,
tables=[
DatasourceLifecycleEvidenceRecord.__table__,
DatasourceStageRecord.__table__,
DatasourcePublicationRecord.__table__,
DatasourceMaterializationRecord.__table__,
@@ -260,6 +271,85 @@ class DatasourceLifecycleTests(unittest.TestCase):
)
self.engine.dispose()
def test_original_csv_preserves_source_but_respects_current_and_historical_visibility(self) -> None:
text = 'value\r\n" keep me "\r\n0.123456789012345678901234567890\r\n" "\r\n'
source = TabularCsvSource(text=text, value_mode="text")
request = DatasourceStageInput(name="Text", source_name="csv_text", kind="upload", mode="static", shape="tabular", rows=parse_tabular_csv(text, value_mode="text"), csv_source=source)
with self.assertRaises(DatasourceValidationError):
self.provider.create_stage(self.session, principal(), stage=replace(request, rows=({"value": "changed"},)))
stage = self.provider.create_stage(self.session, principal(), stage=request)
descriptor, materialization = self.provider.promote_stage(self.session, principal(), stage_ref=stage.ref)
self.session.commit()
self.session.expunge_all()
admin = principal(scopes=(ADMIN_SCOPE,))
self.assertEqual(text, self.provider.original_csv(self.session, admin, datasource_ref=descriptor.ref, materialization_ref=materialization.ref))
from govoplan_datasources.backend.router import api_original_csv
with patch("govoplan_datasources.backend.router._provider", return_value=self.provider), patch("govoplan_datasources.backend.router._audit") as audit:
response = api_original_csv(descriptor.ref.split(":", 1)[1], materialization.ref.split(":", 1)[1], session=self.session, principal=admin)
self.assertEqual(text.encode("utf-8"), response.body)
self.assertEqual("no-store", response.headers["cache-control"])
self.assertEqual("datasources.original_csv.exported", audit.call_args.kwargs["action"])
self.assertNotIn(text, repr(audit.call_args.kwargs["details"]))
with patch("govoplan_datasources.backend.router._provider") as read, self.assertRaises(HTTPException) as denied:
api_original_csv("anything", "anything", session=self.session, principal=principal())
self.assertEqual(403, denied.exception.status_code)
read.assert_not_called()
frozen = self.provider.freeze_datasource(self.session, admin, datasource_ref=descriptor.ref)
self.assertEqual(text, self.provider.original_csv(self.session, admin, datasource_ref=descriptor.ref, materialization_ref=frozen.ref))
self.assertNotIn("text", descriptor.metadata["csv_source"])
self.assertNotIn("text", materialization.metadata["csv_source"])
with self.assertRaises(DatasourceAccessError):
self.provider.original_csv(self.session, principal(), datasource_ref=descriptor.ref, materialization_ref=materialization.ref)
from govoplan_core.core.datasources import DatasourceNotFoundError
with self.assertRaises(DatasourceNotFoundError):
self.provider.original_csv(self.session, principal("other-tenant", scopes=(ADMIN_SCOPE,)), datasource_ref=descriptor.ref, materialization_ref=materialization.ref)
record = self.session.get(DatasourceRecord, descriptor.ref.split(":", 1)[1])
record.visibility_policy = {"fields": {"value": {"classification": "restricted", "action": "omit", "allow": {"account_ids": ["other"]}}}}
self.session.flush()
with self.assertRaises(DatasourceAccessError):
self.provider.original_csv(self.session, admin, datasource_ref=descriptor.ref, materialization_ref=materialization.ref)
record.visibility_policy = {}
stored = self.session.get(DatasourceMaterializationRecord, materialization.ref.split(":", 1)[1])
stored.governance_snapshot_ = {**stored.governance_snapshot_, "visibility_policy": {"row_filters": [{"field": "value", "claim": "account_id"}]}}
self.session.flush()
with self.assertRaises(DatasourceAccessError):
self.provider.original_csv(self.session, admin, datasource_ref=descriptor.ref, materialization_ref=materialization.ref)
stored.governance_snapshot_ = {**stored.governance_snapshot_, "visibility_policy": {}}
stored.csv_source_ = {**stored.csv_source_, "text": "changed"}
self.session.flush()
with self.assertRaises(DatasourceUnavailableError):
self.provider.original_csv(self.session, admin, datasource_ref=descriptor.ref, materialization_ref=materialization.ref)
def test_csv_stage_projection_binding_rejects_equal_but_different_types(self) -> None:
for text, value in (("value\ntrue\n", 1), ("value\n1\n", True), ("value\n1\n", 1.0)):
with self.subTest(text=text, value=value), self.assertRaises(DatasourceValidationError):
self.provider.create_stage(self.session, principal(), stage=DatasourceStageInput(name="Invalid", source_name="invalid", kind="upload", mode="static", shape="tabular", rows=({"value": value},), csv_source=TabularCsvSource(text=text)))
def test_csv_invalid_unicode_is_validation_in_both_modes(self) -> None:
from govoplan_datasources.backend.tabular import parse_csv_rows
for mode in ("text", "legacy_typed"):
with self.subTest(mode=mode), self.assertRaisesRegex(DatasourceValidationError, "valid Unicode"):
parse_csv_rows("value\nprivate-\ud800\n", value_mode=mode)
def test_freezing_csv_preserves_historical_restrictions_and_rejects_resealed_drift(self) -> None:
source = TabularCsvSource(text='value\nprivate\n', value_mode="text")
governance = DatasourceGovernance(visibility_policy={"fields": {"value": {"classification": "restricted", "action": "omit", "allow": {"account_ids": ["other"]}}}})
stage = self.provider.create_stage(self.session, principal(), stage=DatasourceStageInput(name="Private CSV", source_name="private_csv", kind="upload", mode="static", shape="tabular", rows=parse_tabular_csv(source.text, value_mode="text"), csv_source=source, governance=governance))
descriptor, original = self.provider.promote_stage(self.session, principal(), stage_ref=stage.ref)
record = self.session.get(DatasourceRecord, descriptor.ref.split(":", 1)[1])
record.visibility_policy = {}
self.session.flush()
admin = principal(scopes=(ADMIN_SCOPE,))
frozen = self.provider.freeze_datasource(self.session, admin, datasource_ref=descriptor.ref)
for ref in (original.ref, frozen.ref):
with self.subTest(ref=ref), self.assertRaises(DatasourceAccessError):
self.provider.original_csv(self.session, admin, datasource_ref=descriptor.ref, materialization_ref=ref)
stored = self.session.get(DatasourceMaterializationRecord, original.ref.split(":", 1)[1])
stored.csv_source_ = csv_source_payload(TabularCsvSource(text="value\nchanged\n", value_mode="text"))
self.session.flush()
with self.assertRaises(DatasourceUnavailableError):
self.provider.freeze_datasource(self.session, admin, datasource_ref=descriptor.ref)
def test_static_stage_promote_update_and_frozen_read(self) -> None:
first_stage = self.provider.create_stage(
self.session,
+503
View File
@@ -0,0 +1,503 @@
from __future__ import annotations
from govoplan_core.core.tabular_sources import TabularCsvSource
import unittest
from datetime import timedelta
from sqlalchemy import create_engine, select
from sqlalchemy.orm import sessionmaker
from govoplan_core.auth import ApiPrincipal
from govoplan_core.core.access import PrincipalRef
from govoplan_core.core.datasources import (
CAPABILITY_DATASOURCE_ORIGINS,
DatasourceField,
DatasourceGovernance,
DatasourceOrigin,
DatasourceOriginReadRequest,
DatasourceOriginReadResult,
DatasourceReadRequest,
DatasourceStageInput,
DatasourceUnavailableError,
DatasourceValidationError,
)
from govoplan_core.core.tabular_sources import TabularPushdown, TabularSourceHealth
from govoplan_core.db.base import Base
from govoplan_datasources.backend.db.models import (
DatasourceGovernanceReferenceRecord,
DatasourceLifecycleEvidenceRecord,
DatasourceMaterializationRecord,
DatasourcePayloadRecord,
DatasourcePayloadRowRecord,
DatasourcePublicationRecord,
DatasourceRecord,
DatasourceStageRecord,
)
from govoplan_datasources.backend.service import (
CATALOGUE_READ_SCOPE,
SOURCE_WRITE_SCOPE,
STAGE_APPROVE_SCOPE,
STAGE_WRITE_SCOPE,
SqlDatasourceProvider,
)
def principal(
account_id: str,
*,
scopes: tuple[str, ...],
) -> ApiPrincipal:
return ApiPrincipal(
principal=PrincipalRef(
account_id=account_id,
membership_id=f"membership-{account_id}",
tenant_id="tenant-1",
scopes=frozenset(scopes),
),
account=object(),
user=object(),
)
class _OriginProvider:
def __init__(self) -> None:
self.rows = [{"id": 1, "status": "initial"}]
def origin(self) -> DatasourceOrigin:
return DatasourceOrigin(
ref="origin:cases",
source_name="cached_cases",
name="Cached cases",
kind="database",
shape="tabular",
supported_modes=("cached",),
provider="connectors.test",
schema=(
DatasourceField("id", "integer", False),
DatasourceField("status", "string", False),
),
schema_version="1",
fingerprint=f"cases-{self.rows[-1]['status']}",
row_count=len(self.rows),
source_mode="cached",
pushdown=TabularPushdown(pagination=True),
health=TabularSourceHealth(
status="healthy",
code="origin.ready",
summary="Origin is ready.",
),
)
def list_origins(self, _session, _principal, *, query="", limit=100):
del limit
origin = self.origin()
return (origin,) if query.casefold() in origin.name.casefold() else ()
def get_origin(self, _session, _principal, *, origin_ref):
return self.origin() if origin_ref == "origin:cases" else None
def read_origin(
self,
_session,
_principal,
*,
request: DatasourceOriginReadRequest,
) -> DatasourceOriginReadResult:
rows = self.rows[request.offset : request.offset + request.limit]
return DatasourceOriginReadResult(
origin=self.origin(),
rows=tuple(dict(row) for row in rows),
total_rows=len(self.rows),
truncated=request.offset + len(rows) < len(self.rows),
returned_bytes=64,
elapsed_ms=1,
effective_row_limit=request.limit,
effective_byte_limit=request.max_bytes,
effective_timeout_ms=request.timeout_ms,
)
class _Registry:
def __init__(self, origins: _OriginProvider) -> None:
self.origins = origins
def has_capability(self, name: str) -> bool:
return name == CAPABILITY_DATASOURCE_ORIGINS
def capability(self, name: str):
if not self.has_capability(name):
raise KeyError(name)
return self.origins
class DatasourceLifecycleGovernanceTests(unittest.TestCase):
def setUp(self) -> None:
self.engine = create_engine("sqlite:///:memory:")
self.tables = [
DatasourceRecord.__table__,
DatasourceGovernanceReferenceRecord.__table__,
DatasourcePayloadRecord.__table__,
DatasourcePayloadRowRecord.__table__,
DatasourceMaterializationRecord.__table__,
DatasourceStageRecord.__table__,
DatasourcePublicationRecord.__table__,
DatasourceLifecycleEvidenceRecord.__table__,
]
Base.metadata.create_all(self.engine, tables=self.tables)
self.session = sessionmaker(bind=self.engine)()
self.origins = _OriginProvider()
self.provider = SqlDatasourceProvider(registry=_Registry(self.origins))
self.writer = principal(
"writer",
scopes=(
CATALOGUE_READ_SCOPE,
SOURCE_WRITE_SCOPE,
STAGE_WRITE_SCOPE,
),
)
def tearDown(self) -> None:
self.session.close()
Base.metadata.drop_all(self.engine, tables=list(reversed(self.tables)))
self.engine.dispose()
def test_approval_quorum_is_attributable_idempotent_and_separated(self) -> None:
stage = self.provider.create_stage(
self.session,
self.writer,
stage=DatasourceStageInput(
name="Approval register",
source_name="approval_register",
kind="upload",
mode="static",
shape="tabular",
rows=({"id": 1},),
governance=DatasourceGovernance(
approval_policy={
"version": "promotion-v2",
"required": True,
"required_approvals": 2,
"separation_of_duties": True,
}
),
),
)
self.assertEqual("awaiting_approval", stage.state)
policy_hash = str(stage.approval["policy_hash"])
subject_digest = str(stage.approval["subject_digest"])
creator_approver = principal(
"writer",
scopes=(STAGE_APPROVE_SCOPE,),
)
with self.assertRaisesRegex(
DatasourceValidationError,
"creator cannot approve",
):
self.provider.decide_stage(
self.session,
creator_approver,
stage_ref=stage.ref,
decision="approve",
reason="Creator review",
expected_policy_hash=policy_hash,
expected_subject_digest=subject_digest,
)
first, first_hash, replayed = self.provider.decide_stage(
self.session,
principal("approver-1", scopes=(STAGE_APPROVE_SCOPE,)),
stage_ref=stage.ref,
decision="approve",
reason="Quality and schema evidence reviewed.",
expected_policy_hash=policy_hash,
expected_subject_digest=subject_digest,
)
self.assertFalse(replayed)
self.assertTrue(first_hash)
self.assertEqual("awaiting_approval", first.state)
replay, replay_hash, replayed = self.provider.decide_stage(
self.session,
principal("approver-1", scopes=(STAGE_APPROVE_SCOPE,)),
stage_ref=stage.ref,
decision="approve",
reason="Quality and schema evidence reviewed.",
expected_policy_hash=policy_hash,
expected_subject_digest=subject_digest,
)
self.assertTrue(replayed)
self.assertIsNone(replay_hash)
self.assertEqual(1, replay.approval["approval_count"])
approved, second_hash, replayed = self.provider.decide_stage(
self.session,
principal("approver-2", scopes=(STAGE_APPROVE_SCOPE,)),
stage_ref=stage.ref,
decision="approve",
reason="Authority and promotion impact reviewed.",
expected_policy_hash=policy_hash,
expected_subject_digest=subject_digest,
)
self.assertFalse(replayed)
self.assertTrue(second_hash)
self.assertEqual("ready", approved.state)
datasource, materialization = self.provider.promote_stage(
self.session,
self.writer,
stage_ref=stage.ref,
)
self.assertEqual(2, materialization.provenance["stage_approval"]["approval_count"])
self.assertTrue(materialization.provenance["promotion_evidence_hash"])
self.assertEqual(materialization.ref, datasource.current_materialization_ref)
evidence = tuple(
reversed(
self.provider.list_lifecycle_evidence(
self.session,
self.writer,
subject_ref=stage.ref,
)
)
)
self.assertEqual(
["stage.validated", "stage.approved", "stage.approved", "stage.promoted"],
[item.event_type for item in evidence],
)
for previous, current in zip(evidence, evidence[1:], strict=False):
self.assertEqual(previous.event_hash, current.previous_event_hash)
def test_approved_refresh_stage_is_required_before_current_changes(self) -> None:
datasource = self.provider.register_origin(
self.session,
self.writer,
origin_ref="origin:cases",
name="Cached cases",
source_name="cached_cases",
mode="cached",
governance=DatasourceGovernance(
approval_policy={
"version": "refresh-v1",
"required": True,
"required_approvals": 1,
}
),
)
original_ref = datasource.current_materialization_ref
self.origins.rows = [{"id": 1, "status": "refreshed"}]
with self.assertRaisesRegex(
DatasourceValidationError,
"approved refresh stage",
):
self.provider.refresh_datasource(
self.session,
self.writer,
datasource_ref=datasource.ref,
)
stage = self.provider.prepare_refresh(
self.session,
self.writer,
datasource_ref=datasource.ref,
)
self.assertEqual("awaiting_approval", stage.state)
approved, _, _ = self.provider.decide_stage(
self.session,
principal("refresh-approver", scopes=(STAGE_APPROVE_SCOPE,)),
stage_ref=stage.ref,
decision="approve",
reason="The connector delta and schema are acceptable.",
expected_policy_hash=str(stage.approval["policy_hash"]),
expected_subject_digest=str(stage.approval["subject_digest"]),
)
self.assertEqual("ready", approved.state)
refreshed, current = self.provider.promote_stage(
self.session,
self.writer,
stage_ref=stage.ref,
)
self.assertNotEqual(original_ref, refreshed.current_materialization_ref)
self.assertEqual(current.ref, refreshed.current_materialization_ref)
preview = self.provider.read_datasource(
self.session,
self.writer,
request=DatasourceReadRequest(datasource_ref=datasource.ref),
)
self.assertEqual("refreshed", preview.rows[0]["status"])
def test_retention_preview_blocks_current_and_held_evidence_then_purges_payload(self) -> None:
governance = DatasourceGovernance(
retention_policy={
"version": "records-v3",
"enabled": True,
"materialization_days": 1,
"frozen_evidence_days": 1,
}
)
first_stage = self.provider.create_stage(
self.session,
self.writer,
stage=DatasourceStageInput(
name="Retained register",
source_name="retained_register",
kind="upload",
mode="static",
shape="tabular",
rows=({"id": 1},),
csv_source=TabularCsvSource(text="id\n1\n"),
governance=governance,
),
)
datasource, first = self.provider.promote_stage(
self.session,
self.writer,
stage_ref=first_stage.ref,
)
second_stage = self.provider.create_stage(
self.session,
self.writer,
stage=DatasourceStageInput(
name="Retained register",
source_name="retained_register",
kind="upload",
mode="static",
shape="tabular",
rows=({"id": 2},),
target_datasource_ref=datasource.ref,
),
)
_, second = self.provider.promote_stage(
self.session,
self.writer,
stage_ref=second_stage.ref,
)
as_of = max(first.created_at, second.created_at) + timedelta(days=2)
plan = self.provider.preview_retention(
self.session,
principal("admin", scopes=("datasources:source:admin",)),
as_of=as_of,
)
by_ref = {item.ref: item for item in plan.candidates}
self.assertTrue(by_ref[first.ref].eligible)
self.assertFalse(by_ref[second.ref].eligible)
self.assertIn("current_materialization", by_ref[second.ref].blockers)
first_row = self.session.scalar(
select(DatasourceMaterializationRecord).where(
DatasourceMaterializationRecord.id
== first.ref.removeprefix("materialization:")
)
)
payload_id = first_row.payload_id
self.assertIsNotNone(first_row.csv_source_)
disposed, evidence_hashes = self.provider.apply_retention(
self.session,
principal("admin", scopes=("datasources:source:admin",)),
as_of=as_of,
plan_hash=plan.plan_hash,
target_refs=(first.ref,),
)
self.assertEqual((first.ref,), disposed)
self.assertEqual(1, len(evidence_hashes))
self.assertIsNone(self.session.get(DatasourcePayloadRecord, payload_id))
self.assertIsNotNone(first_row.disposed_at)
self.assertIsNone(first_row.csv_source_)
self.assertEqual("disposed", first_row.state)
with self.assertRaises(DatasourceUnavailableError):
self.provider.read_datasource(
self.session,
self.writer,
request=DatasourceReadRequest(
datasource_ref=datasource.ref,
materialization_ref=first.ref,
),
)
held = self.provider.update_datasource_governance(
self.session,
self.writer,
datasource_ref=datasource.ref,
governance=DatasourceGovernance(
retention_policy=governance.retention_policy,
hold_refs=("hold:legal-1",),
),
)
frozen = self.provider.freeze_datasource(
self.session,
self.writer,
datasource_ref=held.ref,
label="Legal evidence",
)
held_plan = self.provider.preview_retention(
self.session,
principal("admin", scopes=("datasources:source:admin",)),
as_of=frozen.created_at + timedelta(days=2),
)
held_candidate = next(item for item in held_plan.candidates if item.ref == frozen.ref)
self.assertFalse(held_candidate.eligible)
self.assertIn("legal_hold", held_candidate.blockers)
def test_retention_deletes_only_an_explicitly_selected_eligible_stage(self) -> None:
stage = self.provider.create_stage(
self.session,
self.writer,
stage=DatasourceStageInput(
name="Transient import",
source_name="transient_import",
kind="upload",
mode="static",
shape="tabular",
rows=({"id": 1},),
csv_source=TabularCsvSource(text="id\n1\n"),
governance=DatasourceGovernance(
retention_policy={
"version": "stage-retention-v1",
"enabled": True,
"stage_days": 1,
}
),
),
)
admin = principal(
"admin",
scopes=("datasources:source:admin",),
)
as_of = stage.created_at + timedelta(days=2)
plan = self.provider.preview_retention(
self.session,
admin,
as_of=as_of,
)
candidate = next(item for item in plan.candidates if item.ref == stage.ref)
self.assertTrue(candidate.eligible)
self.assertEqual("delete_stage", candidate.disposition)
disposed, evidence_hashes = self.provider.apply_retention(
self.session,
admin,
as_of=as_of,
plan_hash=plan.plan_hash,
target_refs=(stage.ref,),
)
self.assertEqual((stage.ref,), disposed)
self.assertEqual(1, len(evidence_hashes))
self.assertIsNone(
self.session.get(
DatasourceStageRecord,
stage.ref.removeprefix("stage:"),
)
)
evidence = self.provider.list_lifecycle_evidence(
self.session,
self.writer,
subject_ref=stage.ref,
)
self.assertEqual("retention.stage_deleted", evidence[0].event_type)
self.assertEqual(plan.plan_hash, evidence[0].details_["plan_hash"])
if __name__ == "__main__":
unittest.main()
+37
View File
@@ -0,0 +1,37 @@
from __future__ import annotations
import unittest
from pathlib import Path
ROOT = Path(__file__).resolve().parents[1]
PAGE = ROOT / "webui" / "src" / "features" / "datasources" / "DatasourcesPage.tsx"
API = ROOT / "webui" / "src" / "api" / "datasources.ts"
class DatasourceLifecycleGovernanceUiTests(unittest.TestCase):
def test_stage_decisions_and_retention_use_shared_semantic_primitives(self) -> None:
source = PAGE.read_text(encoding="utf-8")
self.assertIn("<WorkspaceActionBar", source)
self.assertIn("function StageDecisionDialog", source)
self.assertIn("function RetentionDialog", source)
self.assertIn("<ConfirmDialog", source)
self.assertIn('variant="danger"', source)
self.assertIn("datasources.field.approval-policy", source)
self.assertIn("datasources.field.retention-policy-contract", source)
self.assertIn('state === "awaiting_approval"', source)
def test_client_binds_decisions_and_apply_to_server_evidence(self) -> None:
source = API.read_text(encoding="utf-8")
self.assertIn("expected_policy_hash", source)
self.assertIn("expected_subject_digest", source)
self.assertIn("/lifecycle-evidence", source)
self.assertIn("/retention/plan", source)
self.assertIn("plan_hash: plan.plan_hash", source)
self.assertIn("/refresh/stage", source)
if __name__ == "__main__":
unittest.main()
+4
View File
@@ -31,6 +31,10 @@ class DatasourceManifestTests(unittest.TestCase):
if item.name == "connectors.datasource_origins"
)
self.assertTrue(requirement.optional)
self.assertIn(
"datasources:stage:approve",
{item.scope for item in manifest.permissions},
)
if __name__ == "__main__":
+63 -1
View File
@@ -14,6 +14,47 @@ from govoplan_datasources.backend.manifest import get_manifest
class DatasourceMigrationTests(unittest.TestCase):
def test_csv_evidence_upgrade_preserves_legacy_rows_and_fingerprints(self) -> None:
with tempfile.TemporaryDirectory(prefix="govoplan-datasources-csv-migration-") as directory:
url = f"sqlite:///{Path(directory) / 'datasources.db'}"
config = self._config(url)
command.upgrade(config, "d1a7c3e9f5b2")
engine = create_engine(url)
try:
metadata = MetaData()
tables = {name: Table(name, metadata, autoload_with=engine) for name in (
"datasource_catalogue", "datasource_stages", "datasource_materializations",
)}
now = datetime.now(UTC)
common = dict(tenant_id="tenant-1", schema=[], fingerprint="a" * 64,
metadata={"retained": True}, provenance={}, created_at=now, updated_at=now)
with engine.begin() as connection:
connection.execute(tables["datasource_catalogue"].insert().values(
**common, id="legacy-source", source_name="legacy", name="Legacy", kind="upload",
mode="static", shape="tabular", status="active", schema_version=1,
))
connection.execute(tables["datasource_stages"].insert().values(
**common, id="legacy-stage", source_name="staged", name="Staged", kind="upload",
mode="static", shape="tabular", state="ready", rows=[{"id": 1}],
row_count=1, byte_count=10, validation={}, governance={}, approval={},
))
connection.execute(tables["datasource_materializations"].insert().values(
**common, id="legacy-materialization", datasource_id="legacy-source", revision=1,
state="published", schema_version=1, rows=[{"id": 1}], row_count=1,
byte_count=10, governance_snapshot={},
))
before = {name: dict(connection.execute(select(table)).mappings().one()) for name, table in tables.items()}
command.upgrade(config, "e2b8d4a0f6c3")
with engine.connect() as connection:
for name in tables:
upgraded = Table(name, MetaData(), autoload_with=connection)
after = dict(connection.execute(select(upgraded)).mappings().one())
if name != "datasource_catalogue":
self.assertIsNone(after.pop("csv_source"))
self.assertEqual(before[name], after)
finally:
engine.dispose()
@staticmethod
def _config(url: str):
return alembic_config(
@@ -34,7 +75,7 @@ class DatasourceMigrationTests(unittest.TestCase):
try:
with engine.connect() as connection:
self.assertIn(
"c9e3a6f1d4b8",
"e2b8d4a0f6c3",
set(MigrationContext.configure(connection).get_current_heads()),
)
catalogue_columns = {
@@ -52,13 +93,34 @@ class DatasourceMigrationTests(unittest.TestCase):
"quality_policy",
"access_policy_ref",
"visibility_policy",
"approval_policy",
"retention_policy",
"dependency_refs",
}.issubset(catalogue_columns)
)
stage_columns = {
item["name"]
for item in inspect(connection).get_columns(
"datasource_stages"
)
}
materialization_columns = {
item["name"]
for item in inspect(connection).get_columns(
"datasource_materializations"
)
}
self.assertIn("approval", stage_columns)
self.assertTrue(
{"disposed_at", "disposition"}.issubset(
materialization_columns
)
)
self.assertEqual(
{
"datasource_catalogue",
"datasource_governance_references",
"datasource_lifecycle_evidence",
"datasource_materializations",
"datasource_payload_rows",
"datasource_payloads",
+4 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@govoplan/datasources-webui",
"version": "0.1.20",
"version": "0.1.26",
"private": true,
"type": "module",
"main": "src/index.ts",
@@ -14,10 +14,11 @@
"./styles/datasources.css": "./src/styles/datasources.css"
},
"scripts": {
"typecheck": "tsc --noEmit"
"typecheck": "tsc --noEmit",
"test:detail-refresh": "node --test scripts/test-detail-refresh.mjs"
},
"peerDependencies": {
"@govoplan/core-webui": "^0.1.18",
"@govoplan/core-webui": "^0.1.46",
"lucide-react": "^1.23.0",
"react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20",
+258
View File
@@ -0,0 +1,258 @@
import assert from "node:assert/strict";
import { readFileSync } from "node:fs";
import { createRequire } from "node:module";
import test from "node:test";
const require = createRequire(new URL("../../../govoplan-core/webui/package.json", import.meta.url));
const { transformSync } = require("esbuild");
const page = readFileSync(new URL("../src/features/datasources/DatasourcesPage.tsx", import.meta.url), "utf8");
function extract(startMarker, endMarker) {
const start = page.indexOf(startMarker);
const end = page.indexOf(endMarker, start);
assert.ok(start >= 0 && end > start, "test the actual page closures");
return page.slice(start + startMarker.length, end);
}
const reloadBody = extract(" const reload = useCallback(async (preferredDatasourceRef?: string) => {", " }, [dialogScope]);");
const detailBody = extract(" useEffect(() => {\n if (!selectedDatasourceRef || loading || !catalogueReady)", " }, [selectedDatasourceRef, detailScope, loading, catalogueReady]);");
function evaluate(body, bindings) {
const code = transformSync(body, { loader: "ts", target: "es2022" }).code;
return new Function(...Object.keys(bindings), code)(...Object.values(bindings));
}
const deferred = () => {
let resolve, reject;
const promise = new Promise((yes, no) => { resolve = yes; reject = no; });
return { promise, resolve, reject };
};
const settle = async () => { await Promise.resolve(); await Promise.resolve(); await Promise.resolve(); };
function harness() {
const state = { selectedDatasourceRef: "source-1", loading: false, detailRevision: 0, preview: null, materializations: [], detailLoading: false, catalogueAuthority: 0 };
const settings = {};
const auth = {};
const bindings = {
settings, auth, reloadRequestId: { current: 0 }, authority: { current: "authority-A" }, authorityKey: "authority-A", dialogScope: 0, authorityEpoch: { current: { revision: 0 } },
currentDetailScope: { current: null }, apiErrorMessage: String,
listDatasources: async () => [{ ref: "source-1" }], listDatasourceStages: async () => [],
listDatasourceOrigins: async () => ({ origins: [], available: false })
};
bindings.isCurrentAuthority = () => bindings.authority.current === "authority-A" && bindings.authorityEpoch.current.revision === 0;
for (const key of ["loading", "error", "datasources", "stages", "origins", "originsAvailable", "detailRevision", "selectedDatasourceRef", "selectedStageRef", "selectedOriginRef", "preview", "materializations", "detailLoading", "detailResponseScope", "catalogueAuthority", "working", "success", "view", "addOpen", "freezeOpen", "freezeLabel", "retireOpen", "promoteOpen", "governanceOpen", "decisionOpen", "retentionOpen"]) {
bindings[`set${key[0].toUpperCase()}${key.slice(1)}`] = (value) => { state[key] = typeof value === "function" ? value(state[key]) : value; };
}
return {
state, bindings,
reload: (preferredDatasourceRef) => evaluate(`return (async () => {${reloadBody}})();`, { ...bindings, preferredDatasourceRef }),
startDetail: () => {
const preview = deferred();
const history = deferred();
const scope = {};
bindings.currentDetailScope.current = scope;
const cleanup = evaluate(`if (!selectedDatasourceRef || loading || !catalogueReady)${detailBody}`, {
...bindings, selectedDatasourceRef: state.selectedDatasourceRef, loading: state.loading, detailScope: scope,
catalogueReady: state.catalogueAuthority === bindings.authorityEpoch.current.revision,
previewDatasource: () => preview.promise, listDatasourceMaterializations: () => history.promise
});
return { preview, history, scope, cleanup };
}
};
}
test("same-reference reload invalidates preview/history once, including freeze with an unchanged current materialization", async () => {
const h = harness();
for (const operation of ["manual reload", "refresh", "freeze", "promotion"]) {
const previous = h.state.detailRevision;
await h.reload("source-1");
assert.equal(h.state.selectedDatasourceRef, "source-1", operation);
assert.equal(h.state.detailRevision, previous + 1, operation);
const detail = h.startDetail();
detail.preview.resolve({ rows: [{ value: operation }] });
detail.history.resolve([{ revision: h.state.detailRevision }]);
await settle();
assert.equal(h.state.preview.rows[0].value, operation);
assert.equal(h.state.materializations[0].revision, h.state.detailRevision);
assert.equal(h.state.detailResponseScope, detail.scope);
detail.cleanup();
}
});
test("a changed scope immediately suppresses old preview, history and errors, even before effect cleanup", async () => {
const h = harness();
const old = h.startDetail();
const current = h.startDetail();
current.preview.resolve({ rows: [{ value: "current" }] });
current.history.resolve([{ revision: 2 }]);
await settle();
old.preview.reject(new Error("stale error"));
old.history.resolve([{ revision: 1 }]);
await settle();
assert.equal(h.state.preview.rows[0].value, "current");
assert.equal(h.state.materializations[0].revision, 2);
assert.equal(h.state.error, undefined);
current.cleanup();
});
test("unmount cancellation and partial detail failures preserve allSettled behavior", async () => {
const h = harness();
const cancelled = h.startDetail();
cancelled.cleanup();
cancelled.preview.resolve({ rows: ["obsolete"] });
cancelled.history.resolve([]);
await settle();
assert.equal(h.state.preview, null);
const current = h.startDetail();
current.preview.reject(new Error("current preview denied"));
current.history.resolve([{ revision: 3 }]);
await settle();
assert.equal(h.state.preview, null);
assert.equal(h.state.materializations[0].revision, 3);
assert.match(h.state.error, /current preview denied/);
assert.equal(h.state.detailLoading, false);
});
test("initial/loading catalogue does not issue duplicate detail reads; scoped rendering cannot flash old rows", () => {
const h = harness();
h.state.loading = true;
const detail = h.startDetail();
assert.equal(detail.cleanup, undefined);
assert.equal(h.state.preview, null);
assert.match(page, /useMemo\(\(\) => \(\{\}\), \[selectedDatasourceRef, dialogScope, detailRevision\]\)/);
assert.match(page, /preview=\{!loading && detailResponseScope === detailScope \? preview : null\}/);
assert.match(page, /materializations=\{!loading && detailResponseScope === detailScope \? materializations : \[\]\}/);
});
test("older catalogue reloads and revoked authority cannot invalidate or replace the current catalogue", async () => {
const h = harness();
const older = deferred();
h.bindings.listDatasources = () => older.promise;
const pending = h.reload();
h.bindings.listDatasources = async () => [{ ref: "source-1", revision: 2 }];
await h.reload();
older.resolve([{ ref: "source-1", revision: 1 }]);
await pending;
assert.equal(h.state.datasources[0].revision, 2);
assert.equal(h.state.detailRevision, 1);
const revoked = deferred();
h.bindings.listDatasources = () => revoked.promise;
const revokedPending = h.reload();
h.bindings.authority.current = "authority-B";
revoked.resolve([{ ref: "source-1", revision: 3 }]);
await revokedPending;
assert.equal(h.state.datasources[0].revision, 2);
});
test("an old reload invoked only after B is active cannot issue requests or invalidate B state", async () => {
const h = harness();
const oldReload = h.reload;
h.bindings.authority.current = "authority-B";
h.bindings.authorityEpoch.current.revision = 1;
h.state.catalogueAuthority = 1;
h.state.datasources = [{ ref: "B-source" }];
h.state.detailRevision = 8;
let calls = 0;
h.bindings.listDatasources = async () => { calls += 1; return [{ ref: "A-source" }]; };
const requestId = h.bindings.reloadRequestId.current;
await oldReload();
assert.equal(calls, 0);
assert.equal(h.bindings.reloadRequestId.current, requestId);
assert.equal(h.state.datasources[0].ref, "B-source");
assert.equal(h.state.detailRevision, 8);
});
test("the first authority-transition render cannot request details from a stale catalogue", () => {
const h = harness();
h.bindings.authority.current = "authority-B";
h.bindings.authorityEpoch.current.revision = 1;
h.state.loading = false; // The new reload's effect has not committed loading=true yet.
const detail = h.startDetail();
assert.equal(detail.cleanup, undefined);
assert.equal(h.state.detailLoading, false);
assert.match(page, /const datasources = catalogueReady \? loadedDatasources : \[\]/);
assert.match(page, /const stages = catalogueReady \? loadedStages : \[\]/);
});
test("real-authority setup closes confirmations and clears freeze input; unmount blocks old callbacks", () => {
const h = harness();
const body = extract(" useEffect(() => {\n authority.current = authorityKey;", " }, [reload]);");
const flags = ["addOpen", "freezeOpen", "retireOpen", "promoteOpen", "governanceOpen", "decisionOpen", "retentionOpen"];
for (const flag of flags) {
h.state[flag] = true;
// Hide the old intent already in the first transition render, before the
// passive effect clears it; it cannot be clicked against a new selection.
assert.ok(page.includes(`open={${flag} && catalogueReady}`), flag);
}
h.state.freezeLabel = "Evidence from prior authority";
let reloads = 0;
const cleanup = evaluate(`authority.current = authorityKey;${body}`, {
...h.bindings, reload: () => { reloads += 1; }
});
assert.equal(reloads, 1);
for (const flag of flags) assert.equal(h.state[flag], false, flag);
assert.equal(h.state.freezeLabel, "");
assert.equal(h.bindings.isCurrentAuthority(), true);
cleanup();
assert.equal(h.bindings.isCurrentAuthority(), false);
// The reload callback/effect depend on the stable numeric authority epoch,
// not cosmetic settings/auth object identities.
assert.match(page, /\}, \[dialogScope\]\);\s*useEffect/);
});
test("stale mutation success/failure/finally cannot reload, select or overwrite B messages", async () => {
for (const operation of ["promoteStage", "refreshSelected", "freezeSelected", "retireSelected"]) {
for (const outcome of ["resolve", "reject"]) {
const h = harness();
const pending = deferred();
let reloads = 0;
const signature = operation === "freezeSelected" ? "async (): Promise<boolean>" : "async ()";
const body = extract(` const ${operation} = ${signature} => {`, "\n };");
const result = evaluate(`return (async () => {${body}})();`, {
...h.bindings,
selectedDatasource: { ref: "A-source", governance: { approval_policy: { required: false } } },
selectedStage: { ref: "A-stage", state: "ready" }, freezeLabel: "Freeze A",
reload: async () => { reloads += 1; },
promoteDatasourceStage: () => pending.promise, refreshDatasource: () => pending.promise,
freezeDatasource: () => pending.promise, retireDatasource: () => pending.promise
});
h.bindings.authority.current = "authority-B";
Object.assign(h.state, { success: "B success", error: "B error", view: "origins", working: true });
if (outcome === "reject") pending.reject(new Error("A error"));
else pending.resolve({ datasource: { ref: "A-source", name: "A" }, materialization: { revision: 1 }, revision: 1 });
await result;
assert.equal(reloads, 0, operation);
assert.equal(h.state.success, "B success", operation);
assert.equal(h.state.error, "B error", operation);
assert.equal(h.state.view, "origins", operation);
assert.equal(h.state.working, true, operation);
}
}
});
test("CSV stage dialog sends its explicit mode and exact text; JSON rows remain independent", async () => {
const dialog = page.slice(page.indexOf("function AddDatasourceDialog("));
const start = dialog.indexOf(" const create = async (): Promise<boolean> => {");
const end = dialog.indexOf("\n };", start);
assert.ok(start >= 0 && end > start);
const body = dialog.slice(start + " const create = async (): Promise<boolean> => {".length, end);
const csvText = 'code;value\r\n001;" text "\r\n';
for (const format of ["csv", "json"]) {
for (const csvValueMode of ["text", "legacy_typed"]) {
let payload;
const result = await evaluate(`return (async () => {${body}})();`, {
kind: "upload", settings: {}, format, csvValueMode, csvText, delimiter: ";",
mode: "static", name: "Fixture", sourceName: "fixture", description: "", targetRef: "",
rowsText: '[{"code":"001","value":" text "}]', parseRows: JSON.parse,
createDatasourceStage: async (_settings, value) => { payload = value; return {}; },
onCreated: async () => {}, setBusy: () => {}, setError: () => {}, apiErrorMessage: String
});
assert.equal(result, true);
if (format === "csv") {
assert.equal(payload.csv_value_mode, csvValueMode);
assert.equal(payload.csv_text, csvText);
} else {
assert.equal("csv_value_mode" in payload, false);
assert.deepEqual(payload.rows, [{ code: "001", value: " text " }]);
}
}
}
assert.match(dialog, /\[csvValueMode, setCsvValueMode\] = useState<"text" \| "legacy_typed">\("text"\)/);
assert.match(dialog, /setCsvValueMode\("text"\)/);
assert.match(dialog, /csvValueMode: "text"/);
});
+112 -1
View File
@@ -35,6 +35,8 @@ export type DatasourceGovernance = {
transfer_agreement_ref?: string | null;
freshness_policy: Record<string, unknown>;
quality_policy: Record<string, unknown>;
approval_policy: Record<string, unknown>;
retention_policy: Record<string, unknown>;
known_limits: string[];
correction_procedure_ref?: string | null;
affected_refs: string[];
@@ -85,6 +87,8 @@ export type DatasourceMaterialization = {
frozen_label?: string | null;
source_timestamp?: string | null;
created_at?: string | null;
disposed_at?: string | null;
disposition: Record<string, unknown>;
provenance: Record<string, unknown>;
metadata: Record<string, unknown>;
governance: DatasourceGovernance;
@@ -142,6 +146,21 @@ export type DatasourceStage = {
row_count?: number | null;
byte_count?: number | null;
validation: DatasourceStageValidation;
approval: {
state?: "not_required" | "pending" | "approved" | "rejected" | "expired";
policy_hash?: string;
subject_digest?: string;
required_approvals?: number;
approval_count?: number;
expires_at?: string | null;
approvals?: Array<{
actor_ref?: string;
decision?: "approve" | "reject";
reason?: string;
decided_at?: string;
}>;
policy?: Record<string, unknown>;
};
created_at?: string | null;
promoted_at?: string | null;
promoted_materialization_ref?: string | null;
@@ -203,6 +222,38 @@ export type DatasourcePreview = {
}>;
};
export type DatasourceLifecycleEvidence = {
ref: string;
subject_ref: string;
event_type: string;
occurred_at: string;
actor_ref?: string | null;
policy_version?: string | null;
policy_hash?: string | null;
subject_digest: string;
previous_event_hash?: string | null;
event_hash: string;
details: Record<string, unknown>;
};
export type DatasourceRetentionCandidate = {
ref: string;
kind: "stage" | "materialization";
datasource_ref?: string | null;
disposition: "delete_stage" | "purge_materialization_payload";
eligible_at: string;
eligible: boolean;
blockers: string[];
policy_version: string;
policy_hash: string;
};
export type DatasourceRetentionPlan = {
as_of: string;
plan_hash: string;
candidates: DatasourceRetentionCandidate[];
};
export async function listDatasources(
settings: ApiSettings,
query = "",
@@ -273,7 +324,7 @@ export function createDatasourceStage(
governance?: DatasourceGovernance | null;
} & (
{ format: "json"; rows: Record<string, unknown>[] }
| { format: "csv"; csv_text: string; delimiter: string }
| { format: "csv"; csv_text: string; delimiter: string; csv_value_mode?: "text" | "legacy_typed" }
)
): Promise<DatasourceStage> {
return apiFetch(settings, "/api/v1/datasources/stages", {
@@ -293,6 +344,22 @@ export function promoteDatasourceStage(
});
}
export function decideDatasourceStage(
settings: ApiSettings,
stageRef: string,
payload: {
decision: "approve" | "reject";
reason: string;
expected_policy_hash: string;
expected_subject_digest: string;
}
): Promise<DatasourceStage> {
return apiFetch(settings, `/api/v1/datasources/stages/${refId(stageRef)}/decision`, {
method: "POST",
body: JSON.stringify(payload)
});
}
export function registerDatasourceOrigin(
settings: ApiSettings,
payload: {
@@ -319,6 +386,50 @@ export function refreshDatasource(
});
}
export function prepareDatasourceRefresh(
settings: ApiSettings,
datasourceRef: string
): Promise<DatasourceStage> {
return apiFetch(settings, `/api/v1/datasources/${refId(datasourceRef)}/refresh/stage`, {
method: "POST"
});
}
export async function listDatasourceLifecycleEvidence(
settings: ApiSettings,
subjectRef?: string
): Promise<DatasourceLifecycleEvidence[]> {
const params = new URLSearchParams();
if (subjectRef) params.set("subject_ref", subjectRef);
const suffix = params.size ? `?${params.toString()}` : "";
const response = await apiFetch<{ evidence: DatasourceLifecycleEvidence[] }>(
settings,
`/api/v1/datasources/lifecycle-evidence${suffix}`
);
return response.evidence;
}
export function previewDatasourceRetention(
settings: ApiSettings
): Promise<DatasourceRetentionPlan> {
return apiFetch(settings, "/api/v1/datasources/retention/plan");
}
export function applyDatasourceRetention(
settings: ApiSettings,
plan: DatasourceRetentionPlan,
targetRefs: string[]
): Promise<{ plan_hash: string; disposed_refs: string[]; evidence_hashes: string[] }> {
return apiFetch(settings, "/api/v1/datasources/retention/apply", {
method: "POST",
body: JSON.stringify({
as_of: plan.as_of,
plan_hash: plan.plan_hash,
target_refs: targetRefs
})
});
}
export function freezeDatasource(
settings: ApiSettings,
datasourceRef: string,
@@ -2,6 +2,7 @@ import {
useCallback,
useEffect,
useMemo,
useRef,
useState
} from "react";
import {
@@ -15,6 +16,7 @@ import {
Plus,
Snowflake,
ShieldCheck,
ShieldQuestion,
Trash2,
Upload
} from "lucide-react";
@@ -42,6 +44,7 @@ import { FormGrid, DialogSection, ActionToolbar,
WorkspaceFrame,
WorkspaceLayout,
hasScope,
authAuthorityKey,
isApiError,
useUnsavedChanges,
useUnsavedDraftGuard,
@@ -49,14 +52,18 @@ import { FormGrid, DialogSection, ActionToolbar,
type AuthInfo
} from "@govoplan/core-webui";
import {
applyDatasourceRetention,
createDatasourceStage,
decideDatasourceStage,
freezeDatasource,
listDatasourceMaterializations,
listDatasourceOrigins,
listDatasourceStages,
listDatasources,
previewDatasource,
previewDatasourceRetention,
promoteDatasourceStage,
prepareDatasourceRefresh,
refreshDatasource,
registerDatasourceOrigin,
retireDatasource,
@@ -66,6 +73,7 @@ import {
type DatasourceMaterialization,
type DatasourceOrigin,
type DatasourcePreview,
type DatasourceRetentionPlan,
type DatasourceSchemaChange,
type DatasourceStage,
type DatasourceValidationDiagnostic
@@ -90,10 +98,10 @@ export default function DatasourcesPage({
auth: AuthInfo;
}) {
const [view, setView] = useState<CatalogueView>("catalogue");
const [datasources, setDatasources] = useState<Datasource[]>([]);
const [stages, setStages] = useState<DatasourceStage[]>([]);
const [origins, setOrigins] = useState<DatasourceOrigin[]>([]);
const [originsAvailable, setOriginsAvailable] = useState(false);
const [loadedDatasources, setDatasources] = useState<Datasource[]>([]);
const [loadedStages, setStages] = useState<DatasourceStage[]>([]);
const [loadedOrigins, setOrigins] = useState<DatasourceOrigin[]>([]);
const [loadedOriginsAvailable, setOriginsAvailable] = useState(false);
const [selectedDatasourceRef, setSelectedDatasourceRef] = useState(
initialDatasourceRef
);
@@ -104,6 +112,28 @@ export default function DatasourcesPage({
const [search, setSearch] = useState("");
const [loading, setLoading] = useState(true);
const [detailLoading, setDetailLoading] = useState(false);
const [detailRevision, setDetailRevision] = useState(0);
const authorityKey = authAuthorityKey(auth, settings);
const authority = useRef(authorityKey);
authority.current = authorityKey;
const authorityEpoch = useRef({ key: authorityKey, revision: 0 });
if (authorityEpoch.current.key !== authorityKey) {
authorityEpoch.current = { key: authorityKey, revision: authorityEpoch.current.revision + 1 };
}
const dialogScope = authorityEpoch.current.revision;
const isCurrentAuthority = () => authority.current === authorityKey
&& authorityEpoch.current.revision === dialogScope;
const [catalogueAuthority, setCatalogueAuthority] = useState<number | null>(null);
const catalogueReady = catalogueAuthority === dialogScope;
const datasources = catalogueReady ? loadedDatasources : [];
const stages = catalogueReady ? loadedStages : [];
const origins = catalogueReady ? loadedOrigins : [];
const originsAvailable = catalogueReady && loadedOriginsAvailable;
const detailScope = useMemo(() => ({}), [selectedDatasourceRef, dialogScope, detailRevision]);
const currentDetailScope = useRef(detailScope);
currentDetailScope.current = detailScope;
const [detailResponseScope, setDetailResponseScope] = useState<object | null>(null);
const reloadRequestId = useRef(0);
const [working, setWorking] = useState(false);
const [error, setError] = useState("");
const [success, setSuccess] = useState("");
@@ -113,14 +143,25 @@ export default function DatasourcesPage({
const [retireOpen, setRetireOpen] = useState(false);
const [promoteOpen, setPromoteOpen] = useState(false);
const [governanceOpen, setGovernanceOpen] = useState(false);
const [decisionOpen, setDecisionOpen] = useState(false);
const [retentionOpen, setRetentionOpen] = useState(false);
const { requestDiscard } = useUnsavedChanges();
const canManage = hasScope(auth, "datasources:source:write")
|| hasScope(auth, "datasources:source:admin");
const canStage = hasScope(auth, "datasources:stage:write")
|| hasScope(auth, "datasources:source:admin");
const canApprove = hasScope(auth, "datasources:stage:approve")
|| hasScope(auth, "datasources:source:admin");
const canAdmin = hasScope(auth, "datasources:source:admin");
const reload = useCallback(async (preferredDatasourceRef?: string) => {
// An old mutation callback can invoke this closure AFTER authority changed.
// Compare the closure's scope before any request, state write or generation bump.
if (!isCurrentAuthority()) return;
const requestId = ++reloadRequestId.current;
const isCurrent = () => requestId === reloadRequestId.current
&& isCurrentAuthority();
setLoading(true);
setError("");
try {
@@ -129,10 +170,15 @@ export default function DatasourcesPage({
listDatasourceStages(settings),
listDatasourceOrigins(settings)
]);
if (!isCurrent()) return;
setCatalogueAuthority(dialogScope);
setDatasources(nextDatasources);
setStages(nextStages);
setOrigins(originCatalogue.origins);
setOriginsAvailable(originCatalogue.available);
// Reload also invalidates history/preview when the selected reference did
// not change (refresh, freeze, promotion, governance and manual reload).
setDetailRevision((current) => current + 1);
setSelectedDatasourceRef((current) => {
const preferred = preferredDatasourceRef || current;
return nextDatasources.some((item) => item.ref === preferred)
@@ -146,20 +192,38 @@ export default function DatasourcesPage({
? current
: originCatalogue.origins[0]?.ref ?? "");
} catch (loadError) {
setError(apiErrorMessage(loadError));
if (isCurrent()) setError(apiErrorMessage(loadError));
} finally {
setLoading(false);
if (isCurrent()) setLoading(false);
}
}, [settings]);
}, [dialogScope]);
useEffect(() => {
authority.current = authorityKey;
setWorking(false);
setSuccess("");
// Confirmations and their input must not follow a selection into a new
// authority context. Equivalent session refreshes keep this effect stable.
setAddOpen(false);
setFreezeOpen(false);
setFreezeLabel("");
setRetireOpen(false);
setPromoteOpen(false);
setGovernanceOpen(false);
setDecisionOpen(false);
setRetentionOpen(false);
void reload();
return () => {
reloadRequestId.current += 1;
if (authority.current === authorityKey) authority.current = "";
};
}, [reload]);
useEffect(() => {
if (!selectedDatasourceRef) {
if (!selectedDatasourceRef || loading || !catalogueReady) {
setPreview(null);
setMaterializations([]);
setDetailLoading(false);
return;
}
let cancelled = false;
@@ -168,7 +232,8 @@ export default function DatasourcesPage({
previewDatasource(settings, selectedDatasourceRef),
listDatasourceMaterializations(settings, selectedDatasourceRef)
]).then(([previewResult, materializationResult]) => {
if (cancelled) return;
if (cancelled || currentDetailScope.current !== detailScope) return;
setDetailResponseScope(detailScope);
if (previewResult.status === "fulfilled") {
setPreview(previewResult.value);
} else {
@@ -185,7 +250,7 @@ export default function DatasourcesPage({
return () => {
cancelled = true;
};
}, [selectedDatasourceRef, settings]);
}, [selectedDatasourceRef, detailScope, loading, catalogueReady]);
const selectedDatasource = datasources.find((item) => item.ref === selectedDatasourceRef) ?? null;
const selectedStage = stages.find((item) => item.ref === selectedStageRef) ?? null;
@@ -208,38 +273,50 @@ export default function DatasourcesPage({
);
const promoteStage = async () => {
if (!selectedStage || selectedStage.state !== "ready") return;
if (!isCurrentAuthority() || !selectedStage || selectedStage.state !== "ready") return;
setWorking(true);
setError("");
try {
const result = await promoteDatasourceStage(settings, selectedStage.ref);
if (!isCurrentAuthority()) return;
setSuccess(`Promoted ${result.datasource.name} as revision ${result.materialization.revision}.`);
setView("catalogue");
await reload(result.datasource.ref);
} catch (operationError) {
setError(apiErrorMessage(operationError));
if (isCurrentAuthority()) setError(apiErrorMessage(operationError));
} finally {
setWorking(false);
if (isCurrentAuthority()) setWorking(false);
}
};
const refreshSelected = async () => {
if (!selectedDatasource) return;
if (!isCurrentAuthority() || !selectedDatasource) return;
setWorking(true);
setError("");
try {
if (selectedDatasource.governance.approval_policy.required === true) {
const stage = await prepareDatasourceRefresh(settings, selectedDatasource.ref);
if (!isCurrentAuthority()) return;
await reload(selectedDatasource.ref);
if (!isCurrentAuthority()) return;
setSelectedStageRef(stage.ref);
setView("staging");
setSuccess(`Prepared refresh stage ${stage.name}. It must be approved before promotion.`);
return;
}
const result = await refreshDatasource(settings, selectedDatasource.ref);
if (!isCurrentAuthority()) return;
setSuccess(`Refreshed ${result.datasource.name} as revision ${result.materialization.revision}.`);
await reload(result.datasource.ref);
} catch (operationError) {
setError(apiErrorMessage(operationError));
if (isCurrentAuthority()) setError(apiErrorMessage(operationError));
} finally {
setWorking(false);
if (isCurrentAuthority()) setWorking(false);
}
};
const freezeSelected = async (): Promise<boolean> => {
if (!selectedDatasource) return false;
if (!isCurrentAuthority() || !selectedDatasource) return false;
setWorking(true);
setError("");
try {
@@ -248,32 +325,34 @@ export default function DatasourcesPage({
selectedDatasource.ref,
freezeLabel
);
if (!isCurrentAuthority()) return false;
setSuccess(`Created frozen revision ${materialization.revision}.`);
setFreezeOpen(false);
setFreezeLabel("");
await reload(selectedDatasource.ref);
return true;
return isCurrentAuthority();
} catch (operationError) {
setError(apiErrorMessage(operationError));
if (isCurrentAuthority()) setError(apiErrorMessage(operationError));
return false;
} finally {
setWorking(false);
if (isCurrentAuthority()) setWorking(false);
}
};
const retireSelected = async () => {
if (!selectedDatasource) return;
if (!isCurrentAuthority() || !selectedDatasource) return;
setWorking(true);
setError("");
try {
await retireDatasource(settings, selectedDatasource.ref);
if (!isCurrentAuthority()) return;
setSuccess(`Retired ${selectedDatasource.name}.`);
setRetireOpen(false);
await reload();
} catch (operationError) {
setError(apiErrorMessage(operationError));
if (isCurrentAuthority()) setError(apiErrorMessage(operationError));
} finally {
setWorking(false);
if (isCurrentAuthority()) setWorking(false);
}
};
@@ -296,6 +375,22 @@ export default function DatasourcesPage({
return (
<WorkspaceFrame as="main" height="viewport" surface="plain" className="datasources-page" label="Datasource workspace">
<WorkspaceActionBar
title="Data"
titleHelp={<DocumentationHelpLink reference={DATASOURCES_DOCUMENTATION} />}
scope="workspace"
variant="collection"
refreshable
reloadAction={{ onReload: () => void reload(selectedDatasourceRef), loading: loading || working }}
createAction={<IconButton
label="Add datasource or stage"
icon={<Plus size={17} />}
variant="primary"
onClick={() => setAddOpen(true)}
disabled={!canStage && !canManage}
disabledReason={!canStage && !canManage ? DATASOURCES_I18N.manageReason : undefined}
/>}
/>
<WorkspaceLayout
variant="split"
primarySize="compact"
@@ -306,21 +401,6 @@ export default function DatasourcesPage({
contentLabel="Datasource workspace"
contentClassName="datasources-workspace"
primary={<>
<WorkspaceActionBar
scope="collection-pane"
variant="collection"
refreshable
reloadAction={{ onReload: () => void reload(selectedDatasourceRef), loading: loading || working }}
contextActions={<strong>Data</strong>}
createAction={<IconButton
label="Add datasource or stage"
icon={<Plus size={17} />}
variant="primary"
onClick={() => setAddOpen(true)}
disabled={!canStage && !canManage}
disabledReason={!canStage && !canManage ? DATASOURCES_I18N.manageReason : undefined}
/>}
/>
<div className="datasources-view-switch">
<SegmentedControl<CatalogueView>
ariaLabel="Datasource view"
@@ -421,11 +501,15 @@ export default function DatasourcesPage({
</small>
</span>
</span>}
helpAction={<DocumentationHelpLink reference={DATASOURCES_DOCUMENTATION} />}
primaryActions={<>
{view === "catalogue" && selectedDatasource?.mode === "cached" ? (
<Button onClick={() => void refreshSelected()} disabled={!canManage || working} disabledReason={working ? DATASOURCES_I18N.working : !canManage ? DATASOURCES_I18N.manageReason : undefined}>
<Download size={16} /> Refresh
<Download size={16} /> {selectedDatasource.governance.approval_policy.required === true ? "Stage refresh" : "Refresh"}
</Button>
) : null}
{view === "catalogue" && canAdmin ? (
<Button helpContextId="datasources.retention" helpModuleId="datasources" onClick={() => setRetentionOpen(true)} disabled={working}>
<Archive size={16} /> Retention
</Button>
) : null}
{view === "catalogue" && selectedDatasource ? (
@@ -452,6 +536,16 @@ export default function DatasourcesPage({
<Upload size={16} /> Promote
</Button>
) : null}
{view === "staging" && selectedStage?.state === "awaiting_approval" ? (
<Button
variant="primary"
onClick={() => setDecisionOpen(true)}
disabled={!canApprove || working}
disabledReason={working ? DATASOURCES_I18N.working : !canApprove ? "Datasource approval permission is required." : undefined}
>
<ShieldQuestion size={16} /> Decide
</Button>
) : null}
{view === "origins" && selectedOrigin ? (
<Button
variant="primary"
@@ -505,9 +599,9 @@ export default function DatasourcesPage({
selectedDatasource ? (
<DatasourceDetail
datasource={selectedDatasource}
preview={preview}
materializations={materializations}
loading={detailLoading}
preview={!loading && detailResponseScope === detailScope ? preview : null}
materializations={!loading && detailResponseScope === detailScope ? materializations : []}
loading={loading || detailLoading || detailResponseScope !== detailScope}
/>
) : <EmptyWorkspace icon={<DatabaseZap size={32} />} label="No datasource selected" />
) : null}
@@ -528,7 +622,8 @@ export default function DatasourcesPage({
</WorkspaceLayout>
<AddDatasourceDialog
open={addOpen}
key={`add:${dialogScope}`}
open={addOpen && catalogueReady}
settings={settings}
initialKind={view === "origins" ? "origin" : "upload"}
initialOrigin={view === "origins" ? selectedOrigin : null}
@@ -539,6 +634,7 @@ export default function DatasourcesPage({
canManage={canManage}
onClose={() => setAddOpen(false)}
onCreated={async (result) => {
if (!isCurrentAuthority()) return;
setAddOpen(false);
if ("state" in result) {
setView("staging");
@@ -553,18 +649,47 @@ export default function DatasourcesPage({
}}
/>
<GovernanceDialog
open={governanceOpen}
key={`governance:${dialogScope}`}
open={governanceOpen && catalogueReady}
settings={settings}
datasource={selectedDatasource}
onClose={() => setGovernanceOpen(false)}
onSaved={async (updated) => {
if (!isCurrentAuthority()) return;
setGovernanceOpen(false);
setSuccess(`Updated governance for ${updated.name}.`);
await reload(updated.ref);
}}
/>
<StageDecisionDialog
key={`decision:${dialogScope}`}
open={decisionOpen && catalogueReady}
settings={settings}
stage={selectedStage}
onClose={() => setDecisionOpen(false)}
onDecided={async (updated) => {
if (!isCurrentAuthority()) return;
setDecisionOpen(false);
await reload();
if (!isCurrentAuthority()) return;
setSelectedStageRef(updated.ref);
setSuccess(`Recorded ${updated.approval.state ?? "approval"} decision state for ${updated.name}.`);
}}
/>
<RetentionDialog
key={`retention:${dialogScope}`}
open={retentionOpen && catalogueReady}
settings={settings}
onClose={() => setRetentionOpen(false)}
onApplied={async (count) => {
if (!isCurrentAuthority()) return;
setRetentionOpen(false);
setSuccess(`Applied retention to ${count} eligible target${count === 1 ? "" : "s"}.`);
await reload(selectedDatasourceRef);
}}
/>
<Dialog
open={freezeOpen}
open={freezeOpen && catalogueReady}
title="Freeze datasource state"
onClose={closeFreeze}
footer={(
@@ -588,7 +713,7 @@ export default function DatasourcesPage({
</FormField>
</Dialog>
<ConfirmDialog
open={promoteOpen}
open={promoteOpen && catalogueReady}
title="i18n:govoplan-datasources.promote_title"
message="i18n:govoplan-datasources.promote_message"
confirmLabel="Promote"
@@ -600,7 +725,7 @@ export default function DatasourcesPage({
}}
/>
<ConfirmDialog
open={retireOpen}
open={retireOpen && catalogueReady}
title="Retire datasource"
message={`Retire ${selectedDatasource?.name ?? "this datasource"}? Existing materialization references remain in the database, but the datasource will no longer be available to new definitions.`}
confirmLabel="Retire"
@@ -630,7 +755,7 @@ function DatasourceDetail({
<MetricCard density="compact" label="Mode" value={datasource.mode} valueTitle={datasource.mode} />
<MetricCard density="compact" label="Rows" value={formatNumber(datasource.row_count)} />
<MetricCard density="compact" label="Fields" value={String(datasource.schema.length)} />
<MetricCard density="compact" label="Revisions" value={String(materializations.length)} />
<MetricCard density="compact" label="Revisions" value={loading ? "…" : String(materializations.length)} />
<MetricCard density="compact" label="Updated" value={formatDate(datasource.updated_at)} />
</MetricGrid>
{datasource.description ? (
@@ -651,6 +776,8 @@ function DatasourceDetail({
<span><small>Steward</small><strong>{datasource.governance.steward_ref || "Not assigned"}</strong></span>
<span><small>Responsible organization</small><strong>{datasource.governance.responsible_organization_ref || "Not assigned"}</strong></span>
<span><small>Purposes</small><strong>{datasource.governance.purposes.join(", ") || "Not declared"}</strong></span>
<span><small>Approval gate</small><strong>{datasource.governance.approval_policy.required === true ? "Required" : "Not required"}</strong></span>
<span><small>Retention</small><strong>{datasource.governance.retention_policy.enabled === true ? "Configured" : "Disabled"}</strong></span>
</div>
{datasource.governance.semantic_definition ? (
<p className="datasources-dialog-copy">{datasource.governance.semantic_definition}</p>
@@ -692,7 +819,9 @@ function DatasourceDetail({
<td>{formatDate(item.created_at)}</td>
<td>{formatNumber(item.row_count)}</td>
<td>
{item.frozen_at ? (
{item.disposed_at ? (
<StatusBadge status="disposed" label="payload disposed" />
) : item.frozen_at ? (
<StatusBadge
status="frozen"
label={item.frozen_label || "frozen"}
@@ -704,7 +833,9 @@ function DatasourceDetail({
</td>
</tr>
))}
{!materializations.length ? (
{loading ? (
<tr><td colSpan={5}>Loading materializations...</td></tr>
) : !materializations.length ? (
<tr><td colSpan={5}>Live source without materializations</td></tr>
) : null}
</tbody>
@@ -773,6 +904,28 @@ function StageDetail({ stage }: { stage: DatasourceStage }) {
</div>
)}
</ContentSection>
<ContentSection>
<ActionToolbar surface="section-header" className="datasources-section-heading">
<span><ShieldQuestion size={16} /> Promotion approval</span>
<StatusBadge status={stage.approval.state ?? "not_required"} label={readableToken(stage.approval.state ?? "not_required")} />
</ActionToolbar>
<div className="datasources-key-values">
<span><small>Progress</small><strong>{stage.approval.approval_count ?? 0} / {stage.approval.required_approvals ?? 1}</strong></span>
<span><small>Policy hash</small><strong>{shortFingerprint(stage.approval.policy_hash ?? "")}</strong></span>
<span><small>Subject digest</small><strong>{shortFingerprint(stage.approval.subject_digest ?? "")}</strong></span>
<span><small>Expires</small><strong>{formatDate(stage.approval.expires_at)}</strong></span>
</div>
{stage.approval.approvals?.length ? (
<ul className="datasources-diagnostic-list">
{stage.approval.approvals.map((item, index) => (
<li key={`${item.actor_ref ?? "actor"}-${index}`}>
<span>{item.actor_ref ?? "Unknown actor"} · {readableToken(item.decision ?? "decision")}</span>
<small>{item.reason ?? "No reason recorded"} · {formatDate(item.decided_at)}</small>
</li>
))}
</ul>
) : <div className="datasources-validation-ok">No approval decision has been recorded.</div>}
</ContentSection>
{schemaChanges.length ? (
<ContentSection>
<ActionToolbar surface="section-header" className="datasources-section-heading">
@@ -797,6 +950,211 @@ function StageDetail({ stage }: { stage: DatasourceStage }) {
);
}
function StageDecisionDialog({
open,
settings,
stage,
onClose,
onDecided
}: {
open: boolean;
settings: ApiSettings;
stage: DatasourceStage | null;
onClose: () => void;
onDecided: (stage: DatasourceStage) => void | Promise<void>;
}) {
const [decision, setDecision] = useState<"approve" | "reject">("approve");
const [reason, setReason] = useState("");
const [busy, setBusy] = useState(false);
const [error, setError] = useState("");
useEffect(() => {
if (!open) return;
setDecision("approve");
setReason("");
setError("");
}, [open, stage?.ref]);
const submit = async () => {
if (!stage?.approval.policy_hash || !stage.approval.subject_digest) return;
setBusy(true);
setError("");
try {
const updated = await decideDatasourceStage(settings, stage.ref, {
decision,
reason,
expected_policy_hash: stage.approval.policy_hash,
expected_subject_digest: stage.approval.subject_digest
});
await onDecided(updated);
} catch (operationError) {
setError(apiErrorMessage(operationError));
} finally {
setBusy(false);
}
};
return (
<Dialog
open={open}
title="Decide datasource promotion"
onClose={() => !busy && onClose()}
footer={<>
<Button onClick={onClose} disabled={busy}>Cancel</Button>
<Button
variant={decision === "reject" ? "danger" : "primary"}
onClick={() => void submit()}
disabled={busy || reason.trim().length < 5 || !stage?.approval.policy_hash}
>
{decision === "approve" ? "Approve stage" : "Reject stage"}
</Button>
</>}
>
{error ? <DismissibleAlert tone="danger" resetKey={error}>{error}</DismissibleAlert> : null}
<p className="datasources-dialog-copy">
The decision is bound to this exact stage, validation result, policy hash, and your account authority.
</p>
<div className="datasources-key-values">
<span><small>Stage</small><strong>{stage?.name ?? "Unavailable"}</strong></span>
<span><small>Approval progress</small><strong>{stage?.approval.approval_count ?? 0} / {stage?.approval.required_approvals ?? 1}</strong></span>
<span><small>Policy hash</small><strong>{shortFingerprint(stage?.approval.policy_hash ?? "")}</strong></span>
<span><small>Expires</small><strong>{formatDate(stage?.approval.expires_at)}</strong></span>
</div>
<SegmentedControl<"approve" | "reject">
ariaLabel="Approval decision"
width="fill"
size="equal"
options={[
{ id: "approve", label: "Approve" },
{ id: "reject", label: "Reject" }
]}
value={decision}
onChange={setDecision}
/>
<FormField label="Decision reason" interfaceId="datasources.action.approve" helpContextId="datasources.action.approve" helpModuleId="datasources">
<textarea value={reason} onChange={(event) => setReason(event.target.value)} placeholder="Record what was reviewed and why this decision is justified." />
</FormField>
</Dialog>
);
}
function RetentionDialog({
open,
settings,
onClose,
onApplied
}: {
open: boolean;
settings: ApiSettings;
onClose: () => void;
onApplied: (count: number) => void | Promise<void>;
}) {
const [plan, setPlan] = useState<DatasourceRetentionPlan | null>(null);
const [selected, setSelected] = useState<string[]>([]);
const [loading, setLoading] = useState(false);
const [busy, setBusy] = useState(false);
const [confirming, setConfirming] = useState(false);
const [error, setError] = useState("");
const loadPlan = useCallback(async () => {
setLoading(true);
setError("");
try {
const next = await previewDatasourceRetention(settings);
setPlan(next);
setSelected([]);
} catch (loadError) {
setError(apiErrorMessage(loadError));
} finally {
setLoading(false);
}
}, [settings]);
useEffect(() => {
if (open) void loadPlan();
}, [loadPlan, open]);
const apply = async () => {
if (!plan || !selected.length) return;
setBusy(true);
setError("");
try {
const result = await applyDatasourceRetention(settings, plan, selected);
setConfirming(false);
await onApplied(result.disposed_refs.length);
} catch (operationError) {
setConfirming(false);
setError(apiErrorMessage(operationError));
await loadPlan();
} finally {
setBusy(false);
}
};
const toggle = (ref: string) => setSelected((current) =>
current.includes(ref)
? current.filter((item) => item !== ref)
: [...current, ref]);
return <>
<Dialog
open={open}
title="Datasource retention preview"
size="wide"
onClose={() => !busy && onClose()}
footer={<>
<Button onClick={() => void loadPlan()} disabled={loading || busy}>Reload preview</Button>
<Button onClick={onClose} disabled={busy}>Cancel</Button>
<Button variant="danger" onClick={() => setConfirming(true)} disabled={busy || loading || !selected.length}>
Apply selected dispositions
</Button>
</>}
>
{error ? <DismissibleAlert tone="danger" resetKey={error}>{error}</DismissibleAlert> : null}
<p className="datasources-dialog-copy">
The preview is read-only. Legal holds, current materializations, pending approvals, and publication evidence remain blocked.
</p>
{plan ? (
<div className="datasources-key-values">
<span><small>As of</small><strong>{formatDate(plan.as_of)}</strong></span>
<span><small>Plan hash</small><strong>{shortFingerprint(plan.plan_hash)}</strong></span>
<span><small>Due targets</small><strong>{plan.candidates.length}</strong></span>
<span><small>Selected</small><strong>{selected.length}</strong></span>
</div>
) : null}
<LoadingFrame loading={loading}>
<div className="datasources-table-scroll">
<table>
<thead><tr><th className="datasources-retention-select-cell" aria-label="Select" /><th>Target</th><th>Disposition</th><th>Eligible since</th><th>Policy / blockers</th></tr></thead>
<tbody>
{plan?.candidates.map((candidate) => (
<tr key={candidate.ref}>
<td className="datasources-retention-select-cell"><input type="checkbox" aria-label={`Select ${candidate.ref}`} checked={selected.includes(candidate.ref)} disabled={!candidate.eligible} onChange={() => toggle(candidate.ref)} /></td>
<td><strong>{candidate.ref}</strong><small>{candidate.datasource_ref ?? "Unpromoted stage"}</small></td>
<td>{readableToken(candidate.disposition)}</td>
<td>{formatDate(candidate.eligible_at)}</td>
<td>{candidate.blockers.length ? candidate.blockers.map(readableToken).join(", ") : `v${candidate.policy_version} · eligible`}</td>
</tr>
))}
{!plan?.candidates.length ? <tr><td colSpan={5}>No retention targets are due.</td></tr> : null}
</tbody>
</table>
</div>
</LoadingFrame>
</Dialog>
<ConfirmDialog
open={confirming}
title="Apply datasource retention"
message={`Dispose ${selected.length} selected target${selected.length === 1 ? "" : "s"}? Payload rows or transient stages will be removed; lifecycle evidence remains.`}
confirmLabel="Apply retention"
tone="danger"
busy={busy}
onCancel={() => setConfirming(false)}
onConfirm={() => void apply()}
/>
</>;
}
function ValidationDiagnosticList({
diagnostics
}: {
@@ -900,6 +1258,8 @@ function GovernanceDialog({
const [freshness, setFreshness] = useState("{}");
const [quality, setQuality] = useState("{}");
const [visibility, setVisibility] = useState("{}");
const [approval, setApproval] = useState("{}");
const [retention, setRetention] = useState("{}");
const [baselineKey, setBaselineKey] = useState("");
const [busy, setBusy] = useState(false);
const [error, setError] = useState("");
@@ -911,15 +1271,19 @@ function GovernanceDialog({
const nextFreshness = JSON.stringify(datasource.governance.freshness_policy, null, 2);
const nextQuality = JSON.stringify(datasource.governance.quality_policy, null, 2);
const nextVisibility = JSON.stringify(datasource.governance.visibility_policy ?? {}, null, 2);
const nextApproval = JSON.stringify(datasource.governance.approval_policy ?? {}, null, 2);
const nextRetention = JSON.stringify(datasource.governance.retention_policy ?? {}, null, 2);
setDraft(nextDraft);
setFreshness(nextFreshness);
setQuality(nextQuality);
setVisibility(nextVisibility);
setBaselineKey(JSON.stringify({ draft: nextDraft, freshness: nextFreshness, quality: nextQuality, visibility: nextVisibility }));
setApproval(nextApproval);
setRetention(nextRetention);
setBaselineKey(JSON.stringify({ draft: nextDraft, freshness: nextFreshness, quality: nextQuality, visibility: nextVisibility, approval: nextApproval, retention: nextRetention }));
setError("");
}, [datasource, open]);
const dirty = Boolean(open && draft && JSON.stringify({ draft, freshness, quality, visibility }) !== baselineKey);
const dirty = Boolean(open && draft && JSON.stringify({ draft, freshness, quality, visibility, approval, retention }) !== baselineKey);
const save = async (): Promise<boolean> => {
if (!datasource || !draft) return false;
@@ -930,7 +1294,9 @@ function GovernanceDialog({
...draft,
freshness_policy: parseObject(freshness, "Freshness policy"),
quality_policy: parseObject(quality, "Quality policy"),
visibility_policy: parseObject(visibility, "Visibility policy")
visibility_policy: parseObject(visibility, "Visibility policy"),
approval_policy: parseObject(approval, "Approval policy"),
retention_policy: parseObject(retention, "Retention policy")
});
await onSaved(updated);
return true;
@@ -1042,7 +1408,7 @@ function GovernanceDialog({
<GovernanceListField label="Purposes" values={draft.purposes} onChange={(values) => setValue("purposes", values)} />
<GovernanceListField label="Legal basis references" values={draft.legal_basis_refs} onChange={(values) => setValue("legal_basis_refs", values)} />
<GovernanceListField label="Official keys" values={draft.official_keys} onChange={(values) => setValue("official_keys", values)} />
<GovernanceListField label="Legal hold references" values={draft.hold_refs} onChange={(values) => setValue("hold_refs", values)} />
<GovernanceListField label="Legal hold references" helpContextId="datasources.field.retention-policy-contract" values={draft.hold_refs} onChange={(values) => setValue("hold_refs", values)} />
<GovernanceListField label="Affected services and processes" values={draft.affected_refs} onChange={(values) => setValue("affected_refs", values)} />
<GovernanceListField label="Dependent flows, reports, controls and decisions" values={draft.dependency_refs} onChange={(values) => setValue("dependency_refs", values)} />
<GovernanceListField label="Known limits" values={draft.known_limits} onChange={(values) => setValue("known_limits", values)} />
@@ -1058,6 +1424,14 @@ function GovernanceDialog({
<FormField label="Quality policy (JSON)" documentation={DATASOURCE_GOVERNANCE_DOCUMENTATION}>
<textarea value={quality} onChange={(event) => setQuality(event.target.value)} spellCheck={false} />
</FormField>
<FormField label="Approval policy (JSON)" interfaceId="datasources.field.approval-policy" helpContextId="datasources.field.approval-policy" helpModuleId="datasources" documentation={DATASOURCE_GOVERNANCE_DOCUMENTATION}>
<textarea value={approval} onChange={(event) => setApproval(event.target.value)} spellCheck={false} />
<small>Configure a version, required approvals, separation of duties, and optional expiry.</small>
</FormField>
<FormField label="Retention policy (JSON)" interfaceId="datasources.field.retention-policy-contract" helpContextId="datasources.field.retention-policy-contract" helpModuleId="datasources" documentation={DATASOURCE_GOVERNANCE_DOCUMENTATION}>
<textarea value={retention} onChange={(event) => setRetention(event.target.value)} spellCheck={false} />
<small>Configure explicit stage, materialization, and frozen-evidence durations; execution always starts with a preview.</small>
</FormField>
</FormGrid>
</DialogSection>
) : null}
@@ -1067,15 +1441,17 @@ function GovernanceDialog({
function GovernanceListField({
label,
helpContextId,
values,
onChange
}: {
label: string;
helpContextId?: string;
values: string[];
onChange: (values: string[]) => void;
}) {
return (
<FormField label={label}>
<FormField label={label} helpContextId={helpContextId} helpModuleId="datasources">
<textarea
value={values.join("\n")}
onChange={(event) => onChange(splitLines(event.target.value))}
@@ -1123,6 +1499,7 @@ function AddDatasourceDialog({
const [rowsText, setRowsText] = useState('[\n { "id": 1 }\n]');
const [csvText, setCsvText] = useState("");
const [delimiter, setDelimiter] = useState(";");
const [csvValueMode, setCsvValueMode] = useState<"text" | "legacy_typed">("text");
const [baselineKey, setBaselineKey] = useState("");
const [busy, setBusy] = useState(false);
const [error, setError] = useState("");
@@ -1141,6 +1518,7 @@ function AddDatasourceDialog({
setRowsText('[\n { "id": 1 }\n]');
setCsvText("");
setDelimiter(";");
setCsvValueMode("text");
setBaselineKey(addDatasourceDraftKey({
kind: initialKind,
format: "csv",
@@ -1152,7 +1530,8 @@ function AddDatasourceDialog({
description: initialOrigin?.description ?? "",
rowsText: '[\n { "id": 1 }\n]',
csvText: "",
delimiter: ";"
delimiter: ";",
csvValueMode: "text"
}));
setError("");
}, [initialKind, initialOrigin, open]);
@@ -1169,7 +1548,8 @@ function AddDatasourceDialog({
description,
rowsText,
csvText,
delimiter
delimiter,
csvValueMode
}) !== baselineKey);
const chooseOrigin = (ref: string) => {
@@ -1221,7 +1601,8 @@ function AddDatasourceDialog({
...common,
format: "csv",
csv_text: csvText,
delimiter
delimiter,
csv_value_mode: csvValueMode
})
: await createDatasourceStage(settings, {
...common,
@@ -1415,6 +1796,16 @@ function AddDatasourceDialog({
<option value="|">Pipe</option>
</select>
</FormField>
<FormField label="CSV values" documentation={DATASOURCE_FIELDS_DOCUMENTATION}>
<select
value={csvValueMode}
onChange={(event) => setCsvValueMode(event.target.value as "text" | "legacy_typed")}
disabled={busy}
>
<option value="text">Preserve text (no automatic conversion)</option>
<option value="legacy_typed">Infer types (legacy)</option>
</select>
</FormField>
<FormField label="CSV data">
<textarea
value={csvText}
@@ -1533,6 +1924,7 @@ function addDatasourceDraftKey(value: {
rowsText: string;
csvText: string;
delimiter: string;
csvValueMode: "text" | "legacy_typed";
}): string {
return JSON.stringify(value);
}
+8
View File
@@ -1,6 +1,10 @@
import type { PlatformTranslations } from "@govoplan/core-webui";
const en = {
"CSV values": "CSV values",
"Preserve text (no automatic conversion)": "Preserve text (no automatic conversion)",
"Infer types (legacy)": "Infer types (legacy)",
"Loading materializations...": "Loading materializations...",
"i18n:govoplan-datasources.datasources": "Datasources",
"i18n:govoplan-datasources.catalogue": "Datasource catalogue",
"i18n:govoplan-datasources.staging": "Datasource staging",
@@ -78,6 +82,10 @@ const en = {
} as const;
const de: Record<keyof typeof en, string> = {
"CSV values": "CSV-Werte",
"Preserve text (no automatic conversion)": "Text erhalten (keine automatische Umwandlung)",
"Infer types (legacy)": "Typen ableiten (bisheriges Verhalten)",
"Loading materializations...": "Materialisierungen werden geladen...",
"i18n:govoplan-datasources.datasources": "Datenquellen",
"i18n:govoplan-datasources.catalogue": "Datenquellenkatalog",
"i18n:govoplan-datasources.staging": "Datenquellen-Staging",
+1 -1
View File
@@ -10,7 +10,7 @@ const readScopes = ["datasources:catalogue:read", "datasources:source:admin"];
export const datasourcesModule: PlatformWebModule = {
id: "datasources",
label: "i18n:govoplan-datasources.datasources",
version: "0.1.18",
version: "0.1.22",
optionalDependencies: [
"access",
"audit",
+11
View File
@@ -287,6 +287,17 @@
max-height: min(860px, calc(100vh - 32px));
}
.datasources-retention-select-cell {
width: 2.5rem;
text-align: center;
}
.datasources-table-scroll td small {
display: block;
margin-top: 0.2rem;
color: var(--color-text-muted);
}
.datasources-governance-dialog .datasources-dialog-fields textarea {
min-height: 76px;
}