mrohith3693 opened a new pull request, #53441:
URL: https://github.com/apache/airflow/pull/53441
### Simplify Parsing of apprise_default Connection ID in AppriseHook
This PR improves the robustness of AppriseHook.get_config_from_conn() to
correctly handle cases where the config field is either:
- A valid JSON string (escaped), or
- A parsed Python dictionary (via environment variable like
AIRFLOW_CONN_APPRISE_DEFAULT)
#### Problem
Currently, if the connection extra field already contains a dictionary (not
a string), Airflow raises:
TypeError: the JSON object must be str, bytes or bytearray, not dict
This happens because the method always calls json.loads() on the config
field without checking its type. This fails when config is already a dictionary
(e.g., injected via env vars in Docker).
#### ✅ What This PR Changes
- Updates get_config_from_conn() to:
- Return the config directly if it's already a dictionary.
- Otherwise, parse it using json.loads() if it's a string.
- Maintains backward compatibility with escaped JSON strings.
- Adds robust unit tests to validate both scenarios.
- Ensures better developer experience when using environment-based Airflow
connections.
#### 🧪 How It Was Tested
- Added a failing unit test
(test_get_config_from_conn_with_dict_should_fail) to reproduce the bug.
- Applied the fix and verified the test passes.
- Confirmed that other existing test cases still pass.
- Verified the functionality with both types of config input:
- JSON string
- Direct Python dictionary
#### 🔍 Context
- Airflow Version: 2.8.1
- Apprise Provider: 1.2.1
- Deployment: Docker-Compose (Ubuntu 20.04.6 LTS)
- Related issue: Parsing fails if quotes not escaped or config is dict
#### 📌 Why This Matters
This change allows developers to use intuitive and clean environment
variable formats when configuring Apprise connections. It removes the need to
escape quotes manually in JSON strings and makes the hook more robust to
varying input formats.
#### 🧼 Clean-up
Also removed some duplicate imports and cleaned up unused variables in tests
to align with Airflow's style guide.
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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]
