feat(cdk): handle include_files from configured catalog #512
+256
−16
Conversation
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
… configured catalog.
…s to always return bool
…-api/handle-include-files
maxi297
reviewed
Apr 28, 2025
| @@ -229,7 +230,9 @@ def connection_checker(self) -> ConnectionChecker: | |||
| f"Expected to generate a ConnectionChecker component, but received {check_stream.__class__}" | |||
| ) | |||
|
|
|||
| def streams(self, config: Mapping[str, Any]) -> List[Stream]: | |||
| def streams( | |||
| self, config: Mapping[str, Any], catalog: Optional[ConfiguredAirbyteCatalog] = None | |||
There was a problem hiding this comment.
I'm a bit ambivalent on modifying this interface because now, it does not align with the parent interface so it seems like we are breaking compatibility and it'll be hard to maintain with doing isinstance before calling which means that we will lose most of the benefits of inheritance.
Could we pass the catalog at ModelToComponentFactory.__init__ as a mandatory field? It seems like we are already passing the information here. This would avoid the interface problem, the problem of managing an optional catalog and the problem of passing include_files through kwargs. We might want to do it here too if it's not too much trouble.
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.
What
There is a scenario where the user may not want to include files from a file stream, so they will only get metadata. We were not handling this.
How
Read value from the stream configured catalog and check the include_files value, if false/none use NoopWriter, if true, it is fine to use the FileSystemWriter.
This only happens for read operations.