Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Source Shopify: fix customer journey summary field schema type #43326

Merged
merged 26 commits into from
Aug 6, 2024

Conversation

bazarnov
Copy link
Collaborator

@bazarnov bazarnov commented Aug 6, 2024

What

While running CAT, the missing schema type for the customer_journey_summary field is missing it's schema type.
It should be the ["null," "object"] type declared.

Shopify Doc

How

  • added ["null", "object"] as a type for the customer_journey_summary field in the Customer Journey Summary stream

User Impact

No impact is expected, not a breaking change.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

@bazarnov bazarnov self-assigned this Aug 6, 2024
Copy link

vercel bot commented Aug 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Aug 6, 2024 4:26pm

@bazarnov bazarnov marked this pull request as ready for review August 6, 2024 15:56
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Aug 6, 2024
@bazarnov bazarnov requested a review from maxi297 August 6, 2024 15:57
Copy link
Contributor

@maxi297 maxi297 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide more context on these questions of mine?

"description": "Paid search terms used by a marketing campaign.",
"type": ["null", "string"]
},
"customer_order_index": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does that mean that the customer_order_index was not nested enough? Does that also mean that those fields are empty in the destination right now as we populate customer_journey_summary. customer_order_index instead of customer_order_index?

The same question applies to the other fields like first_visit

Copy link
Collaborator Author

@bazarnov bazarnov Aug 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was not nested under the properties - yes, but originally it was nested correctly under the customer_journey_summary object, as expected.

Screenshot 2024-08-06 at 19 22 45

I don't think so; no one has asked questions yet, we have had this for 2 months, and I assume the destination_v2 handles the Mapping without type declared correctly for us.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh! I got confused by the indentation. So we assume here the if there are fields under a property that does not have properties, than the platform use those fields as properties? Or does the platform ignore nested fields?

Like, on master we have this:

    "customer_journey_summary": {
      "ready": {
        "description": "Whether the attributed sessions for the order have been created yet.",
        "type": ["null", "boolean"]
      },

Either the platform assume customer_journey_summary to be an object and does not clean the nested fields in customer_journey_summary or the platform just doesn't even consider the nested fields as customer_journey_summary is an object. Does that make sense to you?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we assume here the if there are fields under a property that does not have properties, than the platform use those fields as properties? Or does the platform ignore nested fields?

This should be done by the destination v2, which should treat the non-typed object as an object that has something, thus it's pushed to the destination as an json-string, I believe, instead of the serialized object.

Copy link
Contributor

@maxi297 maxi297 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving even with the pending question as we can assume that we would have had customer complaints if this was an issue

@bazarnov
Copy link
Collaborator Author

bazarnov commented Aug 6, 2024

/approve-regression-tests

Check job output.

✅ Approving regression tests

@bazarnov bazarnov merged commit 4bcf36c into master Aug 6, 2024
38 checks passed
@bazarnov bazarnov deleted the baz/source/shopify/fix-customer-jpurney-schema-type branch August 6, 2024 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/shopify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants