lorebase-keeper 0.3.1__tar.gz → 0.4.0__tar.gz

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: lorebase-keeper
-Version: 0.3.1
+Version: 0.4.0
 Summary: Lorebase Keeper: REST API service
 Project-URL: Homepage, https://github.com/aantenore/lorebase
 Project-URL: Documentation, https://aantenore.github.io/lorebase/
@@ -22,9 +22,9 @@ Requires-Python: >=3.12
 Requires-Dist: asyncpg>=0.29
 Requires-Dist: fastapi>=0.115
 Requires-Dist: httpx>=0.27
-Requires-Dist: lorebase-core<0.4,>=0.3
-Requires-Dist: lorebase-platform<0.4,>=0.3
-Requires-Dist: lorebase-store<0.4,>=0.3
+Requires-Dist: lorebase-core<0.5,>=0.4
+Requires-Dist: lorebase-platform<0.5,>=0.4
+Requires-Dist: lorebase-store<0.5,>=0.4
 Requires-Dist: opentelemetry-api>=1.25
 Requires-Dist: pgvector>=0.3
 Requires-Dist: pydantic>=2.7

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lorebase-keeper"
-version = "0.3.1"
+version = "0.4.0"
 description = "Lorebase Keeper: REST API service"
 requires-python = ">=3.12"
 readme = "README.md"
