Clean up destination bases #25346

jcowanpdx · 2023-04-19T21:16:37Z

What

Prior to more refactoring work for destinations, lets clean up the base classes.

Put some first class interfaces in place around buffer creation, flushing and start/stop functions
Some renaming for consistency.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?
There should be ZERO impact to customer facing functionality. These are refactors that affect maintainability and errors will be caught by compiler checks

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

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

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 and connector version bumped by running the /publish command 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 · 2023-04-19T21:20:29Z

Affected Connector Report

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to do the following as needed:

Run integration tests
Bump connector or module version
Add changelog
Publish the new version

✅ Sources (33)

Connector	Version	Changelog	Publish
`source-alloydb`	`2.0.23`	✅	✅
`source-alloydb-strict-encrypt`	`2.0.23`	🔵 (ignored)	🔵 (ignored)
`source-azure-blob-storage`	`0.1.0`	✅	✅
`source-bigquery`	`0.2.3`	✅	✅
`source-clickhouse`	`0.1.17`	✅	✅
`source-clickhouse-strict-encrypt`	`0.1.17`	🔵 (ignored)	🔵 (ignored)
`source-cockroachdb`	`0.1.22`	✅	✅
`source-cockroachdb-strict-encrypt`	`0.1.22`	🔵 (ignored)	🔵 (ignored)
`source-db2`	`0.1.19`	✅	✅
`source-db2-strict-encrypt`	`0.1.19`	🔵 (ignored)	🔵 (ignored)
`source-dynamodb`	`0.1.2`	✅	✅
`source-e2e-test`	`2.1.4`	✅	✅
`source-e2e-test-cloud`	`2.1.4`	🔵 (ignored)	🔵 (ignored)
`source-elasticsearch`	`0.1.1`	✅	✅
`source-jdbc`	`0.3.5`	🔵 (ignored)	🔵 (ignored)
`source-kafka`	`0.2.3`	✅	✅
`source-mongodb-strict-encrypt`	`0.1.19`	🔵 (ignored)	🔵 (ignored)
`source-mongodb-v2`	`0.1.19`	✅	✅
`source-mssql`	`1.0.14`	✅	✅
`source-mssql-strict-encrypt`	`1.0.14`	🔵 (ignored)	🔵 (ignored)
`source-mysql`	`2.0.18`	✅	✅
`source-mysql-strict-encrypt`	`2.0.18`	🔵 (ignored)	🔵 (ignored)
`source-oracle`	`0.3.24`	✅	✅
`source-oracle-strict-encrypt`	`0.3.24`	🔵 (ignored)	🔵 (ignored)
`source-postgres`	`2.0.27`	✅	✅
`source-postgres-strict-encrypt`	`2.0.27`	🔵 (ignored)	🔵 (ignored)
`source-redshift`	`0.3.16`	✅	✅
`source-relational-db`	`0.3.1`	🔵 (ignored)	🔵 (ignored)
`source-scaffold-java-jdbc`	`0.1.0`	🔵 (ignored)	🔵 (ignored)
`source-sftp`	`0.1.2`	✅	✅
`source-snowflake`	`0.1.34`	✅	✅
`source-teradata`	`0.1.0`	✅	✅
`source-tidb`	`0.2.4`	✅	✅

See "Actionable Items" below for how to resolve warnings and errors.

❌ Destinations (49)

Connector	Version	Changelog	Publish
`destination-azure-blob-storage`	`0.2.0`	✅	✅
`destination-bigquery`	`1.3.3`	❌ (changelog missing)	✅
`destination-bigquery-denormalized`	`1.3.3`	❌ (changelog missing)	✅
`destination-cassandra`	`0.1.4`	✅	✅
`destination-clickhouse`	`0.2.3`	✅	✅
`destination-clickhouse-strict-encrypt`	`0.2.3`	🔵 (ignored)	🔵 (ignored)
`destination-csv`	`1.0.0`	✅	✅
`destination-databricks`	`1.0.2`	✅	✅
`destination-dev-null`	`0.2.7`	🔵 (ignored)	🔵 (ignored)
`destination-doris`	`0.1.0`	✅	✅
`destination-dynamodb`	`0.1.7`	✅	✅
`destination-e2e-test`	`0.2.4`	✅	✅
`destination-elasticsearch`	`0.1.6`	✅	✅
`destination-elasticsearch-strict-encrypt`	`0.1.6`	🔵 (ignored)	🔵 (ignored)
`destination-exasol`	`0.1.1`	✅	✅
`destination-gcs`	`0.2.17`	❌ (changelog missing)	✅
`destination-iceberg`	`0.1.0`	✅	✅
`destination-kafka`	`0.1.10`	✅	✅
`destination-keen`	`0.2.4`	✅	✅
`destination-kinesis`	`0.1.5`	✅	✅
`destination-local-json`	`0.2.11`	✅	✅
`destination-mariadb-columnstore`	`0.1.7`	✅	✅
`destination-mongodb`	`0.1.9`	✅	✅
`destination-mongodb-strict-encrypt`	`0.1.9`	🔵 (ignored)	🔵 (ignored)
`destination-mqtt`	`0.1.3`	✅	✅
`destination-mssql`	`0.1.23`	✅	✅
`destination-mssql-strict-encrypt`	`0.1.23`	🔵 (ignored)	🔵 (ignored)
`destination-mysql`	`0.1.20`	✅	✅
`destination-mysql-strict-encrypt`	❌ `0.1.21` (mismatch: `0.1.20`)	🔵 (ignored)	🔵 (ignored)
`destination-oracle`	`0.1.19`	✅	✅
`destination-oracle-strict-encrypt`	`0.1.19`	🔵 (ignored)	🔵 (ignored)
`destination-postgres`	`0.3.27`	✅	✅
`destination-postgres-strict-encrypt`	`0.3.27`	🔵 (ignored)	🔵 (ignored)
`destination-pubsub`	`0.2.0`	✅	✅
`destination-pulsar`	`0.1.3`	✅	✅
`destination-r2`	`0.1.0`	✅	✅
`destination-redis`	`0.1.4`	✅	✅
`destination-redpanda`	`0.1.0`	✅	✅
`destination-redshift`	`0.4.6`	❌ (changelog missing)	✅
`destination-rockset`	`0.1.4`	✅	✅
`destination-s3`	`0.3.25`	❌ (changelog missing)	✅
`destination-s3-glue`	`0.1.6`	✅	✅
`destination-scylla`	`0.1.3`	✅	✅
`destination-selectdb`	`0.1.0`	✅	✅
`destination-snowflake`	`0.4.63`	❌ (changelog missing)	✅
`destination-starburst-galaxy`	`0.0.1`	✅	✅
`destination-teradata`	`0.1.1`	✅	✅
`destination-tidb`	`0.1.1`	✅	✅
`destination-yugabytedb`	`0.1.1`	✅	✅

See "Actionable Items" below for how to resolve warnings and errors.

👀 Other Modules (1)

base-normalization

Actionable Items

(click to expand)

Category	Status	Actionable Item
Version	❌ mismatch	The version of the connector is different from its normal variant. Please bump the version of the connector.
	⚠ doc not found	The connector does not seem to have a documentation file. This can be normal (e.g. basic connector like `source-jdbc` is not published or documented). Please double-check to make sure that it is not a bug.
Changelog	⚠ doc not found	The connector does not seem to have a documentation file. This can be normal (e.g. basic connector like `source-jdbc` is not published or documented). Please double-check to make sure that it is not a bug.
	❌ changelog missing	There is no chnagelog for the current version of the connector. If you are the author of the current version, please add a changelog.
Publish	⚠ not in seed	The connector is not in the seed file (e.g. `source_definitions.yaml`), so its publication status cannot be checked. This can be normal (e.g. some connectors are cloud-specific, and only listed in the cloud seed file). Please double-check to make sure that it is not a bug.
	❌ diff seed version	The connector exists in the seed file, but the latest version is not listed there. This usually means that the latest version is not published. Please use the `/publish` command to publish the latest version.

edgao

lgtm!

... though I'm surprised that some of these interfaces already exist and we just weren't using them consistently >.>

