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 Hubspot: Add missing types for the Workflows stream schema #39314

Merged
merged 3 commits into from
Jun 6, 2024

Conversation

bazarnov
Copy link
Collaborator

@bazarnov bazarnov commented Jun 6, 2024

What

Resolving:

How

  • added missing type: ["null", "object"] where the schema declares it for the Workflows 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 Jun 6, 2024
Copy link

vercel bot commented Jun 6, 2024

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

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2024 0:43am

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jun 6, 2024
@bazarnov bazarnov marked this pull request as ready for review June 6, 2024 12:37
@bazarnov bazarnov requested review from a team and maxi297 June 6, 2024 12:37
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.

Just comments outside of the scope of this fix

@@ -158,6 +158,7 @@
"properties": {
"sourceApplication": {
"description": "Application details of the workflow update source",
"type": ["null", "object"],
Copy link
Contributor

Choose a reason for hiding this comment

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

Out of curiosity, what is the default type if this is not provided? Should this have been caught by CATs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is a great question.

The data structure remains the same, but the schema was missing these types only.
I wonder why the CAT didn't catch such things,
I assume we don't have the type field presence check yet for the schemas, as a separate testing scenario for the CAT, thus we can easily bypass such things.

Correct me if I'm wrong here.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would definitely expect this test to fail in that case. Maybe we haven't configured the validator properly..?

Copy link
Collaborator Author

@bazarnov bazarnov Jun 6, 2024

Choose a reason for hiding this comment

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

The type field is optional for the JsonSchema, in general, so probably there should be an additional check on top of the existing validator to validate its presence.

Copy link
Contributor

@maxi297 maxi297 Jun 6, 2024

Choose a reason for hiding this comment

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

What is the default value? I could not find this information. If it is the case, we either need to have destinations support this or update our CATs. The latter seems to build more leverage and seems easier to implement too. Can we at least create an issue for that?

Copy link
Collaborator Author

@bazarnov bazarnov Jun 6, 2024

Choose a reason for hiding this comment

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

I think, in this case; it depends on the destination used. There is no default value for the source; in this case, it's a matter of how the destination treats the missing types. For instance, BigQuery raises an Exception that there is no type, but it expected any of Null, Object based on the actual data type faced.

@bazarnov bazarnov merged commit f1d1295 into master Jun 6, 2024
36 checks passed
@bazarnov bazarnov deleted the baz/hubspot/add-missing-schema-types branch June 6, 2024 13:03
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/hubspot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants