Destination Redshift: fixed array contents verification for SUPER #13069

adam-bloom · 2022-05-20T21:46:03Z

What

Follow up to #12940. That solution relies on Jsons.flatten, which previously did not actually flatten arrays, but rather just converted them to strings. Redshift can store arrays within a SUPER.

How

Added a case to flatten to handle arrays. This function is only used one other location:

airbyte/airbyte-scheduler/persistence/src/main/java/io/airbyte/scheduler/persistence/job_tracker/JobTracker.java

Line 218 in a1b1c1c

return Jsons.flatten(config);

As far as I can tell, that case (enum/const) should never encounter an array, so I do not believe adding this handling will result in any other negative consequences. Someone with more knowledge of the codebase than me, feel free to disagree! I can always add a switch to enable this behavior.

When flatten encounters an array, it will now flatten it into a map with keys [<index>] and the corresponding values. This should allow flatten to truly flatten arbitrary data.

As an example:

{"foo": [{"blue": "apple"}]}

would have previously been flattened to: {"foo": "[{\"blue\": \"apple\"}]"}
It will now flatten to: {"foo.[0].blue": "apple"}

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

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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

adam-bloom · 2022-05-20T21:51:36Z

@marcosmarxm @alexandertsukanov FYI - not a regression in the last PR, but one more edge case that I missed.

marcosmarxm · 2022-05-23T12:41:26Z

airbyte-commons/src/main/java/io/airbyte/commons/json/Jsons.java