...ses/base-java-s3/src/main/java/io/airbyte/integrations/destination/s3/S3ConsumerFactory.java

...se-java-s3/src/main/java/io/airbyte/integrations/destination/s3/SerializedBufferFactory.java

...-java-s3/src/main/java/io/airbyte/integrations/destination/s3/avro/AvroSerializedBuffer.java

...se-java-s3/src/main/java/io/airbyte/integrations/destination/s3/csv/CsvSerializedBuffer.java

...ava-s3/src/main/java/io/airbyte/integrations/destination/s3/jsonl/JsonLSerializedBuffer.java

ryankfu · 2023-04-20T22:48:17Z

...s3/src/test/java/io/airbyte/integrations/destination/s3/jsonl/JsonLSerializedBufferTest.java

@@ -70,7 +70,7 @@ private static void runTest(final BufferStorage buffer,
      throws Exception {
    final File outputFile = buffer.getFile();
    try (final JsonLSerializedBuffer writer = (JsonLSerializedBuffer) JsonLSerializedBuffer
-        .createFunction(null, () -> buffer)
+        .createBufferFunction(null, () -> buffer)


loving the more explicit function names!

ryankfu · 2023-04-20T22:50:00Z

...io/airbyte/integrations/destination/buffered_stream_consumer/CheckAndRemoveRecordWriter.java

@@ -14,6 +14,6 @@ public interface CheckAndRemoveRecordWriter {
   * different, then the staging writer corresponding to `stagingFileName` is closed and the name of
   * the new file where the record will be sent will be returned.
   */
-  String apply(AirbyteStreamNameNamespacePair airbyteStreamNameNamespacePair, String stagingFileName) throws Exception;
+  String apply(AirbyteStreamNameNamespacePair stream, String stagingFileName) throws Exception;


this is kind of confusing because technically this is a tuple of <stream, fully qualified namespace> so somewhat in favor of not having this be the new name

EDIT: seeing this is named stream in other parts of the code so guess it's fine albeit confusing

We can come up with a better name as well. streamName? streamIdentifier?

fwiw I've used streamIdentifier in the past, since each AirbyteStreamNameNamespacePair uniquely identifies a stream (and it's not overloaded with the stream itself having a name)

...-java/src/main/java/io/airbyte/integrations/destination/record_buffer/BufferingStrategy.java

...src/main/java/io/airbyte/integrations/destination/bigquery/BigQueryAvroSerializedBuffer.java

...c/main/java/io/airbyte/integrations/destination/bigquery/BigQueryStagingConsumerFactory.java

ryankfu

Overall, mostly nits to keep consistency with how methods are called but nothing blocking. Looks great!

ryankfu · 2023-04-20T22:59:22Z

/test connector=connectors/destination-snowflake

🕑 connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/4759615702
❌ connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/4759615702
🐛 https://gradle.com/s/vpffzcy7yaozs

Build Failed

Test summary info:

Could not find result summary

jcowanpdx · 2023-04-21T01:02:37Z

/test connector=connectors/destination-snowflake

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

Name                                                              Stmts   Miss  Cover
-------------------------------------------------------------------------------------
normalization/transform_config/__init__.py                            2      0   100%
normalization/transform_catalog/reserved_keywords.py                 15      0   100%
normalization/transform_catalog/__init__.py                           2      0   100%
normalization/destination_type.py                                    18      0   100%
normalization/__init__.py                                             4      0   100%
normalization/transform_catalog/destination_name_transformer.py     171     10    94%
normalization/transform_catalog/table_name_registry.py              174     34    80%
normalization/transform_config/transform.py                         195     48    75%
normalization/transform_catalog/utils.py                             51     14    73%
normalization/transform_catalog/dbt_macro.py                         22      7    68%
normalization/transform_catalog/catalog_processor.py                147     80    46%
normalization/transform_catalog/transform.py                         65     39    40%
normalization/transform_catalog/stream_processor.py                 595    400    33%
-------------------------------------------------------------------------------------
TOTAL                                                              1461    632    57%

Build Passed

Test summary info:

All Passed

jcowanpdx · 2023-04-21T14:34:52Z

/test connector=connectors/destination-bigquery

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

Name                                                              Stmts   Miss  Cover
-------------------------------------------------------------------------------------
normalization/transform_config/__init__.py                            2      0   100%
normalization/transform_catalog/reserved_keywords.py                 15      0   100%
normalization/transform_catalog/__init__.py                           2      0   100%
normalization/destination_type.py                                    18      0   100%
normalization/__init__.py                                             4      0   100%
normalization/transform_catalog/destination_name_transformer.py     171     10    94%
normalization/transform_catalog/table_name_registry.py              174     34    80%
normalization/transform_config/transform.py                         195     48    75%
normalization/transform_catalog/utils.py                             51     14    73%
normalization/transform_catalog/dbt_macro.py                         22      7    68%
normalization/transform_catalog/catalog_processor.py                147     80    46%
normalization/transform_catalog/transform.py                         65     39    40%
normalization/transform_catalog/stream_processor.py                 595    400    33%
-------------------------------------------------------------------------------------
TOTAL                                                              1461    632    57%

Build Passed

Test summary info:

All Passed

jcowanpdx · 2023-04-21T14:35:32Z

/test connector=connectors/destination-s3-glue

🕑 connectors/destination-s3-glue https://github.com/airbytehq/airbyte/actions/runs/4765986641
✅ connectors/destination-s3-glue https://github.com/airbytehq/airbyte/actions/runs/4765986641
No Python unittests run

Build Passed

Test summary info:

All Passed

jcowanpdx · 2023-04-21T21:14:07Z

/publish connector=connectors/destination-bigquery

🕑 Publishing the following connectors:
connectors/destination-bigquery
https://github.com/airbytehq/airbyte/actions/runs/4768876038

Connector	Version	Did it publish?	Were definitions generated?
connectors/destination-bigquery	1.3.1	✅	✅

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

… compile time checks so should be low risk.

jcowanpdx · 2023-04-27T01:18:33Z

/publish connector=connectors/destination-bigquery,connectors/destination-bigquery-denormalized

🕑 Publishing the following connectors:
connectors/destination-bigquery,connectors/destination-bigquery-denormalized
https://github.com/airbytehq/airbyte/actions/runs/4814938601

Connector	Version	Did it publish?	Were definitions generated?
connectors/destination-bigquery	1.3.2	❌	❌
connectors/destination-bigquery-denormalized	1.3.2	✅	✅

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

…jeff/cleanup-dest-bases-1

jcowanpdx · 2023-04-27T13:08:16Z

/publish connector=connectors/destination-bigquery,connectors/destination-bigquery-denormalized

🕑 Publishing the following connectors:
connectors/destination-bigquery,connectors/destination-bigquery-denormalized
https://github.com/airbytehq/airbyte/actions/runs/4820165251

Connector	Version	Did it publish?	Were definitions generated?
connectors/destination-bigquery	1.3.3	✅	✅
connectors/destination-bigquery-denormalized	1.3.3	✅	✅

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

jcowanpdx · 2023-04-27T14:36:44Z

/publish connector=connectors/destination-redshift,connectors/destination-snowflake run-tests=false

🕑 Publishing the following connectors:
connectors/destination-redshift,connectors/destination-snowflake
https://github.com/airbytehq/airbyte/actions/runs/4821073379

Connector	Version	Did it publish?	Were definitions generated?
connectors/destination-redshift	0.4.6	✅	✅
connectors/destination-snowflake	0.4.63	✅	✅

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

Changes in this refactor PR * Use the proper interface name for the OnStartFunction * Use the proper interface name for the OnCloseFunction * Create and use a proper interface name for the FlushBufferFunction * Create and use a proper interface name for the BufferCreateFunction * Mostly naming consistency changes. These are things caught in static, compile time checks so should be low risk. --------- Co-authored-by: jcowanpdx <jcowanpdx@users.noreply.github.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>

jcowanpdx requested review from a team as code owners April 19, 2023 21:16

octavia-squidington-iii added area/connectors Connector related issues connectors/destination/bigquery connectors/destination/elasticsearch connectors/destination/s3-glue labels Apr 19, 2023

edgao approved these changes Apr 20, 2023

View reviewed changes