🎉 Destination Redshift: Add "Loading Method" option to Redshift Destination spec and UI #13415

alexandertsukanov · 2022-06-02T10:44:57Z

What

This PR improves UX/UI experience by adding a dropdown to select the Redshift Uploading Data method:

How

Modified connector's specification

🚨 User Impact 🚨

After this update, the customer uploading method will be set to Standard, and the customer will need to reconfigure the method to use S3 Staging, to fill the appropriate parameters again.

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.

...io/airbyte/integrations/destination/redshift/RedshiftStagingS3DestinationAcceptanceTest.java

alexandertsukanov · 2022-06-02T13:23:22Z

/test connector=connectors/destination-redshift

🕑 connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2428502158
✅ connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2428502158
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%
normalization/transform_catalog/destination_name_transformer.py     155      8    95%
normalization/transform_config/transform.py                         159     31    81%
normalization/transform_catalog/table_name_registry.py              174     34    80%
normalization/transform_catalog/utils.py                             38      9    76%
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                 543    352    35%
-------------------------------------------------------------------------------------
TOTAL                                                              1333    559    58%

Build Passed

Test summary info:

All Passed

alexandr-shegeda · 2022-06-02T17:00:45Z

airbyte-integrations/connectors/destination-redshift/src/main/resources/spec.json

-          "eu-west-3",
-          "sa-east-1",
-          "me-south-1"
+      "uploading_method": {


I'm a bit concerned with broken backward compatibility. @alexandertsukanov is there a way to pick S3 staging by default and probably read existing config instead of making users update connector settings?
cc @grishick

@alexandr-shegeda this was fixed and covered with the unit tests. Great comment. Thanks.

__
Summary: 👌 This code looks good

alexandertsukanov · 2022-06-03T08:42:34Z

/test connector=connectors/destination-redshift

🕑 connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2433523841
✅ connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2433523841
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%
normalization/transform_catalog/destination_name_transformer.py     155      8    95%
normalization/transform_config/transform.py                         159     31    81%
normalization/transform_catalog/table_name_registry.py              174     34    80%
normalization/transform_catalog/utils.py                             38      9    76%
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                 543    352    35%
-------------------------------------------------------------------------------------
TOTAL                                                              1333    559    58%

Build Passed

Test summary info:

All Passed

alexandr-shegeda

looks great

edgao

checking my understanding: Existing configs (including S3 and standard inserts) will continue to work, because validateIfAllRequiredS3fieldsAreNullOrEmpty will try to find the upload method entry, fail to find it, and just return the top-level config node?

edgao · 2022-06-03T16:11:07Z

...redshift/src/main/java/io/airbyte/integrations/destination/redshift/RedshiftDestination.java

      LOGGER.warn("The \"standard\" upload mode is not performant, and is not recommended for production. " +
          "Please use the Amazon S3 upload mode if you are syncing a large amount of data.");
      return DestinationType.STANDARD;
    }

