[AIRFLOW-4899] Fix BQ Hook - get_datasets_list uses pagination (#6780) by benjamingrenier · Pull Request #6780 · apache/airflow

benjamingrenier · 2019-12-10T19:24:58Z

Make sure you have checked all steps below.

Jira

My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"
- https://issues.apache.org/jira/browse/AIRFLOW-4899
- 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.
- In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
- In case you are adding a dependency, check if the license complies with the ASF 3rd Party License Policy.

Description

Here are some details about my PR, including screenshots of any UI changes:

Tests

My PR adds the following unit tests OR does not need testing for this extremely good reason:

Commits

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":
1. Subject is separated from body by a blank line
2. Subject is limited to 50 characters (not including Jira issue reference)
3. Subject does not end with a period
4. Subject uses the imperative mood ("add", not "adding")
5. Body wraps at 72 characters
6. Body explains "what" and "why", not "how"

Documentation

In case of new functionality, my PR adds documentation that describes how to use it.
- All the public functions and the classes in the PR contain docstrings that explain what it does
- If you implement backwards incompatible changes, please leave a note in the Updating.md so we can assign it to a appropriate release

…e#6780) Fix CloudBaseHook decorator

TobKed · 2019-12-11T07:28:12Z

@benjamingrenier could you fix link to the Jira issue in the description please?

TobKed

Good job @benjamingrenier :) . I've left some comments

TobKed · 2019-12-11T07:29:29Z

airflow/gcp/hooks/bigquery.py


-    def get_datasets_list(self, project_id: Optional[str] = None) -> List:
+    @CloudBaseHook.catch_http_exception
+    def get_datasets_list(self, project_id=None, max_results=None, all_datasets=False):


Could you add type annotations, please? I think it is good idea to keep them :)

TobKed · 2019-12-11T07:37:12Z

airflow/gcp/hooks/bigquery.py

+            projectId=dataset_project_id,
+            **optional_params)
+
+        datasets_list = []


I think you could just use datasets here and add type. What do you think?

TobKed · 2019-12-11T07:41:32Z

airflow/gcp/hooks/bigquery.py

-                'BigQuery job failed. Error was: {}'.format(err.content))
+        request = self.service.datasets().list(
+            projectId=dataset_project_id,
+            **optional_params)


I wonder is this optional_params dictionary is required. I've checked how it is done here: airflow.providers.google.marketing_platform.hooks.campaign_manager.GoogleCampaignManagerHook.list_reports and it is slightly cleaner. WDYT?

TobKed · 2019-12-11T07:45:37Z

tests/gcp/hooks/test_bigquery.py

