gooddata-flexconnect 1.74.1.dev1__tar.gz → 1.74.1.dev2__tar.gz

gooddata_flexconnect-1.74.1.dev2/AGENTS.md

@@ -0,0 +1,83 @@
+# gooddata-flexconnect
+
+Lets a developer expose their own tabular data as a data source inside GoodData, using a
+table-function model: you subclass `FlexConnectFunction`, declare a name and an Arrow
+schema, and implement `call()`. A FlexConnect server — `gooddata-flight-server` plus this
+package's method provider — discovers your functions at startup, and GoodData maps each
+one's schema to a dataset in the semantic model, invoking it over Flight RPC.
+
+Consumed as a framework by projects outside this repo (see the `gooddata-flexconnect-template`
+repository), so the function-authoring contract is an external API.
+
+## Owns
+
+- The `FlexConnectFunction` contract for authoring table-function style data sources
+- Function registration and discovery
+- The typed execution-context decoding of the request payload
+- The Flight RPC glue that turns a generic Flight server into a FlexConnect server
+
+## Does NOT Own
+
+- Generic Flight server infrastructure, CLI, config and telemetry → `gooddata-flight-server`
+- Core GoodData Cloud domain, catalog and compute APIs → `gooddata-sdk`
+- PostgreSQL FDW integration → `gooddata-fdw`
+
+## Architecture
+
+**Depends on**: `gooddata-flight-server` and `gooddata-sdk`, plus `pyarrow`, `dynaconf`,
+`structlog`, `orjson`.
+
+All code lives under `src/gooddata_flexconnect/function/`: the base class, the registry,
+the execution context, and the Flight methods.
+
+### Authoring a function
+
+A function is a **class**, not a callable. Subclass `FlexConnectFunction` and provide:
+
+- `Name: str` — unique across the server; required
+- `Schema: pyarrow.Schema` — the full result schema, declared statically; required
+- `call(self, parameters, columns, headers) -> ArrowData` — the implementation
+
+Optional overrides: `create()` (instance factory, called per invocation), `cancel()`, and
+the static `on_load(ctx: ServerContext)` for one-time initialization.
+
+### Discovery
+
+Functions are not registered by hand. The server reads the `flexconnect.functions` setting
+— a list of importable module paths — and `FlexConnectFunctionRegistry.load()` imports each
+module and registers every top-level member that subclasses `FlexConnectFunction`. A
+missing or empty `Name`, a duplicate `Name`, or a missing `Schema` raises at load time and
+aborts startup. A function that is not exported at module top level is simply never found.
+
+### Hosting
+
+`create_flexconnect_flight_methods` is decorated with `@flight_server_methods` from
+`gooddata-flight-server` and returns the `FlightServerMethods` implementation — it is the
+single methods factory that turns the generic server into a FlexConnect server. It also
+reads `flexconnect.call_deadline_ms` and `flexconnect.polling_interval_ms`.
+
+## Gotchas
+
+**Decode `parameters`, don't hand-parse it.** `call()` receives `parameters` as a raw
+JSON-like dict. Use `ExecutionContext.from_parameters(parameters)` — it returns `None` when
+there is no `executionContext` key, and otherwise a typed object exposing
+`execution_type`, `organization_id`, `workspace_id`, `user_id` and either a
+`ReportExecutionRequest` (attributes, metrics, filters) or a `LabelElementsExecutionRequest`.
+Because this is public API consumed downstream, hand-rolled parsing in external projects
+breaks silently on any wire-format change.
+
+**`columns` is a trimming hint, not a contract.** The full result schema is fixed on the
+class before any call. `columns` tells you which of those the caller wants and may be
+ignored; it must not change aggregation semantics. Only `parameters` should drive
+computation. Conflating "requested columns" with "requested aggregation" is the subtle
+correctness trap here.
+
+**Calls are asynchronous with a deadline.** Invocations run as background tasks with a
+configurable call deadline and cancellation support, and the RPC layer supports polling for
+long-running calls. Relevant when debugging timeouts.
+
+## Testing
+
+Package-local pytest suites under `tests/`. `make dev-certs` generates a CA/server/client
+chain into the gitignored `test_data/` for driving a server by hand over TLS; the package
+also ships its own checked-in certificates for the tests themselves.

gooddata_flexconnect-1.74.1.dev2/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

{gooddata_flexconnect-1.74.1.dev1 → gooddata_flexconnect-1.74.1.dev2}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.5
 Name: gooddata-flexconnect
-Version: 1.74.1.dev1
+Version: 1.74.1.dev2
 Summary: Build your own data source for GoodData Cloud and GoodData Cloud Native.
-Project-URL: Documentation, https://gooddata-flexconnect.readthedocs.io/en/v1.74.1.dev1
+Project-URL: Documentation, https://gooddata-flexconnect.readthedocs.io/en/v1.74.1.dev2
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Author-email: GoodData <support@gooddata.com>
 License-Expression: MIT
@@ -21,11 +21,11 @@ Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Requires-Dist: dynaconf<4.0.0,>=3.1.11
-Requires-Dist: gooddata-flight-server~=1.74.1.dev1
-Requires-Dist: gooddata-sdk~=1.74.1.dev1
+Requires-Dist: gooddata-flight-server~=1.74.1.dev2
+Requires-Dist: gooddata-sdk~=1.74.1.dev2
 Requires-Dist: orjson<4.0.0,>=3.9.15
 Requires-Dist: pyarrow>=16.1.0
-Requires-Dist: structlog<25.0.0,>=24.0.0
+Requires-Dist: structlog<=26.1.0,>=24.0.0
 Description-Content-Type: text/markdown
 
 # GoodData FlexConnect

{gooddata_flexconnect-1.74.1.dev1 → gooddata_flexconnect-1.74.1.dev2}/pyproject.toml

@@ -1,7 +1,7 @@
 # (C) 2025 GoodData Corporation
 [project]
 name = "gooddata-flexconnect"
-version = "1.74.1.dev1"
+version = "1.74.1.dev2"
 description = "Build your own data source for GoodData Cloud and GoodData Cloud Native."
 readme = "README.md"
 license = "MIT"
@@ -29,11 +29,11 @@ keywords = [
 requires-python = ">=3.10"
 dependencies = [
     "dynaconf>=3.1.11,<4.0.0",
-    "gooddata-flight-server~=1.74.1.dev1",
-    "gooddata-sdk~=1.74.1.dev1",
+    "gooddata-flight-server~=1.74.1.dev2",
+    "gooddata-sdk~=1.74.1.dev2",
     "orjson>=3.9.15,<4.0.0",
     "pyarrow>=16.1.0",
-    "structlog>=24.0.0,<25.0.0",
+    "structlog>=24.0.0,<=26.1.0",
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -50,14 +50,14 @@ classifiers = [
 ]
 
 [project.urls]
-Documentation = "https://gooddata-flexconnect.readthedocs.io/en/v1.74.1.dev1"
+Documentation = "https://gooddata-flexconnect.readthedocs.io/en/v1.74.1.dev2"
 Source = "https://github.com/gooddata/gooddata-python-sdk"
 
 [dependency-groups]
 test = [
     "jsonschema~=4.23.0",
-    "pytest~=8.3.4",
-    "pytest-cov~=6.0.0",
+    "pytest~=9.1.1",
+    "pytest-cov~=7.1.0",
     "pytest-json-report==1.5.0",
 ]