You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "mrohith3693 (via GitHub)" <gi...@apache.org> on 2025/07/17 04:37:41 UTC

[PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #53441:
URL: https://github.com/apache/airflow/pull/53441#issuecomment-3082463919

   Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
   Here are some useful points:
   - Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-pre-commit-hooks) will help you with that.
   - In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/airflow-core/docs/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
   - Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
   - Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
   - Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
   - Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#coding-style-and-best-practices).
   - Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
   Apache Airflow is a community-driven project and together we are making it better 🚀.
   In case of doubts contact the developers at:
   Mailing List: dev@airflow.apache.org
   Slack: https://s.apache.org/airflow-slack
   


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

Posted by "mrohith3693 (via GitHub)" <gi...@apache.org>.
mrohith3693 commented on PR #53441:
URL: https://github.com/apache/airflow/pull/53441#issuecomment-3083514455

   Thank you for pointing that out. The license header was removed
   unintentionally during a merge conflict. I’ve now restored it in the test
   file. Please let me know if anything else is needed.
   
   Regards
   Rohith
   
   On Thu, Jul 17, 2025, 3:19 PM Dominik ***@***.***> wrote:
   
   > ***@***.**** commented on this pull request.
   > ------------------------------
   >
   > In providers/apprise/tests/unit/apprise/hooks/test_apprise.py
   > <https://github.com/apache/airflow/pull/53441#discussion_r2212880598>:
   >
   > > -# 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.
   >
   > Why did you remove the license headers?
   >
   > —
   > Reply to this email directly, view it on GitHub
   > <https://github.com/apache/airflow/pull/53441#pullrequestreview-3028788977>,
   > or unsubscribe
   > <https://github.com/notifications/unsubscribe-auth/BUYB46G3ROJTRBPKWDR3DC33I5WTDAVCNFSM6AAAAACBWVHMPWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTAMRYG44DQOJXG4>
   > .
   > You are receiving this because you authored the thread.Message ID:
   > ***@***.***>
   >
   


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #53441:
URL: https://github.com/apache/airflow/pull/53441#issuecomment-3260108619

   This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

Posted by "mrohith3693 (via GitHub)" <gi...@apache.org>.
mrohith3693 commented on PR #53441:
URL: https://github.com/apache/airflow/pull/53441#issuecomment-3082523559

   Hi 👋 This PR fixes a TypeError in AppriseHook.get_config_from_conn() caused when the Apprise connection's config is already a dictionary (e.g. from env vars like AIRFLOW_CONN_APPRISE_DEFAULT). It now supports both string and dict types.
   
   Let me know if anything else is needed! Thanks for reviewing 


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #53441: Fix: simplify parsing of Apprise config in AppriseHook
URL: https://github.com/apache/airflow/pull/53441


-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

Posted by "dominikhei (via GitHub)" <gi...@apache.org>.
dominikhei commented on code in PR #53441:
URL: https://github.com/apache/airflow/pull/53441#discussion_r2212880598


##########
providers/apprise/tests/unit/apprise/hooks/test_apprise.py:
##########
@@ -1,21 +1,3 @@
-# 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.

Review Comment:
   Why did you remove the license headers?



-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Fix: simplify parsing of Apprise config in AppriseHook [airflow]

Posted by "mrohith3693 (via GitHub)" <gi...@apache.org>.
mrohith3693 commented on code in PR #53441:
URL: https://github.com/apache/airflow/pull/53441#discussion_r2214353866


##########
providers/apprise/tests/unit/apprise/hooks/test_apprise.py:
##########
@@ -1,21 +1,3 @@
-# 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.

Review Comment:
   Thank you for pointing that out. The license header was removed
   unintentionally during a merge conflict. I’ve now restored it in the test
   file. Please let me know if anything else is needed.



-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org