Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add support for deferrable operators in AMPP by syedahsn · Pull Request #30032 · apache/airflow · GitHub
Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add support for deferrable operators in AMPP by syedahsn · Pull Request #30032 · apache/airflow · GitHub
Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add support for deferrable operators in AMPP by syedahsn · Pull Request #30032 · apache/airflow · GitHub
Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add support for deferrable operators in AMPP by syedahsn · Pull Request #30032 · apache/airflow · GitHub
Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add support for deferrable operators in AMPP by syedahsn · Pull Request #30032 · apache/airflow · GitHub
Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add support for deferrable operators in AMPP by syedahsn · Pull Request #30032 · apache/airflow · GitHub
Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Add support for deferrable operators in AMPP by syedahsn · Pull Request #30032 · apache/airflow · GitHub
Skip to content

Add support for deferrable operators in AMPP - #30032

Merged
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster
Apr 24, 2023
Merged

Add support for deferrable operators in AMPP#30032
potiuk merged 25 commits into
apache:mainfrom
aws-mwaa:syedahsn/deferrable-redshift-create-cluster

Conversation

@syedahsn

@syedahsnsyedahsn commented Mar 10, 2023

Copy link
Copy Markdown
Contributor

The purpose of this PR is to add the foundations required to convert AMPP operators to deferrable operators.
The aiobotocore library is being used to make all async calls to the boto3 API.

Rather than create separate Async hooks for every service, we create an async_conn property in base_aws.py which behaves similar to the existing conn property. This property allows us to get access to a client that can make async boto3 API calls. This also allows us to make use of the supporting code that exists for the conn property. The get_client_type function is extended to handle returning a ClientCreatorContext object which can be used to get a client that supports asynchronous calls.

Another addition this PR makes is extending get_waiter in base_aws.py to work with custom async waiters. Currently, the get_waiter function allows us to create a custom waiter using a JSON config file. This PR allows passing a client parameter which can be used to return an async waiter generated by the aiobotocore library. This feature will save a lot of code duplication by standardizing the polling portion of Triggers. A README.md file is included that describes how Triggers can be written which make use of these features. Although not all operators and sensor will be able to make use of these features, there are many in the AMPP that can be written in a standardized format following the methods described.

The RedshiftCreateClusterOperator is chosen to demonstrate how an operator would be modified to become a deferrable operator. We use the built-in cluster_available waiter in the Trigger to asynchronously poll the boto3 API to wait for the cluster to become available.
@Taragolis, @uranusjr , @potiuk , @pankajastro I'd love to hear your thoughts on this approach, and see what you think.


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

Comment threadairflow/providers/amazon/provider.yaml Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 5 times, most recently from 7717291 to 8c93e1aCompareMarch 25, 2023 00:02
@potiuk

Copy link
Copy Markdown
Member

You need to skip your aiobotocore tests conditionally - see other deferrable tests in aws

@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 7 times, most recently from b6b680d to 075f201CompareMarch 29, 2023 18:29
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
Comment threadairflow/providers/amazon/aws/hooks/base_aws.py Outdated
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 4 times, most recently from 9633b59 to f023f32CompareApril 6, 2023 17:07
@syedahsn
syedahsnforce-pushed the syedahsn/deferrable-redshift-create-cluster branch 2 times, most recently from 571789d to b164050CompareApril 11, 2023 16:52
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/triggers/README.md Outdated
Comment threadairflow/providers/amazon/aws/operators/redshift_cluster.py
Add unit test for deferrable in test_redshift_cluster.py operator
Add docstring for deferrable param
Comment on lines +132 to +133
with pytest.raises(TaskDeferred):
redshift_operator.execute(None)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I was expecting to check that self.defer have been called, but this one works as well :)

@vincbeck

Copy link
Copy Markdown
Contributor

There are some static check failures

@potiuk
potiuk merged commit 62ea0ff into apache:mainApr 24, 2023
potiuk added a commit to potiuk/airflow that referenced this pull request Apr 26, 2023
The apache#30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
potiuk added a commit that referenced this pull request Apr 26, 2023
The #30032 has been merged with aiobotore as required dependency.
The aiobotocore package adds specific requirements for botocore
and boto and it conflicts with older versions of Airflow, so
we have to bring it back as optional dependency of the
amazon provider.
@vandonr-amz
vandonr-amz deleted the syedahsn/deferrable-redshift-create-cluster branch May 24, 2023 20:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providersprovider:amazonAWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@syedahsn@potiuk@vandonr-amz@vincbeck@Taragolis@eladkal@o-nikolas@shubham22