add user agent to bigquery connector by samhita-alla · Pull Request #3232 · flyteorg/flytekit

samhita-alla · 2025-04-17T12:31:53Z

Tracking issue

Why are the changes needed?

necessary for the bigquery partnership with google.

What changes were proposed in this pull request?

added user agent to the bigquery client call per the format described by google.

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

I updated the documentation accordingly.
All new and existing tests passed.
All commits are signed-off.

Related PRs

Docs link

Summary by Bito

This PR enhances the BigQuery integration by adding a custom user agent to meet Google partnership requirements. It reorganizes imports, adjusts client initialization with safer domain field handling using .get() method, and updates task configuration to include domain details. These changes improve error handling, ensure compliance, and validate the updated client configuration.

Unit tests added: False

Estimated effort to review (1-5, lower is better): 1

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

flyte-bot · 2025-04-17T12:32:04Z

Code Review Agent Run #95d281

Actionable Suggestions - 1

plugins/flytekit-bigquery/flytekitplugins/bigquery/task.py - 1
- Missing attribute check for settings.domain · Line 73-77

Additional Suggestions - 1

plugins/flytekit-bigquery/flytekitplugins/bigquery/connector.py - 1
- Use built-in dict instead of typing.Dict · Line 3-3

Review Details

Files reviewed - 2 · Commit Range: d0bdc49..d0bdc49
- plugins/flytekit-bigquery/flytekitplugins/bigquery/connector.py
- plugins/flytekit-bigquery/flytekitplugins/bigquery/task.py
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.

Refer to the documentation for additional commands.

Configuration

This repository uses code_review_bito You can customize the agent settings here or contact your Bito workspace admin at haytham@union.ai.

Documentation & Help

AI Code Review powered by

flyte-bot · 2025-04-17T12:35:20Z

Changelist by Bito

This pull request implements the following key changes.

Key Change	Files Impacted
Feature Improvement - Enhanced BigQuery Connector for Custom User Agent	- `connector.py` - Refactored imports and added user agent initialization using ClientInfo to pass domain and sdk_version info to the bigquery client. - `task.py` - Updated configuration to include a Domain field which supports the new user agent setup.
Testing - Updated Tests for Domain Configuration	- `test_bigquery.py` - Modified test assertions to accommodate the new Domain field in the task_spec custom configuration. - `test_connector.py` - Added Domain key to task_config to ensure connector tests cover user agent and domain support.

codecov · 2025-04-17T12:44:26Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.58%. Comparing base (26db7a3) to head (d0bdc49).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3232      +/-   ##
==========================================
+ Coverage   74.77%   83.58%   +8.81%     
==========================================
  Files         295        3     -292     
  Lines       25725      195   -25530     
  Branches     2924        0    -2924     
==========================================
- Hits        19235      163   -19072     
+ Misses       5663       32    -5631     
+ Partials      827        0     -827

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

pingsutw

Awesome, thank you @samhita-alla

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

Future-Outlier

is it backward compatible with old syntax?

flyte-bot · 2025-04-22T11:52:32Z

Code Review Agent Run #e1e431

Actionable Suggestions - 0

Additional Suggestions - 2

plugins/flytekit-bigquery/tests/test_bigquery.py - 1
- Test expects field not in BigQueryConfig definition · Line 46-46
plugins/flytekit-bigquery/tests/test_connector.py - 1
- Unused Domain parameter in BigQuery task config · Line 62-62

Review Details

Files reviewed - 2 · Commit Range: d0bdc49..2174efe
- plugins/flytekit-bigquery/tests/test_bigquery.py
- plugins/flytekit-bigquery/tests/test_connector.py
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.

Refer to the documentation for additional commands.

Configuration

This repository uses code_review_bito You can customize the agent settings here or contact your Bito workspace admin at haytham@union.ai.

Documentation & Help

AI Code Review powered by

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

flyte-bot · 2025-04-22T18:02:19Z

Code Review Agent Run #cd796a

Actionable Suggestions - 0

Review Details

Files reviewed - 1 · Commit Range: 2174efe..6e574ab
- plugins/flytekit-bigquery/flytekitplugins/bigquery/connector.py
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.

Refer to the documentation for additional commands.

Configuration

This repository uses code_review_bito You can customize the agent settings here or contact your Bito workspace admin at haytham@union.ai.

Documentation & Help

AI Code Review powered by

* add user agent to bigquery connector Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * fix test Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * fix test Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * make domain fetch optional Signed-off-by: Samhita Alla <aallasamhita@gmail.com> --------- Signed-off-by: Samhita Alla <aallasamhita@gmail.com> Signed-off-by: Atharva <atharvakulkarni172003@gmail.com>

add user agent to bigquery connector

d0bdc49

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

samhita-alla requested review from Future-Outlier, cosmicBboy, davidmirror-ops, eapolinario, kumare3, pingsutw, thomasjpfan and wild-endeavor as code owners April 17, 2025 12:31

flyte-bot reviewed Apr 17, 2025

View reviewed changes

Comment thread plugins/flytekit-bigquery/flytekitplugins/bigquery/task.py

pingsutw previously approved these changes Apr 22, 2025

View reviewed changes

fix test

abcb371

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

samhita-alla dismissed pingsutw’s stale review via abcb371 April 22, 2025 10:46

fix test

2174efe

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

Future-Outlier previously approved these changes Apr 22, 2025

View reviewed changes

Future-Outlier reviewed Apr 22, 2025

View reviewed changes

Comment thread plugins/flytekit-bigquery/flytekitplugins/bigquery/connector.py

make domain fetch optional

6e574ab

Signed-off-by: Samhita Alla <aallasamhita@gmail.com>

samhita-alla dismissed Future-Outlier’s stale review via 6e574ab April 22, 2025 16:43

Future-Outlier approved these changes Apr 23, 2025

View reviewed changes

samhita-alla merged commit 8a4a19a into master Apr 23, 2025
114 of 115 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add user agent to bigquery connector#3232

add user agent to bigquery connector#3232
samhita-alla merged 4 commits into
masterfrom
bigquery-useragent

samhita-alla commented Apr 17, 2025 •

edited by flyte-bot

Loading

Uh oh!

flyte-bot commented Apr 17, 2025 •

edited

Loading

Code Review Agent Run #95d281

Uh oh!

flyte-bot commented Apr 17, 2025 •

edited

Loading

Changelist by Bito

Uh oh!

Uh oh!

codecov Bot commented Apr 17, 2025

Uh oh!

pingsutw left a comment

Uh oh!

Future-Outlier left a comment

Uh oh!

flyte-bot commented Apr 22, 2025 •

edited

Loading

Code Review Agent Run #e1e431

Uh oh!

Uh oh!

flyte-bot commented Apr 22, 2025 •

edited

Loading

Code Review Agent Run #cd796a

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

samhita-alla commented Apr 17, 2025 • edited by flyte-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tracking issue

Why are the changes needed?

What changes were proposed in this pull request?

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

Related PRs

Docs link

Summary by Bito

Uh oh!

flyte-bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #95d281

Uh oh!

flyte-bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelist by Bito

Uh oh!

Uh oh!

codecov Bot commented Apr 17, 2025

Codecov Report

Uh oh!

pingsutw left a comment

Choose a reason for hiding this comment

Uh oh!

Future-Outlier left a comment

Choose a reason for hiding this comment

Uh oh!

flyte-bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #e1e431

Uh oh!

Uh oh!

flyte-bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #cd796a

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

samhita-alla commented Apr 17, 2025 •

edited by flyte-bot

Loading

flyte-bot commented Apr 17, 2025 •

edited

Loading

flyte-bot commented Apr 17, 2025 •

edited

Loading

flyte-bot commented Apr 22, 2025 •

edited

Loading

flyte-bot commented Apr 22, 2025 •

edited

Loading