-    if (isNullOrEmpty(bucketNode) && isNullOrEmpty(regionNode) && isNullOrEmpty(accessKeyIdNode)
-        && isNullOrEmpty(secretAccessKeyNode)) {
+    if (validateIfAllRequiredS3fieldsAreNullOrEmpty(jsonNode)) {


hm, I think this might have been bugged previously? It seems weird that this condition is identical to the previous one. Maybe it was supposed to be using || instead of &&?

Sorry, the statement by itself is correct just a little bit confused with the name. Fixed please take a look.

I think I'm confused about when this condition is ever true: the if-statement right above has the exact same condition, so wouldn't we always hit the return Destination.STANDARD?

@edgao if each of the next parameters:

return isNullOrEmpty(jsonNode.get("s3_bucket_name")) && isNullOrEmpty(jsonNode.get("s3_bucket_region")) && isNullOrEmpty(jsonNode.get("access_key_id")) && isNullOrEmpty(jsonNode.get("secret_access_key"));

won't be null or empty, the method will return DestinationType.COPY_S3

However, I strongly agree with you we don't need to check this parameter on BE, as if any of them is null or empty we will strike Destination.STANDARD anyway.

...shift/src/main/java/io/airbyte/integrations/destination/redshift/validator/RedshiftUtil.java

edgao · 2022-06-03T16:19:42Z

...shift/src/main/java/io/airbyte/integrations/destination/redshift/validator/RedshiftUtil.java

+    return config.has(UPLOADING_METHOD) ? config.get(UPLOADING_METHOD) : config;
+  }
+
+  public static boolean validateIfAllRequiredS3fieldsAreNullOrEmpty(final JsonNode jsonNode) {


nitpick: rename to hasNoS3Fields

Please, take a look comment above.

...redshift/src/main/java/io/airbyte/integrations/destination/redshift/RedshiftDestination.java

alexandertsukanov · 2022-06-09T09:05:52Z

checking my understanding: Existing configs (including S3 and standard inserts) will continue to work, because validateIfAllRequiredS3fieldsAreNullOrEmpty will try to find the upload method entry, fail to find it, and just return the top-level config node?

@edgao This is correct.

edgao

alexandertsukanov · 2022-06-10T10:37:07Z

/publish connector=connectors/destination-redshift

🕑 connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2474422800
❌ Failed to publish connectors/destination-redshift
❌ Couldn't auto-bump version for connectors/destination-redshift

alexandertsukanov · 2022-06-10T10:56:00Z

/publish connector=connectors/destination-redshift

🕑 connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2474511057
🚀 Successfully published connectors/destination-redshift
🚀 Auto-bumped version for connectors/destination-redshift
✅ connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2474511057

airbyte-12709 Add "Loading Method" option to Redshift Destination spec.

59c3a15

alexandertsukanov requested review from alexandr-shegeda and andriikorotkov June 2, 2022 10:44

github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Jun 2, 2022

alexandertsukanov linked an issue Jun 2, 2022 that may be closed by this pull request

Add "Loading Method" option to Redshift Destination spec #12709

Closed

andriikorotkov approved these changes Jun 2, 2022

View reviewed changes

airbyte-12709: Fixed unit tests.

5ec09f0

alexandr-shegeda reviewed Jun 2, 2022

View reviewed changes

...io/airbyte/integrations/destination/redshift/RedshiftStagingS3DestinationAcceptanceTest.java Show resolved Hide resolved

alexandertsukanov added 2 commits June 2, 2022 16:51

airbyte-12709: Updated README.md.

d7cd6df

airbyte-12709: change the number of PR in redshift.md.

1826247

alexandr-shegeda marked this pull request as ready for review June 2, 2022 16:50

alexandr-shegeda reviewed Jun 2, 2022

View reviewed changes

bleonard added the connectors/destination/redshift label Jun 2, 2022

alexandertsukanov requested a review from alexandr-shegeda June 3, 2022 07:46

airbyte-12709: Added backward compatibility for old json schema.

65dc670

alexandr-shegeda approved these changes Jun 3, 2022

View reviewed changes

alexandertsukanov requested review from edgao and grishick June 3, 2022 11:01

edgao reviewed Jun 3, 2022

View reviewed changes

alexandertsukanov added 2 commits June 8, 2022 11:40

airbyte-12709: Fix PR comments.

7ce6e98

airbyte-12709: Removed throwing an exception. Fixed PR comments.

07554db

edgao approved these changes Jun 9, 2022

View reviewed changes

airbyte-12709: Bump the airbyte version.

2cc0b59

auto-bump connector version

ffe86e2

octavia-squidington-iii temporarily deployed to more-secrets June 10, 2022 11:42 Inactive

alexandertsukanov merged commit b45014d into master Jun 10, 2022

alexandertsukanov deleted the otsukanov/airbyte-12709_add_loading_method branch June 10, 2022 11:47

octavia-squidington-iii mentioned this pull request Jun 14, 2022

Bump Airbyte version from 0.39.17-alpha to 0.39.18-alpha #13759

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 Destination Redshift: Add "Loading Method" option to Redshift Destination spec and UI #13415

🎉 Destination Redshift: Add "Loading Method" option to Redshift Destination spec and UI #13415

alexandertsukanov commented Jun 2, 2022 •

edited

Loading

alexandertsukanov commented Jun 2, 2022 •

edited by github-actions bot

Loading

alexandr-shegeda Jun 2, 2022

alexandertsukanov Jun 3, 2022

alexandertsukanov commented Jun 3, 2022 •

edited by github-actions bot

Loading

alexandr-shegeda left a comment

edgao left a comment

edgao Jun 3, 2022

alexandertsukanov Jun 8, 2022 •

edited

Loading

edgao Jun 9, 2022

alexandertsukanov Jun 9, 2022

edgao Jun 3, 2022

alexandertsukanov Jun 8, 2022

alexandertsukanov commented Jun 9, 2022 •

edited

Loading

edgao left a comment

alexandertsukanov commented Jun 10, 2022 •

edited by github-actions bot

Loading

alexandertsukanov commented Jun 10, 2022 •

edited by github-actions bot

Loading

🎉 Destination Redshift: Add "Loading Method" option to Redshift Destination spec and UI #13415

🎉 Destination Redshift: Add "Loading Method" option to Redshift Destination spec and UI #13415

Conversation

alexandertsukanov commented Jun 2, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

alexandertsukanov commented Jun 2, 2022 • edited by github-actions bot Loading

Build Passed

alexandr-shegeda Jun 2, 2022

Choose a reason for hiding this comment

alexandertsukanov Jun 3, 2022

Choose a reason for hiding this comment

alexandertsukanov commented Jun 3, 2022 • edited by github-actions bot Loading

Build Passed

alexandr-shegeda left a comment

Choose a reason for hiding this comment

edgao left a comment

Choose a reason for hiding this comment

edgao Jun 3, 2022

Choose a reason for hiding this comment

alexandertsukanov Jun 8, 2022 • edited Loading

Choose a reason for hiding this comment

edgao Jun 9, 2022

Choose a reason for hiding this comment

alexandertsukanov Jun 9, 2022

Choose a reason for hiding this comment

edgao Jun 3, 2022

Choose a reason for hiding this comment

alexandertsukanov Jun 8, 2022

Choose a reason for hiding this comment

alexandertsukanov commented Jun 9, 2022 • edited Loading

edgao left a comment

Choose a reason for hiding this comment

alexandertsukanov commented Jun 10, 2022 • edited by github-actions bot Loading

alexandertsukanov commented Jun 10, 2022 • edited by github-actions bot Loading

alexandertsukanov commented Jun 2, 2022 •

edited

Loading

alexandertsukanov commented Jun 2, 2022 •

edited by github-actions bot

Loading

alexandertsukanov commented Jun 3, 2022 •

edited by github-actions bot

Loading

alexandertsukanov Jun 8, 2022 •

edited

Loading

alexandertsukanov commented Jun 9, 2022 •

edited

Loading

alexandertsukanov commented Jun 10, 2022 •

edited by github-actions bot

Loading

alexandertsukanov commented Jun 10, 2022 •

edited by github-actions bot

Loading