Skip to content

🎉 BigQuery Destination: improve check performance - #11350

Merged
VitaliiMaltsev merged 62 commits into
masterfrom
vmaltsev/10377-bigquery-improve-check-perf
Mar 24, 2022
Merged

VitaliiMaltsev merged 62 commits into
masterfrom
vmaltsev/10377-bigquery-improve-check-perf

Conversation

@VitaliiMaltsev

@VitaliiMaltsev VitaliiMaltsev commented Mar 23, 2022 •

Copy link
Copy Markdown
Contributor

What

BiqQuery check method shows low performance

How

Test necessary permissions using Google Cloud CDK without any actions on GCS

Recommended reading order

  1. BigQueryDestination.java

🚨 User Impact 🚨

There should not be any user impact

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

vmaltsev added 30 commits December 15, 2021 10:45
@CLAassistant

CLAassistant commented Mar 23, 2022 •

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ sherifnada
❌ vmaltsev


vmaltsev seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions Bot added the area/connectors Connector related issues label Mar 23, 2022
@github-actions github-actions Bot added the area/documentation Improvements or additions to documentation label Mar 24, 2022
@VitaliiMaltsev

VitaliiMaltsev commented Mar 24, 2022 •

Copy link
Copy Markdown
Contributor Author

/test connector=connectors/destination-bigquery

🕑 connectors/destination-bigquery https://github.com/airbytehq/airbyte/actions/runs/2033713458
✅ connectors/destination-bigquery https://github.com/airbytehq/airbyte/actions/runs/2033713458
Python tests coverage:

Name                                                                                                                            Stmts   Miss  Cover
---------------------------------------------------------------------------------------------------------------------------------------------------
normalization/transform_config/__init__.py                                                                                          2      0   100%
normalization/transform_catalog/reserved_keywords.py                                                                               13      0   100%
normalization/transform_catalog/__init__.py                                                                                         2      0   100%
normalization/destination_type.py                                                                                                  13      0   100%
normalization/__init__.py                                                                                                           4      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/airbyte_protocol.py     124      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/models/__init__.py               1      0   100%
/actions-runner/_work/airbyte/airbyte/airbyte-integrations/bases/airbyte-protocol/airbyte_protocol/__init__.py                      2      0   100%
normalization/transform_catalog/destination_name_transformer.py                                                                   155      8    95%
normalization/transform_config/transform.py                                                                                       159     30    81%
normalization/transform_catalog/table_name_registry.py                                                                            174     34    80%
normalization/transform_catalog/utils.py                                                                                           33      7    79%
normalization/transform_catalog/catalog_processor.py                                                                              143     77    46%
normalization/transform_catalog/transform.py                                                                                       45     26    42%
normalization/transform_catalog/stream_processor.py                                                                               524    337    36%
---------------------------------------------------------------------------------------------------------------------------------------------------
TOTAL                                                                                                                            1394    519    63%

@VitaliiMaltsev VitaliiMaltsev linked an issue Mar 24, 2022 that may be closed by this pull request
1 task
@VitaliiMaltsev
VitaliiMaltsev marked this pull request as ready for review March 24, 2022 13:04
}
}

public AirbyteConnectionStatus checkStorageIamPermissions(JsonNode config) {

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.

VitaliiMaltsev this is great, but could you put this inside the GCSDestination::check method instead? we will want this logic to be replicated for both GCS and BQ Destinatio

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.

once that is done I think we can move forward with this PR

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

VitaliiMaltsev this is great, but could you put this inside the GCSDestination::check method instead? we will want this logic to be replicated for both GCS and BQ Destinatio

Sherif A. Nada (@sherifnada) Now the main idea in BigQuery check() method - to use credentials_json parameter for authentification and IAM storage permissions testing.

  Storage storage = StorageOptions.newBuilder()
          .setProjectId(config.get(BigQueryConsts.CONFIG_PROJECT_ID).asText())
          **.setCredentials**(!isNull(credentials) ? credentials : ServiceAccountCredentials.getApplicationDefault())
          .build().getService();

Restriction here that we can use only credentials_json but not hmac_key_access_id and hmac_key_secret. We already have this param for Destination BigQuery spec, so it's a valid case.

But if you take a look at spec.json for Destination GCS you'll find that authentification use hmac_key_access_id and hmac_key_secret and AWS S3 dependency. The easiest way is to just add the credentials_json parameter to the spec, but wouldn't that be a backwards compatibility issue for existing users?
WDYT?

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.

VitaliiMaltsev got it, thanks for clarifying. Created this issue: https://github.com/airbytehq/airbyte/issues/11398

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.

the approach in this PR is fine as an intermediate step

}
}

public AirbyteConnectionStatus checkStorageIamPermissions(JsonNode config) {

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.

VitaliiMaltsev got it, thanks for clarifying. Created this issue: https://github.com/airbytehq/airbyte/issues/11398

}
}

public AirbyteConnectionStatus checkStorageIamPermissions(JsonNode config) {

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.

the approach in this PR is fine as an intermediate step

…java/io/airbyte/integrations/destination/bigquery/BigQueryDestination.java
…check-perf' into vmaltsev/10377-bigquery-improve-check-perf
@VitaliiMaltsev

VitaliiMaltsev commented Mar 24, 2022 •

Copy link
Copy Markdown
Contributor Author

/publish connector=connectors/destination-bigquery

🕑 connectors/destination-bigquery https://github.com/airbytehq/airbyte/actions/runs/2035564726
✅ connectors/destination-bigquery https://github.com/airbytehq/airbyte/actions/runs/2035564726

@subodh1810

Subodh Chaturvedi (subodh1810) commented Apr 6, 2022 •

Copy link
Copy Markdown
Contributor

Sherif A. Nada (@sherifnada) VitaliiMaltsev this approach doesn't work when people are using conditional binding on roles/permissions. For instance if I grant the role roles/storage.objectAdmin to the service account that am using with Airbyte for BigQuery GCS upload but add a condition that it should only be limited to objects inside the folder/directory (via using conditional binding) that am passing as a parameter in BigQuery setup form then this approach would fail. even though using the service account credentials we will be able to upload and read data from objects inside the folder/directory the check command would fail

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/connectors Connector related issues area/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Destination BigQuery: improve check connection performance

4 participants