fred-oss 0.34.0__tar.gz → 0.36.0__tar.gz

{fred_oss-0.34.0/src/main/fred_oss.egg-info → fred_oss-0.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fred-oss
-Version: 0.34.0
+Version: 0.36.0
 Summary: FREDOSS
 Home-page: https://fred.fahera.mx
 Author: Fahera Research, Education, and Development

fred_oss-0.36.0/src/main/fred/version

@@ -0,0 +1 @@
+0.36.0

{fred_oss-0.34.0 → fred_oss-0.36.0}/src/main/fred/worker/runner/client.py

@@ -88,6 +88,34 @@ class RunnerClient:
     def fetch_status(request_id: str) -> Optional[str]:
         return FutureResult._get_status_key(future_id=request_id).get()
 
+    def _pullsync(
+            self,
+            request_id: str,
+            retry_sync: int = 10,
+            retry_delay: float = 0.2,
+            retry_backoff_rate: float = 0.1,
+            **kwargs,
+    ):
+        from fred.future.utils import pull_future_result
+
+        if not self._is_ready_for_pullsync(
+                request_id=request_id,
+                retry_sync=retry_sync,
+                retry_delay=retry_delay,
+                retry_backoff_rate=retry_backoff_rate,
+                # Always fail in pullsync to raise an exception if not ready.
+                # In addition, this will be caught by the Future to propagate the exception.
+                fail=True,
+        ):
+            raise ValueError(f"The provided request_id '{request_id}' is not ready for pullsync.")
+
+        return pull_future_result(
+            future_id=request_id,
+            retry_delay=retry_delay,
+            retry_backoff_rate=retry_backoff_rate,
+            **kwargs
+        )
+
     def pullsync(
             self,
             request_id: str,
@@ -96,18 +124,13 @@ class RunnerClient:
             retry_backoff_rate: float = 0.1,
             **kwargs,
     ) -> Future:
-        # TODO: Once the broadcast method is implemented, we can add a warning notice regarding
-        # the pullsync metho adding extra load to the backend service
-        future = Future(
-            function=self._is_ready_for_pullsync,
+        return Future(
+            function=self._pullsync,
             request_id=request_id,
             retry_sync=retry_sync,
             retry_delay=retry_delay,
             retry_backoff_rate=retry_backoff_rate,
-            fail=True,  # Always fail inside the future to propagate the exception
-        )
-        return future.flat_map(
-            lambda _: Future.pullsync(future_id=request_id, **kwargs)
+            **kwargs
         )
 
     def _is_ready_for_pullsync(
@@ -137,8 +160,8 @@ class RunnerClient:
                 return False
         return True
 
-    def fetch_result(self, request_id: str, now: bool = False, timeout: Optional[float] = None) -> Optional[dict]:
-        future = self.pullsync(request_id=request_id)
+    def fetch_result(self, request_id: str, now: bool = False, timeout: Optional[float] = None, **kwargs) -> Optional[dict]:
+        future = self.pullsync(request_id=request_id, **kwargs)
         if now:
             return future.getwhatevernow()
         return future.wait_and_resolve(timeout=timeout)

{fred_oss-0.34.0 → fred_oss-0.36.0}/src/main/fred/worker/runner/model/_runner_spec.py

@@ -73,11 +73,11 @@ class RunnerSpec(ModelInterface):
             "timeout": self.timeout,
         }
     
-    def as_event(self) -> dict:
-        return {
-            "id": self.runner_id,
-            "input": self.as_dict(),
-        }
+    def as_event(self, drop_id: bool = False) -> dict:
+        event = {"input": self.as_dict()}
+        if not drop_id:
+            event["id"] = self.runner_id
+        return event
     
     @property
     def request_queue_name(self) -> str:

{fred_oss-0.34.0 → fred_oss-0.36.0}/src/main/fred/worker/runner/plugins/_local.py

@@ -1,7 +1,6 @@
 from dataclasses import dataclass
 
 from fred.settings import logger_manager
-from fred.worker.runner.info import RunnerInfo
 from fred.worker.runner.handler import RunnerHandler
 from fred.worker.runner.model._runner_spec import RunnerSpec
 from fred.worker.runner.plugins.interface import PluginInterface
@@ -31,4 +30,4 @@ class LocalPlugin(PluginInterface):
             import_pattern=outer_handler_classpath,
             **outer_handler_init_kwargs,
         )
-        outer_handler.run(event=spec.as_event(), as_future=False)
+        return outer_handler.run(event=spec.as_event(), as_future=False)

fred_oss-0.36.0/src/main/fred/worker/runner/plugins/_runpod.py

@@ -0,0 +1,79 @@
+import posixpath
+from dataclasses import dataclass
+
+from fred.settings import logger_manager
+from fred.worker.runner.model._runner_spec import RunnerSpec
+from fred.worker.runner.plugins.interface import PluginInterface
+from fred.settings import get_environ_variable
+
+logger = logger_manager.get_logger(name=__name__)
+
+
+@dataclass(frozen=True, slots=True)
+class RunpodPlugin(PluginInterface):
+
+    def _execute(
+            self,
+            spec: RunnerSpec,
+            **kwargs
+        ):
+        """Execute the runner specification on RunPod's serverless platform.
+        Args:
+            spec (RunnerSpec): The runner specification to execute.
+            **kwargs: Additional keyword arguments for RunPod configuration, such as:
+                - runpod_key: API key for RunPod.
+                - runpod_url: Base URL for RunPod API.
+                - runpod_serverless_id: The ID of the serverless function to invoke.
+                - runpod_serverless_endpoint: The endpoint to use ('run' or 'runsync').
+                - headers: Additional headers to include in the request.
+        """
+        import requests
+
+        RUNPOD_KEY = (
+            kwargs.get("runpod_key")
+            or get_environ_variable(name="RUNPOD_KEY", default="")
+        )
+        RUNPOD_URL = (
+            kwargs.get("runpod_url")
+            or get_environ_variable(name="RUNPOD_URL", default="https://api.runpod.ai/v2")
+        )
+        RUNPOD_SERVERLESS_ID = (
+            kwargs.get("runpod_serverless_id")
+            or get_environ_variable(name="RUNPOD_SERVERLESS_ID", default=None)
+        )
+        RUNPOD_SERVERLESS_ENDPOINT = (
+            # We do expect the specific endpoint to come from kwargs in most cases
+            kwargs.get("runpod_serverless_endpoint")
+            or get_environ_variable(name="RUNPOD_SERVERLESS_ENDPOINT", default="run")
+        )
+        if not RUNPOD_KEY:
+            raise ValueError("RUNPOD_KEY is required to execute the runner on RunPod.")
+        if not RUNPOD_SERVERLESS_ID:
+            raise ValueError("RUNPOD_SERVERLESS_ID is required to execute the runner on RunPod.")
+        if RUNPOD_SERVERLESS_ENDPOINT not in ["run", "runsync"]:
+            # Right now we only support these two endpoints... We might add more in the future.
+            # https://docs.runpod.io/serverless/endpoints/send-requests 
+            raise ValueError("RUNPOD_SERVERLESS_ENDPOINT must be either 'run' or 'runsync'.")
+        target_url = posixpath.join(
+            RUNPOD_URL,
+            RUNPOD_SERVERLESS_ID,
+            RUNPOD_SERVERLESS_ENDPOINT,
+        )
+        headers = {
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {RUNPOD_KEY}",
+            **kwargs.get("headers", {}),
+        }
+        start_event = spec.as_event(drop_id=True)
+        response = requests.post(
+            url=target_url,
+            json=start_event,
+            headers=headers,
+        )
+        return {
+            "target_url": target_url,
+            "spec_created_at": spec.created_at,
+            "status_code": response.status_code,
+            "response": response.json(),
+            "ok": response.ok,
+        }

{fred_oss-0.34.0 → fred_oss-0.36.0}/src/main/fred/worker/runner/plugins/catalog.py

@@ -3,6 +3,7 @@ from dataclasses import dataclass
 
 from fred.settings import logger_manager
 from fred.worker.runner.plugins._local import LocalPlugin
+from fred.worker.runner.plugins._runpod import RunpodPlugin
 
 logger = logger_manager.get_logger(name=__name__)
 
@@ -11,7 +12,7 @@ class PluginCatalog(enum.Enum):
     """Enum for the different plugins available in FRED."""
 
     LOCAL = LocalPlugin
-    RUNPOD = None  # Placeholder for future RunPod plugin
+    RUNPOD = RunpodPlugin
     LAMBDA = None  # Placeholder for future AWS Lambda plugin
 
     def __call__(self, *args, **kwargs):

{fred_oss-0.34.0 → fred_oss-0.36.0}/src/main/fred/worker/runner/plugins/interface.py

@@ -4,7 +4,7 @@ from typing import Optional
 
 from fred.future import Future
 from fred.settings import logger_manager
-from fred.utils.dateops import datetime_utcnow
+from fred.monad.catalog import EitherMonad
 from fred.worker.runner.status import RunnerStatus
 from fred.worker.runner.model._runner_spec import RunnerSpec
 from fred.worker.runner.backend import RunnerBackend
@@ -55,7 +55,7 @@ class PluginInterface:
             self,
             spec: RunnerSpec,
             **kwargs
-        ) -> str:
+        ) -> dict:
         """Wrapper method to handle execution and include error logging.
 
         Since we don't control the implementation of the _execute method in subclasses, we
@@ -66,17 +66,17 @@ class PluginInterface:
             outer_handler (RunnerHandler): The outer handler to use for execution.
             **kwargs: Additional keyword arguments to pass to the execution method implemented by the subclass.
         """
