Update config handling

Author: Pijukatel

src/apify/_actor.py

@@ -13,7 +13,6 @@
 
 from apify_client import ApifyClientAsync
 from apify_shared.consts import ActorEnvVars, ActorExitCodes, ApifyEnvVars
-from crawlee import service_locator
 from crawlee.events import (
     Event,
     EventAbortingData,
@@ -25,7 +24,7 @@
 )
 
 from apify._charging import ChargeResult, ChargingManager, ChargingManagerImplementation
-from apify._configuration import Configuration
+from apify._configuration import Configuration, service_locator
 from apify._consts import EVENT_LISTENERS_TIMEOUT
 from apify._crypto import decrypt_input_secrets, load_private_key
 from apify._models import ActorRun
@@ -119,7 +118,9 @@ def __init__(
         self._exit_process = self._get_default_exit_process() if exit_process is None else exit_process
         self._is_exiting = False
 
-        self._configuration = configuration or Configuration.get_global_configuration()
+        if configuration:
+            service_locator.set_configuration(configuration)
+        self._configuration = service_locator.get_configuration()
         self._configure_logging = configure_logging
         self._apify_client = self.new_client()
 

src/apify/_configuration.py

@@ -9,6 +9,8 @@
 from pydantic import AliasChoices, BeforeValidator, Field, model_validator
 from typing_extensions import Self, deprecated
 
+import crawlee
+from crawlee._service_locator import ServiceLocator
 from crawlee._utils.models import timedelta_ms
 from crawlee._utils.urls import validate_http_url
 from crawlee.configuration import Configuration as CrawleeConfiguration
@@ -429,8 +431,25 @@ def get_global_configuration(cls) -> Configuration:
         Mostly for the backwards compatibility. It is recommended to use the `service_locator.get_configuration()`
         instead.
         """
-        return cls()
+        return service_locator.get_configuration()
 
 
-# Monkey-patch the base class so that it works with the extended configuration
-CrawleeConfiguration.get_global_configuration = Configuration.get_global_configuration  # type: ignore[method-assign]
+class ApifyServiceLocator(ServiceLocator):
+    """Same as ServiceLocator from Crawlee, but it always returns Apify Configuration."""
+
+    def get_configuration(self) -> Configuration:
+        # ApifyServiceLocator can store any children of Crawlee Configuration, but in Apify context it is desired to
+        # return Apify Configuration.
+        stored_configuration = super().get_configuration()
+        # Ensure the returned configuration is of type Apify Configuration.
+        model_dump = stored_configuration.model_dump()
+        # The configuration will read env variables first and overridden with stored_configuration
+        _config = Configuration()
+        for key in model_dump:
+            setattr(_config, key, model_dump[key])
+        return _config
+
+
+# Ensure that ApifyServiceLocator is used to make sure Apify Configuration is used.
+service_locator = ApifyServiceLocator()
+crawlee.service_locator = ApifyServiceLocator()

tests/unit/actor/test_configuration.py

@@ -1,6 +1,9 @@
 import pytest
 
-from apify import Configuration
+from crawlee.configuration import Configuration as CrawleeConfiguration
+
+from apify import Configuration as ApifyConfiguration
+from apify._configuration import service_locator
 
 
 @pytest.mark.parametrize(
@@ -16,6 +19,19 @@ def test_disable_browser_sandbox(
     *, is_at_home: bool, disable_browser_sandbox_in: bool, disable_browser_sandbox_out: bool
 ) -> None:
     assert (
-        Configuration(is_at_home=is_at_home, disable_browser_sandbox=disable_browser_sandbox_in).disable_browser_sandbox
+        ApifyConfiguration(
+            is_at_home=is_at_home, disable_browser_sandbox=disable_browser_sandbox_in
+        ).disable_browser_sandbox
         == disable_browser_sandbox_out
     )
+
+
+def test_apify_configuration_is_always_used() -> None:
+    """Set Crawlee Configuration in service_locator and verify that Apify Configuration is returned."""
+    # Some value to verify
+    max_used_cpu_ratio = 0.123456
+    service_locator.set_configuration(CrawleeConfiguration(max_used_cpu_ratio=max_used_cpu_ratio))
+
+    returned_config = service_locator.get_configuration()
+    assert returned_config.max_used_cpu_ratio == max_used_cpu_ratio
+    assert isinstance(returned_config, ApifyConfiguration)

tests/unit/conftest.py

@@ -13,9 +13,9 @@
 
 from apify_client import ApifyClientAsync
 from apify_shared.consts import ApifyEnvVars
-from crawlee import service_locator
 
 import apify._actor
+from apify._configuration import service_locator
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterator