[
https://issues.apache.org/jira/browse/AIRFLOW-2548?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16622898#comment-16622898
]
ASF GitHub Bot commented on AIRFLOW-2548:
-----------------------------------------
jcao219 opened a new pull request #3930: [AIRFLOW-2548] Output plugin import
errors to web UI
URL: https://github.com/apache/incubator-airflow/pull/3930
Make sure you have checked _all_ steps below.
### Jira
- [x] My PR addresses the following [Airflow
Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references
them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- https://issues.apache.org/jira/browse/AIRFLOW-2548
- In case you are fixing a typo in the documentation you can prepend your
commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
### Description
- [x] Here are some details about my PR, including screenshots of any UI
changes:
This change displays an alert in the web interface for each ImportError that
occurs on the DAGs homepage.
A limitation is that the presence of the error alert reflects the brokenness
of the plugin according to the webserver, not the scheduler. So, if the user
fixes the plugin and restarts *only* the webserver, that web UI will not show
the error anymore, but the airflow DAGs may still be broken because the
scheduler also needs a restart. In other words, the plugin can be
simultaneously fixed for the webserver but broken for the scheduler. After
editing the plugin's code, both the scheduler and the webserver need to be
restarted.
The proposer of the Jira issue @andscoop outlined a different approach to
add this feature in the Jira issue. I may be mistaken, but that approach would
cause the opposite limitation, where the error alert would reflect the
brokenness of the plugin according to the scheduler, not the webserver?
### Tests
- [x] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
It is unclear how I can unit test a small UI change like this.
### Commits
- [x] My commits all reference Jira issues in their subject lines, and I
have squashed multiple commits if they address the same issue. In addition, my
commits follow the guidelines from "[How to write a good git commit
message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [x] In case of new functionality, my PR adds documentation that describes
how to use it.
- When adding new operators/hooks/sensors, the autoclass documentation
generation needs to be added.
Added a sentence to clarify the need to restart both the webserver and the
scheduler after plugin changes.
### Code Quality
- [x] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Output Plugin Import Errors to WebUI
> ------------------------------------
>
> Key: AIRFLOW-2548
> URL: https://issues.apache.org/jira/browse/AIRFLOW-2548
> Project: Apache Airflow
> Issue Type: Bug
> Reporter: Andy Cooper
> Priority: Major
> Fix For: 2.0.0
>
>
> All,
>
> We currently output all DAG import errors to the webUI. I propose we do the
> same with plugin errors as well. This will provide a better user experience
> by bubbling up all errors to the webUI instead of hiding them in stdOut.
>
> Proposal...
> * Extend models.ImportError to have a "type" field to distinguish from error
> types.
> * Prevent class SchedulerJob methods from clearing out and pulling from
> models.ImportError if type = 'plugin'
> * Create new ImportError records in plugins_manager.py for each plugin that
> fails to import
> * Prompt user in views.py with plugin ImportErrors - specifying that they
> need to fix and restart webserver to resolve.
>
> Does this seem reasonable to everyone? I'd be interested in taking on this
> work if needed
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