-        runner_id = spec.runner_id
+        response = {"runner_id": spec.runner_id}
         runner_status = self.backend.keyval(
-            key=RunnerStatus.get_key(runner_id=runner_id)
+            key=RunnerStatus.get_key(runner_id=spec.runner_id)
         )
         try:
-            self._execute(spec=spec, **kwargs)
+            response["plugin_output"] = self._execute(spec=spec, **kwargs)
         except Exception as e:
             runner_status.set(RunnerStatus.ERROR.get_val(str(e)))
-            logger.error(f"Error executing runner '{runner_id}': {e}")
+            logger.error(f"Error executing runner '{spec.runner_id}': {e}")
             raise
-        return runner_id
+        return response
     
     def execute(
             self,
@@ -101,7 +101,12 @@ class PluginInterface:
             logger.info(f"Monitoring disabled for runner '{runner_id}'.")
         if wait_for_exec:
             logger.info(f"Waiting for execution of runner '{runner_id}' to complete.")
-            future_exec.wait(timeout=timeout)
+            match future_exec.wait(timeout=timeout):
+                case EitherMonad.Right(value):
+                    logger.info(f"Execution of runner '{runner_id}' completed successfully.")
+                    logger.debug(f"Execution of runner '{runner_id}' output: {value}")
+                case EitherMonad.Left(error):
+                    logger.error(f"Execution of runner '{runner_id}' failed with error: {error}")
         if future_monitor and wait_for_monitor:
             future_monitor.wait(timeout=timeout)
         return PluginExecutionOutput(

{fred_oss-0.34.0 → fred_oss-0.36.0}/src/main/fred/worker/runner/rest/routers/_runner.py

@@ -58,7 +58,7 @@ class RunnerRouterMethods:
         # Instantiate the plugin and execute the runner
         plugin = PluginCatalog[plugin_name.upper()]()
         return {
-            "runner_id": plugin.execute(runner_spec, wait_for_exec=wait_for_exec).runner_id,
+            "runner_id": plugin.execute(runner_spec, wait_for_exec=wait_for_exec, **payload).runner_id,
             "queue_slug": runner_spec.queue_slug,
         }
     

{fred_oss-0.34.0 → fred_oss-0.36.0/src/main/fred_oss.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fred-oss
-Version: 0.34.0
+Version: 0.36.0
 Summary: FREDOSS
 Home-page: https://fred.fahera.mx
 Author: Fahera Research, Education, and Development

{fred_oss-0.34.0 → fred_oss-0.36.0}/src/main/fred_oss.egg-info/SOURCES.txt

@@ -56,7 +56,6 @@ src/main/fred/worker/runner/__init__.py
 src/main/fred/worker/runner/backend.py
 src/main/fred/worker/runner/client.py
 src/main/fred/worker/runner/handler.py
-src/main/fred/worker/runner/info.py
 src/main/fred/worker/runner/settings.py
 src/main/fred/worker/runner/signal.py
 src/main/fred/worker/runner/status.py
@@ -70,6 +69,7 @@ src/main/fred/worker/runner/model/catalog.py
 src/main/fred/worker/runner/model/interface.py
 src/main/fred/worker/runner/plugins/__init__.py
 src/main/fred/worker/runner/plugins/_local.py
+src/main/fred/worker/runner/plugins/_runpod.py
 src/main/fred/worker/runner/plugins/catalog.py
 src/main/fred/worker/runner/plugins/interface.py
 src/main/fred/worker/runner/rest/__init__.py

fred_oss-0.34.0/src/main/fred/version

@@ -1 +0,0 @@
-0.34.0

fred_oss-0.34.0/src/main/fred/worker/runner/info.py

@@ -1,54 +0,0 @@
-import uuid
-from typing import Optional
-from dataclasses import dataclass
-
-from fred.settings import logger_manager
-
-logger = logger_manager.get_logger(name=__name__)
-
-
-@dataclass(frozen=True, slots=True)
-class RunnerInfo:
-    runner_id: str
-    created_at: str
-    runner_inner_handler_classname: str
-    runner_inner_handler_classpath: str
-    lifetime: int
-    timeout: int
-
-    @classmethod
-    def create(
-        cls,
-        runner_inner_handler_classname: str,
-        runner_inner_handler_classpath: str,
-        runner_id: Optional[str] = None,
-        created_at: Optional[str] = None,
-        lifetime: int = 3600,  # Default to 1 hour
-        timeout: int = 10,  # Default to 10 seconds
-    ) -> "RunnerInfo":
-        from fred.utils.dateops import datetime_utcnow
-        return cls(
-            runner_id=runner_id or str(uuid.uuid4()),
-            runner_inner_handler_classname=runner_inner_handler_classname,
-            runner_inner_handler_classpath=runner_inner_handler_classpath,
-            created_at=created_at or datetime_utcnow().isoformat(),
-            lifetime=lifetime,
-            timeout=timeout,
-        )
-
-    def get_start_event(self, **kwargs) -> dict:
-        runner_id = kwargs.pop("runner_id", self.runner_id) 
-        payload = {
-            "lifetime": self.lifetime,
-            "timeout": self.timeout,
-            "runner_configs": {
-                "id": runner_id,
-                "import_pattern": self.runner_inner_handler_classpath,
-                "handler_classname": self.runner_inner_handler_classname,
-            },
-            **kwargs,
-        }
-        return {
-            "input": payload,
-            "id": runner_id,
-        }