aminghadersohi commented on code in PR #44834: URL: https://github.com/apache/superset/pull/44834#discussion_r4150406753
########## superset-core/src/superset_core/semantic_layers/metadata.py: ########## @@ -0,0 +1,174 @@ +# 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. Review Comment: Finite/expiry checks are prose-only; the test file hand-writes `deadline <= monotonic()` five times. One SDK helper raising `MetadataRefreshError("deadline")` would share it. Neither check catches a `time.time()` value (~1.79e9 vs monotonic ~5.2e6 here): a decades-long budget, silently. ########## superset-core/src/superset_core/semantic_layers/metadata.py: ########## @@ -0,0 +1,174 @@ +# 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 isinstance(self.payload, str): + raise TypeError("Catalog payload must be a string") + if not isinstance(self.cache_token, str): + raise TypeError("Catalog cache_token must be a string") + if not isinstance(self.observed_at, str): + raise TypeError("Catalog observed_at must be a string") + if not self.cache_token: + raise ValueError("Catalog cache token must not be empty") + if not self.observed_at: + raise ValueError("Catalog observed_at 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") Review Comment: Same gap Thread A closed on `CatalogSnapshot`: `MetadataRefreshResult("changed", "not a snapshot")` constructs today (ran it), and a host then reads `result.snapshot.cache_token`. With the check below all 73 cases pass and that probe raises `TypeError`. ```suggestion if self.status not in ("changed", "unchanged"): raise ValueError("Unknown metadata refresh result status") if not isinstance(self.snapshot, CatalogSnapshot): raise TypeError("Metadata refresh snapshot must be a CatalogSnapshot") ``` ########## superset-core/src/superset_core/semantic_layers/metadata.py: ########## @@ -0,0 +1,174 @@ +# 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", Review Comment: `configuration_changed`, `invalid_payload` and `unavailable` appear only in this list and the doc's enumeration; nothing says when to raise them. With no in-tree producer yet, when is a failure `unavailable` rather than `upstream`? One line each in the doc would settle it 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]
