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.

Sign up for GitHub

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

Jump to bottom

Checkpoint snapshot skeleton #33838

Open
wants to merge 1 commit into
base: 12-29-Model_update
Choose a base branch
from
Open

Checkpoint snapshot skeleton #33838

wants to merge 1 commit into from

Conversation

rodireich
Copy link
Contributor

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

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.

@rodireich rodireich mentioned this pull request Dec 29, 2023
Open
@rodireich Graphite App
Copy link
Contributor Author

rodireich commented Dec 29, 2023 •
edited
Loading

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@vercel Vercel
Copy link

vercel bot commented Dec 29, 2023 •
edited
Loading

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 Jan 31, 2024 3:04am

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 29, 2023 •
edited
Loading

Warning

🚨 Connector code freeze is in effect until 2024-01-02. This PR is changing connector code. Please contact the current OC engineers if you want to merge this change to master.

@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label Dec 29, 2023
@github-actions GitHub Actions
Copy link
Contributor

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.

@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from fefa086 to 2011184 Compare December 29, 2023 22:11
@rodireich rodireich changed the base branch from 12-26-Debug_log_mssql to 12-29-Model_update December 29, 2023 22:11
@rodireich rodireich mentioned this pull request Dec 29, 2023
Open
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from 2011184 to 36e9ac2 Compare December 30, 2023 05:10
@rodireich rodireich mentioned this pull request Dec 30, 2023
Open
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from 36e9ac2 to c964c15 Compare December 30, 2023 06:03
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from c964c15 to c1ed503 Compare January 9, 2024 05:11
@rodireich rodireich mentioned this pull request Jan 9, 2024
Open
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from c1ed503 to 849216e Compare January 10, 2024 00:31
@rodireich rodireich mentioned this pull request Jan 10, 2024
Open
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from 849216e to c42143b Compare January 10, 2024 20:01
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from c42143b to c524fb9 Compare January 10, 2024 23:34
@rodireich rodireich mentioned this pull request Jan 11, 2024
Merged
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from c524fb9 to e64062e Compare January 11, 2024 18:55
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from e64062e to 3553861 Compare January 12, 2024 05:49
postamar
postamar reviewed Jan 18, 2024
View reviewed changes
.../src/main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadHandler.java
final ConfiguredAirbyteCatalog catalog,
final Map<String, TableInfo<CommonField<JDBCType>>> tableNameToTable,
final Instant emittedAt) {
final List<AutoCloseableIterator<AirbyteMessage>> iteratorList = new ArrayList<>();
Copy link
Contributor

@postamar postamar Jan 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

nit: this is beyond the scope of this change but does spamming the final keyword really improve code quality? I wonder especially in cases like this one when we're assigning a value which is in reality obviously mutable, even if the enclosing container reference doesn't change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The narrowest response to why add final is that something will complain if you don't mark it as final and try to build.

It improves performance I think

Copy link
Contributor

Choose a reason for hiding this comment

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

I tried removing final in a bunch of places and nothing complained. Perhaps that's because I ripped out PMD a few months ago (nobody noticed, I think).

I don't buy the performance argument. Very little of our code is in the hotpath. Not to mention that if PMD can figure out which variables are final then I trust that javac can tool.

IMHO lack of readability is a fantastic source of bugs and our code isn't great in this regard. Let's all improve it a little bit at a time.

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
.../src/main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadHandler.java
.map(CommonField::getName)
.filter(CatalogHelpers.getTopLevelFieldNames(airbyteStream)::contains)
.toList();
primaryKeys.forEach(pk -> {
Copy link
Contributor

@postamar postamar Jan 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

nit: can we either have a vanilla for-loop, or use the Streams constructs fully, instead of this mix of styles?

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
.../src/main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadHandler.java
new MssqlInitialLoadRecordIterator(database, sourceOperations, quoteString, initialLoadStateManager, selectedDatabaseFields, pair, calculateChunkSize(), isCompositePrimaryKey(airbyteStream));
final AutoCloseableIterator<AirbyteMessage> recordIterator =
getRecordIterator(queryStream, streamName, namespace, emittedAt.toEpochMilli());
final AutoCloseableIterator<AirbyteMessage> recordAndMessageIterator = augmentWithState(recordIterator, pair);
Copy link
Contributor

@postamar postamar Jan 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

nit: can we use var more, please? the LHS types in this line and those above is not ambiguous

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
.../src/main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadHandler.java
.withNamespace(namespace)
.withEmittedAt(emittedAt)
.withData(r)));
}
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: perhaps it's just me but if this were inlined I'd find the code more readable. If we're worried about cyclomatic complexity then let's lift L80:99 into a separate function or something.

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
.../src/main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadHandler.java Outdated

// Augments the given iterator with record count logs.
private AutoCloseableIterator<AirbyteMessage> augmentWithLogs(final AutoCloseableIterator<AirbyteMessage> iterator,
final io.airbyte.protocol.models.AirbyteStreamNameNamespacePair pair,
Copy link
Contributor

Choose a reason for hiding this comment

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

why is this type name fully qualified?

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
.../src/main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadHandler.java Outdated
final OrderedColumnLoadStatus currentOcLoadStatus = initialLoadStateManager.getOrderedColumnLoadStatus(pair);
final JsonNode incrementalState =
(currentOcLoadStatus == null || currentOcLoadStatus.getIncrementalState() == null) ? streamStateForIncrementalRunSupplier.apply(pair)
:currentOcLoadStatus.getIncrementalState();
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: formatting

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...in/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadRecordIterator.java Outdated

private boolean shouldBuildNextSubquery() {
// The next sub-query should be built if (i) it is the first subquery in the sequence. (ii) the
// previous subquery has finished.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: comment formatting

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...in/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadRecordIterator.java
final String schemaName = pair.getNamespace();
LOGGER.info("Preparing query for table: {}", tableName);
final String fullTableName = getFullyQualifiedTableNameWithQuoting(schemaName, tableName,
quoteString);
Copy link
Contributor

Choose a reason for hiding this comment

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

similar comment regarding use of fullTableName in log msg

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...in/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadRecordIterator.java Outdated
final String wrappedColumnNames = RelationalDbQueryUtils.enquoteIdentifierList(columnNames, quoteString);
final OrderedColumnLoadStatus ocLoadStatus = initialLoadStateManager.getOrderedColumnLoadStatus(pair);
if (ocLoadStatus == null) {
LOGGER.info("pkLoadStatus is null");
Copy link
Contributor

Choose a reason for hiding this comment

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

consider improving this log msg, which is not terribly informative

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadStateManager.java Outdated
AirbyteStateMessage createFinalStateMessage(final AirbyteStreamNameNamespacePair pair, final JsonNode streamStateForIncrementalRun);

// Returns the previous state emitted, represented as a {@link OrderedColumnLoadStatus} associated with
// the stream.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: javadoc instead of // comments?

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadStateManager.java Outdated
final AirbyteStreamNameNamespacePair updatedPair = new AirbyteStreamNameNamespacePair(pair.getName(), pair.getNamespace());
map.put(updatedPair, ocStatus);
});
return map;
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: use Streams constructs

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...ava/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadStreamStateManager.java Outdated
}

private AirbyteStreamState getAirbyteStreamState(final io.airbyte.protocol.models.AirbyteStreamNameNamespacePair pair, final JsonNode stateData) {
LOGGER.info("STATE DATA FOR {}: {}", pair.getNamespace().concat("_").concat(pair.getName()), stateData);
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: caps

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...ava/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadStreamStateManager.java Outdated
private AirbyteStreamState getAirbyteStreamState(final io.airbyte.protocol.models.AirbyteStreamNameNamespacePair pair, final JsonNode stateData) {
LOGGER.info("STATE DATA FOR {}: {}", pair.getNamespace().concat("_").concat(pair.getName()), stateData);
assert Objects.nonNull(pair.getName());
assert Objects.nonNull(pair.getNamespace());
Copy link
Contributor

Choose a reason for hiding this comment

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

similar comment as earlier regarding assertions

postamar
postamar reviewed Jan 18, 2024
View reviewed changes
...sql/src/main/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialReadUtil.java

}

public record OrderedColumnInfo(String ocFieldName, JDBCType fieldType, String ocMaxValue) {}
Copy link
Contributor

Choose a reason for hiding this comment

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

curious why are these defined as inner classes? files are cheap

postamar
postamar approved these changes Jan 18, 2024
View reviewed changes
Copy link
Contributor

@postamar postamar left a comment

Choose a reason for hiding this comment

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

Just a bunch of nits on my end.

@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from a9e4d07 to f853b53 Compare January 18, 2024 19:07
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from f853b53 to 7d9fc69 Compare January 18, 2024 21:52
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch 2 times, most recently from b355b73 to 8c1e809 Compare January 20, 2024 07:53
stephane-airbyte
stephane-airbyte reviewed Jan 23, 2024
View reviewed changes
...in/java/io/airbyte/integrations/source/mssql/initialsync/MssqlInitialLoadRecordIterator.java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@SuppressWarnings("try")
Copy link
Contributor

Choose a reason for hiding this comment

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

what's the reason we have to use the supresswarnings here. Usually those are pretty useful in preventing resource leaks

@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from 8c1e809 to 0554fad Compare January 27, 2024 00:22
@rodireich rodireich force-pushed the 33399-checkpointing-snapshot branch from 0554fad to eb7b3b4 Compare January 31, 2024 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stephane-airbyte stephane-airbyte stephane-airbyte left review comments

@postamar postamar postamar approved these changes

@lazebnyi lazebnyi lazebnyi approved these changes

Assignees
No one assigned
Labels
area/connectors Connector related issues connectors/source/mssql connectors/source/mysql
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rodireich @postamar @lazebnyi @stephane-airbyte @octavia-squidington-iii