Support defining custom callbacks alongside the WATCHER_KUBERNETES callback#2307
Conversation
✅ Deploy Preview for astronomer-cosmos canceled.
|
There was a problem hiding this comment.
Pull request overview
This PR updates the Kubernetes watcher producer operator so that it no longer overwrites existing callbacks, but instead augments them with the watcher-specific callback.
Changes:
- Modifies
DbtProducerWatcherKubernetesOperator.__init__to appendWatcherKubernetesCallbackto any existingcallbackskwarg instead of passing it exclusively. - Leaves the rest of the watcher Kubernetes operator behavior (retry handling, pod manager, execution flow) unchanged.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| kwargs["retries"] = 0 | ||
|
|
||
| super().__init__(task_id=task_id, *args, callbacks=WatcherKubernetesCallback, **kwargs) | ||
| kwargs["callbacks"] = kwargs.get("callbacks", []) + [WatcherKubernetesCallback] |
There was a problem hiding this comment.
The updated initialization now conditionally appends WatcherKubernetesCallback to any user-provided callbacks, but there is no unit test asserting that both callbacks are preserved (e.g., when setup_operator_args passes custom Kubernetes callbacks). Given the importance of these callbacks for log processing and watcher behavior, consider adding a test that constructs DbtProducerWatcherKubernetesOperator with existing callbacks and verifies the resulting callbacks attribute includes both the user-defined and watcher callbacks in the expected order.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Thanks a lot for this improvement, @johnhoran ! |
ExecutionMode.WATCHER_KUBERNETES callback
ExecutionMode.WATCHER_KUBERNETES callbackWATCHER_KUBERNETES callback
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2307 +/- ##
=======================================
Coverage 98.12% 98.12%
=======================================
Files 100 100
Lines 6725 6733 +8
=======================================
+ Hits 6599 6607 +8
Misses 126 126 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tatiana
left a comment
There was a problem hiding this comment.
Thanks a lot for the improvement, @johnhoran ! We'll release this as part of Cosmos 1.13.0
Features * Support cross-referencing models across dbt projects using dbt-loom by @pankajkoti in #2271 * Support use of YAML selectors when using ``LoadMode.DBT_MANIFEST`` by @YourRoyalLinus in #2261 * Introduce ``ExecutionMode.WATCHER_KUBERNETES`` to use the watcher with ``KubernetesPodOperator`` by @tatiana in #2207 * Add support for StarRocks profile mapping by @kurkim0661 in #2256 * Allow pushing URIs as XComs for Cosmos tasks by @corsettigyg in #2275 * Support defining custom callbacks alongside the ``WATCHER_KUBERNETES`` callback by @johnhoran in #2307 Enhancements * Refactor: remove duplicate ``_construct_dest_file_path`` by @jx2lee in #2077 * Leverage Airflow ``::group::`` to group logs associated with DAG parsing by @tatiana in #2235 * Refactor ``DbtConsumerWatcherSensor`` for reusability by @tatiana in #2245 * Restore plain text output when using ``ExecutionMode.WATCHER`` by @tiovader in #2241 Bug Fixes * Fix running empty models or ephemeral nodes in ``ExecutionMode.WATCHER`` by @tatiana in #2279 * Improve watcher producer task priority in scheduling and the UI by @tatiana in #2237 * Fix typos and formatting issues in documentation by @pankajkoti in #2259 * Allow watcher producer retries without erroring by @tatiana in #2283 * Fix ``TestBehavior.AFTER_ALL`` is missing project_name information when loading project using manifest file by @tuantran0910 in #2242 * Fix duplicate log lines in watcher subprocess execution and format timestamps by @pankajkoti in #2301 Docs * Add Watcher Kubernetes documentation by @tatiana in #2303 * Document newly added telemetry metrics in the privacy notice by @pankajkoti in #2249 * Add compatibility policy document by @pankajastro in #2251 * Improve watcher documentation related to dbt threads by @tatiana in #2273 * Fix link in watcher execution mode documentation by @jedcunningham in #2277 * Update Apache Airflow minimum compatibility policy by @tatiana in #2285 * Clarify Cosmos runtime support until "End of Basic Support" by @jedcunningham in #2286 * Update watcher docs by @tatiana in #2298 * Update watcher kubernetes documentation by @tatiana in #2306 Others * Add Airflow 3 DAG versioning tests for Cosmos by @michal-mrazek in #2177 * Add dbt Core 1.11 to the test matrix by @tatiana in #2230 * Add integration tests using InvocationMode.SUBPROCESS and validate output by @tatiana in #2287 * Fix main branch failing tests by @tatiana in #2296 * Update pre-commit hooks to the latest versions by @jedcunningham in #2289 * Pre-commit autoupdates by @pre-commit in #2222, #2264, #2274 and #2290 * Dependabot updates by @dependabot in #2218, #2219, #2220, #2280 and #2284 * Add Scarf metrics to understand Cosmos feature usage patterns - Add telemetry tracking for dbt docs plugin usage by @pankajkoti in #2240 - Add DAG run telemetry metrics for load mode, invocation, and render_config parameters by @pankajkoti in #2223 - Collect profile metrics for DAG runs by @pankajastro in #2228 - Compress telemetry metadata to reduce serialized DAG size by @pankajkoti in #2252 - Skip storing telemetry metadata when emission is disabled by @pankajkoti in #2278 - Hide telemetry metadata parameters from the Airflow trigger UI by @pankajkoti in #2247 closes: astronomer/oss-integrations-private#317 --------- Co-authored-by: Tatiana Al-Chueyr <tatiana.alchueyr@gmail.com>
**Enhancements** * Change Snowflake profile mappings to default to four threads by @tatiana in #2374 * Refactor to avoid potential future ``UnboundLocalError`` for ``producer_task`` in ``calculate_tasks_map`` by @rin in #2309 **Bug Fixes** * Fix graph selector when using + selector with ``dbt-loom`` by @award1230 in #2389 * Populate ``compiled_sql`` for ``InvocationMode.SUBPROCESS`` in ``ExecutionMode.WATCHER`` by @pankajkoti in #2319 * Preserve ``extra_context`` for watcher consumer task instances by @pankajkoti in #2381 * Fix watcher: respect ``deferrable=False`` from ``operator_args`` on consumer sensor by @pankajkoti in #2384 * Error handle invalid YAML with ``LoadMode.DBT_MANIFEST`` and ``RenderConfig.selector`` by @jonbillings in #2316 * Fix selecting model when it has the same name as folder by @pankajastro in #2328 * Handle Param Validation errors by @tatiana in #2358 * Fix cache swap issue by @jonbillings in #2332 * Fix leaked semaphore warnings in Airflow 3 by resetting dbt adapters by @pankajkoti in #2335 **Docs** * Document ``ExecutionMode.KUBERNETES`` limitations by @tatiana in #2326 **Others** * Add .airflow-registry.yaml for Airflow Provider Registry by @kaxil in #2387 * Improve test coverage for PR #2307 by @tatiana in #2308 * Address feedback from code review #2389 by @evanvolgas in #2394 Closes: astronomer/oss-integrations-private#333
Enhancements * Change Snowflake profile mappings to default to four threads by @tatiana in #2374 * Refactor to avoid potential future ``UnboundLocalError`` for ``producer_task`` in ``calculate_tasks_map`` by @rin in #2309 Bug Fixes * Fix graph selector when using + selector with ``dbt-loom`` by @award1230 in #2389 * Populate ``compiled_sql`` for ``InvocationMode.SUBPROCESS`` in ``ExecutionMode.WATCHER`` by @pankajkoti in #2319 * Preserve ``extra_context`` for watcher consumer task instances by @pankajkoti in #2381 * Fix watcher: respect ``deferrable=False`` from ``operator_args`` on consumer sensor by @pankajkoti in #2384 * Error handle invalid YAML with ``LoadMode.DBT_MANIFEST`` and ``RenderConfig.selector`` by @YourRoyalLinus in #2316 * Fix selecting model when it has the same name as folder by @pankajastro in #2328 * Handle Param Validation errors by @tatiana in #2358 * Fix cache swap issue by @YourRoyalLinus in #2332 * Fix leaked semaphore warnings in Airflow 3 by resetting dbt adapters by @pankajkoti in #2335 Docs * Document ``ExecutionMode.KUBERNETES`` limitations by @tatiana in #2326 Others * Add .airflow-registry.yaml for Airflow Provider Registry by @kaxil in #2387 * Improve test coverage for PR #2307 by @tatiana in #2308 * Address feedback from code review #2389 by @evanvolgas in #2394 Additional details on this change: - The actual release was done from branch 1.13: https://github.com/astronomer/astronomer-cosmos/releases/tag/astronomer-cosmos-v1.13.1 - This PR aims to update our CHANGELOG, and allow us to give credit to the username that was being questioned by codespell
Description
I am also setting callbacks on the watcher producer, and the code as it is tries to set them exclusively. So just checking to see if the task already has some and adding the watcher pattern to the callback if it does.
Related Issue(s)
Breaking Change?
Checklist