add __requires_migration: bool flag to manifest config

Author: Oleksandr Bazarnov

airbyte_cdk/connector_builder/connector_builder_handler.py

@@ -56,12 +56,23 @@ def get_limits(config: Mapping[str, Any]) -> TestLimits:
     return TestLimits(max_records, max_pages_per_slice, max_slices, max_streams)
 
 
+def requires_migration(config: Mapping[str, Any]) -> bool:
+    """
+    Check if the manifest requires migration.
+
+    :param config: The config to check
+    :return: True if the manifest requires migration, False otherwise
+    """
+    return config.get("__requires_migration", False)
+
+
 def create_source(config: Mapping[str, Any], limits: TestLimits) -> ManifestDeclarativeSource:
     manifest = config["__injected_declarative_manifest"]
     return ManifestDeclarativeSource(
         config=config,
         emit_connector_builder_messages=True,
         source_config=manifest,
+        migrate_manifest=requires_migration(config),
         component_factory=ModelToComponentFactory(
             emit_connector_builder_messages=True,
             limit_pages_fetched_per_slice=limits.max_pages_per_slice,

airbyte_cdk/sources/declarative/manifest_declarative_source.py

@@ -72,14 +72,16 @@ def __init__(
         debug: bool = False,
         emit_connector_builder_messages: bool = False,
         component_factory: Optional[ModelToComponentFactory] = None,
+        migrate_manifest: Optional[bool] = False,
     ) -> None:
         """
         Args:
             config: The provided config dict.
             source_config: The manifest of low-code components that describe the source connector.
-            debug: True if debug mode is enabled.
-            emit_connector_builder_messages: True if messages should be emitted to the connector builder.
-            component_factory: optional factory if ModelToComponentFactory's default behavior needs to be tweaked.
+            debug: bool True if debug mode is enabled.
+            emit_connector_builder_messages: Optional[bool] True if messages should be emitted to the connector builder.
+            component_factory: Optional factory if ModelToComponentFactory's default behavior needs to be tweaked.
+            migrate_manifest: Optional[bool] if the manifest should be migrated to pick up the latest declarative component schema changes at runtime.
         """
         self.logger = logging.getLogger(f"airbyte.{self.name}")
 
@@ -96,11 +98,12 @@ def __init__(
             "", resolved_source_config, {}
         )
 
-        migrated_source_config = ManifestMigrationHandler(
-            propagated_source_config
-        ).apply_migrations()
+        if migrate_manifest:
+            propagated_source_config = ManifestMigrationHandler(
+                propagated_source_config
+            ).apply_migrations()
 
-        self._source_config = migrated_source_config
+        self._source_config = propagated_source_config
         self._debug = debug
         self._emit_connector_builder_messages = emit_connector_builder_messages
         self._constructor = (

unit_tests/connector_builder/test_connector_builder_handler.py

@@ -606,6 +606,7 @@ def test_resolve_manifest(valid_resolve_manifest_config_file):
                     },
                     "requester": {
                         "type": "HttpRequester",
+                        "path": "/v3/marketing/lists",
                         "authenticator": {
                             "type": "BearerAuthenticator",
                             "api_token": "{{ config.apikey }}",
@@ -617,7 +618,7 @@ def test_resolve_manifest(valid_resolve_manifest_config_file):
                         "request_parameters": {"a_param": "10"},
                         "name": _stream_name,
                         "primary_key": _stream_primary_key,
-                        "url": _stream_url_base + "/v3/marketing/lists",
+                        "url_base": _stream_url_base,
                         "$parameters": _stream_options,
                     },
                     "partition_router": {
@@ -1495,6 +1496,7 @@ def test_full_resolve_manifest(valid_resolve_manifest_config_file):
                         },
                     },
                     "requester": {
+                        "path": "/v3/marketing/lists",
                         "authenticator": {
                             "type": "BearerAuthenticator",
                             "api_token": "{{ config.apikey }}",
@@ -1511,7 +1513,7 @@ def test_full_resolve_manifest(valid_resolve_manifest_config_file):
                         "type": "HttpRequester",
                         "name": "stream_with_custom_requester",
                         "primary_key": "id",
-                        "url": "https://10.0.27.27/api/v1/v3/marketing/lists",
+                        "url_base": "https://10.0.27.27/api/v1/",
                         "$parameters": {
                             "name": "stream_with_custom_requester",
                             "primary_key": "id",