Common Jsons: add flag to apply flatten to arrays #13464

marcosmarxm · 2022-06-03T20:45:35Z

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

How

Describe the solution

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

marcosmarxm · 2022-06-03T20:48:58Z

/test connector=connectors/destination-redshift

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

tuliren · 2022-06-03T21:10:11Z

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

   */
-  public static Map<String, Object> flatten(final JsonNode node) {
+  public static Map<String, Object> flatten(final JsonNode node, final Boolean applyFlattenToArray) {


Suggested change

public static Map<String, Object> flatten(final JsonNode node, final Boolean applyFlattenToArray) {

public static Map<String, Object> flatten(final JsonNode node, final boolean applyFlattenToArray) {

tuliren · 2022-06-03T21:18:43Z

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

   * Flattens an ObjectNode, or dumps it into a {null: value} map if it's not an object.
+   * this is used for JobTracker where is arrays aren't flatten and only converted to strings
+   * and Redshift SUPER type now reuse the function and need to arrays be flatten in the
+   * correct format


Suggested change

* Flattens an ObjectNode, or dumps it into a {null: value} map if it's not an object.

* this is used for JobTracker where is arrays aren't flatten and only converted to strings

* and Redshift SUPER type now reuse the function and need to arrays be flatten in the

* correct format

* Flattens an ObjectNode, or dumps it into a {null: value} map if it's not an object. When

* applyFlattenToArray is true, each element in the array will be one entry in the returned map.

* This behavior is used in the Redshift SUPER type. When it is false, the whole array will be one

* entry. This is used in the JobTracker.

I'll apply format. thanks for the review @tuliren

adam-bloom · 2022-06-03T23:44:29Z

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

    if (node.isObject()) {
      final Map<String, Object> output = new HashMap<>();
      for (final Iterator<Entry<String, JsonNode>> it = node.fields(); it.hasNext();) {
        final Entry<String, JsonNode> entry = it.next();
        final String field = entry.getKey();
        final JsonNode value = entry.getValue();
-        mergeMaps(output, field, flatten(value));
+        mergeMaps(output, field, flatten(value, false));


@marcosmarxm this cannot be hardcoded to false, but needs to pass applyFlattenToArray through - you can have an array nested inside an object.

adam-bloom · 2022-06-03T23:45:24Z

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

      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));
+        mergeMaps(output, field, flatten(value, true));


for consistency with the case above, I'd recommend changing this to flatten(value, applyFlattenToArray), although of course it will only be invoked when applyFlattenToArray is true

adam-bloom

@marcosmarxm thanks for addressing this case - I wasn't sure if we needed to go here or not. See my comments below for a quick functional fix we need to apply.

Do we need to republish redshift 0.3.38 too? Looks like the connector version bump/changelog was backed out too. Even though this will result in a functionally equivalent connector, we should make sure the changelog remains accurate.

cgardens

Can you write some unit tests please?

add flag to apply flatten to arrays

b3299bd

marcosmarxm requested a review from alovew June 3, 2022 20:45

github-actions bot added area/connectors Connector related issues area/platform issues related to the platform area/scheduler labels Jun 3, 2022

octavia-squidington-iii added the connectors/destination/redshift label Jun 3, 2022

marcosmarxm requested a review from cgardens June 3, 2022 20:47

marcosmarxm temporarily deployed to more-secrets June 3, 2022 20:47 Inactive

marcosmarxm requested review from tuliren and removed request for alovew June 3, 2022 21:13

tuliren approved these changes Jun 3, 2022

View reviewed changes

run format change docstirng

45a6888

marcosmarxm temporarily deployed to more-secrets June 3, 2022 21:28 Inactive

adam-bloom reviewed Jun 3, 2022

View reviewed changes

adam-bloom suggested changes Jun 3, 2022

View reviewed changes

cgardens requested changes Jun 4, 2022

View reviewed changes

adam-bloom mentioned this pull request Sep 27, 2022

Common Jsons: add flag to apply flatten to arrays #17273

Closed

37 tasks

marcosmarxm closed this Apr 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Common Jsons: add flag to apply flatten to arrays #13464

Common Jsons: add flag to apply flatten to arrays #13464

marcosmarxm commented Jun 3, 2022

marcosmarxm commented Jun 3, 2022 •

edited by github-actions bot

Loading

tuliren Jun 3, 2022

tuliren Jun 3, 2022 •

edited

Loading

marcosmarxm Jun 3, 2022

adam-bloom Jun 3, 2022

adam-bloom Jun 3, 2022

adam-bloom left a comment •

edited

Loading

cgardens left a comment

	public static Map<String, Object> flatten(final JsonNode node, final Boolean applyFlattenToArray) {
	public static Map<String, Object> flatten(final JsonNode node, final boolean applyFlattenToArray) {

Common Jsons: add flag to apply flatten to arrays #13464

Common Jsons: add flag to apply flatten to arrays #13464

Conversation

marcosmarxm commented Jun 3, 2022

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

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

Build Passed

tuliren Jun 3, 2022

Choose a reason for hiding this comment

tuliren Jun 3, 2022 • edited Loading

Choose a reason for hiding this comment

marcosmarxm Jun 3, 2022

Choose a reason for hiding this comment

adam-bloom Jun 3, 2022

Choose a reason for hiding this comment

adam-bloom Jun 3, 2022

Choose a reason for hiding this comment

adam-bloom left a comment • edited Loading

Choose a reason for hiding this comment

cgardens left a comment

Choose a reason for hiding this comment

marcosmarxm commented Jun 3, 2022 •

edited by github-actions bot

Loading

tuliren Jun 3, 2022 •

edited

Loading

adam-bloom left a comment •

edited

Loading