Enable use of custom conn extra fields without prefix #22607
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dstandish
requested review from
ryanahamilton,
ashb and
bbovenzi
as code owners
|
Needs rebase (FAB upgrade) |
dstandish
force-pushed
the
deprecate-conn-extra-prefix
branch
from
8cb3a7e to
6122689
Compare
ok done |
dstandish
force-pushed
the
deprecate-conn-extra-prefix
branch
from
6122689 to
b008b3f
Compare
ashb
approved these changes
Apr 20, 2022
github-actions
bot
added
the
full tests needed
|
The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease. |
dstandish
force-pushed
the
deprecate-conn-extra-prefix
branch
from
b008b3f to
acf17ab
Compare
jedcunningham
approved these changes
Apr 22, 2022
dstandish
commented
Apr 22, 2022
dstandish
requested review from
mik-laj,
ephraimbuddy,
kaxil and
XD-DENG
as code owners
dstandish
force-pushed
the
deprecate-conn-extra-prefix
branch
from
c8a98ee to
400c4e7
Compare
|
@josh-fell mentioned some potential issues with this so converting to draft for now while i investigate |
Previously, connection "extra" fields which were added as custom fields in the webserver connection form had to be named with prefix `extra__<conn_type>__`. This was because custom fields are registered globally on the connection view model, so the prefix was necessary to prevent collisions. But the prefix is ugly and cumbersome in the `extra` field. So now what we do is add this prefix when defining the field internally in the model, and strip it when saving the connection.
Co-authored-by: Jed Cunningham <[email protected]>
Co-authored-by: Jed Cunningham <[email protected]>
dstandish
force-pushed
the
deprecate-conn-extra-prefix
branch
from
400c4e7 to
5728a82
Compare
|
ok @josh-fell i think i came up with a reasonable solution to the "test connection" issue |
ashb
approved these changes
Apr 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Historically when adding custom extra fields we had to store them in the
extrajson field asextra__conn_type__field_name.This was somewhat cumbersome. And it meant that when adding them as UI form fields, you had to make a change to the structure of the
extraschema.With this PR, we do away with the requirement of this prefix. In effect, we separate the field "key" -- how it is identified internally in the model and form -- with "name", how it is identified in the
extrajson field.This leaves us with a backward compatible change, so that we can update hook classes (or class families) one at a time.
Notes on behavior
For hooks which have not updated
get_connection_form_widgetsto remove the prefixes, there's no change in behavior.But for hooks that have, then in the Web UI, when reading the connection (e.g. for an update) Airflow will check first for non-prefixed value then if it doesn't find it, it will check for prefixed value.
On save, it will always store in the manner defined by
get_connection_form_widgets. In the case where theextrafield was defined pre-hook-upgrade, I leave the old (prefixed) value alone, so as to be non-destructive. However I can see an argument for removing the old vaule.When we update hooks to remove the prefix, we need to add a
_get_fieldmethod to handle the extra lookup properly. Considering what happens with new hook and old airflow, we either have to bump min airflow version, or add Airflow-backcompat logic to re-prefix when using with an old version of Airflow. And I suppose this can be decided on a case-by-case basis with each provider.Other note
When implementing
get_ui_field_behaviourfor custom fields, you still will have to reference the prefixed field name. This I don't really like, but to solve it we'd have to do something a lot more elaborate and this is the simplest approach.