+    } else if (node.isArray()) {
+      final Map<String, Object> output = new HashMap<>();
+      final int arrayLen = node.size();
+      for (int i = 0; i < arrayLen; i++) {
+        final String field = String.format("[%d]", i);
+        final JsonNode value = node.get(i);
+        mergeMaps(output, field, flatten(value));
+      }
+      return output;


thanks @adam-bloom but can you add a unit test for this? I'll request the team to review it becsause the change can impact more than just Redshift.

adam-bloom · 2022-05-23T14:27:12Z

Sure @marcosmarxm. There weren't any unit tests for flatten, so I just added two. One covering arrays and one without any arrays.

> Task :airbyte-commons:test
OpenJDK 64-Bit Server VM warning: Sharing is only supported for boot loader classes because bootstrap classpath has been appended

Deprecated Gradle features were used in this build, making it incompatible with Gradle 8.0.

You can use '--warning-mode all' to show the individual deprecation warnings and determine if they come from your own scripts or plugins.

See https://docs.gradle.org/7.4/userguide/command_line_interface.html#sec:command_line_warnings

BUILD SUCCESSFUL in 15s
16 actionable tasks: 3 executed, 13 up-to-date

Again, let me know if anyone thinks there is a potential impact to behavior elsewhere, and I can make this optional behavior in flatten.

alexandertsukanov · 2022-05-27T08:46:31Z

@adam-bloom looks like some conflicts with the master, could you fix them after I will run the tests? Thanks.

__
Summary: 🛠️ This code needs a fix

adam-bloom · 2022-05-27T14:23:20Z

@alexandertsukanov resolved

alexandertsukanov · 2022-05-27T14:30:37Z

/test connector=connectors/destination-redshift

🕑 connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2397080295
❌ connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2397080295
🐛 https://gradle.com/s/3hjibqwkf2s2e

Build Failed

Test summary info:

Could not find result summary

adam-bloom · 2022-05-27T15:21:16Z

@alexandertsukanov looks like the failure was in dbt/normalization. Is that test currently passing on master? Or do you think that there's a side-effect of the other use of flatten showing up here?

adam-bloom · 2022-06-01T15:51:49Z

Hi @alexandertsukanov @marcosmarxm - do either of you have suggestions for next steps? I don't see an obvious cause/relationship for the test that failed, and I cannot run the tests locally to verify if this test behavior changed with this change. I'm hoping to get this PR closed out soon, but don't know how to move it forward right now.

alexandertsukanov · 2022-06-02T11:11:46Z

@adam-bloom I see normalization tests are failing, let me ask somebody from Python team to take a look

__
Summary: 🛠️ This code needs a fix

grubberr · 2022-06-02T11:27:30Z

@adam-bloom please merge latest master branch to your branch and re-run
/test connector=connectors/destination-redshift
again

adam-bloom · 2022-06-02T13:18:31Z

@grubberr easy enough, done! @alexandertsukanov @marcosmarxm can one of you kick of another test run for me, thanks.

alexandertsukanov · 2022-06-02T14:22:19Z

/test connector=connectors/destination-redshift

🕑 connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2428849153
✅ connectors/destination-redshift https://github.com/airbytehq/airbyte/actions/runs/2428849153
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

marcosmarxm · 2022-06-03T17:38:58Z

/publish connector=connectors/destination-redshift

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

octavia-squidington-iii added the community label May 20, 2022

adam-bloom changed the title ~~Destination Redshift: fixed array handling for SUPER~~ Destination Redshift: fixed array contents verification for SUPER May 20, 2022

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

marcosmarxm requested changes May 23, 2022

View reviewed changes

marcosmarxm self-assigned this May 23, 2022

adam-bloom requested a review from marcosmarxm May 23, 2022 14:27

adam-bloom force-pushed the redshift/fix-super-arrays branch 2 times, most recently from 4a0c874 to 5ec2047 Compare May 25, 2022 20:50

adam-bloom force-pushed the redshift/fix-super-arrays branch from 5ec2047 to c09f683 Compare May 27, 2022 14:22

adam-bloom added 3 commits June 2, 2022 06:17

add array handling to json flatten

003bd27

bump version, add changelog entry

b263a52

test: add flatten unit tests

bc9aa13

adam-bloom force-pushed the redshift/fix-super-arrays branch from c09f683 to bc9aa13 Compare June 2, 2022 13:17

bleonard added bounty connectors/destination/redshift labels Jun 2, 2022

auto-bump connector version

501946a

marcosmarxm merged commit 071a8e9 into airbytehq:master Jun 3, 2022

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

Bump Airbyte version from 0.39.9-alpha to 0.39.10-alpha #13470

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Destination Redshift: fixed array contents verification for SUPER #13069

Destination Redshift: fixed array contents verification for SUPER #13069

adam-bloom commented May 20, 2022 •

edited

Loading

adam-bloom commented May 20, 2022

marcosmarxm May 23, 2022

adam-bloom commented May 23, 2022

alexandertsukanov commented May 27, 2022

adam-bloom commented May 27, 2022

alexandertsukanov commented May 27, 2022 •

edited by github-actions bot

Loading

adam-bloom commented May 27, 2022

adam-bloom commented Jun 1, 2022

alexandertsukanov commented Jun 2, 2022

grubberr commented Jun 2, 2022

adam-bloom commented Jun 2, 2022

alexandertsukanov commented Jun 2, 2022 •

edited by github-actions bot

Loading

marcosmarxm commented Jun 3, 2022 •

edited by github-actions bot

Loading

Destination Redshift: fixed array contents verification for SUPER #13069

Destination Redshift: fixed array contents verification for SUPER #13069

Conversation

adam-bloom commented May 20, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Tests

adam-bloom commented May 20, 2022

marcosmarxm May 23, 2022

Choose a reason for hiding this comment

adam-bloom commented May 23, 2022

alexandertsukanov commented May 27, 2022

adam-bloom commented May 27, 2022

alexandertsukanov commented May 27, 2022 • edited by github-actions bot Loading

Build Failed

adam-bloom commented May 27, 2022

adam-bloom commented Jun 1, 2022

alexandertsukanov commented Jun 2, 2022

grubberr commented Jun 2, 2022

adam-bloom commented Jun 2, 2022

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

Build Passed

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

adam-bloom commented May 20, 2022 •

edited

Loading

alexandertsukanov commented May 27, 2022 •

edited by github-actions bot

Loading

alexandertsukanov commented Jun 2, 2022 •

edited by github-actions bot

Loading

marcosmarxm commented Jun 3, 2022 •

edited by github-actions bot

Loading