@@ -18,9 +18,9 @@ classifiers = [
   "Topic :: Database",
 ]
 dependencies = [
-  "lorebase-core>=0.3,<0.4",
-  "lorebase-store>=0.3,<0.4",
-  "lorebase-platform>=0.3,<0.4",
+  "lorebase-core>=0.4,<0.5",
+  "lorebase-store>=0.4,<0.5",
+  "lorebase-platform>=0.4,<0.5",
   "fastapi>=0.115",
   "uvicorn>=0.30",
   "pydantic>=2.7",

lorebase_keeper-0.4.0/src/lorebase_keeper/__init__.py

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

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/src/lorebase_keeper/reading/records.py

@@ -9,7 +9,7 @@ snapshot of the Revision (`reading.snapshots`) for everything else.
 from __future__ import annotations
 
 from collections import defaultdict
-from collections.abc import Mapping, Sequence
+from collections.abc import Awaitable, Callable, Mapping, Sequence
 from dataclasses import dataclass
 from typing import Any
 
@@ -52,6 +52,7 @@ from lorebase_keeper.reading.tree import TreeReader
 from lorebase_keeper.reading.views import (
     AggregateCount,
     AggregateOut,
+    ConflictInProgressOut,
     LineageOut,
     LinkCountOut,
     LinkOut,
@@ -66,7 +67,7 @@ from lorebase_keeper.tracing.explain import explain
 from lorebase_store.indexes import plan_indexes
 from lorebase_store.materialize.rows import record_title, split_link_key
 from lorebase_store.reads import hydrate_records, links_to_record
-from lorebase_store.repositories import ProvenanceRepository
+from lorebase_store.repositories import ConflictRepository, ProvenanceRepository
 
 
 @dataclass(frozen=True, slots=True)
@@ -177,6 +178,50 @@ async def get_record(
     return record, fetched
 
 
+async def conflicts_in_progress(
+    session: AsyncSession,
+    point: ReadPoint,
+    kind: Kind,
+    key: str,
+    *,
+    may_read_source: Callable[[str], Awaitable[bool]],
+) -> list[ConflictInProgressOut]:
+    """The open Conflicts about the Record `(kind, key)` in the open Proposals into the branch
+    read (one lookup by element in the index of unresolved Conflicts).
+
+    An entry tells that a Proposal exists and what it contests, so it is listed only to a
+    caller who may read that Proposal (`may_read_source` tells for its source branch; the
+    target branch is the one read) and the Attribute's values: a Conflict about an Attribute
+    the caller's schema leaves out or whose values the caller sees masked is dropped.
+    """
+    rows = await ConflictRepository(session, point.domain.id).pending(
+        point.branch, kind_partition(kind.id), key
+    )
+    pending: list[ConflictInProgressOut] = []
+    readable: dict[str, bool] = {}
+    for row in rows:
+        name: str | None = None
+        if row.attribute_id is not None:
+            attribute = kind.attributes.get(row.attribute_id)
+            if attribute is None or point.masking.hidden(attribute, [kind.id]):
+                continue
+            name = attribute.api_name
+        if row.source_ref not in readable:
+            readable[row.source_ref] = await may_read_source(row.source_ref)
+        if not readable[row.source_ref]:
+            continue
+        pending.append(
+            ConflictInProgressOut(
+                proposal_id=row.proposal_id,
+                conflict_id=row.fingerprint,
+                code=row.code,
+                attribute=name,
+                competing_hash=row.competing_hash,
+            )
+        )
+    return pending
+
+
 async def link_counts(
     session: AsyncSession,
     runtime: ReadRuntime,

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/src/lorebase_keeper/reading/sensitivity.py

@@ -862,8 +862,9 @@ def mask_conflict(
     payload: Mapping[str, Any], schema: Schema | None, masking: Masking
 ) -> dict[str, Any]:
     """A stored Conflict with the values the caller may not read masked: the three versions
-    of a sensitive Attribute (with the message and details, which may quote them), or the
-    sensitive entries of whole value maps."""
+    of a sensitive Attribute (with the message and details, which may quote them, and the
+    provenance of the sides, which says who changed the value, from which Source and when),
+    or the sensitive entries of whole value maps."""
     out = dict(payload)
     located = _element_attributes(schema, str(payload.get("partition", "")))
     if located is None:
@@ -874,6 +875,7 @@ def mask_conflict(
                 out[name] = masking.masked
         out["message"] = "The versions of a sensitive Attribute differ."
         out["details"] = {}
+        out.pop("provenance", None)
         return out
     if payload.get("attribute") is None:
         attributes, kinds = located

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/src/lorebase_keeper/reading/views.py

@@ -40,6 +40,24 @@ class LineageOut(BaseModel):
     at: datetime | None = None
 
 
+class ConflictInProgressOut(BaseModel):
+    """A Conflict about a Record that waits for a decision in an open Proposal into the branch
+    read: the value served is the one already merged, and a competing change is pending."""
+
+    proposal_id: str = Field(description="The open Proposal whose merge has the Conflict.")
+    conflict_id: str = Field(description="The Conflict id (its fingerprint) in that Proposal.")
+    code: str = Field(description="Conflict code, such as `DV1`.")
+    attribute: str | None = Field(
+        default=None,
+        description="Api name of the contested Attribute; null when the whole Record is "
+        "contested (deleted on one side and changed on the other).",
+    )
+    competing_hash: str | None = Field(
+        default=None,
+        description="Hash of the competing Record on the Proposal's source side.",
+    )
+
+
 class RecordOut(BaseModel):
     """A Record with values keyed by Attribute api name."""
 
@@ -56,6 +74,12 @@ class RecordOut(BaseModel):
 
 class RecordResponse(Served):
     record: RecordOut
+    conflict_in_progress: list[ConflictInProgressOut] | None = Field(
+        default=None,
+        description="Open Conflicts about the Record in Proposals into the branch read; set "
+        "by `conflicts=true` on a read of one Record at the branch head (empty when nothing "
+        "is pending), null otherwise.",
+    )
 
 
 class RecordPage(Served):

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/src/lorebase_keeper/routes/proposals.py

@@ -265,14 +265,45 @@ class AttemptOut(BaseModel):
     auto_resolutions: list[dict[str, Any]]
 
 
+class SideProvenanceOut(BaseModel):
+    """Who or what last changed the Attribute of a Conflict on one side, and when."""
+
+    provenance_id: str = Field(description="Provenance entry of the change.")
+    at: datetime = Field(description="When the change was made.")
+    actor: str | None = Field(default=None, description="Who wrote the provenance entry.")
+    origin: str | None = Field(
+        default=None, description="Origin type: `source_sync`, `operation`, `extraction`, ..."
+    )
+    source: str | None = Field(default=None, description="Source id, for a Source sync.")
+    principal: str | None = Field(default=None, description="Principal, for an Operation.")
+    labels: list[str] = Field(
+        default_factory=list, description="Origin labels an `authority` ranking matches."
+    )
+
+
+class ConflictProvenanceOut(BaseModel):
+    """The provenance of the two competing sides; null for a side of unknown Lineage."""
+
+    ours: SideProvenanceOut | None = None
+    theirs: SideProvenanceOut | None = None
+
+
 class ConflictOut(BaseModel):
-    """A Conflict (core `Conflict`) with its id, state and members."""
+    """A Conflict (core `Conflict`) with its id, state and members.
+
+    `provenance` is set on Attribute Conflicts (`DV1`, `DV3`) whose merge knew the Lineage of
+    at least one side, and null otherwise.
+    """
 
     model_config = {"extra": "allow"}
 
     id: str
     status: Literal["open", "resolved"]
     resolution: dict[str, Any] | None = None
+    provenance: ConflictProvenanceOut | None = Field(
+        default=None,
+        description="Who or what changed each side and when; null when the merge did not know it.",
+    )
 
 
 class ConflictsOut(AttemptOut):

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/src/lorebase_keeper/routes/read.py

@@ -14,6 +14,7 @@ resolved. POST reads carry an `ETag` too.
 from __future__ import annotations
 
 import json
+from collections.abc import Awaitable, Callable
 from typing import Annotated, Any
 
 from fastapi import APIRouter, Depends, Query, Request, Response
@@ -97,8 +98,16 @@ def _mark(response: Response, point: ReadPoint, body: BaseModel) -> None:
 
 
 async def _answer(
-    request: Request, runtime: ReadRuntime, point: ReadPoint, produce: Any, session: AsyncSession
+    request: Request,
+    runtime: ReadRuntime,
+    point: ReadPoint,
+    produce: Any,
+    session: AsyncSession,
+    *,
+    state: str = "",
 ) -> Response:
+    """`state` names what the body depends on that the Revision does not fix (the open
+    Conflicts a read asked for): it joins the cache key and the ETag."""
     return await respond(
         request,
         runtime.cache,
@@ -107,7 +116,7 @@ async def _answer(
         produce=produce,
         time_travel=not point.materialized,
         headers={REVISION_HEADER: point.revision_hex},
-        variant=point.variant,
+        variant="|".join(part for part in (point.variant, state) if part),
         disclose=point.disclosure(session, runtime).send,
     )
 
@@ -245,6 +254,16 @@ async def list_record_links(
     return await _answer(request, runtime, point, produce, session)
 
 
+def _may_read_proposal_source(access: ReadGuard) -> Callable[[str], Awaitable[bool]]:
+    """Whether the caller reads a Proposal whose target branch it reads: `data.read` on the
+    source branch too, or grants narrowed to Kinds (which cover every branch)."""
+
+    async def may(source_ref: str) -> bool:
+        return await access.may(source_ref) or bool(await access.granted_kinds())
+
+    return may
+
+
 @router.get(
     f"{BASE}/kinds/{{kind}}/records/{{key}}",
     summary="Get a Record by key",
@@ -263,22 +282,48 @@ async def get_record(
     at: At = None,
     links: Annotated[bool, Query(description="Add Link counts per Relation.")] = False,
     lineage: Annotated[bool, Query(description="Add the provenance of each value.")] = False,
+    conflicts: Annotated[
+        bool,
+        Query(
+            description="Add `conflict_in_progress`: the open Conflicts about the Record in "
+            "Proposals into the branch read. Branch head only (ignored with `at`)."
+        ),
+    ] = False,
 ) -> Response:
-    """One Record, optionally with its Link counts and the lineage of its values."""
-    if at is None and (
-        unchanged := await unchanged_head(session, runtime, access, request, branch=branch)
+    """One Record, optionally with its Link counts, the lineage of its values and the
+    Conflicts about it that wait for a decision.
+
+    While a merge is stuck on a Conflict nothing is committed, so the Record keeps the value
+    already merged. `conflicts=true` lists the Conflicts of open Proposals into the branch
+    that touch the Record (Proposal, Conflict, Attribute, hash of the competing Record). They
+    change without a new Revision, so such a read is not answered from the head Revision
+    alone: the pending Conflicts are looked up on every request and are part of its `ETag`.
+    """
+    watch = conflicts and at is None
+    if (
+        at is None
+        and not watch
+        and (unchanged := await unchanged_head(session, runtime, access, request, branch=branch))
     ):
         return unchanged
     point = await resolve_point(session, runtime, access, branch=branch, at=at)
     found = records.require_kind(point, kind)
+    pending = (
+        await records.conflicts_in_progress(
+            session, point, found, key, may_read_source=_may_read_proposal_source(access)
+        )
+        if watch
+        else None
+    )
 
     async def produce() -> RecordResponse:
         record, _ = await records.get_record(
             session, runtime, point, found, key, links=links, lineage=lineage
         )
-        return RecordResponse(**served(point), record=record)
+        return RecordResponse(**served(point), record=record, conflict_in_progress=pending)
 
-    return await _answer(request, runtime, point, produce, session)
+    state = fingerprint("conflicts", [p.model_dump() for p in pending]) if pending else ""
+    return await _answer(request, runtime, point, produce, session, state=state)
 
 
 @router.get(

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/src/lorebase_keeper/services/proposal_reads.py

@@ -206,16 +206,17 @@ class ConflictVisibility:
         return any(i in text for i in self.left_out)
 
     def scrub(self, payload: dict[str, Any]) -> dict[str, Any]:
-        """`payload` without the values of Attributes left out, and without a message or
-        details naming something left out."""
+        """`payload` without the values of Attributes left out, and without a message,
+        details or provenance naming something left out."""
         if not self.left_out:
             return payload
         out = dict(payload)
         for name in (*_CONFLICT_SIDES, "values"):
             out[name] = _without(out.get(name), self.left_out)
-        if self.names_left_out([out.get("message"), out.get("details")]):
+        if self.names_left_out([out.get("message"), out.get("details"), out.get("provenance")]):
             out["message"] = "The versions differ."
             out["details"] = {}
+            out.pop("provenance", None)
         return out
 
 

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/tests/auth/test_proposal_read_authorization.py

@@ -273,4 +273,18 @@ def test_record_level_conflicts_lose_values_and_messages_left_out() -> None:
     assert scrubbed["theirs"] == {"values": {}}
     assert scrubbed["details"] == {}
     assert supplier.id not in scrubbed["message"]
+    assert "provenance" not in scrubbed
     assert ConflictVisibility(None, UNCLEARED).scrub(payload) == payload
+
+
+def test_provenance_naming_something_left_out_is_dropped() -> None:
+    hidden = "src_01JB8Z00000000000000000042"
+    stamp = {"provenance_id": "prv_1", "at": "2026-03-01T10:00:00+00:00", "source": hidden}
+    payload = {"ours": 1, "theirs": 2, "message": "m", "details": {}}
+    stamped = {**payload, "provenance": {"ours": stamp, "theirs": None}}
+    seen = ConflictVisibility(None, UNCLEARED, frozenset({hidden}))
+    scrubbed = seen.scrub(stamped)
+    assert "provenance" not in scrubbed
+    assert hidden not in str(scrubbed)
+    other = ConflictVisibility(None, UNCLEARED, frozenset({"knd_other"}))
+    assert other.scrub(stamped)["provenance"] == stamped["provenance"]

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/tests/integration/writes/test_proposals_postgres.py

@@ -551,6 +551,119 @@ async def test_lineage_policies_resolve_conflicts_from_provenance(
         assert city["provenance"]["origin"]["resolver"] == "policy:newest_wins"
 
 
+async def test_open_conflicts_say_who_changed_each_side_and_when(
+    keeper: Any, installation_admin: Any, loader: Loader
+) -> None:
+    """An open Attribute Conflict carries the provenance of ours and theirs, read from the
+    Lineage of both branches in Postgres."""
+    admin = installation_admin.headers
+    async with keeper(proposals={"required_approvals": 0}) as http:
+        await setup_domain(http, admin, loader, "left", "right")
+        await loader.edit("left", "S-1001", city="Gdansk")
+        await loader.edit("right", "S-1001", city="Warsaw")  # the later change
+
+        opened = await http.post(PROPOSALS, json=proposal_body("right", "left"), headers=admin)
+        assert opened.status_code == 201, opened.text
+        proposal = opened.json()
+        assert proposal["attempt"]["open_conflicts"] == 1
+        listed = await http.get(f"{PROPOSALS}/{proposal['id']}/conflicts", headers=admin)
+        assert listed.status_code == 200, listed.text
+        [conflict] = listed.json()["conflicts"]
+        assert (conflict["kind"], conflict["key"], conflict["attribute"]) == ("DV1", "S-1001", CITY)
+        ours, theirs = conflict["provenance"]["ours"], conflict["provenance"]["theirs"]
+        for side in (ours, theirs):
+            assert side["provenance_id"]
+            assert side["actor"]
+            assert side["origin"]
+            assert {f"actor:{side['actor']}", f"origin:{side['origin']}"} <= set(side["labels"])
+        assert ours["provenance_id"] != theirs["provenance_id"]
+        assert theirs["at"] > ours["at"]
+
+
+async def test_a_record_read_flags_a_conflict_waiting_for_a_decision(
+    keeper: Any, installation_admin: Any, loader: Loader
+) -> None:
+    """While a Proposal is stuck on a Conflict the target keeps the merged value; a read that
+    asks for it (`conflicts=true`) names the Proposal, the Attribute and the competing hash."""
+    admin = installation_admin.headers
+    record = f"{DOMAIN}/kinds/Supplier/records/S-1001"
+    watching = {"branch": "left", "conflicts": "true"}
+    async with keeper(proposals={"required_approvals": 0}) as http:
+        await setup_domain(http, admin, loader, "left", "right")
+        await loader.edit("left", "S-1001", city="Gdansk")
+        await loader.edit("right", "S-1001", city="Warsaw")
+
+        quiet = await http.get(record, params=watching, headers=admin)
+        assert quiet.status_code == 200, quiet.text
+        assert quiet.json()["conflict_in_progress"] == []
+
+        opened = await http.post(PROPOSALS, json=proposal_body("right", "left"), headers=admin)
+        assert opened.status_code == 201, opened.text
+        proposal = opened.json()
+        assert proposal["attempt"]["open_conflicts"] == 1
+        base = f"{PROPOSALS}/{proposal['id']}"
+        [conflict] = (await http.get(f"{base}/conflicts", headers=admin)).json()["conflicts"]
+
+        # The same Revision answers, now with the marker: the ETag of the earlier read is stale.
+        contested = await http.get(
+            record, params=watching, headers={**admin, "If-None-Match": quiet.headers["ETag"]}
+        )
+        assert contested.status_code == 200, contested.text
+        assert contested.headers["Lorebase-Revision"] == quiet.headers["Lorebase-Revision"]
+        assert contested.headers["ETag"] != quiet.headers["ETag"]
+        body = contested.json()
+        assert body["record"]["values"]["city"] == "Gdansk"
+        assert body["conflict_in_progress"] == [
+            {
+                "proposal_id": proposal["id"],
+                "conflict_id": conflict["id"],
+                "code": "DV1",
+                "attribute": "city",
+                "competing_hash": conflict["theirs_hash"],
+            }
+        ]
+        again = await http.get(
+            record, params=watching, headers={**admin, "If-None-Match": contested.headers["ETag"]}
+        )
+        assert again.status_code == 304
+
+        # Not asked for, not on the source branch, not about another Record: nothing changes.
+        plain = await http.get(record, params={"branch": "left"}, headers=admin)
+        assert plain.json()["conflict_in_progress"] is None
+        assert plain.json()["record"] == body["record"]
+        source = await http.get(
+            record, params={"branch": "right", "conflicts": "true"}, headers=admin
+        )
+        assert source.json()["conflict_in_progress"] == []
+        other = await http.get(
+            f"{DOMAIN}/kinds/Supplier/records/S-1002", params=watching, headers=admin
+        )
+        assert other.json()["conflict_in_progress"] == []
+
+        # The partial index of unresolved Conflicts serves the lookup.
+        assert (
+            await loader.scalar(
+                "SELECT count(*) FROM pg_indexes WHERE tablename = 'conflicts' "
+                "AND indexname = 'ix_conflicts_open_element' "
+                "AND indexdef LIKE '%resolved_by IS NULL%'"
+            )
+            == 1
+        )
+
+        resolved = await http.post(
+            f"{base}/conflicts/{conflict['id']}/resolution",
+            json={"choice": "theirs"},
+            headers=admin,
+        )
+        assert resolved.status_code == 200, resolved.text
+        merged = await http.post(f"{base}/merge", headers=admin)
+        assert merged.status_code == 200, merged.text
+        settled = await http.get(record, params=watching, headers=admin)
+        assert settled.json()["record"]["values"]["city"] == "Warsaw"
+        assert settled.json()["conflict_in_progress"] == []
+        await loader.verify("left")
+
+
 async def test_deleting_a_domain_removes_its_history_and_keeps_the_audit_log(
     keeper: Any, installation_admin: Any, loader: Loader
 ) -> None:

{lorebase_keeper-0.3.1 → lorebase_keeper-0.4.0}/tests/reading/test_routes.py

@@ -31,6 +31,27 @@ def test_read_routes_are_documented(app: FastAPI) -> None:
     assert documented >= READ_PATHS
 
 
+def test_a_record_read_documents_the_pending_conflicts_option(app: FastAPI) -> None:
+    document = app.openapi()
+    read = document["paths"]["/api/v1/domains/{domain_id}/kinds/{kind}/records/{key}"]["get"]
+    option = next(p for p in read["parameters"] if p["name"] == "conflicts")
+    assert option["in"] == "query"
+    assert option["required"] is False
+    assert option["schema"]["default"] is False
+    schemas = document["components"]["schemas"]
+    assert "conflict_in_progress" in schemas["RecordResponse"]["properties"]
+    assert "conflict_in_progress" not in schemas["RecordResponse"].get("required", [])
+    assert set(schemas["ConflictInProgressOut"]["properties"]) == {
+        "proposal_id",
+        "conflict_id",
+        "code",
+        "attribute",
+        "competing_hash",
+    }
+    # The marker is on the answer of one Record, never on every Record of a listing.
+    assert "conflict_in_progress" not in schemas["RecordOut"]["properties"]
+
+
 async def test_reads_need_a_database(
     app: FastAPI, client_for: Callable[[FastAPI], AbstractAsyncContextManager[httpx.AsyncClient]]
 ) -> None: