10 Commits
Author SHA1 Message Date
zemion 6c5545af66 docs(search): add complete German workflow guidance
Module Package Release / publish-packages (push) Successful in 11s
2026-08-22 20:56:44 +02:00
zemion 016136f56c feat(search): add governed DSAR coverage 2026-08-21 03:01:01 +02:00
zemion cc13bcf45e style: use shared WebUI foundation tokens 2026-08-18 21:32:50 +02:00
zemion 1a042593d5 Adopt shared WebUI structural primitives 2026-08-18 13:17:32 +02:00
zemion 9826d098f6 Adopt shared WebUI layout primitives 2026-08-18 11:30:40 +02:00
zemion 279226594c Adopt shared WebUI layout primitives 2026-08-18 10:42:54 +02:00
zemion 0f9d760bb0 Release v0.1.18
Module Package Release / publish-packages (push) Successful in 12s
2026-08-05 21:07:52 +02:00
zemion 016869aba0 Release v0.1.17
Module Package Release / publish-packages (push) Successful in 12s
2026-08-05 20:34:13 +02:00
zemion 101dc3814c Release v0.1.16
Module Package Release / publish-packages (push) Successful in 12s
2026-08-05 19:52:32 +02:00
zemion 3442b5fa4e refactor: open search from titlebar command 2026-08-05 00:03:33 +02:00
16 changed files with 1377 additions and 129 deletions
+22 -1
View File
@@ -4,7 +4,14 @@
**Repository type:** module (platform). **Repository type:** module (platform).
<!-- govoplan-repository-type:end --> <!-- govoplan-repository-type:end -->
Permission-aware global and contextual search for GovOPlaN. Permission-aware global and contextual search for GovOPlaN. Search is the first
command in the titlebar action group. Clicking its icon, pressing `F3`, or
pressing `Ctrl`/`Cmd`+`K` opens the same full query field and result overlay.
The titlebar command, result overlay, filters, and Search administration route
announce stable help contexts. Pressing `F1` while one of those controls is
focused opens its Search documentation, with the current page retained as a
fallback.
The route, overlay, state, accessibility, and consequence mapping is recorded in The route, overlay, state, accessibility, and consequence mapping is recorded in
[`docs/INTERFACE_PATTERN_MIGRATION.md`](docs/INTERFACE_PATTERN_MIGRATION.md). [`docs/INTERFACE_PATTERN_MIGRATION.md`](docs/INTERFACE_PATTERN_MIGRATION.md).
@@ -48,3 +55,17 @@ Files, Campaign, Calendar, Mail, IDM, and Postbox provide native source
adapters. Mail indexes only its bounded read-only cache, and Postbox never adapters. Mail indexes only its bounded read-only cache, and Postbox never
indexes ciphertext or key material. All six recheck current source-owned indexes ciphertext or key material. All six recheck current source-owned
authorization when results are returned. authorization when results are returned.
## Data-subject requests
Search publishes `privacy.dsar.search` for derived index documents, queued
changes, and minimized ACL projections. Exact Search or source-module
references locate derived copies without exporting indexed text, URLs,
metadata, token values, hashes, cursors, queued payloads, or errors. Account,
identity, and membership matches describe access projections only and do not
establish ownership of source content.
Derived documents and queued changes can be purged idempotently. ACL-only
matches require review at the source authority. The authoritative module must
be corrected or erased before a rebuild; otherwise its provider may republish
the derived Search row.
+1 -1
View File
@@ -6,7 +6,7 @@ authorization, and optional external engines remain provider capabilities.
| Surface | Task and archetype | Consequence and state contract | | Surface | Task and archetype | Consequence and state contract |
| --- | --- | --- | | --- | --- | --- |
| Title-bar search and anchored overlay | Global or context-sensitive focused lookup | F3 and Ctrl/Cmd+K open the same focus-contained Core dialog. Arrow keys move through the listbox, Enter opens the selected result, Escape closes it and restores focus. | | Title-bar Search command and overlay | Global or context-sensitive focused lookup | The left-most titlebar command, F3, and Ctrl/Cmd+K open the same focus-contained Core dialog with a full-width query field. Arrow keys move through the listbox, Enter opens the selected result, Escape closes it and restores focus. |
| Overlay filters | Progressive-disclosure filter popover | Module and resource filters only narrow authorized results. Active filters stay visible and removable by keyboard. | | Overlay filters | Progressive-disclosure filter popover | Module and resource filters only narrow authorized results. Active filters stay visible and removable by keyboard. |
| `/search` | Full-page search/results fallback | Query and filters are URL-stable. Loading, empty, provider-partial, failed, and paged states remain inside the result region. | | `/search` | Full-page search/results fallback | Query and filters are URL-stable. Loading, empty, provider-partial, failed, and paged states remain inside the result region. |
| Result entries | Permission-filtered list-detail destinations | A source module supplies the title, safe summary, breadcrumbs, and destination. Search does not infer or bypass source authorization. | | Result entries | Permission-filtered list-detail destinations | A source module supplies the title, safe summary, breadcrumbs, and destination. Search does not infer or bypass source authorization. |
+2 -2
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/search-webui", "name": "@govoplan/search-webui",
"version": "0.1.15", "version": "0.1.19",
"private": true, "private": true,
"type": "module", "type": "module",
"main": "webui/src/index.ts", "main": "webui/src/index.ts",
@@ -19,7 +19,7 @@
"LICENSE" "LICENSE"
], ],
"peerDependencies": { "peerDependencies": {
"@govoplan/core-webui": "^0.1.15", "@govoplan/core-webui": "^0.1.18",
"lucide-react": "^1.23.0", "lucide-react": "^1.23.0",
"react": ">=19.2.7 <20", "react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20", "react-dom": ">=19.2.7 <20",
+2 -2
View File
@@ -4,13 +4,13 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "govoplan-search" name = "govoplan-search"
version = "0.1.15" version = "0.1.19"
description = "Permission-aware global and contextual search for GovOPlaN." description = "Permission-aware global and contextual search for GovOPlaN."
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"
license = "AGPL-3.0-or-later" license = "AGPL-3.0-or-later"
authors = [{ name = "GovOPlaN" }] authors = [{ name = "GovOPlaN" }]
dependencies = ["govoplan-core>=0.1.15"] dependencies = ["govoplan-core>=0.1.37"]
[tool.setuptools.packages.find] [tool.setuptools.packages.find]
where = ["src"] where = ["src"]
+1 -1
View File
@@ -1,3 +1,3 @@
"""GovOPlaN search module.""" """GovOPlaN search module."""
__version__ = "0.1.15" __version__ = "0.1.19"
@@ -0,0 +1,576 @@
from __future__ import annotations
from collections.abc import Sequence
from dataclasses import dataclass
from datetime import datetime, timezone
from sqlalchemy import tuple_
from sqlalchemy.orm import Session
from govoplan_core.core.dsar import (
DsarErasureActionRef,
DsarExecutionResultRef,
DsarRecordRef,
DsarSubjectRef,
dsar_capability_name,
)
from govoplan_search.backend.db.models import (
SearchIndexAclToken,
SearchIndexChangeQueue,
SearchIndexDocument,
)
SEARCH_DSAR_CAPABILITY = dsar_capability_name("search")
_MAX_RECORDS = 5_000
_CONFLICT = object()
_RESERVED_REFERENCE_NAMES = frozenset(
{
"search.account",
"search.identity",
"search.membership",
"access.account",
"identity.id",
"tenancy.membership",
"search.document",
"search.index_document",
"search.change",
"search.queued_change",
}
)
@dataclass(frozen=True, slots=True)
class _SourceReference:
module_id: str
resource_type: str
resource_id: str
@dataclass(frozen=True, slots=True)
class _SubjectSelectors:
account_id: str | None
identity_id: str | None
membership_id: str | None
document_id: str | None
change_id: str | None
source_references: tuple[_SourceReference, ...]
@property
def acl_tokens(self) -> tuple[str, ...]:
return tuple(
token
for token in (
f"account:{self.account_id}" if self.account_id else None,
f"identity:{self.identity_id}" if self.identity_id else None,
f"membership:{self.membership_id}" if self.membership_id else None,
)
if token
)
@property
def has_direct_selector(self) -> bool:
return bool(self.document_id or self.change_id or self.source_references)
@dataclass(frozen=True, slots=True)
class _ResourceIdentity:
module_id: str
resource_type: str
resource_id: str
class SearchDsarProvider:
provider_id = "search"
module_id = "search"
def search_subject(
self,
session: object,
*,
tenant_id: str,
subject: DsarSubjectRef,
) -> Sequence[DsarRecordRef]:
db = _session(session)
selectors = _subject_selectors(subject)
if selectors is None or not (
selectors.acl_tokens or selectors.has_direct_selector
):
return ()
direct = _direct_rows(db, tenant_id=tenant_id, selectors=selectors)
if direct is None:
return ()
documents, changes = direct
records: list[DsarRecordRef] = []
seen: set[tuple[str, str]] = set()
def append(record: DsarRecordRef) -> None:
key = (record.resource_type, record.resource_id)
if key in seen:
return
if len(records) >= _MAX_RECORDS:
raise ValueError(
"Search DSAR result limit exceeded; narrow the selectors."
)
seen.add(key)
records.append(record)
for row in documents:
append(_document_record(row))
for row in changes:
append(_change_record(row))
for row, document in _acl_rows(
db,
tenant_id=tenant_id,
selectors=selectors,
direct_identities={_identity(item) for item in (*documents, *changes)},
):
append(_acl_record(row, document=document))
return tuple(records)
def plan_erasure(
self,
session: object,
*,
tenant_id: str,
subject: DsarSubjectRef,
records: Sequence[DsarRecordRef],
) -> Sequence[DsarErasureActionRef]:
del tenant_id
_session(session)
if _subject_selectors(subject) is None:
raise ValueError("Search DSAR subject selectors conflict.")
actions: list[DsarErasureActionRef] = []
for record in records:
_validate_record(record)
executable = record.resource_type in {
"search_index_document",
"search_index_change",
}
kind = "delete" if executable else "manual_review"
actions.append(
DsarErasureActionRef(
action_id=(
f"search:{kind}:{record.resource_type}:{record.resource_id}"
),
provider_id=self.provider_id,
module_id=self.module_id,
kind=kind,
resource_type=record.resource_type,
resource_id=record.resource_id,
title=(
f"Delete {record.title}"
if executable
else f"Review {record.title}"
),
rationale=(
"The row is a derived Search cache or queued copy and can "
"be removed without changing the authoritative source."
if executable
else "The ACL token is a derived authorization projection; correct or revoke authority at the source before rebuilding Search."
),
executable=executable,
)
)
return tuple(actions)
def execute_erasure(
self,
session: object,
*,
tenant_id: str,
subject: DsarSubjectRef,
actions: Sequence[DsarErasureActionRef],
request_id: str,
) -> Sequence[DsarExecutionResultRef]:
db = _session(session)
if _subject_selectors(subject) is None:
raise ValueError("Search DSAR subject selectors conflict.")
results: list[DsarExecutionResultRef] = []
for action in actions:
_validate_action(action)
if not action.executable:
results.append(
DsarExecutionResultRef(
action_id=action.action_id,
status="blocked",
summary=(
"Correct the source-owned authorization before the "
"next Search rebuild."
),
evidence={"request_id": request_id},
)
)
continue
model = {
"search_index_document": SearchIndexDocument,
"search_index_change": SearchIndexChangeQueue,
}.get(action.resource_type)
if model is None or action.kind != "delete":
raise ValueError("Search DSAR executable action is not supported.")
row = (
db.query(model)
.filter(
model.tenant_id == tenant_id,
model.id == action.resource_id,
)
.one_or_none()
)
if row is None:
status = "unchanged"
summary = "Derived Search row was already absent."
else:
db.delete(row)
db.flush()
status = "executed"
summary = (
"Derived Search row removed; the source owner remains "
"authoritative and must be corrected before any rebuild."
)
results.append(
DsarExecutionResultRef(
action_id=action.action_id,
status=status,
summary=summary,
evidence={"request_id": request_id},
)
)
return tuple(results)
def _direct_rows(
session: Session,
*,
tenant_id: str,
selectors: _SubjectSelectors,
) -> tuple[list[SearchIndexDocument], list[SearchIndexChangeQueue]] | None:
documents: dict[str, SearchIndexDocument] = {}
changes: dict[str, SearchIndexChangeQueue] = {}
direct_identities: list[_ResourceIdentity] = []
source_identities: set[_ResourceIdentity] = set()
if selectors.document_id:
row = (
session.query(SearchIndexDocument)
.filter(
SearchIndexDocument.tenant_id == tenant_id,
SearchIndexDocument.id == selectors.document_id,
)
.one_or_none()
)
if row is None:
return None
documents[row.id] = row
direct_identities.append(_identity(row))
if selectors.change_id:
row = (
session.query(SearchIndexChangeQueue)
.filter(
SearchIndexChangeQueue.tenant_id == tenant_id,
SearchIndexChangeQueue.id == selectors.change_id,
)
.one_or_none()
)
if row is None:
return None
changes[row.id] = row
direct_identities.append(_identity(row))
if len(set(direct_identities)) > 1:
return None
for reference in selectors.source_references:
document_rows = (
session.query(SearchIndexDocument)
.filter(
SearchIndexDocument.tenant_id == tenant_id,
SearchIndexDocument.module_id == reference.module_id,
SearchIndexDocument.resource_type == reference.resource_type,
SearchIndexDocument.resource_id == reference.resource_id,
)
.order_by(SearchIndexDocument.id)
.limit(_MAX_RECORDS + 1)
.all()
)
change_rows = (
session.query(SearchIndexChangeQueue)
.filter(
SearchIndexChangeQueue.tenant_id == tenant_id,
SearchIndexChangeQueue.module_id == reference.module_id,
SearchIndexChangeQueue.resource_type == reference.resource_type,
SearchIndexChangeQueue.resource_id == reference.resource_id,
)
.order_by(SearchIndexChangeQueue.id)
.limit(_MAX_RECORDS + 1)
.all()
)
if not document_rows and not change_rows:
return None
source_identities.update(
_identity(row) for row in (*document_rows, *change_rows)
)
documents.update((row.id, row) for row in document_rows)
changes.update((row.id, row) for row in change_rows)
if direct_identities and selectors.source_references:
if not set(direct_identities).issubset(source_identities):
return None
if len(documents) + len(changes) > _MAX_RECORDS:
raise ValueError("Search DSAR result limit exceeded; narrow the selectors.")
return (
sorted(documents.values(), key=lambda row: row.id),
sorted(changes.values(), key=lambda row: row.id),
)
def _acl_rows(
session: Session,
*,
tenant_id: str,
selectors: _SubjectSelectors,
direct_identities: set[_ResourceIdentity],
) -> list[tuple[SearchIndexAclToken, SearchIndexDocument]]:
if not selectors.acl_tokens:
return []
query = (
session.query(SearchIndexAclToken, SearchIndexDocument)
.join(
SearchIndexDocument,
SearchIndexDocument.id == SearchIndexAclToken.document_id,
)
.filter(
SearchIndexDocument.tenant_id == tenant_id,
SearchIndexAclToken.token.in_(selectors.acl_tokens),
)
)
if direct_identities:
query = query.filter(
tuple_(
SearchIndexDocument.module_id,
SearchIndexDocument.resource_type,
SearchIndexDocument.resource_id,
).in_(
sorted(
(
identity.module_id,
identity.resource_type,
identity.resource_id,
)
for identity in direct_identities
)
)
)
rows = (
query.order_by(SearchIndexDocument.id, SearchIndexAclToken.id)
.limit(_MAX_RECORDS + 1)
.all()
)
if len(rows) > _MAX_RECORDS:
raise ValueError("Search DSAR result limit exceeded; narrow the selectors.")
return rows
def _identity(row: object) -> _ResourceIdentity:
return _ResourceIdentity(
module_id=str(getattr(row, "module_id")),
resource_type=str(getattr(row, "resource_type")),
resource_id=str(getattr(row, "resource_id")),
)
def _document_record(row: SearchIndexDocument) -> DsarRecordRef:
return _record(
"search_index_document",
row.id,
"derived_search_document",
"Derived Search document",
{
"module_id": row.module_id,
"provider_id": row.provider_id,
"resource_type": row.resource_type,
"resource_id": row.resource_id,
"source_revision": row.source_revision,
"source_updated_at": _iso(row.source_updated_at),
"visibility": row.visibility,
"index_version": row.index_version,
"requires_authorization_recheck": row.requires_authorization_recheck,
"active": row.active,
"indexed_at": _iso(row.indexed_at),
},
observed_at=row.indexed_at,
)
def _change_record(row: SearchIndexChangeQueue) -> DsarRecordRef:
return _record(
"search_index_change",
row.id,
"derived_search_change",
"Queued Search change",
{
"module_id": row.module_id,
"provider_id": row.provider_id,
"resource_type": row.resource_type,
"resource_id": row.resource_id,
"kind": row.kind,
"source_revision": row.source_revision,
"occurred_at": _iso(row.occurred_at),
"status": row.status,
"attempts": row.attempts,
"available_at": _iso(row.available_at),
"processed_at": _iso(row.processed_at),
},
observed_at=row.occurred_at or row.created_at,
)
def _acl_record(
row: SearchIndexAclToken,
*,
document: SearchIndexDocument,
) -> DsarRecordRef:
return _record(
"search_acl_projection",
row.id,
"derived_access_projection",
"Search access projection",
{
"module_id": document.module_id,
"resource_type": document.resource_type,
"resource_id": document.resource_id,
"token_kind": row.token.partition(":")[0],
"active": document.active,
"indexed_at": _iso(document.indexed_at),
},
observed_at=document.indexed_at,
)
def _subject_selectors(subject: DsarSubjectRef) -> _SubjectSelectors | None:
references = subject.external_references
values = {
"account_id": _coalesce(
subject.account_id,
references.get("search.account"),
references.get("access.account"),
),
"identity_id": _coalesce(
subject.identity_id,
references.get("search.identity"),
references.get("identity.id"),
),
"membership_id": _coalesce(
subject.membership_id,
references.get("search.membership"),
references.get("tenancy.membership"),
),
"document_id": _coalesce(
references.get("search.document"),
references.get("search.index_document"),
),
"change_id": _coalesce(
references.get("search.change"),
references.get("search.queued_change"),
),
}
if any(value is _CONFLICT for value in values.values()):
return None
source_references: list[_SourceReference] = []
for key, raw_value in sorted(references.items()):
if key in _RESERVED_REFERENCE_NAMES:
continue
module_id, separator, resource_type = key.partition(".")
value = str(raw_value or "").strip()
if (
not separator
or not module_id
or module_id == "search"
or not resource_type
or not value
):
continue
source_references.append(
_SourceReference(
module_id=module_id,
resource_type=resource_type,
resource_id=value,
)
)
return _SubjectSelectors(
account_id=_optional_string(values["account_id"]),
identity_id=_optional_string(values["identity_id"]),
membership_id=_optional_string(values["membership_id"]),
document_id=_optional_string(values["document_id"]),
change_id=_optional_string(values["change_id"]),
source_references=tuple(source_references),
)
def _coalesce(*values: str | None) -> str | None | object:
normalized = {str(value).strip() for value in values if str(value or "").strip()}
if len(normalized) > 1:
return _CONFLICT
return next(iter(normalized), None)
def _optional_string(value: object) -> str | None:
return value if isinstance(value, str) and value else None
def _record(
resource_type: str,
resource_id: str,
category: str,
title: str,
data: dict[str, object],
*,
observed_at: datetime | None,
) -> DsarRecordRef:
return DsarRecordRef(
provider_id="search",
module_id="search",
resource_type=resource_type,
resource_id=resource_id,
category=category,
title=title,
data={key: value for key, value in data.items() if value is not None},
observed_at=_aware(observed_at),
source_path="/admin/search",
)
def _iso(value: datetime | None) -> str | None:
aware = _aware(value)
return aware.isoformat() if aware else None
def _aware(value: datetime | None) -> datetime | None:
if value is None or value.tzinfo is not None:
return value
return value.replace(tzinfo=timezone.utc)
def _session(value: object) -> Session:
if not isinstance(value, Session):
raise TypeError("Search DSAR requires a SQLAlchemy Session.")
return value
def _validate_record(record: DsarRecordRef) -> None:
if record.provider_id != "search" or record.module_id != "search":
raise ValueError("Search DSAR cannot plan a foreign provider record.")
if not record.resource_type or not record.resource_id:
raise ValueError("Search DSAR record identity is incomplete.")
def _validate_action(action: DsarErasureActionRef) -> None:
if action.provider_id != "search" or action.module_id != "search":
raise ValueError("Search DSAR cannot execute a foreign provider action.")
if not action.action_id.startswith("search:"):
raise ValueError("Search DSAR action identity is invalid.")
__all__ = ["SEARCH_DSAR_CAPABILITY", "SearchDsarProvider"]
+207 -5
View File
@@ -11,6 +11,8 @@ from govoplan_core.core.module_guards import (
persistent_table_uninstall_guard, persistent_table_uninstall_guard,
) )
from govoplan_core.core.modules import ( from govoplan_core.core.modules import (
CapabilityDocumentation,
DocumentationCondition,
DocumentationLink, DocumentationLink,
DocumentationTopic, DocumentationTopic,
FrontendModule, FrontendModule,
@@ -30,11 +32,15 @@ from govoplan_core.core.search import (
from govoplan_core.core.views import ViewSurface from govoplan_core.core.views import ViewSurface
from govoplan_core.db.base import Base from govoplan_core.db.base import Base
from govoplan_search.backend.db import models as search_models from govoplan_search.backend.db import models as search_models
from govoplan_search.backend.dsar_provider import (
SEARCH_DSAR_CAPABILITY,
SearchDsarProvider,
)
MODULE_ID = "search" MODULE_ID = "search"
MODULE_NAME = "Search" MODULE_NAME = "Search"
MODULE_VERSION = "0.1.15" MODULE_VERSION = "0.1.19"
READ_SCOPE = "search:result:read" READ_SCOPE = "search:result:read"
INDEX_SCOPE = "search:index:write" INDEX_SCOPE = "search:index:write"
ADMIN_SCOPE = "search:index:admin" ADMIN_SCOPE = "search:index:admin"
@@ -101,6 +107,11 @@ def _router(_context: ModuleContext):
return router return router
def _dsar_provider(context: ModuleContext) -> SearchDsarProvider:
del context
return SearchDsarProvider()
manifest = ModuleManifest( manifest = ModuleManifest(
id=MODULE_ID, id=MODULE_ID,
name=MODULE_NAME, name=MODULE_NAME,
@@ -122,6 +133,7 @@ manifest = ModuleManifest(
ModuleInterfaceProvider(name="search.provider", version="1.0.0"), ModuleInterfaceProvider(name="search.provider", version="1.0.0"),
ModuleInterfaceProvider(name="search.index_writer", version="1.1.0"), ModuleInterfaceProvider(name="search.index_writer", version="1.1.0"),
ModuleInterfaceProvider(name="search.source", version="1.0.0"), ModuleInterfaceProvider(name="search.source", version="1.0.0"),
ModuleInterfaceProvider(name=SEARCH_DSAR_CAPABILITY, version="0.1.0"),
), ),
permissions=PERMISSIONS, permissions=PERMISSIONS,
role_templates=ROLE_TEMPLATES, role_templates=ROLE_TEMPLATES,
@@ -189,6 +201,14 @@ manifest = ModuleManifest(
), ),
capability_factories={ capability_factories={
CAPABILITY_SEARCH_INDEX_WRITER: _service, CAPABILITY_SEARCH_INDEX_WRITER: _service,
SEARCH_DSAR_CAPABILITY: _dsar_provider,
},
capability_documentation={
SEARCH_DSAR_CAPABILITY: CapabilityDocumentation(
label="Search data-subject request provider",
summary="Finds and purges derived index copies while preserving source authority.",
contract_version="0.1.0",
),
}, },
search_providers=( search_providers=(
SearchProviderRegistration( SearchProviderRegistration(
@@ -198,6 +218,84 @@ manifest = ModuleManifest(
), ),
), ),
documentation=( documentation=(
DocumentationTopic(
id="search.data-subject-requests",
title="Derived Search data-subject requests",
summary="Remove derived index copies without treating Search as the authoritative data owner.",
body=(
"Search correlates explicit index/change identifiers and provider-owned source references inside the exact tenant. Account, identity, and membership selectors expose only minimized ACL projections and never imply ownership of the indexed source object. Indexed title, summary, body, search text, URL, keywords, metadata, external-reference payloads, ACL token values, hashes, cursors, queued documents, and errors are excluded. "
"Derived document and queued-change rows may be deleted idempotently. ACL-only matches require source-authority review. Source correction or erasure must happen in the owner module before Search is rebuilt; otherwise the source can legitimately republish the derived entry."
),
layer="configured",
documentation_types=("admin", "user"),
audience=("user", "operator", "module_admin", "auditor"),
related_modules=("core", "access"),
metadata={
"kind": "reference",
"help_contexts": [
"search.data-subject-requests",
"search.admin.index",
],
"consequence_classes": {
"purge_derived_index": (
"Deletes matching derived documents and queued changes idempotently."
),
"preserve_authoritative_source": (
"Does not correct or erase the authoritative object owned by its source module."
),
"review_acl_only_matches": (
"Requires source-authority review when only an ACL projection identifies the subject."
),
},
},
translations={
"de": {
"title": "Datenschutzanfragen zum abgeleiteten Suchindex",
"summary": (
"Abgeleitete Indexkopien entfernen, ohne Search als führende Quelle "
"der indexierten Objekte zu behandeln."
),
"body": (
"Search gleicht innerhalb des exakten Mandanten nur ausdrückliche Index- "
"oder Änderungskennungen und quellanbietergeführte Referenzen ab. Selektoren "
"für Konten, Identitäten und Mitgliedschaften legen ausschließlich minimierte "
"Berechtigungsprojektionen offen und begründen niemals die Eigentümerschaft am "
"indexierten Quellobjekt. Indexierter Titel, Zusammenfassung, Inhalt, Suchtext, "
"URL, Schlüsselwörter, Metadaten, externe Referenzinhalte, Berechtigungswerte, "
"Prüfsummen, Cursor, eingereihte Dokumente und Fehler bleiben ausgeschlossen. "
"Abgeleitete Dokumente und eingereihte Änderungen können idempotent gelöscht "
"werden. Treffer allein über Berechtigungsprojektionen erfordern eine Prüfung "
"durch die führende Quelle. Berichtigung oder Löschung muss im Eigentümermodul "
"erfolgen, bevor Search neu aufgebaut wird; andernfalls darf die Quelle den "
"abgeleiteten Eintrag erneut veröffentlichen."
),
}
},
structured_translation_version="1",
structured_translations={
"de": {
"consequence_classes": {
"purge_derived_index": (
"Löscht passende abgeleitete Dokumente und eingereihte Änderungen idempotent."
),
"preserve_authoritative_source": (
"Berichtigt oder löscht nicht das führende Objekt des jeweiligen Quellmoduls."
),
"review_acl_only_matches": (
"Erfordert eine Prüfung durch die führende Quelle, wenn die betroffene Person nur über eine Berechtigungsprojektion erkannt wird."
),
}
}
},
links=(
DocumentationLink(
label="Search index lifecycle",
href="govoplan-search/README.md",
kind="repository",
),
),
order=11,
),
DocumentationTopic( DocumentationTopic(
id="search.global-and-contextual", id="search.global-and-contextual",
title="Global and contextual search", title="Global and contextual search",
@@ -209,7 +307,8 @@ manifest = ModuleManifest(
"Search works with the built-in database index and can aggregate " "Search works with the built-in database index and can aggregate "
"optional providers. Source modules announce searchable types, " "optional providers. Source modules announce searchable types, "
"context scopes, and ACL-aware index entries. External engines " "context scopes, and ACL-aware index entries. External engines "
"remain optional adapters. F3 or the title-bar field opens the " "remain optional adapters. The title-bar Search command, F3, "
"or Ctrl/Cmd+K opens the "
"keyboard-navigable search overlay; filters never broaden the " "keyboard-navigable search overlay; filters never broaden the "
"current principal's source permissions. Provider failures are " "current principal's source permissions. Provider failures are "
"shown as partial diagnostics without discarding safe results." "shown as partial diagnostics without discarding safe results."
@@ -222,6 +321,99 @@ manifest = ModuleManifest(
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
audience=("administrator", "user"), audience=("administrator", "user"),
related_modules=("connectors", "views"), related_modules=("connectors", "views"),
conditions=(DocumentationCondition(required_scopes=(READ_SCOPE,)),),
metadata={
"kind": "workflow",
"help_contexts": [
"search.global",
"search.results",
"search.filters",
"search.admin.index",
],
"purpose": (
"Find currently authorized native and connected objects without broadening source permissions."
),
"prerequisites": [
"The actor has Search read access and the source module authorizes each returned object now.",
"At least one enabled source provider has published or can supply a searchable projection.",
],
"steps": [
"Open Search from the title bar, F3, or Ctrl/Cmd+K and enter a precise term.",
"Narrow the result set by type, source, or context without changing source authorization.",
"Review partial-provider and quarantine diagnostics before relying on completeness.",
"Open an authorized result; Search rechecks the provider-owned object permission before disclosure.",
"Administrators may process queued changes, reconcile providers, or start a bounded rebuild when diagnostics require it.",
],
"limitations": [
"Search is a derived discovery layer and is never authoritative for source content or access decisions.",
"A provider failure can make results incomplete but never permits unsafe results to bypass ACL filtering.",
],
"operational_consequences": {
"process_queue": "Applies pending derived index changes under current tenant and provider boundaries.",
"reconcile": "Compares enabled source coverage and retains unresolved changes in quarantine.",
"rebuild": "Recreates bounded derived projections while source data remains authoritative.",
},
"verification": [
"Every displayed result names its source and remains openable by the current principal.",
"Partial-provider failures and quarantined changes remain visible as diagnostics.",
"Administrative rebuild status can be reconciled against the enabled provider inventory.",
],
},
translations={
"de": {
"title": "Globale und kontextbezogene Suche",
"summary": (
"Berechtigte native und angebundene Objekte über eine gemeinsame, "
"berechtigungsbewusste Oberfläche finden."
),
"body": (
"Search verwendet den eingebauten Datenbankindex und kann optionale Anbieter "
"zusammenführen. Quellmodule melden durchsuchbare Typen, Kontextbereiche und "
"berechtigungsgeprüfte Indexeinträge. Externe Suchmaschinen bleiben optionale "
"Adapter. Der Suchbefehl in der Titelleiste, F3 oder Strg/Cmd+K öffnet die per "
"Tastatur bedienbare Suchüberlagerung; Filter erweitern niemals die "
"Quellberechtigungen der aktuellen Person. Anbieterausfälle werden als partielle "
"Diagnosen angezeigt, ohne sichere Ergebnisse zu verwerfen. Administratoren "
"können die Abdeckung nativer Quellen prüfen, eingereihte Änderungen verarbeiten, "
"aktivierte Module abgleichen und begrenzte Neuaufbauten aus der Administration "
"starten. Änderungen in Quarantäne bleiben sichtbar, bis sie repariert und "
"abgeglichen wurden."
),
}
},
structured_translation_version="1",
structured_translations={
"de": {
"purpose": (
"Aktuell berechtigte native und angebundene Objekte finden, ohne Quellberechtigungen zu erweitern."
),
"prerequisites": [
"Die handelnde Person darf Search lesen und das Quellmodul autorisiert jedes zurückgegebene Objekt weiterhin.",
"Mindestens ein aktivierter Quellanbieter hat eine durchsuchbare Projektion veröffentlicht oder kann sie bereitstellen.",
],
"steps": [
"Search über die Titelleiste, F3 oder Strg/Cmd+K öffnen und einen präzisen Suchbegriff eingeben.",
"Die Ergebnisse nach Typ, Quelle oder Kontext eingrenzen, ohne die Quellautorisierung zu verändern.",
"Diagnosen zu partiellen Anbieterausfällen und Quarantäne prüfen, bevor Vollständigkeit angenommen wird.",
"Ein berechtigtes Ergebnis öffnen; Search prüft vor der Offenlegung erneut die Berechtigung am quellengeführten Objekt.",
"Administratoren können bei entsprechenden Diagnosen eingereihte Änderungen verarbeiten, Anbieter abgleichen oder einen begrenzten Neuaufbau starten.",
],
"limitations": [
"Search ist eine abgeleitete Auffindbarkeitsschicht und niemals führend für Quellinhalte oder Zugriffsentscheidungen.",
"Ein Anbieterausfall kann Ergebnisse unvollständig machen, erlaubt aber niemals das Umgehen der Berechtigungsfilterung.",
],
"operational_consequences": {
"process_queue": "Verarbeitet ausstehende abgeleitete Indexänderungen innerhalb der aktuellen Mandanten- und Anbietergrenzen.",
"reconcile": "Vergleicht die Abdeckung aktivierter Quellen und hält ungeklärte Änderungen in Quarantäne.",
"rebuild": "Erstellt begrenzte abgeleitete Projektionen neu, während die Quelldaten führend bleiben.",
},
"verification": [
"Jedes angezeigte Ergebnis nennt seine Quelle und kann von der aktuellen Person weiterhin geöffnet werden.",
"Partielle Anbieterausfälle und Änderungen in Quarantäne bleiben als Diagnosen sichtbar.",
"Der administrative Neuaufbaustatus lässt sich mit dem Inventar aktivierter Anbieter abgleichen.",
],
}
},
links=( links=(
DocumentationLink( DocumentationLink(
label="Search interface pattern audit", label="Search interface pattern audit",
@@ -238,10 +430,20 @@ manifest = ModuleManifest(
maturity="vertical_slice", maturity="vertical_slice",
documentation_ref="README.md", documentation_ref="README.md",
test_ref="tests/test_postgres_search.py", test_ref="tests/test_postgres_search.py",
known_limits=("The built-in PostgreSQL index is implemented; optional OpenSearch target evidence is not.",), known_limits=(
"The built-in PostgreSQL index is implemented; optional OpenSearch target evidence is not.",
),
supported_authority_modes=("external_mirror",), supported_authority_modes=("external_mirror",),
owned_concepts=("derived search index", "search ACL projection", "index change queue"), owned_concepts=(
non_owned_concepts=("source object", "source authorization", "external search engine"), "derived search index",
"search ACL projection",
"index change queue",
),
non_owned_concepts=(
"source object",
"source authorization",
"external search engine",
),
recovery_docs=("README.md",), recovery_docs=("README.md",),
security_docs=("README.md",), security_docs=("README.md",),
operations_docs=("README.md",), operations_docs=("README.md",),
+31
View File
@@ -0,0 +1,31 @@
from __future__ import annotations
import unittest
from govoplan_core.core.modules import (
documentation_structured_translation_issues,
user_workflow_scope_condition_issues,
)
from govoplan_search.backend.manifest import manifest
class SearchDocumentationTests(unittest.TestCase):
def test_public_topics_have_complete_german_reference_content(self) -> None:
self.assertEqual(2, len(manifest.documentation))
for topic in manifest.documentation:
translation = topic.translations.get("de", {})
self.assertTrue(
all(translation.get(key) for key in ("title", "summary", "body"))
)
self.assertEqual((), documentation_structured_translation_issues(topic))
def test_documentation_has_scope_conditioned_workflow_and_reference(self) -> None:
kinds = {topic.metadata.get("kind") for topic in manifest.documentation}
self.assertIn("workflow", kinds)
self.assertIn("reference", kinds)
for topic in manifest.documentation:
self.assertEqual((), user_workflow_scope_condition_issues(topic))
if __name__ == "__main__":
unittest.main()
+482
View File
@@ -0,0 +1,482 @@
from __future__ import annotations
import json
import unittest
from datetime import UTC, datetime, timedelta
from sqlalchemy import create_engine
from sqlalchemy.orm import Session
from govoplan_core.core.dsar import (
DsarErasureActionRef,
DsarProvider,
DsarRecordRef,
DsarSubjectRef,
)
from govoplan_core.db.base import Base
from govoplan_core.privacy.dsar_workflow import (
create_data_subject_request,
search_data_subject_request,
)
from govoplan_search.backend.db.models import (
SearchIndexAclToken,
SearchIndexChangeQueue,
SearchIndexDocument,
)
from govoplan_search.backend.dsar_provider import (
SEARCH_DSAR_CAPABILITY,
SearchDsarProvider,
)
from govoplan_search.backend.manifest import manifest
NOW = datetime(2026, 8, 21, 17, 0, tzinfo=UTC)
class _Registry:
def __init__(self, provider: SearchDsarProvider, *, active: bool = True) -> None:
self.provider = provider
self.active = active
def capability_names(self):
return (SEARCH_DSAR_CAPABILITY,)
def capability_owner(self, name):
self._assert_capability(name)
return "search"
def tenant_entitlement_resolver(self):
active = self.active
class _Resolver:
@staticmethod
def resolve(session, tenant_id):
del session, tenant_id
return type(
"State",
(),
{"effective_modules": ("search",) if active else ()},
)()
return _Resolver()
def require_tenant_capability(self, name, session, **kwargs):
del session, kwargs
self._assert_capability(name)
return self.provider
def manifests(self):
return (type("Manifest", (), {"id": "search"})(),)
@staticmethod
def _assert_capability(name: str) -> None:
if name != SEARCH_DSAR_CAPABILITY:
raise KeyError(name)
class SearchDsarProviderTests(unittest.TestCase):
def setUp(self) -> None:
self.engine = create_engine("sqlite+pysqlite:///:memory:")
Base.metadata.create_all(self.engine)
self.session = Session(self.engine)
self.provider = SearchDsarProvider()
self.assertIsInstance(self.provider, DsarProvider)
self._seed()
self.session.commit()
def tearDown(self) -> None:
self.session.close()
self.engine.dispose()
def _document(
self,
*,
row_id: str,
tenant_id: str,
resource_id: str,
) -> SearchIndexDocument:
return SearchIndexDocument(
id=row_id,
tenant_id=tenant_id,
module_id="cases",
provider_id="cases.search",
resource_type="case",
resource_id=resource_id,
title="private-title-do-not-export",
summary="private-summary-do-not-export",
body="private-body-do-not-export",
keywords=["private-keyword-do-not-export"],
search_text="private-search-text-do-not-export",
url="/private-url-do-not-export",
visibility="restricted",
external_reference={"secret": "private-reference-do-not-export"},
metadata_={"secret": "private-metadata-do-not-export"},
content_hash="a" * 64,
source_revision="revision-1",
change_cursor="private-cursor-do-not-export",
source_updated_at=NOW,
language="simple",
index_version=1,
requires_authorization_recheck=True,
rebuild_id="private-rebuild-id-do-not-export",
active=True,
indexed_at=NOW,
)
def _seed(self) -> None:
document = self._document(
row_id="document-1",
tenant_id="tenant-1",
resource_id="case-1",
)
document.acl_tokens.extend(
(
SearchIndexAclToken(
id="acl-1",
token="account:account-1",
),
SearchIndexAclToken(
id="acl-2",
token="identity:identity-1",
),
)
)
unrelated = self._document(
row_id="document-2",
tenant_id="tenant-1",
resource_id="case-2",
)
unrelated.acl_tokens.append(
SearchIndexAclToken(
id="acl-3",
token="account:account-1",
)
)
other_tenant = self._document(
row_id="document-3",
tenant_id="tenant-2",
resource_id="case-1",
)
other_tenant.acl_tokens.append(
SearchIndexAclToken(
id="acl-4",
token="account:account-1",
)
)
self.session.add_all((document, unrelated, other_tenant))
self.session.add_all(
(
SearchIndexChangeQueue(
id="change-1",
change_id="change-public-1",
tenant_id="tenant-1",
provider_id="cases.search",
module_id="cases",
resource_type="case",
resource_id="case-1",
kind="upsert",
source_revision="revision-1",
source_cursor="private-source-cursor-do-not-export",
document_={"secret": "private-queue-document-do-not-export"},
occurred_at=NOW,
status="queued",
attempts=1,
available_at=NOW,
error="private-error-do-not-export",
),
SearchIndexChangeQueue(
id="change-2",
change_id="change-public-2",
tenant_id="tenant-1",
provider_id="cases.search",
module_id="cases",
resource_type="case",
resource_id="case-2",
kind="upsert",
source_revision="revision-1",
source_cursor="unrelated-private-cursor",
document_={"secret": "unrelated-private-document"},
occurred_at=NOW + timedelta(minutes=1),
status="queued",
attempts=0,
available_at=NOW,
),
)
)
def test_source_reference_exports_only_minimized_derived_rows(self) -> None:
records = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(external_references={"cases.case": "case-1"}),
)
self.assertEqual(
{"search_index_document", "search_index_change"},
{record.resource_type for record in records},
)
exported = json.dumps([record.to_dict() for record in records])
self.assertIn("case-1", exported)
self.assertNotIn("case-2", exported)
for secret in (
"private-title-do-not-export",
"private-summary-do-not-export",
"private-body-do-not-export",
"private-keyword-do-not-export",
"private-search-text-do-not-export",
"private-url-do-not-export",
"private-reference-do-not-export",
"private-metadata-do-not-export",
"private-cursor-do-not-export",
"private-rebuild-id-do-not-export",
"private-source-cursor-do-not-export",
"private-queue-document-do-not-export",
"private-error-do-not-export",
):
self.assertNotIn(secret, exported)
def test_canonical_selectors_export_acl_projection_not_source_content(self) -> None:
records = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
account_id="account-1",
identity_id="identity-1",
),
)
self.assertEqual(
{"search_acl_projection"},
{record.resource_type for record in records},
)
self.assertEqual(3, len(records))
exported = json.dumps([record.to_dict() for record in records])
self.assertNotIn("account-1", exported)
self.assertNotIn("identity-1", exported)
self.assertNotIn("private-title-do-not-export", exported)
self.assertNotIn("document-3", exported)
def test_direct_references_and_conflicts_fail_closed(self) -> None:
direct = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
external_references={"search.document": "document-1"}
),
)
conflict = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
external_references={
"search.document": "document-1",
"cases.case": "case-2",
}
),
)
alias_conflict = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
external_references={
"search.document": "document-1",
"search.index_document": "document-2",
}
),
)
wrong_tenant = self.provider.search_subject(
self.session,
tenant_id="tenant-2",
subject=DsarSubjectRef(
external_references={"search.document": "document-1"}
),
)
wrong_resource_type = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(external_references={"cases.ticket": "case-1"}),
)
change_and_account = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=DsarSubjectRef(
account_id="account-1",
external_references={"search.change": "change-1"},
),
)
self.assertEqual(["document-1"], [record.resource_id for record in direct])
self.assertEqual((), conflict)
self.assertEqual((), alias_conflict)
self.assertEqual((), wrong_tenant)
self.assertEqual((), wrong_resource_type)
self.assertEqual(
{"change-1", "acl-1"},
{record.resource_id for record in change_and_account},
)
def test_derived_deletion_is_idempotent_but_acl_review_is_blocked(self) -> None:
direct_subject = DsarSubjectRef(external_references={"cases.case": "case-1"})
direct_records = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=direct_subject,
)
actions = self.provider.plan_erasure(
self.session,
tenant_id="tenant-1",
subject=direct_subject,
records=direct_records,
)
self.assertTrue(actions)
self.assertTrue(all(action.kind == "delete" for action in actions))
self.assertTrue(all(action.executable for action in actions))
first = self.provider.execute_erasure(
self.session,
tenant_id="tenant-1",
subject=direct_subject,
actions=actions,
request_id="dsar-1",
)
second = self.provider.execute_erasure(
self.session,
tenant_id="tenant-1",
subject=direct_subject,
actions=actions,
request_id="dsar-1-retry",
)
self.assertTrue(all(result.status == "executed" for result in first))
self.assertTrue(all(result.status == "unchanged" for result in second))
self.assertIsNone(self.session.get(SearchIndexDocument, "document-1"))
self.assertIsNone(self.session.get(SearchIndexChangeQueue, "change-1"))
acl_subject = DsarSubjectRef(account_id="account-1")
acl_records = self.provider.search_subject(
self.session,
tenant_id="tenant-1",
subject=acl_subject,
)
acl_actions = self.provider.plan_erasure(
self.session,
tenant_id="tenant-1",
subject=acl_subject,
records=acl_records,
)
self.assertTrue(all(action.kind == "manual_review" for action in acl_actions))
self.assertTrue(all(not action.executable for action in acl_actions))
results = self.provider.execute_erasure(
self.session,
tenant_id="tenant-1",
subject=acl_subject,
actions=acl_actions,
request_id="dsar-2",
)
self.assertTrue(all(result.status == "blocked" for result in results))
def test_foreign_records_and_actions_are_rejected(self) -> None:
subject = DsarSubjectRef(external_references={"cases.case": "case-1"})
with self.assertRaisesRegex(ValueError, "foreign provider record"):
self.provider.plan_erasure(
self.session,
tenant_id="tenant-1",
subject=subject,
records=(
DsarRecordRef(
provider_id="cases",
module_id="cases",
resource_type="case",
resource_id="case-1",
category="case",
title="Case",
),
),
)
with self.assertRaisesRegex(ValueError, "foreign provider action"):
self.provider.execute_erasure(
self.session,
tenant_id="tenant-1",
subject=subject,
actions=(
DsarErasureActionRef(
action_id="cases:delete:case:case-1",
provider_id="cases",
module_id="cases",
kind="delete",
resource_type="case",
resource_id="case-1",
title="Delete case",
rationale="Foreign",
executable=True,
),
),
request_id="dsar-1",
)
def test_core_workflow_reports_active_and_inactive_provider(self) -> None:
row = create_data_subject_request(
self.session,
tenant_id="tenant-1",
reference="DSAR-SEARCH-1",
request_kind="access_and_erasure",
subject=DsarSubjectRef(external_references={"cases.case": "case-1"}),
purpose="Respond to a verified request.",
legal_basis="Article 15 and 17 GDPR",
due_at=None,
requested_by_account_id="privacy-officer",
)
self.session.commit()
search_data_subject_request(
self.session,
registry=_Registry(self.provider),
row=row,
expected_revision=1,
)
self.assertEqual(
[SEARCH_DSAR_CAPABILITY], row.coverage["provider_capabilities"]
)
self.assertEqual(2, row.search_result["record_count"])
inactive = create_data_subject_request(
self.session,
tenant_id="tenant-1",
reference="DSAR-SEARCH-2",
request_kind="access",
subject=DsarSubjectRef(external_references={"cases.case": "case-1"}),
purpose="Respond to a verified request.",
legal_basis="Article 15 GDPR",
due_at=None,
requested_by_account_id="privacy-officer",
)
self.session.commit()
search_data_subject_request(
self.session,
registry=_Registry(self.provider, active=False),
row=inactive,
expected_revision=1,
)
self.assertEqual([], inactive.coverage["provider_capabilities"])
self.assertEqual(
[SEARCH_DSAR_CAPABILITY],
inactive.coverage["inactive_provider_capabilities"],
)
self.assertEqual(0, inactive.search_result["record_count"])
def test_manifest_registers_and_documents_the_capability(self) -> None:
self.assertIn(SEARCH_DSAR_CAPABILITY, manifest.capability_factories)
self.assertIn(SEARCH_DSAR_CAPABILITY, manifest.capability_documentation)
self.assertIn(
SEARCH_DSAR_CAPABILITY,
{item.name for item in manifest.provides_interfaces},
)
self.assertTrue(
any(
topic.id == "search.data-subject-requests"
and {"admin", "user"}.issubset(topic.documentation_types)
for topic in manifest.documentation
)
)
if __name__ == "__main__":
unittest.main()
+2 -2
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/search-webui", "name": "@govoplan/search-webui",
"version": "0.1.15", "version": "0.1.19",
"private": true, "private": true,
"type": "module", "type": "module",
"main": "src/index.ts", "main": "src/index.ts",
@@ -18,7 +18,7 @@
"test:interface-pattern": "node scripts/test-interface-pattern.mjs" "test:interface-pattern": "node scripts/test-interface-pattern.mjs"
}, },
"peerDependencies": { "peerDependencies": {
"@govoplan/core-webui": "^0.1.15", "@govoplan/core-webui": "^0.1.18",
"lucide-react": "^1.23.0", "lucide-react": "^1.23.0",
"react": ">=19.2.7 <20", "react": ">=19.2.7 <20",
"react-dom": ">=19.2.7 <20", "react-dom": ">=19.2.7 <20",
@@ -9,18 +9,20 @@ const source = readFileSync("src/components/GlobalSearch.tsx", "utf8");
const layoutSource = readFileSync("src/components/searchOverlayLayout.ts", "utf8"); const layoutSource = readFileSync("src/components/searchOverlayLayout.ts", "utf8");
const styles = readFileSync("src/styles/search.css", "utf8"); const styles = readFileSync("src/styles/search.css", "utf8");
assert(source.includes("onFocus={handleSourceFocus}"), "focusing the titlebar field opens Search"); assert(source.includes("titlebar-icon-link titlebar-search-button"), "Search uses the shared titlebar icon-button appearance");
assert(source.includes("suppressRestoredFocusRef.current"), "restored dialog focus does not immediately reopen Search"); assert(source.includes("onClick={openOverlay}"), "clicking the titlebar Search command opens Search");
assert(!source.includes("sourceInputRef"), "the titlebar no longer reserves a persistent Search field");
assert(source.includes("<Dialog"), "Search uses the shared Dialog component"); assert(source.includes("<Dialog"), "Search uses the shared Dialog component");
assert(source.includes("portal"), "the Search dialog portals above the complete shell"); assert(source.includes("portal"), "the Search dialog portals above the complete shell");
assert(source.includes("calculateSearchOverlayLayout"), "the overlay is anchored to the titlebar field"); assert(source.includes("calculateSearchOverlayLayout"), "the overlay position is derived from the titlebar command");
assert(source.includes("listSearchProviders"), "the overlay loads the complete filter catalogue"); assert(source.includes("listSearchProviders"), "the overlay loads the complete filter catalogue");
assert(source.includes("limit: 50"), "the overlay requests full result windows rather than titlebar suggestions"); assert(source.includes("limit: 50"), "the overlay requests full result windows rather than titlebar suggestions");
assert(source.includes("response?.next_cursor"), "the overlay retains cursor pagination"); assert(source.includes("response?.next_cursor"), "the overlay retains cursor pagination");
assert(source.includes('usePlatformUiCapabilities<SearchContextsUiCapability>("search.contexts")'), "contextual Search contributions are consumed"); assert(source.includes('usePlatformUiCapabilities<SearchContextsUiCapability>("search.contexts")'), "contextual Search contributions are consumed");
assert(!source.includes("navigate(`/search"), "normal Search interaction no longer opens a page route"); assert(!source.includes("navigate(`/search"), "normal Search interaction no longer opens a page route");
assert(layoutSource.includes("anchor.left - left"), "desktop input placement is derived from the original field"); assert(layoutSource.includes("const inputWidth = width"), "the opened query field spans the Search overlay");
assert(styles.includes(".global-search-source.is-overlay-open"), "the original field is hidden while its overlay counterpart is active"); assert(layoutSource.includes("(viewportWidth - width) / 2"), "the Search overlay is centered in the viewport");
assert(styles.includes("margin-top: 8px"), "results follow the opened query field without overlap");
assert(styles.includes(".search-overlay-results-panel"), "full Search results have a bounded overlay panel"); assert(styles.includes(".search-overlay-results-panel"), "full Search results have a bounded overlay panel");
console.log("Search overlay structure checks passed."); console.log("Search overlay structure checks passed.");
+18 -43
View File
@@ -10,8 +10,9 @@ import {
type KeyboardEvent as ReactKeyboardEvent type KeyboardEvent as ReactKeyboardEvent
} from "react"; } from "react";
import { useLocation } from "react-router"; import { useLocation } from "react-router";
import { import { ActionToolbar,
Button, Button,
CountBadge,
Dialog, Dialog,
DocumentationHelpLink, DocumentationHelpLink,
DismissibleAlert, DismissibleAlert,
@@ -73,14 +74,12 @@ export default function GlobalSearch({ settings }: GlobalSearchProps) {
const [filtersOpen, setFiltersOpen] = useState(false); const [filtersOpen, setFiltersOpen] = useState(false);
const [activeIndex, setActiveIndex] = useState(-1); const [activeIndex, setActiveIndex] = useState(-1);
const rootRef = useRef<HTMLDivElement>(null); const rootRef = useRef<HTMLButtonElement>(null);
const sourceInputRef = useRef<HTMLInputElement>(null);
const overlayInputRef = useRef<HTMLInputElement>(null); const overlayInputRef = useRef<HTMLInputElement>(null);
const filtersRef = useRef<HTMLDivElement>(null); const filtersRef = useRef<HTMLDivElement>(null);
const resultsRef = useRef<HTMLDivElement>(null); const resultsRef = useRef<HTMLDivElement>(null);
const requestSequenceRef = useRef(0); const requestSequenceRef = useRef(0);
const loadMoreControllerRef = useRef<AbortController | null>(null); const loadMoreControllerRef = useRef<AbortController | null>(null);
const suppressRestoredFocusRef = useRef(false);
const effectiveModules = useMemo( const effectiveModules = useMemo(
() => scope === "context" && currentContext () => scope === "context" && currentContext
@@ -152,7 +151,6 @@ export default function GlobalSearch({ settings }: GlobalSearchProps) {
const closeOverlay = useCallback(() => { const closeOverlay = useCallback(() => {
loadMoreControllerRef.current?.abort(); loadMoreControllerRef.current?.abort();
suppressRestoredFocusRef.current = true;
setOpen(false); setOpen(false);
setFiltersOpen(false); setFiltersOpen(false);
setActiveIndex(-1); setActiveIndex(-1);
@@ -163,14 +161,6 @@ export default function GlobalSearch({ settings }: GlobalSearchProps) {
setOpen(true); setOpen(true);
}, [measureOverlay]); }, [measureOverlay]);
const handleSourceFocus = useCallback(() => {
if (suppressRestoredFocusRef.current) {
suppressRestoredFocusRef.current = false;
return;
}
openOverlay();
}, [openOverlay]);
useEffect(() => { useEffect(() => {
function focusSearch(event: KeyboardEvent) { function focusSearch(event: KeyboardEvent) {
const commandSearch = const commandSearch =
@@ -395,41 +385,26 @@ export default function GlobalSearch({ settings }: GlobalSearchProps) {
return ( return (
<> <>
<div <button
ref={rootRef} ref={rootRef}
className={`global-search global-search-source${open ? " is-overlay-open" : ""}`}> type="button"
<Search size={16} aria-hidden="true" /> data-help-context-id="search.global"
<input data-help-module-id="search"
ref={sourceInputRef} data-help-scope="action"
type="search" className={`titlebar-icon-link titlebar-search-button${open ? " is-context-active" : ""}`}
value={query} title="Search (F3 / Ctrl+K)"
readOnly
tabIndex={open ? -1 : 0}
placeholder={currentContext?.placeholder ?? "Search"}
aria-label="Global search" aria-label="Global search"
aria-keyshortcuts="F3 Control+K Meta+K" aria-keyshortcuts="F3 Control+K Meta+K"
aria-haspopup="dialog"
aria-expanded={open} aria-expanded={open}
onFocus={handleSourceFocus} onClick={openOverlay}>
onClick={openOverlay} <Search size={18} aria-hidden="true" />
/>
{query &&
<button
type="button"
className="global-search-clear"
tabIndex={open ? -1 : 0}
aria-label="Clear search"
onClick={() => {
setQuery("");
setResponse(null);
}}>
<X size={14} />
</button> </button>
}
</div>
<Dialog <Dialog
open={open && Boolean(layout)} open={open && Boolean(layout)}
title="Search" title="Search"
helpContextId="search.results"
onClose={closeOverlay} onClose={closeOverlay}
showCloseButton={false} showCloseButton={false}
portal portal
@@ -493,7 +468,7 @@ export default function GlobalSearch({ settings }: GlobalSearchProps) {
<section <section
className="search-overlay-results-panel" className="search-overlay-results-panel"
style={{ height: layout.resultsHeight }}> style={{ height: layout.resultsHeight }}>
<div className="search-overlay-toolbar"> <ActionToolbar className="search-overlay-toolbar">
{currentContext && {currentContext &&
<SegmentedControl<SearchScope> <SegmentedControl<SearchScope>
className="search-overlay-scope" className="search-overlay-scope"
@@ -522,9 +497,9 @@ export default function GlobalSearch({ settings }: GlobalSearchProps) {
<Filter size={16} aria-hidden="true" /> <Filter size={16} aria-hidden="true" />
<span>Filters</span> <span>Filters</span>
{activeFilterCount > 0 && {activeFilterCount > 0 &&
<span className="search-filter-count" aria-label={`${activeFilterCount} active filters`}> <CountBadge size="compact" aria-label={`${activeFilterCount} active filters`}>
{activeFilterCount} {activeFilterCount}
</span> </CountBadge>
} }
</Button> </Button>
{filtersOpen && {filtersOpen &&
@@ -624,7 +599,7 @@ export default function GlobalSearch({ settings }: GlobalSearchProps) {
)} )}
</div> </div>
} }
</div> </ActionToolbar>
<PageScrollViewport <PageScrollViewport
id="global-search-overlay-results" id="global-search-overlay-results"
+3 -14
View File
@@ -33,16 +33,9 @@ export function calculateSearchOverlayLayout(
const mobile = viewportWidth < MOBILE_BREAKPOINT; const mobile = viewportWidth < MOBILE_BREAKPOINT;
const margin = mobile ? MOBILE_MARGIN : DESKTOP_MARGIN; const margin = mobile ? MOBILE_MARGIN : DESKTOP_MARGIN;
const width = Math.max(1, Math.min(DESKTOP_PANEL_WIDTH, viewportWidth - margin * 2)); const width = Math.max(1, Math.min(DESKTOP_PANEL_WIDTH, viewportWidth - margin * 2));
const centeredLeft = anchor.left + anchor.width / 2 - width / 2; const left = Math.max(margin, (viewportWidth - width) / 2);
const left = mobile const inputWidth = width;
? margin const inputOffset = 0;
: clamp(centeredLeft, margin, Math.max(margin, viewportWidth - width - margin));
const inputWidth = mobile
? width
: Math.min(Math.max(1, anchor.width), width);
const inputOffset = mobile
? 0
: clamp(anchor.left - left, 0, Math.max(0, width - inputWidth));
const top = Math.max(0, anchor.top); const top = Math.max(0, anchor.top);
const inputHeight = Math.max(1, anchor.height); const inputHeight = Math.max(1, anchor.height);
const availableResultsHeight = viewportHeight - top - inputHeight - RESULTS_GAP - margin; const availableResultsHeight = viewportHeight - top - inputHeight - RESULTS_GAP - margin;
@@ -89,7 +82,3 @@ function normalizePath(value: string): string {
const normalized = `/${String(value || "").trim().replace(/^\/+|\/+$/g, "")}`; const normalized = `/${String(value || "").trim().replace(/^\/+|\/+$/g, "")}`;
return normalized === "/" ? normalized : normalized.replace(/\/+$/g, ""); return normalized === "/" ? normalized : normalized.replace(/\/+$/g, "");
} }
function clamp(value: number, minimum: number, maximum: number): number {
return Math.min(Math.max(value, minimum), maximum);
}
@@ -1,3 +1,4 @@
import { MetricGrid } from "@govoplan/core-webui";
import { useEffect, useMemo, useState } from "react"; import { useEffect, useMemo, useState } from "react";
import { import {
AdminPageLayout, AdminPageLayout,
@@ -231,12 +232,12 @@ export default function SearchAdminPanel({ settings }: Props) {
</> </>
)} )}
> >
<div className="metric-grid"> <MetricGrid>
<MetricCard label="Search sources" value={rows.length} tone="neutral" /> <MetricCard label="Search sources" value={rows.length} tone="neutral" />
<MetricCard label="Pending changes" value={pending} tone={pending ? "warning" : "good"} /> <MetricCard label="Pending changes" value={pending} tone={pending ? "warning" : "good"} />
<MetricCard label="Quarantined" value={quarantined} tone={quarantined ? "danger" : "good"} /> <MetricCard label="Quarantined" value={quarantined} tone={quarantined ? "danger" : "good"} />
<MetricCard label="Backend" value={diagnostics?.backend ?? "-"} tone="neutral" /> <MetricCard label="Backend" value={diagnostics?.backend ?? "-"} tone="neutral" />
</div> </MetricGrid>
{quarantined > 0 && ( {quarantined > 0 && (
<DismissibleAlert tone="warning" dismissible={false} compact> <DismissibleAlert tone="warning" dismissible={false} compact>
+6 -5
View File
@@ -8,8 +8,9 @@ import {
type FormEvent type FormEvent
} from "react"; } from "react";
import { useSearchParams } from "react-router"; import { useSearchParams } from "react-router";
import { import { ActionToolbar,
Button, Button,
CountBadge,
DocumentationHelpLink, DocumentationHelpLink,
DismissibleAlert, DismissibleAlert,
IconButton, IconButton,
@@ -209,7 +210,7 @@ export default function SearchPage({ settings }: PlatformRouteContext) {
return ( return (
<main className="search-page"> <main className="search-page">
<div className="search-page-toolbar"> <ActionToolbar className="search-page-toolbar">
<form className="search-page-form" onSubmit={submit}> <form className="search-page-form" onSubmit={submit}>
<Search size={18} aria-hidden="true" /> <Search size={18} aria-hidden="true" />
<input <input
@@ -231,9 +232,9 @@ export default function SearchPage({ settings }: PlatformRouteContext) {
<Filter size={16} aria-hidden="true" /> <Filter size={16} aria-hidden="true" />
<span>Filters</span> <span>Filters</span>
{activeFilterCount > 0 && {activeFilterCount > 0 &&
<span className="search-filter-count" aria-label={`${activeFilterCount} active filters`}> <CountBadge size="compact" aria-label={`${activeFilterCount} active filters`}>
{activeFilterCount} {activeFilterCount}
</span> </CountBadge>
} }
</Button> </Button>
{filtersOpen && {filtersOpen &&
@@ -324,7 +325,7 @@ export default function SearchPage({ settings }: PlatformRouteContext) {
)} )}
</div> </div>
} }
</div> </ActionToolbar>
<PageScrollViewport className="search-results-viewport"> <PageScrollViewport className="search-results-viewport">
{error && {error &&
<DismissibleAlert tone="danger" onDismiss={() => setError("")}> <DismissibleAlert tone="danger" onDismiss={() => setError("")}>
+10 -42
View File
@@ -7,7 +7,7 @@
height: 34px; height: 34px;
box-sizing: border-box; box-sizing: border-box;
border: 1px solid var(--control-border); border: 1px solid var(--control-border);
border-radius: 4px; border-radius: var(--radius-sm);
background: var(--control-bg); background: var(--control-bg);
color: var(--muted); color: var(--muted);
padding: 0 8px; padding: 0 8px;
@@ -41,7 +41,7 @@
width: 24px; width: 24px;
height: 24px; height: 24px;
border: 0; border: 0;
border-radius: 3px; border-radius: var(--radius-tight);
background: transparent; background: transparent;
color: var(--muted); color: var(--muted);
cursor: pointer; cursor: pointer;
@@ -53,10 +53,6 @@
color: var(--text-strong); color: var(--text-strong);
} }
.global-search-source.is-overlay-open {
visibility: hidden;
}
.search-overlay-backdrop { .search-overlay-backdrop {
display: block; display: block;
padding: 0; padding: 0;
@@ -110,10 +106,10 @@
min-width: 0; min-width: 0;
min-height: 0; min-height: 0;
flex-direction: column; flex-direction: column;
margin-top: -44px; margin-top: 8px;
overflow: hidden; overflow: hidden;
border: var(--border-line); border: var(--border-line);
border-radius: 6px; border-radius: var(--radius-compact);
background: var(--surface); background: var(--surface);
box-shadow: var(--shadow-strong); box-shadow: var(--shadow-strong);
} }
@@ -189,7 +185,7 @@
height: 38px; height: 38px;
flex: 1 1 520px; flex: 1 1 520px;
border: 1px solid var(--control-border); border: 1px solid var(--control-border);
border-radius: 4px; border-radius: var(--radius-sm);
background: var(--control-bg); background: var(--control-bg);
color: var(--muted); color: var(--muted);
padding-left: 10px; padding-left: 10px;
@@ -242,21 +238,6 @@
color: var(--text-strong); color: var(--text-strong);
} }
.search-filter-count {
min-width: 19px;
height: 19px;
box-sizing: border-box;
display: inline-flex;
align-items: center;
justify-content: center;
border-radius: 999px;
background: var(--accent);
color: var(--on-accent);
padding: 0 5px;
font-size: 11px;
line-height: 1;
}
.search-filter-popover { .search-filter-popover {
position: absolute; position: absolute;
z-index: 400; z-index: 400;
@@ -268,7 +249,7 @@
flex-direction: column; flex-direction: column;
overflow: hidden; overflow: hidden;
border: var(--border-line); border: var(--border-line);
border-radius: 6px; border-radius: var(--radius-compact);
background: var(--surface); background: var(--surface);
box-shadow: var(--shadow-menu); box-shadow: var(--shadow-menu);
} }
@@ -330,7 +311,7 @@
align-items: center; align-items: center;
gap: 8px; gap: 8px;
min-height: 31px; min-height: 31px;
border-radius: 4px; border-radius: var(--radius-sm);
cursor: pointer; cursor: pointer;
padding: 4px 7px; padding: 4px 7px;
color: var(--text); color: var(--text);
@@ -365,7 +346,7 @@
gap: 6px; gap: 6px;
min-height: 27px; min-height: 27px;
border: 1px solid var(--control-border); border: 1px solid var(--control-border);
border-radius: 4px; border-radius: var(--radius-sm);
background: var(--control-bg); background: var(--control-bg);
color: var(--text); color: var(--text);
cursor: pointer; cursor: pointer;
@@ -439,7 +420,7 @@
gap: 7px; gap: 7px;
margin-top: 14px; margin-top: 14px;
border: 1px solid var(--control-border); border: 1px solid var(--control-border);
border-radius: 4px; border-radius: var(--radius-sm);
background: linear-gradient( background: linear-gradient(
var(--control-gradient-start), var(--control-gradient-start),
var(--control-gradient-end) var(--control-gradient-end)
@@ -464,21 +445,8 @@
} }
@media (max-width: 900px) { @media (max-width: 900px) {
.global-search-source {
width: 34px;
min-width: 34px;
padding: 0 8px;
}
.global-search-source input,
.global-search-source .global-search-clear {
width: 0;
padding: 0;
opacity: 0;
}
.search-overlay-results-panel { .search-overlay-results-panel {
border-radius: 4px; border-radius: var(--radius-sm);
} }
.search-overlay-toolbar { .search-overlay-toolbar {