-            self.assertEqual(result, expected_result['datasets'])
+        mock_service = mock.Mock()
+        cursor = hook.BigQueryBaseCursor(mock_service, project_id)
+        mock_service.datasets.return_value.list.return_value.execute.return_value = {


I think you could check here by using assert_called_once_with with what parameters list method was called.

codecov-io · 2019-12-11T08:10:36Z

Codecov Report

Merging #6780 into master will decrease coverage by 0.29%.
The diff coverage is 91.66%.

@@            Coverage Diff            @@
##           master    #6780     +/-   ##
=========================================
- Coverage   84.53%   84.23%   -0.3%     
=========================================
  Files         672      672             
  Lines       38153    38159      +6     
=========================================
- Hits        32252    32144    -108     
- Misses       5901     6015    +114

Impacted Files	Coverage Δ
airflow/gcp/hooks/bigquery.py	`71.25% <91.66%> (+0.4%)`	⬆️
airflow/kubernetes/volume_mount.py	`44.44% <0%> (-55.56%)`	⬇️
airflow/kubernetes/volume.py	`52.94% <0%> (-47.06%)`	⬇️
airflow/kubernetes/pod_launcher.py	`45.25% <0%> (-46.72%)`	⬇️
airflow/kubernetes/refresh_config.py	`50.98% <0%> (-23.53%)`	⬇️
...rflow/contrib/operators/kubernetes_pod_operator.py	`78.2% <0%> (-20.52%)`	⬇️
airflow/contrib/operators/ssh_operator.py	`83.33% <0%> (-1.29%)`	⬇️
airflow/jobs/backfill_job.py	`90.72% <0%> (-1.16%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 53aa975...183bf8b. Read the comment docs.

stale · 2020-01-25T09:00:36Z

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

Mofef · 2020-12-08T11:04:31Z

@benjamingrenier I just ran into the same issue and found that you were apparently trying to get this fix merged since July 2019 (#5565). Would you be willing to pick this up again? Can I help?

mik-laj · 2020-12-09T15:53:34Z

@Mofef Can you create a new PR? I am happy to help with the review.

Mofef · 2020-12-10T14:27:55Z

Sure, I'd like to try that. Is it ok to start with forking from what @benjamingrenier already achieved and addressing the previous review comments?

benjamingrenier force-pushed the AIRFLOW-4899 branch from 9a86a72 to 1899b52 Compare December 10, 2019 19:25

benjamingrenier changed the title ~~[AIRFLOW-4899] Fix BQ Hook - get_datasets_list uses pagination (#5565)~~ [AIRFLOW-4899] Fix BQ Hook - get_datasets_list uses pagination (#6780) Dec 10, 2019

benjamingrenier mentioned this pull request Dec 10, 2019

[AIRFLOW-4899] Fix get_dataset_list from bigquery hook to return next… #5565

Closed

mik-laj added the provider:google Google (including GCP) related issues label Dec 10, 2019

[AIRFLOW-4899] Fix BQ Hook - get_datasets_list uses pagination (apach…

183bf8b

…e#6780) Fix CloudBaseHook decorator

benjamingrenier force-pushed the AIRFLOW-4899 branch from 1899b52 to 183bf8b Compare December 11, 2019 07:23

TobKed suggested changes Dec 11, 2019

View reviewed changes

stale bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Jan 25, 2020

stale bot closed this Feb 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[AIRFLOW-4899] Fix BQ Hook - get_datasets_list uses pagination (#6780)#6780

[AIRFLOW-4899] Fix BQ Hook - get_datasets_list uses pagination (#6780)#6780
benjamingrenier wants to merge 1 commit intoapache:masterfrom
benjamingrenier:AIRFLOW-4899

benjamingrenier commented Dec 10, 2019 •

edited

Loading

Uh oh!

TobKed commented Dec 11, 2019

Uh oh!

TobKed left a comment

Uh oh!

TobKed Dec 11, 2019

Uh oh!

TobKed Dec 11, 2019

Uh oh!

TobKed Dec 11, 2019

Uh oh!

TobKed Dec 11, 2019

Uh oh!

codecov-io commented Dec 11, 2019

Uh oh!

stale bot commented Jan 25, 2020

Uh oh!

Mofef commented Dec 8, 2020

Uh oh!

mik-laj commented Dec 9, 2020

Uh oh!

Mofef commented Dec 10, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

benjamingrenier commented Dec 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jira

Description

Tests

Commits

Documentation

Uh oh!

TobKed commented Dec 11, 2019

Uh oh!

TobKed left a comment

Choose a reason for hiding this comment

Uh oh!

TobKed Dec 11, 2019

Choose a reason for hiding this comment

Uh oh!

TobKed Dec 11, 2019

Choose a reason for hiding this comment

Uh oh!

TobKed Dec 11, 2019

Choose a reason for hiding this comment

Uh oh!

TobKed Dec 11, 2019

Choose a reason for hiding this comment

Uh oh!

codecov-io commented Dec 11, 2019

Codecov Report

Uh oh!

stale bot commented Jan 25, 2020

Uh oh!

Mofef commented Dec 8, 2020

Uh oh!

mik-laj commented Dec 9, 2020

Uh oh!

Mofef commented Dec 10, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

benjamingrenier commented Dec 10, 2019 •

edited

Loading