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-mysql] merge state manager #35529

Merged
merged 16 commits into from
Feb 29, 2024
Merged

[source-mysql] merge state manager #35529

merged 16 commits into from
Feb 29, 2024

Conversation

xiaohansong
Copy link
Contributor

@xiaohansong xiaohansong commented Feb 21, 2024

What

  • Merge Iterator state manager to the original state manager.
  • SourceStateIterator will now pass stream into state manager.

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • 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.
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

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.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

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.
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:generateScaffolds then checking in your changes
  • Documentation which references the generator is updated as needed
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.

Copy link

vercel bot commented Feb 21, 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 Feb 29, 2024 6:14pm

@octavia-squidington-iii octavia-squidington-iii added the CDK Connector Development Kit label Feb 27, 2024
@xiaohansong xiaohansong changed the title refactor example - merge state manager [source-mysql] merge state manager Feb 28, 2024
@xiaohansong xiaohansong marked this pull request as ready for review February 28, 2024 00:14
@xiaohansong xiaohansong requested a review from a team as a code owner February 28, 2024 00:14
Copy link
Contributor

Choose a reason for hiding this comment

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

You'd need to revert this

Copy link
Contributor

Choose a reason for hiding this comment

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

Can we possibly rename this to something else? Struggling to understand what exactly to call this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

renamed to SourceStateMessageProducer - MySqlInitialLoadStateManager will implement this interface. Think that makes more sense since it's just used to generate state messages and this interface eventually will be the sole place to generate state messages

new MySqlInitialSyncStateIteratorManager(pair, initialLoadStateManager, incrementalState,
syncCheckpointDuration, syncCheckpointRecords);
initialLoadStateManager.setStreamStateForIncrementalRunSupplier(streamStateForIncrementalRunSupplier);
initialLoadStateManager.setSyncCheckpointDuration(syncCheckpointDuration);
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we move syncCheckpointDuration and syncCheckpointRecords to the SourceStateIterator in the constructor?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

Copy link
Contributor

@akashkulk akashkulk left a comment

Choose a reason for hiding this comment

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

Sorry - let's to the refactor and move syncfrequency to the sourcestateiterator

private boolean hasEmittedFinalState = false;
private long recordCount = 0L;
private Instant lastCheckpoint = Instant.now();

private final SourceStateIteratorManager sourceStateIteratorManager;
public record StateEmitFrequency(long syncCheckpointRecords, Duration syncCheckpointDuration) {}
Copy link
Contributor

Choose a reason for hiding this comment

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

nit : can we just have a different file for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@xiaohansong
Copy link
Contributor Author

xiaohansong commented Feb 29, 2024

/publish-java-cdk

🕑 https://github.com/airbytehq/airbyte/actions/runs/8100458818
✅ Successfully published Java CDK version=0.23.8!

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Feb 29, 2024
@xiaohansong xiaohansong enabled auto-merge (squash) February 29, 2024 18:26
@xiaohansong xiaohansong merged commit 2637e97 into master Feb 29, 2024
28 of 29 checks passed
@xiaohansong xiaohansong deleted the xiaohan/state-mgr branch February 29, 2024 18:30
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 CDK Connector Development Kit connectors/source/mysql
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants