Introduce the AirbyteStreamNamespaceNamePair to the DefaultReplicationWorker. #19360

davinchia · 2022-11-12T00:47:36Z

What

#19191 made me realise the DefaultReplicationWorker's metric tracking today has a bug where we aren't accounting for namespace when tracking metrics today. i.e. Streams with the same name and duplicate namespace will merge metrics.

While reading the code to figure out a fix, I realised we don't have a good conceptual representation of stream namespace <> name pairs within the platform today. We use a concatenated string. Though this works, it will become harder and harder to read/track as we do more operations that involve namespace i.e. progress bars and column selection.

This PR introduces the AirbyteStreamNameNamespacePair object into the platform code to make it more convenient to work with Streams in the future. (Especially if we proceed with the project to make streams a first-class citizen!)

The AirbyteStreamNameNamespacePair object was written to deal with the same issue of namespace <> name pair manipulation within the Java destination code. It implements the Comparable interface, which makes it convenient to use for Collections operations.

For an example of how this is consumed, see #19361.

How

Move the AirbyteStreamNameNamespacePair object from the base-java module to the protocol_models module. This location already contains models that make it easier to interact with pure Airbyte protocol-defined models, so moving it here is appropriate. All consumer modules already have dependencies on this, so there are build.gradle changes.
Update SchemaValidation to use the Pair instead of a string. Update all tests to use the Pair instead of a string.

No logic changes here - all modifications are to use the AirbyteStreamNameNamespacePair object.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, 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

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 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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

…tehq/airbyte into davinchia/progress-bar-persistence

…m to stream.

airbyte-commons-worker/src/main/java/io/airbyte/workers/WorkerMetricReporter.java

...protocol-models/src/main/java/io/airbyte/protocol/models/AirbyteStreamNameNamespacePair.java

airbyte-commons-worker/src/main/java/io/airbyte/workers/WorkerMetricReporter.java

…ocol/models/AirbyteStreamNameNamespacePair.java Co-authored-by: Jimmy Ma <gosusnp@users.noreply.github.com>

davinchia · 2022-11-15T00:18:54Z

/test connector=source-postgres

davinchia · 2022-11-15T00:19:35Z

/test connector=destination-snowflake

ryankfu · 2022-11-15T00:46:30Z

...on-jdbc/src/main/java/io/airbyte/integrations/destination/jdbc/copy/CopyConsumerFactory.java

@@ -77,7 +77,7 @@ private static <T> Map<AirbyteStreamNameNamespacePair, StreamCopier> createWrite
    final String stagingFolder = UUID.randomUUID().toString();
    for (final var configuredStream : catalog.getStreams()) {
      final var stream = configuredStream.getStream();
-      final var pair = AirbyteStreamNameNamespacePair.fromAirbyteSteam(stream);
+      final var pair = AirbyteStreamNameNamespacePair.fromAirbyteStream(stream);


non-blocking: since we're being more explicit with AirbyteStreamNameNamespacePair, should this var be AirbyteStreamNameNamespacePair instead?

ryankfu

LGTM

davinchia · 2022-11-15T00:53:29Z

/test connector=source-postgres

davinchia · 2022-11-15T00:53:38Z

/test connector=destination-snowflake

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

Name                                                              Stmts   Miss  Cover
-------------------------------------------------------------------------------------
normalization/transform_config/__init__.py                            2      0   100%
normalization/transform_catalog/reserved_keywords.py                 14      0   100%
normalization/transform_catalog/__init__.py                           2      0   100%
normalization/destination_type.py                                    14      0   100%
normalization/__init__.py                                             4      0   100%
normalization/transform_catalog/destination_name_transformer.py     166      8    95%
normalization/transform_catalog/table_name_registry.py              174     34    80%
normalization/transform_config/transform.py                         189     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                         61     38    38%
normalization/transform_catalog/stream_processor.py                 595    400    33%
-------------------------------------------------------------------------------------
TOTAL                                                              1441    629    56%

Build Passed

Test summary info:

All Passed

davinchia · 2022-11-15T04:39:25Z

/test connector=source-postgres

🕑 source-postgres https://github.com/airbytehq/airbyte/actions/runs/3467497373
❌ source-postgres https://github.com/airbytehq/airbyte/actions/runs/3467497373
🐛 https://gradle.com/s/jo6bjqwnkcbca

Build Failed

Test summary info:

=========================== short test summary info ============================
FAILED test_core.py::TestSpec::test_enum_usage[inputs0] - TypeError: list ind...
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestConnection.test_check: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestDiscovery.test_discover: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestBasicRead.test_read: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestFullRefresh.test_sequential_reads: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestIncremental.test_two_sequential_reads: not found in the config.
============ 1 failed, 13 passed, 5 skipped, 21 warnings in 22.02s =============

davinchia · 2022-11-15T06:06:37Z

@grishick @ryankfu the source-postgres build has been failing for the last 5 days for reasons unrelated to this PR.

From the connector-health dash, looks like this has been failing for a few days now:

Since this is a package change, I think this change set should be fine to merge. I want to check in with both of you first. I would prefer to merge in sooner rather than later due to the freeze next week & this blocking other feature work.

Follow up to #19360. This PR adjusts the MessageTracker interface to use the new Pair object.

…nWorker. (#19360) #19191 made me realise the DefaultReplicationWorker's metric tracking today has a bug where we aren't accounting for namespace when tracking metrics today. i.e. Streams with the same name and duplicate namespace will merge metrics. While reading the code to figure out a fix, I realised we don't have a good conceptual representation of stream namespace <> name pairs within the platform today. We use a concatenated string. Though this works, it will become harder and harder to read/track as we do more operations that involve namespace i.e. progress bars and column selection. This PR introduces the AirbyteStreamNameNamespacePair object into the platform code to make it more convenient to work with Streams in the future. (Especially if we proceed with the project to make streams a first-class citizen!) The AirbyteStreamNameNamespacePair object was written to deal with the same issue of namespace <> name pair manipulation within the Java destination code. It implements the Comparable interface, which makes it convenient to use for Collections operations. For an example of how this is consumed, see #19361.

Follow up to #19360. This PR adjusts the MessageTracker interface to use the new Pair object.

Eusebiotrigo · 2023-01-16T18:15:37Z

Now that there is the v0 version of the protocol models, will there be an updated version of AirbyteStreamNameNamespacePair that accepts the v0 or v1 models?

edgao · 2023-01-17T15:52:51Z

Now that there is the v0 version of the protocol models, will there be an updated version of AirbyteStreamNameNamespacePair that accepts the v0 or v1 models?

Eventually I think we'll want to get something similar (possibly extracting an interface from the protocol models a la #20905). De facto, v0 and v1 don't have any structural changes (since the only diff is in the JSON blob fields, i.e. record data / stream schemas) so we can get away with using v0 everywhere for now.

cc @gosusnp to fact-check me on that though

gosusnp · 2023-01-17T17:47:54Z

@Eusebiotrigo, AirbyteStreamNameNamespacePair may be removed (https://github.com/airbytehq/airbyte-internal-issues/issues/1187), it is currently redundant with StreamDescriptor from the protocol.
The current duplication of objects is far from ideal, it is something we have identified but there is no clear timeline on it yet.

davinchia added 13 commits November 8, 2022 16:43

Add migrations to support progress bar.

38f08db

Merge branch 'master' into davinchia/progress-bar-persistence

8a365d4

Merge branch 'master' into davinchia/progress-bar-persistence

f3fb8f3

Add a new stream table.

6e2c6e3

Merge branch 'master' into davinchia/progress-bar-persistence

b944c15

Add stream_namespace column to new table.

a3ca709

Merge branch 'davinchia/progress-bar-persistence' of github.com:airby…

afca3d2

…tehq/airbyte into davinchia/progress-bar-persistence

Dedup on versions.

c64f8d0

Update test.

5463458

Move AirbyteStreamNameNamespacePair to Protocol Models.

8cbfea0

Fix all the tests. Remove un-used WorkerUtilsTest method. Rename stea…

5847434

…m to stream.

Format.

a0088c7

Merge branch 'master' into davinchia/message-tracker-refactor

b2dfe10

davinchia requested a review from a team as a code owner November 12, 2022 06:10

davinchia mentioned this pull request Nov 12, 2022

Add AirbyteStreamNamespaceNamePair to MessageTracker Interface #19361

Merged

37 tasks

gosusnp reviewed Nov 14, 2022

View reviewed changes

airbyte-commons-worker/src/main/java/io/airbyte/workers/WorkerMetricReporter.java Show resolved Hide resolved

davinchia added 2 commits November 14, 2022 14:24

Change toString.

aca3559

Better comments.

0c9917e

davinchia temporarily deployed to more-secrets November 14, 2022 22:28 Inactive

gosusnp reviewed Nov 14, 2022

View reviewed changes

...protocol-models/src/main/java/io/airbyte/protocol/models/AirbyteStreamNameNamespacePair.java Outdated Show resolved Hide resolved

airbyte-commons-worker/src/main/java/io/airbyte/workers/WorkerMetricReporter.java Show resolved Hide resolved

Update airbyte-protocol/protocol-models/src/main/java/io/airbyte/prot…

ba7f448

…ocol/models/AirbyteStreamNameNamespacePair.java Co-authored-by: Jimmy Ma <gosusnp@users.noreply.github.com>

davinchia temporarily deployed to more-secrets November 14, 2022 22:48 Inactive

davinchia requested a review from gosusnp November 15, 2022 00:06

gosusnp approved these changes Nov 15, 2022

View reviewed changes

grishick approved these changes Nov 15, 2022

View reviewed changes

ryankfu reviewed Nov 15, 2022

View reviewed changes

ryankfu approved these changes Nov 15, 2022

View reviewed changes

davinchia merged commit 0d4a2bb into master Nov 16, 2022

davinchia deleted the davinchia/message-tracker-refactor branch November 16, 2022 19:50

github-actions bot mentioned this pull request Nov 17, 2022

Bump helm chart version reference to 0.40.44 #19546

Merged

davinchia added a commit that referenced this pull request Nov 17, 2022

Add AirbyteStreamNamespaceNamePair to MessageTracker Interface (#19361)

2782b7a

Follow up to #19360. This PR adjusts the MessageTracker interface to use the new Pair object.

octavia-squidington-iii mentioned this pull request Nov 18, 2022

Bump Airbyte version from 0.40.18 to 0.40.19 #19579

Merged

akashkulk pushed a commit that referenced this pull request Dec 2, 2022

Add AirbyteStreamNamespaceNamePair to MessageTracker Interface (#19361)

38c58e0

Follow up to #19360. This PR adjusts the MessageTracker interface to use the new Pair object.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce the AirbyteStreamNamespaceNamePair to the DefaultReplicationWorker. #19360

Introduce the AirbyteStreamNamespaceNamePair to the DefaultReplicationWorker. #19360

davinchia commented Nov 12, 2022 •

edited

Loading

davinchia commented Nov 15, 2022

davinchia commented Nov 15, 2022

ryankfu Nov 15, 2022

ryankfu left a comment

davinchia commented Nov 15, 2022

davinchia commented Nov 15, 2022 •

edited by github-actions bot

Loading

davinchia commented Nov 15, 2022 •

edited by github-actions bot

Loading

davinchia commented Nov 15, 2022

Eusebiotrigo commented Jan 16, 2023

edgao commented Jan 17, 2023 •

edited

Loading

gosusnp commented Jan 17, 2023

Introduce the AirbyteStreamNamespaceNamePair to the DefaultReplicationWorker. #19360

Introduce the AirbyteStreamNamespaceNamePair to the DefaultReplicationWorker. #19360

Conversation

davinchia commented Nov 12, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

davinchia commented Nov 15, 2022

davinchia commented Nov 15, 2022

ryankfu Nov 15, 2022

Choose a reason for hiding this comment

ryankfu left a comment

Choose a reason for hiding this comment

davinchia commented Nov 15, 2022

davinchia commented Nov 15, 2022 • edited by github-actions bot Loading

Build Passed

davinchia commented Nov 15, 2022 • edited by github-actions bot Loading

Build Failed

davinchia commented Nov 15, 2022

Eusebiotrigo commented Jan 16, 2023

edgao commented Jan 17, 2023 • edited Loading

gosusnp commented Jan 17, 2023

davinchia commented Nov 12, 2022 •

edited

Loading

davinchia commented Nov 15, 2022 •

edited by github-actions bot

Loading

davinchia commented Nov 15, 2022 •

edited by github-actions bot

Loading

edgao commented Jan 17, 2023 •

edited

Loading