Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Destination BigQuery-Denormalized: Fix JSON with $ref Definition keys #7736

Conversation

alexandertsukanov
Copy link
Contributor

@alexandertsukanov alexandertsukanov commented Nov 8, 2021

What

The issue appears when Airbyte trying to parse JSON fields that contain $ref definition. e.g.

{ 
  "type" : [ "null", "object" ],
  "properties" : {
    "users": {
      "$ref": "#/definitions/users_"
    }
  }
}

The main problem such values come to BigQueryDenormalizedRecordConsumer.java as ObjecNode classes, despite the fact Schema type of this column is StandardSQLTypeName.STRING.

How

The handling for such a case was added to BigQueryDenormalizedDestination.java and BigQueryDenormalizedRecordConsumer.java . Now, such fields will be stored as raw String JSON at BigQuery DB.
e.g.
See integration tests.

Recommended reading order

  1. x.java

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
  • Credentials added to Github CI. 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
  • Credentials added to Github CI. 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.

@github-actions github-actions bot added the area/connectors Connector related issues label Nov 8, 2021
@alexandertsukanov alexandertsukanov temporarily deployed to more-secrets November 8, 2021 14:58 Inactive
@alexandertsukanov
Copy link
Contributor Author

alexandertsukanov commented Nov 8, 2021

/test connector=connectors/destination-bigquery-denormalized

🕑 connectors/destination-bigquery-denormalized https://github.com/airbytehq/airbyte/actions/runs/1435327112
✅ connectors/destination-bigquery-denormalized https://github.com/airbytehq/airbyte/actions/runs/1435327112
No Python unittests run

@jrhizor jrhizor temporarily deployed to more-secrets November 8, 2021 15:01 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets November 8, 2021 15:18 Inactive
@alexandertsukanov
Copy link
Contributor Author

alexandertsukanov commented Nov 8, 2021

/test connector=connectors/destination-bigquery

🕑 connectors/destination-bigquery https://github.com/airbytehq/airbyte/actions/runs/1435568412
❌ connectors/destination-bigquery https://github.com/airbytehq/airbyte/actions/runs/1435568412
🐛

@jrhizor jrhizor temporarily deployed to more-secrets November 8, 2021 15:58 Inactive
@alexandertsukanov
Copy link
Contributor Author

alexandertsukanov commented Nov 8, 2021

/test connector=connectors/destination-bigquery

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

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                              Stmts   Miss  Cover
	 -------------------------------------------------------------------------------------
	 main_dev_transform_catalog.py                                         3      3     0%
	 main_dev_transform_config.py                                          3      3     0%
	 normalization/__init__.py                                             4      0   100%
	 normalization/destination_type.py                                    12      0   100%
	 normalization/transform_catalog/__init__.py                           2      0   100%
	 normalization/transform_catalog/catalog_processor.py                143     77    46%
	 normalization/transform_catalog/destination_name_transformer.py     120      6    95%
	 normalization/transform_catalog/reserved_keywords.py                 11      0   100%
	 normalization/transform_catalog/stream_processor.py                 468    287    39%
	 normalization/transform_catalog/table_name_registry.py              174     34    80%
	 normalization/transform_catalog/transform.py                         45     26    42%
	 normalization/transform_catalog/utils.py                             33      7    79%
	 normalization/transform_config/__init__.py                            2      0   100%
	 normalization/transform_config/transform.py                         140     29    79%
	 -------------------------------------------------------------------------------------
	 TOTAL                                                              1160    472    59%

@alexandertsukanov alexandertsukanov temporarily deployed to more-secrets November 8, 2021 16:53 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets November 8, 2021 16:54 Inactive
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Nov 8, 2021
@alexandertsukanov alexandertsukanov temporarily deployed to more-secrets November 8, 2021 17:01 Inactive
@alexandertsukanov alexandertsukanov temporarily deployed to more-secrets November 9, 2021 08:20 Inactive
Copy link
Contributor

@alexandr-shegeda alexandr-shegeda left a comment

Choose a reason for hiding this comment

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

LGTM. we can proceed with publish and merge without airbyte review

@alexandr-shegeda alexandr-shegeda marked this pull request as ready for review November 9, 2021 10:18
@alexandertsukanov
Copy link
Contributor Author

alexandertsukanov commented Nov 9, 2021

/publish connector=connectors/destination-bigquery-denormalized

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

@jrhizor jrhizor temporarily deployed to more-secrets November 9, 2021 11:05 Inactive
@alexandertsukanov alexandertsukanov temporarily deployed to more-secrets November 9, 2021 11:35 Inactive
@alexandertsukanov alexandertsukanov merged commit 48d8250 into master Nov 9, 2021
@alexandertsukanov alexandertsukanov deleted the otsukanov/6638_destination_bigquery_denormalized_datetime_fix branch November 9, 2021 11:39
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…ys (airbytehq#7736)

* BUG-6638: Fix fields with $ref definition.

* BUG-6638: Added integration tests.

* BUG-6638: Added integration tests.

* BUG-6638: Added integration tests.

* BUG-6638: Added doc and pumped Dockerfile version.

* BUG-6638: Added doc and pumped Dockerfile version.

* BUG-6638: replaced for with forEach

* BUG-6638: Bumped specification
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants