add ParametrizedComponentsResolver for dynamic streams

darynaishchenko · darynaishchenko · commit f5a08dfbcaaf · 2025-06-13T16:18:37.000+03:00
diff --git a/airbyte_cdk/sources/declarative/declarative_component_schema.yaml b/airbyte_cdk/sources/declarative/declarative_component_schema.yaml
@@ -4186,6 +4186,46 @@ definitions:
       - type
       - stream_config
       - components_mapping
+  StreamParametersDefinition:
+    title: Stream Parameters Definition
+    description: (This component is experimental. Use at your own risk.) Represents a stream parameters definition to set up dynamic streams from defined values in manifest.
+    type: object
+    required:
+      - type
+      - lisf_of_parameters_for_stream
+    properties:
+      type:
+        type: string
+        enum: [StreamParametersDefinition]
+      lisf_of_parameters_for_stream:
+        title: Stream Parameters
+        description: A list of object of parameters for stream, each object in the list represents params for one stream.
+        type: array
+        items:
+          type: object
+        examples:
+          - [{"name": "test stream", "$parameters": {"entity": "test entity"}, "primary_key": "test key"}]
+  ParametrizedComponentsResolver:
+    type: object
+    title: Parametrized Components Resolver
+    description: (This component is experimental. Use at your own risk.) Resolves and populates dynamic streams from defined parametrized values in manifest.
+    properties:
+      type:
+        type: string
+        enum: [ParametrizedComponentsResolver]
+      stream_parameters:
+        "$ref": "#/definitions/StreamParametersDefinition"
+      components_mapping:
+        type: array
+        items:
+          "$ref": "#/definitions/ComponentMappingDefinition"
+      $parameters:
+        type: object
+        additionalProperties: true
+    required:
+      - type
+      - stream_parameters
+      - components_mapping
   DynamicDeclarativeStream:
     type: object
     description: (This component is experimental. Use at your own risk.) A component that described how will be created declarative streams based on stream template.
@@ -4212,6 +4252,7 @@ definitions:
         anyOf:
           - "$ref": "#/definitions/HttpComponentsResolver"
           - "$ref": "#/definitions/ConfigComponentsResolver"
+          - "$ref": "#/definitions/ParametrizedComponentsResolver"
     required:
       - type
       - stream_template
diff --git a/airbyte_cdk/sources/declarative/models/declarative_component_schema.py b/airbyte_cdk/sources/declarative/models/declarative_component_schema.py
@@ -1512,6 +1512,31 @@ class ConfigComponentsResolver(BaseModel):
     parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
 
 
+class StreamParametersDefinition(BaseModel):
+    type: Literal["StreamParametersDefinition"]
+    lisf_of_parameters_for_stream: List[Dict[str, Any]] = Field(
+        ...,
+        description="A list of object of parameters for stream, each object in the list represents params for one stream.",
+        examples=[
+            [
+                {
+                    "name": "test stream",
+                    "$parameters": {"entity": "test entity"},
+                    "primary_key": "test key",
+                }
+            ]
+        ],
+        title="Stream Parameters",
+    )
+
+
+class ParametrizedComponentsResolver(BaseModel):
+    type: Literal["ParametrizedComponentsResolver"]
+    stream_parameters: Union[List[StreamParametersDefinition], StreamParametersDefinition]
+    components_mapping: List[ComponentMappingDefinition]
+    parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
+
+
 class RequestBodyPlainText(BaseModel):
     type: Literal["RequestBodyPlainText"]
     value: str
@@ -2943,7 +2968,9 @@ class DynamicDeclarativeStream(BaseModel):
     stream_template: Union[DeclarativeStream, StateDelegatingStream] = Field(
         ..., description="Reference to the stream template.", title="Stream Template"
     )
-    components_resolver: Union[HttpComponentsResolver, ConfigComponentsResolver] = Field(
+    components_resolver: Union[
+        HttpComponentsResolver, ConfigComponentsResolver, ParametrizedComponentsResolver
+    ] = Field(
         ...,
         description="Component resolve and populates stream templates with components values.",
         title="Components Resolver",
diff --git a/airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py b/airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py
@@ -162,6 +162,9 @@
 from airbyte_cdk.sources.declarative.models.declarative_component_schema import (
     ConfigComponentsResolver as ConfigComponentsResolverModel,
 )
+from airbyte_cdk.sources.declarative.models.declarative_component_schema import (
+    ParametrizedComponentsResolver as ParametrizedComponentsResolverModel,
+)
 from airbyte_cdk.sources.declarative.models.declarative_component_schema import (
     ConfigMigration as ConfigMigrationModel,
 )
@@ -505,6 +508,8 @@
     ConfigComponentsResolver,
     HttpComponentsResolver,
     StreamConfig,
+    StreamParametersDefinition,
+    ParametrizedComponentsResolver,
 )
 from airbyte_cdk.sources.declarative.retrievers import (
     AsyncRetriever,
@@ -738,6 +743,7 @@ def _init_mappings(self) -> None:
             AsyncRetrieverModel: self.create_async_retriever,
             HttpComponentsResolverModel: self.create_http_components_resolver,
             ConfigComponentsResolverModel: self.create_config_components_resolver,
+            ParametrizedComponentsResolverModel: self.create_parametrized_components_resolver,
             StreamConfigModel: self.create_stream_config,
             ComponentMappingDefinitionModel: self.create_components_mapping_definition,
             ZipfileDecoderModel: self.create_zipfile_decoder,
@@ -3861,6 +3867,37 @@ def create_config_components_resolver(
             parameters=model.parameters or {},
         )
 
+    def create_parametrized_components_resolver(
+        self, model: ParametrizedComponentsResolverModel, config: Config
+    ) -> ParametrizedComponentsResolver:
+        updated_stream_parameters = []
+        for stream_parameters in model.stream_parameters.lisf_of_parameters_for_stream:
+            try:
+                stream_parameters = self._create_component_from_model(
+                    stream_parameters, config=config, parameters=model.parameters or {}
+                )
+            except ValueError as ex:  # when an object doesn't have a type, we leave it as is
+                pass
+            updated_stream_parameters.append(stream_parameters)
+
+        model.stream_parameters.lisf_of_parameters_for_stream = updated_stream_parameters
+        components_mapping = [
+            self._create_component_from_model(
+                model=components_mapping_definition_model,
+                value_type=ModelToComponentFactory._json_schema_type_name_to_type(
+                    components_mapping_definition_model.value_type
+                ),
+                config=config,
+            )
+            for components_mapping_definition_model in model.components_mapping
+        ]
+        return ParametrizedComponentsResolver(
+            stream_parameters=model.stream_parameters,
+            config=config,
+            components_mapping=components_mapping,
+            parameters=model.parameters or {},
+        )
+
     _UNSUPPORTED_DECODER_ERROR = (
         "Specified decoder of {decoder_type} is not supported for pagination."
         "Please set as `JsonDecoder`, `XmlDecoder`, or a `CompositeRawDecoder` with an inner_parser of `JsonParser` or `GzipParser` instead."
diff --git a/airbyte_cdk/sources/declarative/resolvers/__init__.py b/airbyte_cdk/sources/declarative/resolvers/__init__.py
@@ -12,6 +12,9 @@
 from airbyte_cdk.sources.declarative.models import (
     HttpComponentsResolver as HttpComponentsResolverModel,
 )
+from airbyte_cdk.sources.declarative.models import (
+    ParametrizedComponentsResolver as ParametrizedComponentsResolverModel,
+)
 from airbyte_cdk.sources.declarative.resolvers.components_resolver import (
     ComponentMappingDefinition,
     ComponentsResolver,
@@ -24,10 +27,15 @@
 from airbyte_cdk.sources.declarative.resolvers.http_components_resolver import (
     HttpComponentsResolver,
 )
+from airbyte_cdk.sources.declarative.resolvers.paramertized_components_resolver import (
+    ParametrizedComponentsResolver,
+    StreamParametersDefinition,
+)
 
 COMPONENTS_RESOLVER_TYPE_MAPPING: Mapping[str, type[BaseModel]] = {
     "HttpComponentsResolver": HttpComponentsResolverModel,
     "ConfigComponentsResolver": ConfigComponentsResolverModel,
+    "ParametrizedComponentsResolver": ParametrizedComponentsResolverModel,
 }
 
 __all__ = [
@@ -38,4 +46,6 @@
     "StreamConfig",
     "ConfigComponentsResolver",
     "COMPONENTS_RESOLVER_TYPE_MAPPING",
+    "ParametrizedComponentsResolver",
+    "StreamParametersDefinition",
 ]
diff --git a/airbyte_cdk/sources/declarative/resolvers/paramertized_components_resolver.py b/airbyte_cdk/sources/declarative/resolvers/paramertized_components_resolver.py
@@ -0,0 +1,124 @@
+#
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
+#
+
+from copy import deepcopy
+from dataclasses import InitVar, dataclass, field, Field
+from itertools import product
+from typing import Any, Dict, Iterable, List, Mapping, Optional, Tuple, Union
+
+import dpath
+import yaml
+from typing_extensions import deprecated
+from yaml.parser import ParserError
+
+from airbyte_cdk.sources.declarative.interpolation import InterpolatedString
+from airbyte_cdk.sources.declarative.resolvers.components_resolver import (
+    ComponentMappingDefinition,
+    ComponentsResolver,
+    ResolvedComponentMappingDefinition,
+)
+from airbyte_cdk.sources.source import ExperimentalClassWarning
+from airbyte_cdk.sources.types import Config
+
+
+@deprecated("This class is experimental. Use at your own risk.", category=ExperimentalClassWarning)
+@dataclass
+class StreamParametersDefinition:
+    """
+    Represents a stream parameters definition to set up dynamic streams from defined values in manifest.
+    """
+
+    lisf_of_parameters_for_stream: List[Dict[str, Any]]
+
+
+@deprecated("This class is experimental. Use at your own risk.", category=ExperimentalClassWarning)
+@dataclass
+class ParametrizedComponentsResolver(ComponentsResolver):
+    """
+    Resolves and populates dynamic streams from defined parametrized values in manifest.
+    """
+
+    stream_parameters: StreamParametersDefinition
+    config: Config
+    components_mapping: List[ComponentMappingDefinition]
+    parameters: InitVar[Mapping[str, Any]]
+    _resolved_components: List[ResolvedComponentMappingDefinition] = field(
+        init=False, repr=False, default_factory=list
+    )
+
+    def __post_init__(self, parameters: Mapping[str, Any]) -> None:
+        """
+        Initializes and parses component mappings, converting them to resolved definitions.
+
+        Args:
+            parameters (Mapping[str, Any]): Parameters for interpolation.
+        """
+
+        for component_mapping in self.components_mapping:
+            if isinstance(component_mapping.value, (str, InterpolatedString)):
+                interpolated_value = (
+                    InterpolatedString.create(component_mapping.value, parameters=parameters)
+                    if isinstance(component_mapping.value, str)
+                    else component_mapping.value
+                )
+
+                field_path = [
+                    InterpolatedString.create(path, parameters=parameters)
+                    for path in component_mapping.field_path
+                ]
+
+                self._resolved_components.append(
+                    ResolvedComponentMappingDefinition(
+                        field_path=field_path,
+                        value=interpolated_value,
+                        value_type=component_mapping.value_type,
+                        create_or_update=component_mapping.create_or_update,
+                        parameters=parameters,
+                    )
+                )
+            else:
+                raise ValueError(
+                    f"Expected a string or InterpolatedString for value in mapping: {component_mapping}"
+                )
+
+    def resolve_components(
+        self, stream_template_config: Dict[str, Any]
+    ) -> Iterable[Dict[str, Any]]:
+        kwargs = {"stream_template_config": stream_template_config}
+
+        for components_values in self.stream_parameters.lisf_of_parameters_for_stream:
+            updated_config = deepcopy(stream_template_config)
+            kwargs["components_values"] = components_values  # type: ignore[assignment] # component_values will always be of type Mapping[str, Any]
+            for resolved_component in self._resolved_components:
+                valid_types = (
+                    (resolved_component.value_type,) if resolved_component.value_type else None
+                )
+                value = resolved_component.value.eval(
+                    self.config, valid_types=valid_types, **kwargs
+                )
+                path = [path.eval(self.config, **kwargs) for path in resolved_component.field_path]
+                parsed_value = self._parse_yaml_if_possible(value)
+                updated = dpath.set(updated_config, path, parsed_value)
+
+                if parsed_value and not updated and resolved_component.create_or_update:
+                    dpath.new(updated_config, path, parsed_value)
+
+            yield updated_config
+
+    @staticmethod
+    def _parse_yaml_if_possible(value: Any) -> Any:
+        """
+        Try to turn value into a Python object by YAML-parsing it.
+
+        * If value is a `str` and can be parsed by `yaml.safe_load`,
+          return the parsed result.
+        * If parsing fails (`yaml.parser.ParserError`) – or value is not
+          a string at all – return the original value unchanged.
+        """
+        if isinstance(value, str):
+            try:
+                return yaml.safe_load(value)
+            except ParserError:  # "{{ record[0] in ['cohortActiveUsers'] }}"   # not valid YAML
+                return value
+        return value
