girder-worker 5.0.14.dev4__tar.gz → 5.0.14.dev12__tar.gz

{girder_worker-5.0.14.dev4 → girder_worker-5.0.14.dev12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder-worker
-Version: 5.0.14.dev4
+Version: 5.0.14.dev12
 Summary: Batch execution engine built on celery.
 Home-page: https://github.com/girder/girder_worker
 Author: Kitware, Inc.

{girder_worker-5.0.14.dev4 → girder_worker-5.0.14.dev12}/girder_worker/app.py

@@ -13,7 +13,8 @@ from girder_worker.context import get_context
 from girder_worker.entrypoint import discover_tasks
 from girder_worker.task import Task
 from girder_worker.utils import (JobSpecNotFound, JobStatus, StateTransitionException, _job_manager,
-                                 _update_status, is_builtin_celery_task, is_revoked)
+                                 _update_status, apply_girder_api_url_override,
+                                 is_builtin_celery_task, is_revoked)
 from girder_worker.utils.transform import ResultTransform
 from kombu.serialization import register
 
@@ -90,7 +91,7 @@ def gw_task_prerun(task=None, sender=None, task_id=None,
                    args=None, kwargs=None, **rest):
     """Deserialize the jobInfoSpec passed in through the headers.
 
-    This provides the a JobManager class as an attribute of the
+    This provides the JobManager class as an attribute of the
     task before task execution.  decorated functions may bind to
     their task and have access to the job_manager for logging and
     updating their status in girder.
@@ -98,6 +99,10 @@ def gw_task_prerun(task=None, sender=None, task_id=None,
     if is_builtin_celery_task(sender.name):
         return
 
+    # Allow each worker to override the API URL attached at schedule time so
+    # callbacks use a URL reachable from this worker's network context.
+    apply_girder_api_url_override(task.request)
+
     try:
         task.job_manager = _job_manager(task.request, task.request.headers)
         _update_status(task, JobStatus.RUNNING)

{girder_worker-5.0.14.dev4 → girder_worker-5.0.14.dev12}/girder_worker/context/nongirder_context.py

@@ -4,7 +4,7 @@ import requests
 from celery import current_app
 from girder_client import GirderClient
 from girder_worker import logger
-from girder_worker.utils import _maybe_model_repr, _walk_obj
+from girder_worker.utils import _maybe_model_repr, _walk_obj, resolve_girder_api_url
 
 
 class MissingJobArguments(RuntimeError):
@@ -33,7 +33,8 @@ def create_task_job(job_defaults, sender=None, body=None,
         if 'id' not in headers:
             raise MissingJobArguments('id is not in headers')
 
-        gc = GirderClient(apiUrl=parent_task.request.girder_api_url)
+        api_url = resolve_girder_api_url(parent_task.request.girder_api_url)
+        gc = GirderClient(apiUrl=api_url)
         gc.token = parent_task.request.girder_client_token
 
         task_args = tuple(_walk_obj(body[0], _maybe_model_repr))
@@ -80,7 +81,8 @@ def attach_girder_api_url(sender=None, body=None, exchange=None,
         if not hasattr(parent_task.request, 'girder_api_url'):
             raise MissingJobArguments(
                 "Parent task's request does not contain girder_api_url")
-        headers['girder_api_url'] = parent_task.request.girder_api_url
+        headers['girder_api_url'] = resolve_girder_api_url(
+            parent_task.request.girder_api_url)
     except MissingJobArguments as e:
         logger.warning(f'Could not get girder_api_url from parent task: {str(e)}')
 

{girder_worker-5.0.14.dev4 → girder_worker-5.0.14.dev12}/girder_worker/utils/__init__.py

@@ -1,10 +1,12 @@
 import importlib.metadata
+import os
 import time
 
 import requests
 # Disable urllib3 warnings about certificate validation. As they are printed in the console, the
 # messages are sent to Girder, creating an infinite loop.
 import urllib3
+from girder_worker import logger
 from requests import HTTPError
 
 from .tee import Tee, tee_stderr, tee_stdout
@@ -17,6 +19,96 @@ except importlib.metadata.PackageNotFoundError:
     # package is not installed
     pass
 
+# Per-worker override for the Girder API URL used when calling back to the server.
+# When set, this takes precedence over the girder_api_url header attached at schedule time.
+GIRDER_WORKER_API_URL_ENV = 'GIRDER_WORKER_API_URL'
+
+
+def resolve_girder_api_url(api_url=None):
+    """Resolve the Girder API URL, preferring a per-worker environment override.
+
+    When a job is scheduled, the Girder server attaches a ``girder_api_url`` header
+    based on its own view of the API root. Workers that run in a different network
+    context (for example inside Docker, or on a remote host) can set
+    ``GIRDER_WORKER_API_URL`` so callbacks use a URL reachable from that worker
+    instead of the URL provided by the scheduling server.
+
+    Called with no argument (or ``None``), this returns the override value alone,
+    or ``None`` if the environment variable is unset.
+
+    :param api_url: The API URL from the task headers / scheduling server.
+    :type api_url: str or None
+    :returns: The override URL if ``GIRDER_WORKER_API_URL`` is set, otherwise
+        ``api_url``.
+    :rtype: str or None
+    """
+    return os.environ.get(GIRDER_WORKER_API_URL_ENV) or api_url
+
+
+def rewrite_url_api_base(url, original_api_url, new_api_url):
+    """Rewrite a URL that starts with ``original_api_url`` to use ``new_api_url``.
+
+    Used to update embedded job callback URLs (for example in ``jobInfoSpec``)
+    when a worker overrides the Girder API base URL.
+
+    :param url: A full URL that may begin with ``original_api_url``.
+    :type url: str or None
+    :param original_api_url: The API base URL originally embedded in ``url``.
+    :type original_api_url: str or None
+    :param new_api_url: The API base URL that should replace ``original_api_url``.
+    :type new_api_url: str or None
+    :returns: The rewritten URL, or ``url`` unchanged if a rewrite is not possible.
+        When ``url`` and ``new_api_url`` are set but ``original_api_url`` is
+        missing, a warning is logged and ``url`` is returned unchanged.
+    :rtype: str or None
+    """
+    if not url or not new_api_url:
+        return url
+    if not original_api_url:
+        logger.warning(
+            'Cannot rewrite API URL %r to %r because the original API base URL '
+            'is missing; leaving the URL unchanged.',
+            url, new_api_url)
+        return url
+    original = original_api_url.rstrip('/')
+    replacement = new_api_url.rstrip('/')
+    if url.startswith(original):
+        return replacement + url[len(original):]
+    return url
+
+
+def apply_girder_api_url_override(request):
+    """Apply ``GIRDER_WORKER_API_URL`` to a Celery task request in place.
+
+    Updates ``girder_api_url`` (and legacy ``apiUrl`` when present) on the request,
+    and rewrites the ``jobInfoSpec`` callback URL so job status/log updates use the
+    overridden API base.
+
+    :param request: The Celery task request / context object.
+    :returns: The resolved API URL after applying any override, or ``None``.
+    :rtype: str or None
+    """
+    original_api_url = getattr(request, 'girder_api_url', None)
+    if original_api_url is None:
+        original_api_url = getattr(request, 'apiUrl', None)
+
+    override = resolve_girder_api_url()
+    if not override:
+        return original_api_url
+
+    if hasattr(request, 'jobInfoSpec') and request.jobInfoSpec:
+        jobSpec = dict(request.jobInfoSpec)
+        if 'url' in jobSpec:
+            jobSpec['url'] = rewrite_url_api_base(
+                jobSpec['url'], original_api_url, override)
+            request.jobInfoSpec = jobSpec
+
+    request.girder_api_url = override
+    if hasattr(request, 'apiUrl'):
+        request.apiUrl = override
+
+    return override
+
 
 def _walk_obj(obj, func, leaf_condition=None):
     """Walk through a nested object applying func to each leaf element.
@@ -135,6 +227,20 @@ def _job_manager(request=None, headers=None, kwargs=None):
     else:
         raise JobSpecNotFound
 
+    override = resolve_girder_api_url()
+    if override:
+        original = None
+        if request is not None:
+            original = getattr(request, 'girder_api_url', None)
+            if original is None:
+                original = getattr(request, 'apiUrl', None)
+        if original is None and headers is not None:
+            original = headers.get('girder_api_url') or headers.get('apiUrl')
+        jobSpec = dict(jobSpec)
+        if 'url' in jobSpec:
+            jobSpec['url'] = rewrite_url_api_base(
+                jobSpec['url'], original, override)
+
     return deserialize_job_info_spec(
         **jobSpec, girder_client_session_kwargs=girder_client_session_kwargs)
 

{girder_worker-5.0.14.dev4 → girder_worker-5.0.14.dev12}/girder_worker.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: girder-worker
-Version: 5.0.14.dev4
+Version: 5.0.14.dev12
 Summary: Batch execution engine built on celery.
 Home-page: https://github.com/girder/girder_worker
 Author: Kitware, Inc.

girder_worker-5.0.14.dev12/girder_worker.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "5.0.13",
+  "distance": 12,
+  "node": "g94cb701e241e311f3afe273c7706c9028705874a",
+  "dirty": false,
+  "branch": "master",
+  "node_date": "2026-07-28"
+}

girder_worker-5.0.14.dev4/girder_worker.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "5.0.13",
-  "distance": 4,
-  "node": "g46b9cfc7cff19f54aca35ba2ebbd2dd2be71d1a6",
-  "dirty": false,
-  "branch": "master",
-  "node_date": "2026-07-23"
-}