estuary-cdk and new connectors #1293
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jgraettinger
force-pushed
the
johnny/sdk-proto
branch
12 times, most recently
from
0383cde
to
6af61ac
Compare
williamhbaker
approved these changes
Mar 1, 2024
There was a problem hiding this comment.
LGTM
Had a couple of questions, and a few other trivial notes. I must admit that a lot of the python stuff is still over my head, but everything generally made sense. Others with more python-specific knowledge might have more useful feedback on specifics of the code.
The Estuary CDK differs from the earlier flow-sdk in fundamental ways: * It leans heavily into Pydantic V2 (with a polyfill for V1), which is used for validation and schema generation, married with Flow's schema inference capabilities. * It has a framework -> connector -> library structure. The framework is maximally unopinionated as to how a connector is built. But, the CDK offers library routines (the `common` module) which encapsulates the common patterns for fetch snapshot or incremental resources. * It's async at it's core. All work proceeds concurrently across all bindings.
Still missing a bunch of entities, but functional.
…wocuments or a LogCursor This avoids implementations from having to know the maximum LogCursor until they're done reading documents, and avoids nested async generators. Also add a BasicAuth credential type.
request_stream() is an AsyncGenerator over arbitrary stream chunks. Then, request() and a new request_lines() are implemented in terms of request_stream(). This allows callers to efficiently process unbounded responses.
…ming Rework the contract to allow implementations to yield checkpoints at times of their choosing. This allows for more ergonomic handling of long-lived push streams of documents.
Begin to factor out common setup steps into reuseable composite actions. Add a common estuary-cdk Dockerfile
The runtime currently uses a non-UUID placeholder internally, which causes spurious schema violations
Establish a convention that `log: Logger` is the first parameter. We're going to be threading these through everywhere -- which is desireable, because it gives us a tightly-scoped structured log context that tells us as much as possible about the surrounding task -- so let's standardize how it should be passed so we don't have to think hard about it. Also refactor `http` module to clarify APIs which are stable, vs portions that are very likely to be refactored. A few other code-review cleanups as well.
We don't need it yet, so let's not have it.
jgraettinger
force-pushed
the
johnny/sdk-proto
branch
from
3fde40f
to
e0c7983
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See individual commits.
Workflow steps:
(How does one use this feature, and how has it changed)
Documentation links affected:
(list any documentation links that you created, or existing ones that you've identified as needing updates, along with a brief description)
Notes for reviewers:
(anything that might help someone review this PR)
This change is