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 Mailchimp: Multiple schema updates and fixes #32836

Merged
merged 49 commits into from
Dec 19, 2023

Conversation

ChristoGrab
Copy link
Contributor

@ChristoGrab ChristoGrab commented Nov 27, 2023

What

This PR introduces multiple breaking changes to Source Mailchimp's schema:

Timestamp fields have been updated from string to airbyte-type timestamp_with_timezone. In order to accommodate this change, empty string values are now converted to null for incremental streams. This is necessary as there are multiple timestamp fields which, when they do not contain a value, will be returned as empty strings by the API, causing validation errors on the declared date-time format.

The ._links field, which contains non-user relevant Mailchimp metadata, has been excluded from all requests, and removed from our schema (it was only declared in the Automations schema). This field was already being excluded from recently added streams, and since this update already constitutes a breaking change, now is a good time to filter it out entirely.

Docs updates

  • Updated Prerequisites and added API Key setup steps
  • Added HideInUI tags to non-setup sections, and collapsible Troubleshooting section
  • Merged sync modes/streams lists into unified table

Misc

  • Added suggested streams based on usage reports from Metabase.
  • Moved logic to remove non-user relevant ._links field from individual stream implementation to base MailchimpStream class request_params.
  • Refactored individual stream implementations of nullifying empty string fields to base IncrementalMailchimpStream class
  • Removed a duplicate stream_state object in integration_tests/state.json
  • Updates to expected records

🚨🚨 User Impact

Due to the changes in type to all timestamp fields, and the removal of the ._links fields from the schema, this is a breaking change affecting all Incremental streams. Customers will have to refresh their schemas and reset data in order to upgrade.

Copy link

vercel bot commented Nov 27, 2023

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 Dec 19, 2023 10:40pm

Copy link
Contributor

github-actions bot commented Nov 27, 2023

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Nov 28, 2023
@ChristoGrab ChristoGrab marked this pull request as ready for review November 28, 2023 16:23
@tolik0
Copy link
Contributor

tolik0 commented Dec 5, 2023

@ChristoGrab Can you please add type for the /properties/recipients/properties/segment_opts/properties/conditions/items field in the automations stream?

@ChristoGrab ChristoGrab requested a review from a team December 6, 2023 20:11
Version 1.0.0 introduces schema changes to all incremental streams.
A full schema refresh and data reset are required to upgrade to this version.
For more details, see our <a href='https://docs.airbyte.io/integrations/sources/mailchimp-migrations'>migration guide</a>.
upgradeDeadline: "2023-12-21"
Copy link
Contributor

Choose a reason for hiding this comment

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

"2024-01-10"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated 👍

@octavia-squidington-iv octavia-squidington-iv requested a review from a team December 6, 2023 20:58
@ChristoGrab ChristoGrab merged commit 3ade71d into master Dec 19, 2023
26 checks passed
@ChristoGrab ChristoGrab deleted the christo/mailchimp-fixes branch December 19, 2023 22:41
@ChristoGrab ChristoGrab linked an issue Jan 3, 2024 that may be closed by this pull request
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
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/mailchimp
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Source Mailchimp: Add undeclared columns to spec
8 participants