refactor: connectors can launch themselves; deprecate: AirbyteEntrypoint and launch(), add SerDe methods on critical protocol classes#562
Draft
Aaron ("AJ") Steers (aaronsteers) wants to merge 15 commits intomainfrom
Conversation
…oint` and `launch()`
AirbyteEntrypoint and launch()AirbyteEntrypoint and launch(), add SerDe methods on critical protocol classes
…/github.com/airbytehq/airbyte-python-cdk into aj/refactor/connectors-can-launch-themselvs
This file contains hidden or 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
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.
Request: Early Feedback.
Goal here is to detangle the tightly-coupled interdependencies:
AirbyteEntrypointclasslaunch()methodConnectorandSourceclasses themselves.Enumerated changes:
parse_cli_args()made a dedicated helper function. Moved to its ownutilsmodule, ensuring no circular dependencies between theairbyte_entrypointmodule and the connector class modules.Connectorclasses inherit class method calledlaunch_with_cli_args()launch()function is deprecated (but not removed).launch()it is now implemented viasource.launch_with_cli_args()Calling it will emit a deprecation warning.AirbyteEntrypoint(although probably not in this iteration).Context
I finally accepted taking on this work, as it is needed to unblock:
The problem is: the
AirbyteEntrypointcurrently gatekeeps access to the connector class itself. AndAirbyteEntrypointdoesn't have flexibility into calling results into memory vs pushing results to STDOUT.Related: the
airbyte_cdk.test.entrypoint_output.EntrypointOutputin some ways tries to mitigate this, but it has to in some cases fully re-invent theAirbyteEntrypointimplementation.And since neither of these gives any flexibility in modes of execution or control of RAM overflow, this PR consolidates the execution to have fewer parts, with the (hopefully) the right interface layers to accomplish execution with minimal wheel-reinventing for callers.