temporal-flowrensic-python-sdk 0.6.63__tar.gz

temporal_flowrensic_python_sdk-0.6.63/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

temporal_flowrensic_python_sdk-0.6.63/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: temporal-flowrensic-python-sdk
+Version: 0.6.63
+Summary: Connects a Temporal Python worker to Flowrensic.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: temporalio>=1.18.1
+Requires-Dist: connect-python>=0.9.0
+Requires-Dist: protobuf>=6.31.1,<8
+Requires-Python: >=3.10
+Project-URL: Homepage, https://flowrensic.com
+Description-Content-Type: text/markdown
+
+# Flowrensic Python SDK
+
+Pre-release. This package is an early preview and not ready for production. Its API can change in any version.
+
+Flowrensic is a platform that runs beside Temporal. It watches what your workflows and workers do and tells you what went wrong, before and after a deploy.
+
+## What it does today
+
+- Connects a Temporal Python worker to your Flowrensic server, with your env access key, so the worker shows up in Flowrensic. Call temporal_flowrensic.client.connect.
+- Every call to Flowrensic carries your env, its access key and the ephemeral run in the headers Flowrensic-Current-Env, Flowrensic-Env-Access-Key and Flowrensic-Current-Ephemeral-Run. Each part takes them as current_env, env_access_key and current_ephemeral_run. An env of kind ephemeral takes the ephemeral run, such as the CI build number, and without one the run is default. The SDK reads no environment variable: you pass the values in code.
+- Records each activity attempt: its result, error type, attempt number and time, with the timeouts and retry limit it ran under. Register temporal_flowrensic.activity.Interceptor in Worker(interceptors=[...]) and give it a sink from temporal_flowrensic.client.create_attempt_sink. Each attempt carries the namespace Temporal gives the activity, so there is no namespace setting. It never changes what an activity returns or raises.
+- The sink keeps the attempts in the worker's memory and sends them to Flowrensic in batches, in the background. Each send has a time limit. When Flowrensic does not answer, the attempts wait and are sent again later. The buffer has a limit on records and on memory, and past it the oldest are dropped and counted.
+
+```python
+import temporal_flowrensic.activity
+import temporal_flowrensic.client
+
+sink = temporal_flowrensic.client.create_attempt_sink(
+    "http://flowrensic:8080", current_env="prod", env_access_key=env_access_key, current_ephemeral_run="prod-1",
+    worker_name="orders-worker",
+)
+worker = Worker(
+    client,
+    task_queue="main",
+    workflows=[...],
+    activities=[...],
+    interceptors=[temporal_flowrensic.activity.Interceptor(sink, current_env="prod", current_ephemeral_run="prod-1", version=build_id)],
+)
+```
+
+- Worker telemetry: temporal_flowrensic.client.start_telemetry says hello, then sends regular beats so Flowrensic knows the worker is up, the engine's and the worker's own metrics, and the history of each run the worker saw. At shutdown it hands the ephemeral run over. When Flowrensic does not answer, the worker still starts and keeps trying in the background. Give telemetry.sink to the activity interceptor.
+
+```python
+telemetry = await temporal_flowrensic.client.start_telemetry(
+    server_base_url="http://flowrensic:8080",
+    current_env="prod",
+    env_access_key=env_access_key,
+    current_ephemeral_run="prod-1",
+    version=build_id,
+    namespace="default",
+    temporal_client=client,
+)
+interceptor = temporal_flowrensic.activity.Interceptor(telemetry.sink, current_env="prod", current_ephemeral_run="prod-1", version=build_id)
+# ... run the worker ...
+await telemetry.shutdown()
+```
+
+- Client calls: temporal_flowrensic.client.ClientInterceptor in Client.connect(plugins=[...]) sends every query and signal that fails, and whether it ended on its deadline, under the namespace of the client. temporal_flowrensic.workflow.Interceptor in Worker(interceptors=[...]) counts the queries your workflows answer. Neither changes what a call returns or raises, or what a workflow does.
+
+- Replay before deploy: in CI, temporal_flowrensic.client.fetch_replay_set writes the histories Flowrensic picks for a workflow type from each env of replay_history_from_envs, such as ["prod", "staging"], asked as your current_env, which must be of kind ephemeral, since a persistent env is refused, you replay them with temporalio's Replayer, and temporal_flowrensic.client.publish_verdicts sends the result back, with the names of the workflow interceptors the replay ran with, as temporal_flowrensic.client.interceptor_name gives them. Give the same interceptors to start_telemetry, so Flowrensic can compare the two lists.
+- Deploy reports from CI: temporal_flowrensic.client.report_deploy_stage sends each stage of a deploy. Every CI call has a time limit and stops with a message that says Flowrensic could not be reached or what it answered. A failed deploy report does not fail the job unless you ask it to.
+
+## Planned
+
+- Each new part of the Node SDK, @flowrensic/temporal-flowrensic-node-sdk, comes to the Python SDK too.
+
+## Install
+
+```sh
+pip install temporal-flowrensic-python-sdk
+```

temporal_flowrensic_python_sdk-0.6.63/README.md

@@ -0,0 +1,61 @@
+# Flowrensic Python SDK
+
+Pre-release. This package is an early preview and not ready for production. Its API can change in any version.
+
+Flowrensic is a platform that runs beside Temporal. It watches what your workflows and workers do and tells you what went wrong, before and after a deploy.
+
+## What it does today
+
+- Connects a Temporal Python worker to your Flowrensic server, with your env access key, so the worker shows up in Flowrensic. Call temporal_flowrensic.client.connect.
+- Every call to Flowrensic carries your env, its access key and the ephemeral run in the headers Flowrensic-Current-Env, Flowrensic-Env-Access-Key and Flowrensic-Current-Ephemeral-Run. Each part takes them as current_env, env_access_key and current_ephemeral_run. An env of kind ephemeral takes the ephemeral run, such as the CI build number, and without one the run is default. The SDK reads no environment variable: you pass the values in code.
+- Records each activity attempt: its result, error type, attempt number and time, with the timeouts and retry limit it ran under. Register temporal_flowrensic.activity.Interceptor in Worker(interceptors=[...]) and give it a sink from temporal_flowrensic.client.create_attempt_sink. Each attempt carries the namespace Temporal gives the activity, so there is no namespace setting. It never changes what an activity returns or raises.
+- The sink keeps the attempts in the worker's memory and sends them to Flowrensic in batches, in the background. Each send has a time limit. When Flowrensic does not answer, the attempts wait and are sent again later. The buffer has a limit on records and on memory, and past it the oldest are dropped and counted.
+
+```python
+import temporal_flowrensic.activity
+import temporal_flowrensic.client
+
+sink = temporal_flowrensic.client.create_attempt_sink(
+    "http://flowrensic:8080", current_env="prod", env_access_key=env_access_key, current_ephemeral_run="prod-1",
+    worker_name="orders-worker",
+)
+worker = Worker(
+    client,
+    task_queue="main",
+    workflows=[...],
+    activities=[...],
+    interceptors=[temporal_flowrensic.activity.Interceptor(sink, current_env="prod", current_ephemeral_run="prod-1", version=build_id)],
+)
+```
+
+- Worker telemetry: temporal_flowrensic.client.start_telemetry says hello, then sends regular beats so Flowrensic knows the worker is up, the engine's and the worker's own metrics, and the history of each run the worker saw. At shutdown it hands the ephemeral run over. When Flowrensic does not answer, the worker still starts and keeps trying in the background. Give telemetry.sink to the activity interceptor.
+
+```python
+telemetry = await temporal_flowrensic.client.start_telemetry(
+    server_base_url="http://flowrensic:8080",
+    current_env="prod",
+    env_access_key=env_access_key,
+    current_ephemeral_run="prod-1",
+    version=build_id,
+    namespace="default",
+    temporal_client=client,
+)
+interceptor = temporal_flowrensic.activity.Interceptor(telemetry.sink, current_env="prod", current_ephemeral_run="prod-1", version=build_id)
+# ... run the worker ...
+await telemetry.shutdown()
+```
+
+- Client calls: temporal_flowrensic.client.ClientInterceptor in Client.connect(plugins=[...]) sends every query and signal that fails, and whether it ended on its deadline, under the namespace of the client. temporal_flowrensic.workflow.Interceptor in Worker(interceptors=[...]) counts the queries your workflows answer. Neither changes what a call returns or raises, or what a workflow does.
+
+- Replay before deploy: in CI, temporal_flowrensic.client.fetch_replay_set writes the histories Flowrensic picks for a workflow type from each env of replay_history_from_envs, such as ["prod", "staging"], asked as your current_env, which must be of kind ephemeral, since a persistent env is refused, you replay them with temporalio's Replayer, and temporal_flowrensic.client.publish_verdicts sends the result back, with the names of the workflow interceptors the replay ran with, as temporal_flowrensic.client.interceptor_name gives them. Give the same interceptors to start_telemetry, so Flowrensic can compare the two lists.
+- Deploy reports from CI: temporal_flowrensic.client.report_deploy_stage sends each stage of a deploy. Every CI call has a time limit and stops with a message that says Flowrensic could not be reached or what it answered. A failed deploy report does not fail the job unless you ask it to.
+
+## Planned
+
+- Each new part of the Node SDK, @flowrensic/temporal-flowrensic-node-sdk, comes to the Python SDK too.
+
+## Install
+
+```sh
+pip install temporal-flowrensic-python-sdk
+```

temporal_flowrensic_python_sdk-0.6.63/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "temporal-flowrensic-python-sdk"
+version = "0.6.63"
+description = "Connects a Temporal Python worker to Flowrensic."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dependencies = [
+    "temporalio>=1.18.1",
+    "connect-python>=0.9.0",
+    "protobuf>=6.31.1,<8",
+]
+
+[project.urls]
+Homepage = "https://flowrensic.com"
+
+[build-system]
+requires = ["uv_build>=0.11.0,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "temporal_flowrensic"

temporal_flowrensic_python_sdk-0.6.63/pyproject.toml.orig

@@ -0,0 +1,23 @@
+[project]
+name = "temporal-flowrensic-python-sdk"
+version = "0.6.63"
+description = "Connects a Temporal Python worker to Flowrensic."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+dependencies = [
+    "temporalio>=1.18.1",
+    "connect-python>=0.9.0",
+    "protobuf>=6.31.1,<8",
+]
+
+[project.urls]
+Homepage = "https://flowrensic.com"
+
+[build-system]
+requires = ["uv_build>=0.11.0,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "temporal_flowrensic"

temporal_flowrensic_python_sdk-0.6.63/src/temporal_flowrensic/__init__.py

@@ -0,0 +1,2 @@
+"""Flowrensic for Temporal Python workers. The parts follow temporalio:
+temporal_flowrensic.activity, temporal_flowrensic.client and temporal_flowrensic.workflow."""

temporal_flowrensic_python_sdk-0.6.63/src/temporal_flowrensic/_calls.py

@@ -0,0 +1,185 @@
+"""The client interceptor: every query and signal of a temporalio Client that
+raises is sent to Flowrensic, through the record buffer."""
+
+from __future__ import annotations
+
+import time
+from typing import Any, Optional
+
+import temporalio.client
+import temporalio.service
+from temporalio.service import RPCError, RPCStatusCode
+
+from temporal_flowrensic._gen.flowrensic.v1.client_calls_pb2 import (
+    CLIENT_CALL_OUTCOME_FAILED,
+    CLIENT_CALL_OUTCOME_TIMED_OUT,
+    ClientCall,
+    IngestClientCallsRequest,
+)
+from temporal_flowrensic._sink import (
+    DEFAULT_BATCH_SIZE,
+    DEFAULT_FLUSH_INTERVAL,
+    DEFAULT_MAX_BATCH_SIZE,
+    DEFAULT_MAX_WAITING,
+    DEFAULT_MAX_WAITING_BYTES,
+    DEFAULT_TIMEOUT_MS,
+    BufferTarget,
+    RecordSink,
+    SendId,
+    SinkCounts,
+    ingest_client_sync,
+    client_headers,
+)
+
+__all__ = ["ClientInterceptor"]
+
+
+# The error type Flowrensic knows a query by that a worker answered with an
+# error, the name the TypeScript client gives it. The Python client raises
+# WorkflowQueryFailedError for the same case.
+_ANSWERED_QUERY_ERROR = "QueryNotRegisteredError"
+
+
+def _error_type(err: BaseException) -> str:
+    if isinstance(err, temporalio.client.WorkflowQueryFailedError):
+        return _ANSWERED_QUERY_ERROR
+    return type(err).__name__
+
+
+def _timed_out(err: BaseException) -> bool:
+    """Whether the call ended on its deadline: deadline exceeded, or cancelled by the server."""
+    return isinstance(err, RPCError) and err.status in (RPCStatusCode.DEADLINE_EXCEEDED, RPCStatusCode.CANCELLED)
+
+
+class _CallTarget(BufferTarget[ClientCall]):
+    def __init__(self, server_base_url: str, headers: dict[str, str]) -> None:
+        self._ingest = ingest_client_sync(server_base_url)
+        self._headers = headers
+
+    def send(self, records: list[ClientCall], timeout_ms: int, id: SendId) -> None:
+        self._ingest.ingest_client_calls(
+            IngestClientCallsRequest(calls=records, sender=id.sender, send_number=id.send_number),
+            headers=self._headers,
+            timeout_ms=max(1, timeout_ms),
+        )
+
+
+# The namespace a temporalio Client talks to when it is given none.
+_DEFAULT_NAMESPACE = "default"
+
+
+class ClientInterceptor(temporalio.client.Interceptor, temporalio.client.Plugin):
+    """Put in Client.connect(plugins=[...]). Every query and signal that
+    raises is sent to Flowrensic with its name, the workflow it was for and
+    whether it ended on its deadline. A call that works is not sent. The calls
+    wait in a buffer and leave in batches, as the attempts of the worker do,
+    so sending never changes what the caller gets or how long it waits. Call
+    close before the process ends, so the calls still waiting are sent.
+
+    As a client plugin it reads the namespace of the client and puts itself in
+    the interceptors of the client, so each call is sent under the namespace
+    the client talks to. current_env, env_access_key and current_ephemeral_run
+    go in their headers on every send. Times are in seconds."""
+
+    def __init__(
+        self,
+        server_base_url: str,
+        *,
+        current_env: str = "",
+        env_access_key: str = "",
+        current_ephemeral_run: str = "",
+        batch_size: int = DEFAULT_BATCH_SIZE,
+        flush_interval: float = DEFAULT_FLUSH_INTERVAL,
+        timeout_ms: int = DEFAULT_TIMEOUT_MS,
+        max_waiting: int = DEFAULT_MAX_WAITING,
+        max_batch_size: int = DEFAULT_MAX_BATCH_SIZE,
+        max_waiting_bytes: int = DEFAULT_MAX_WAITING_BYTES,
+    ) -> None:
+        if not server_base_url:
+            raise ValueError("flowrensic: server_base_url is required")
+        self._namespace = _DEFAULT_NAMESPACE
+        self._next_plugin: Optional[temporalio.client.Plugin] = None
+        self._buffer: RecordSink[ClientCall] = RecordSink(
+            _CallTarget(server_base_url, client_headers(current_env, env_access_key, current_ephemeral_run)),
+            batch_size=batch_size,
+            flush_interval=flush_interval,
+            timeout_ms=timeout_ms,
+            max_waiting=max_waiting,
+            max_batch_size=max_batch_size,
+            max_waiting_bytes=max_waiting_bytes,
+        )
+
+    def intercept_client(self, next: temporalio.client.OutboundInterceptor) -> temporalio.client.OutboundInterceptor:
+        return _ClientOutbound(next, self)
+
+    def init_client_plugin(self, next: temporalio.client.Plugin) -> None:
+        """Keeps the next plugin, for the temporalio versions that chain them."""
+        self._next_plugin = next
+
+    def configure_client(self, config: Any) -> Any:
+        """Reads the namespace of the client and adds this interceptor to its interceptors."""
+        self._namespace = config.get("namespace") or _DEFAULT_NAMESPACE
+        interceptors = list(config.get("interceptors") or [])
+        if not any(one is self for one in interceptors):
+            interceptors.append(self)
+        config["interceptors"] = interceptors
+        if self._next_plugin is not None:
+            return self._next_plugin.configure_client(config)
+        return config
+
+    async def connect_service_client(self, config: Any, next: Any = None) -> Any:
+        """Connects as the next plugin or temporalio would, unchanged."""
+        if next is not None:
+            return await next(config)
+        if self._next_plugin is not None:
+            return await self._next_plugin.connect_service_client(config)
+        return await temporalio.service.ServiceClient.connect(config)
+
+    async def flush(self) -> None:
+        """Sends what waits and waits for it to land."""
+        await self._buffer.flush()
+
+    async def close(self) -> None:
+        """Sends what waits and stops."""
+        await self._buffer.close()
+
+    def counts(self) -> SinkCounts:
+        """What the buffer lost and holds."""
+        return self._buffer.counts()
+
+    def _record(self, kind: str, name: str, workflow_id: str, run_id: Optional[str], err: BaseException) -> None:
+        """Records a call that raised, and never raises itself."""
+        try:
+            call = ClientCall(
+                namespace=self._namespace,
+                workflow_id=workflow_id,
+                run_id=run_id or "",
+                kind=kind,
+                name=name,
+                outcome=CLIENT_CALL_OUTCOME_TIMED_OUT if _timed_out(err) else CLIENT_CALL_OUTCOME_FAILED,
+                error_type=_error_type(err),
+            )
+            call.ended_at.FromNanoseconds(int(time.time() * 1_000_000_000))
+            self._buffer.record(call)
+        except Exception:  # noqa: BLE001
+            return
+
+
+class _ClientOutbound(temporalio.client.OutboundInterceptor):
+    def __init__(self, next: temporalio.client.OutboundInterceptor, owner: ClientInterceptor) -> None:
+        super().__init__(next)
+        self._owner = owner
+
+    async def query_workflow(self, input: temporalio.client.QueryWorkflowInput) -> Any:
+        try:
+            return await super().query_workflow(input)
+        except Exception as err:
+            self._owner._record("query", input.query, input.id, input.run_id, err)
+            raise
+
+    async def signal_workflow(self, input: temporalio.client.SignalWorkflowInput) -> None:
+        try:
+            await super().signal_workflow(input)
+        except Exception as err:
+            self._owner._record("signal", input.signal, input.id, input.run_id, err)
+            raise

temporal_flowrensic_python_sdk-0.6.63/src/temporal_flowrensic/_ci.py

@@ -0,0 +1,56 @@
+"""What the CI side of the SDK shares: the error a call that has to fail
+raises, and the message that says Flowrensic could not be reached or what it
+answered."""
+
+from __future__ import annotations
+
+from typing import Optional
+
+from connectrpc.code import Code
+from connectrpc.errors import ConnectError
+
+__all__ = ["CIError", "ci_error", "ci_failure", "not_reached"]
+
+
+class CIError(Exception):
+    """A CI call to Flowrensic that failed. Its text says that Flowrensic
+    could not be reached in time, or what it answered. code is the Connect code
+    Flowrensic answered with, None when it was not reached."""
+
+    def __init__(self, message: str, code: Optional[Code] = None) -> None:
+        super().__init__(message)
+        self.message = message
+        self.code = code
+
+
+def not_reached(error: BaseException) -> bool:
+    """Whether a call failed because nothing answered in time or no connection
+    could be made. The client raises a transport error, such as a refused
+    connection, as a ConnectError raised from that error, while an answer of
+    Flowrensic carries no error under it."""
+    if not isinstance(error, ConnectError):
+        return True
+    if error.code in (Code.DEADLINE_EXCEEDED, Code.CANCELED):
+        return True
+    return error.__cause__ is not None
+
+
+def _seconds(timeout_ms: int) -> str:
+    return f"{timeout_ms / 1000:g}"
+
+
+def ci_failure(what: str, server_base_url: str, timeout_ms: int, error: BaseException) -> str:
+    """The message a CI call stops with: that Flowrensic could not be reached
+    in time, or what it answered, the code in brackets as Connect writes it and
+    the message. what names the call, such as deploy report."""
+    if not_reached(error):
+        cause = error.message if isinstance(error, ConnectError) else str(error)
+        return f"{what}: Flowrensic at {server_base_url} could not be reached within {_seconds(timeout_ms)} seconds: {cause}"
+    assert isinstance(error, ConnectError)
+    return f"{what}: Flowrensic at {server_base_url} answered [{error.code.value}] {error.message}"
+
+
+def ci_error(what: str, server_base_url: str, timeout_ms: int, error: BaseException) -> CIError:
+    """The error a CI call that has to fail raises, with the message of ci_failure."""
+    code = None if not_reached(error) or not isinstance(error, ConnectError) else error.code
+    return CIError(ci_failure(what, server_base_url, timeout_ms, error), code)