mikebridge commented on code in PR #44834: URL: https://github.com/apache/superset/pull/44834#discussion_r4150151461
########## superset-core/src/superset_core/semantic_layers/metadata.py: ########## @@ -0,0 +1,152 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +"""Optional provider metadata acquisition and host publication interfaces.""" + +from __future__ import annotations + +from abc import ABC, abstractmethod +from collections.abc import Callable +from dataclasses import dataclass, field +from typing import Any, get_args, Literal, Protocol, TypeAlias + +# The host passes a finite absolute time.monotonic() deadline in this process. +CatalogLoader: TypeAlias = Callable[[float], str] +MetadataRefreshErrorCategory: TypeAlias = Literal[ + "unsupported", + "configuration", + "in_progress", + "configuration_changed", + "upstream", + "invalid_payload", + "deadline", + "unavailable", + "indeterminate", +] + + +@dataclass(frozen=True) +class CatalogSnapshot: + """Carry one validated observation and its captured cache identity. + + The provider supplies canonical JSON in payload. The host assigns a nonempty, + opaque, scope-qualified cache_token for each successful publication, including + unchanged discovery. observed_at is a UTC RFC3339 source-observation time for + display, not a cache creation/expiry time or an ordering authority. + """ + + payload: str = field(repr=False) + cache_token: str = field(repr=False) + observed_at: str + + def __post_init__(self) -> None: + if not self.cache_token: + raise ValueError("Catalog cache token must not be empty") + Review Comment: Addressed in `08e39241`: `CatalogSnapshot` now rejects a non-string `payload`, `cache_token` or `observed_at` with fixed messages that don't echo the input, and rejects an empty token or timestamp. RFC3339 parsing stays the producer's responsibility. Red-first regressions cover the malformed field types. ########## superset-core/src/superset_core/semantic_layers/metadata.py: ########## @@ -0,0 +1,152 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +"""Optional provider metadata acquisition and host publication interfaces.""" + +from __future__ import annotations + +from abc import ABC, abstractmethod +from collections.abc import Callable +from dataclasses import dataclass, field +from typing import Any, get_args, Literal, Protocol, TypeAlias + +# The host passes a finite absolute time.monotonic() deadline in this process. +CatalogLoader: TypeAlias = Callable[[float], str] +MetadataRefreshErrorCategory: TypeAlias = Literal[ + "unsupported", + "configuration", + "in_progress", + "configuration_changed", + "upstream", + "invalid_payload", + "deadline", + "unavailable", + "indeterminate", +] + + +@dataclass(frozen=True) +class CatalogSnapshot: + """Carry one validated observation and its captured cache identity. + + The provider supplies canonical JSON in payload. The host assigns a nonempty, + opaque, scope-qualified cache_token for each successful publication, including + unchanged discovery. observed_at is a UTC RFC3339 source-observation time for + display, not a cache creation/expiry time or an ordering authority. + """ + + payload: str = field(repr=False) + cache_token: str = field(repr=False) + observed_at: str + + def __post_init__(self) -> None: + if not self.cache_token: + raise ValueError("Catalog cache token must not be empty") + + +@dataclass(frozen=True) +class MetadataRefreshResult: + """Report a confirmed publication and its immutable observation. + + Unchanged compares discovery payloads, not complete upstream metric + definitions. Changed includes installation without a prior observation. + An indeterminate publication must raise an error instead of returning success. + """ + + status: Literal["changed", "unchanged"] + snapshot: CatalogSnapshot + + def __post_init__(self) -> None: + if self.status not in ("changed", "unchanged"): + raise ValueError("Unknown metadata refresh result status") + + +class MetadataRefreshError(Exception): + """Carry a validated failure category without vendor messages or credentials. + + Hosts must not expose exception cause chains. Providers translating sensitive + upstream exceptions should suppress their displayed chain with ``from None``. + """ + + def __init__(self, category: MetadataRefreshErrorCategory) -> None: + if category not in get_args(MetadataRefreshErrorCategory): + raise ValueError("Unknown metadata refresh error category") + self.category: MetadataRefreshErrorCategory = category + super().__init__(category) + + +class MetadataSnapshotStore(Protocol): + """Define host-owned publication for one authorized connection scope. + + The loader receives a finite absolute time.monotonic() deadline and acquires + and validates canonical JSON within that budget and any tighter provider limit. + The host sets one deadline before waiting or acquisition; providers must not + reset it for nested requests. An exhausted budget raises the deadline category + before further I/O. The deadline is process-local, never serialized or used + for cache expiry or publication ordering; it does not replace writer fencing. + The host owns expiry, writer fencing and publication confirmation. This + protocol does not provide storage, authorization or distributed coordination. + Host-only invalidation and cache inspection are outside the provider interface. + """ + + def read(self, fetch: CatalogLoader) -> CatalogSnapshot: + """Read a valid observation or perform bounded coordinated acquisition. + + Cold readers wait/re-read within a finite deadline or fail safely; they + must not silently use an obsolete local copy. Cache hits retain identity + and expiry. Return the payload and its identity from the same observation. + """ + ... + + def refresh(self, fetch: CatalogLoader) -> MetadataRefreshResult: Review Comment: Addressed in `08e39241`: store `read`/`refresh` and adapter `refresh` now require the caller's absolute monotonic deadline, and `bind(store, *, deadline)` explicitly carries the discovery budget; ordinary provider construction stays deadline-free. The contract and executable examples cover finite-value validation, unchanged propagation to nested calls, and budget exhaustion before publication. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
