Skip to content

CAT: add validation for state messages #36001

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

Merged
merged 7 commits into from
Mar 18, 2024

Conversation

lazebnyi
Copy link
Collaborator

@lazebnyi lazebnyi commented Mar 13, 2024

What

Fixed https://github.com/airbytehq/airbyte-internal-issues/issues/6557

Emit final state message for full refresh syncs and consolidate read flows was added - #35622
We need to test that the legacy state type is not emitted and that the source stats are present in the state message

How

add validation for state messages

Recommended reading order

  1. airbyte-integrations/bases/connector-acceptance-test/connector_acceptance_test/tests/test_core.py

🚨 User Impact 🚨

no breaking changes

Pre-merge Actions

Updating the Python CDK

Airbyter

Before merging:

  • Pull Request description explains what problem it is solving
  • Code change is unit tested
  • Build and my-py check pass
  • Smoke test the change on at least one affected connector
    • On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
    • Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
  • PR is reviewed and approved

After merging:

  • Publish the CDK
    • The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
    • Write a thoughtful changelog message so we know what was updated.
  • Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
    • This step is optional if the change does not affect the connector builder or declarative connectors.

@lazebnyi lazebnyi requested a review from oustynova as a code owner March 13, 2024 01:04
@lazebnyi lazebnyi requested a review from a team March 13, 2024 01:04
Copy link

vercel bot commented Mar 13, 2024

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

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Mar 18, 2024 1:11pm

Copy link
Contributor

@brianjlai brianjlai left a comment

Choose a reason for hiding this comment

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

Overall looks good but I have a couple comments on the validations we have and I think adding a bypass_reason like we do on some of our other tests might be good escape hatch. The default should be on however.

Copy link
Collaborator Author

@lazebnyi lazebnyi left a comment

Choose a reason for hiding this comment

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

Added the should_validate_state_messages flag to disable the test when necessary.
Decide not to add bypass_reason to avoid unnecessary complicity in configuration of this test.

@lazebnyi lazebnyi requested a review from brianjlai March 14, 2024 23:27
Copy link
Contributor

@brianjlai brianjlai left a comment

Choose a reason for hiding this comment

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

lgtm! thanks for making the additions

@lazebnyi lazebnyi merged commit 69b6ad4 into master Mar 18, 2024
28 checks passed
@lazebnyi lazebnyi deleted the lazebnyi/CAT-validate-state-message branch March 18, 2024 13:25
@lazebnyi lazebnyi restored the lazebnyi/CAT-validate-state-message branch March 19, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants