Merge branch 'main' into feat/set-function-as-disabled

# Conflicts:
#	gateway/api/views/programs.py

Author: Tansito

charts/qiskit-serverless/Chart.lock

@@ -10,6 +10,6 @@ dependencies:
   version: 13.4.4
 - name: kuberay-operator
   repository: https://ray-project.github.io/kuberay-helm
-  version: 1.1.1
-digest: sha256:66aa676552fc569d63d2433414b9b116c6833f58801ca8de3aa0e4d7e66ace32
-generated: "2025-03-19T18:47:17.196619173Z"
+  version: 1.3.2
+digest: sha256:d874fa990fa2725d03eef12526c082b702b8ebd1eb86089c14323236adb19c8b
+generated: "2025-04-21T15:57:24.067646-04:00"

charts/qiskit-serverless/Chart.yaml

@@ -21,7 +21,7 @@ dependencies:
     repository: https://charts.bitnami.com/bitnami
   - name: kuberay-operator
     condition: kuberayOperatorEnable
-    version: 1.1.1
+    version: 1.3.2
     repository: https://ray-project.github.io/kuberay-helm
 
 maintainers:

charts/qiskit-serverless/values.yaml

@@ -114,7 +114,7 @@ kuberayOperatorEnable: true
 kuberay-operator:
   image:
     repository: quay.io/kuberay/operator
-    tag: v1.1.1
+    tag: v1.3.2
     pullPolicy: IfNotPresent
 
 # ===================

client/qiskit_serverless/__init__.py

@@ -33,6 +33,8 @@
     RayClient,
     LocalClient,
     save_result,
+    update_status,
+    Job,
     Configuration,
     is_running_in_serverless,
     is_trial,

client/qiskit_serverless/core/__init__.py

@@ -57,6 +57,7 @@
 from .job import (
     Job,
     save_result,
+    update_status,
     Configuration,
     is_running_in_serverless,
     is_trial,

client/qiskit_serverless/core/client.py

@@ -37,7 +37,6 @@
     RunService,
 )
 from qiskit_serverless.utils import JsonSerializable
-from qiskit_serverless.visualizaiton import Widget
 
 
 class BaseClient(JobService, RunService, JsonSerializable, ABC):
@@ -191,4 +190,9 @@ def list(self, **kwargs) -> List[RunnableQiskitFunction]:
 
     def widget(self):
         """Widget for information about provider and jobs."""
+        # prevent ciclic import
+        from qiskit_serverless.visualization import (  # pylint: disable=import-outside-toplevel
+            Widget,
+        )
+
         return Widget(self).show()

client/qiskit_serverless/core/clients/serverless_client.py

@@ -310,7 +310,12 @@ def status(self, job_id: str):
             )
         )
 
-        return response_data.get("status", default_status)
+        status = response_data.get("status", default_status)
+        sub_status = response_data.get("sub_status")
+        if status == Job.RUNNING and sub_status is not None:
+            return sub_status
+
+        return status
 
     @_trace_job
     def stop(self, job_id: str, service: Optional[QiskitRuntimeService] = None):

client/qiskit_serverless/core/decorators.py

@@ -467,6 +467,7 @@ def generated_decorator(traced_function: Union[FunctionType, str]):
         def decorator_trace(func: FunctionType):
             """The decorator that python call"""
 
+            @functools.wraps(func)
             def wrapper(*args, **kwargs):
                 """The wrapper"""
                 tracer = trace.get_tracer("client.tracer")
@@ -475,7 +476,7 @@ def wrapper(*args, **kwargs):
                     if isinstance(traced_function, str)
                     else func.__name__
                 )
-                with tracer.start_as_current_span(f"{traced_feature}.${function_name}"):
+                with tracer.start_as_current_span(f"{traced_feature}.{function_name}"):
                     result = func(*args, **kwargs)
                 return result
 

client/qiskit_serverless/core/job.py

@@ -114,6 +114,19 @@ def filtered_logs(self, job_id: str, **kwargs) -> str:
 class Job:
     """Job."""
 
+    PENDING = "PENDING"
+    RUNNING = "RUNNING"
+    STOPPED = "STOPPED"
+    SUCCEEDED = "SUCCEEDED"
+    FAILED = "FAILED"
+    QUEUED = "QUEUED"
+    # RUNNING statuses
+    MAPPING = "MAPPING"
+    OPTIMIZING_HARDWARE = "OPTIMIZING_HARDWARE"
+    WAITING_QPU = "WAITING_QPU"
+    EXECUTING_QPU = "EXECUTING_QPU"
+    POST_PROCESSING = "POST_PROCESSING"
+
     def __init__(
         self,
         job_id: str,
@@ -200,8 +213,8 @@ def result(self, wait=True, cadence=30, verbose=False, maxwait=0):
 
     def in_terminal_state(self) -> bool:
         """Checks if job is in terminal state"""
-        terminal_states = ["CANCELED", "DONE", "ERROR"]
-        return self.status() in terminal_states
+        terminal_status = ["CANCELED", "DONE", "ERROR"]
+        return self.status() in terminal_status
 
     def __repr__(self):
         return f"<Job | {self.job_id}>"
@@ -277,15 +290,55 @@ def save_result(result: Dict[str, Any]):
     return response.ok
 
 
+def update_status(status: str):
+    """Update sub status."""
+
+    version = os.environ.get(ENV_GATEWAY_PROVIDER_VERSION)
+    if version is None:
+        version = GATEWAY_PROVIDER_VERSION_DEFAULT
+
+    token = os.environ.get(ENV_JOB_GATEWAY_TOKEN)
+    if token is None:
+        logging.warning(
+            "'sub_status' cannot be updated since"
+            "there is no information about the"
+            "authorization token in the environment."
+        )
+        return False
+
+    instance = os.environ.get(ENV_JOB_GATEWAY_INSTANCE, None)
+
+    url = (
+        f"{os.environ.get(ENV_JOB_GATEWAY_HOST)}/"
+        f"api/{version}/jobs/{os.environ.get(ENV_JOB_ID_GATEWAY)}/sub_status/"
+    )
+    response = requests.patch(
+        url,
+        data={"sub_status": status},
+        headers=get_headers(token=token, instance=instance),
+        timeout=REQUESTS_TIMEOUT,
+    )
+    if not response.ok:
+        sanitized = response.text.replace("\n", "").replace("\r", "")
+        logging.warning("Something went wrong: %s", sanitized)
+
+    return response.ok
+
+
 def _map_status_to_serverless(status: str) -> str:
     """Map a status string from job client to the Qiskit terminology."""
     status_map = {
-        "PENDING": "INITIALIZING",
-        "RUNNING": "RUNNING",
-        "STOPPED": "CANCELED",
-        "SUCCEEDED": "DONE",
-        "FAILED": "ERROR",
-        "QUEUED": "QUEUED",
+        Job.PENDING: "INITIALIZING",
+        Job.RUNNING: "RUNNING",
+        Job.STOPPED: "CANCELED",
+        Job.SUCCEEDED: "DONE",
+        Job.FAILED: "ERROR",
+        Job.QUEUED: "QUEUED",
+        Job.MAPPING: "RUNNING: MAPPING",
+        Job.OPTIMIZING_HARDWARE: "RUNNING: OPTIMIZING_FOR_HARDWARE",
+        Job.WAITING_QPU: "RUNNING: WAITING_FOR_QPU",
+        Job.EXECUTING_QPU: "RUNNING: EXECUTING_QPU",
+        Job.POST_PROCESSING: "RUNNING: POST_PROCESSING",
     }
 
     try:

client/qiskit_serverless/visualizaiton/__init__.py renamed to client/qiskit_serverless/visualization/__init__.py

@@ -31,6 +31,7 @@
 from IPython.display import display, clear_output
 from ipywidgets import GridspecLayout, widgets, Layout
 
+from qiskit_serverless.core.client import BaseClient
 from qiskit_serverless.exception import QiskitServerlessException
 
 TABLE_STYLE = """
@@ -53,7 +54,7 @@
 class Widget:  # pylint: disable=too-many-instance-attributes
     """Widget for displaying information related to provider."""
 
-    def __init__(self, provider):
+    def __init__(self, provider: BaseClient):
         """Constructor for widget.
 
         Args:
@@ -67,7 +68,7 @@ def __init__(self, provider):
 
         self.job_offset = 0
         self.job_limit = 10
-        self.jobs = self.provider.get_jobs()
+        self.jobs = self.provider.jobs()
 
         self.job_list_view = widgets.Output()
         with self.job_list_view:
@@ -79,7 +80,7 @@ def __init__(self, provider):
 
         self.program_offset = 0
         self.program_limit = 10
-        self.programs = self.provider.get_programs()
+        self.programs = self.provider.functions()
 
         self.program_list_view = widgets.Output()
         with self.program_list_view:
@@ -166,12 +167,12 @@ def render_job_pagination(self):
         def paginate(page_button):
             """Handles pagination callback logic."""
             if page_button.tooltip == "prev":
-                self.jobs = self.provider.get_jobs(
+                self.jobs = self.provider.jobs(
                     limit=self.job_limit, offset=self.job_offset - self.job_limit
                 )
                 self.job_offset = self.job_offset - self.job_limit
             elif page_button.tooltip == "next":
-                self.jobs = self.provider.get_jobs(
+                self.jobs = self.provider.jobs(
                     limit=self.job_limit, offset=self.job_offset + self.job_limit
                 )
                 self.job_offset = self.job_offset + self.job_limit
@@ -219,13 +220,13 @@ def render_program_pagination(self):
         def paginate(page_button):
             """Handles pagination callback logic."""
             if page_button.tooltip == "prev":
-                self.programs = self.provider.get_programs(
+                self.programs = self.provider.functions(
                     limit=self.program_limit,
                     offset=self.program_offset - self.program_limit,
                 )
                 self.job_offset = self.program_offset - self.job_limit
             elif page_button.tooltip == "next":
-                self.jobs = self.provider.get_jobs(
+                self.jobs = self.provider.jobs(
                     limit=self.program_limit,
                     offset=self.program_offset + self.program_limit,
                 )

client/qiskit_serverless/visualizaiton/widget.py renamed to client/qiskit_serverless/visualization/widget.py

@@ -1,8 +1,8 @@
-ray[default,data]>=2.30.0, <2.35.0
+ray[default,data]>=2.30, <3
 requests>=2.32.2, <3
 importlib-metadata>=5.2.0, <9
-qiskit>=1.0.2
-qiskit-ibm-runtime>=0.29.0
+qiskit>=1.4, <3
+qiskit-ibm-runtime>=0.29.0, <1
 # Make sure ray node and notebook node have the same version of cloudpickle
 cloudpickle==2.2.1
 tqdm>=4.66.3, <5

client/requirements.txt

@@ -17,7 +17,12 @@
     ENV_JOB_GATEWAY_TOKEN,
     ENV_ACCESS_TRIAL,
 )
-from qiskit_serverless.core.job import is_running_in_serverless, save_result, is_trial
+from qiskit_serverless.core.job import (
+    is_running_in_serverless,
+    save_result,
+    is_trial,
+    update_status,
+)
 
 
 # pylint: disable=redefined-outer-name
@@ -74,6 +79,14 @@ def test_save_result(self, job_env_variables):
             )
             assert result is True
 
+    @patch("requests.patch", Mock(return_value=ResponseMock()))
+    def test_update_sub_status(self, job_env_variables):
+        """Tests update sub status."""
+        _ = job_env_variables
+
+        result = update_status("MAPPING")
+        assert result is True
+
     @patch("requests.get", Mock(return_value=ResponseMock()))
     def test_filtered_logs(self):
         """Tests job filtered log."""

client/tests/core/test_job.py

@@ -11,7 +11,7 @@
 logger = logging.getLogger("gateway")
 
 
-class JobAccessPolocies:
+class JobAccessPolicies:
     """
     The main objective of this class is to manage the access for the user
     to the Job entities.
@@ -89,3 +89,25 @@ def can_save_result(user: type[AbstractUser], job: Job) -> bool:
                 job.author,
             )
         return has_access
+
+    @staticmethod
+    def can_update_sub_status(user: type[AbstractUser], job: Job) -> bool:
+        """
+        Checks if the user has permissions to update the substatus of a job:
+
+        Args:
+            user: Django user from the request
+            job: Job instance against to check the permission
+
+        Returns:
+            bool: True or False in case the user has permissions
+        """
+
+        has_access = user.id == job.author.id
+        if not has_access:
+            logger.warning(
+                "User [%s] has no access to update the sub_status of the job [%s].",
+                user.username,
+                job.id,
+            )
+        return has_access

gateway/api/access_policies/jobs.py

@@ -0,0 +1,60 @@
+"""
+======================================================
+Decorators (:mod:`gateway.api.decorators.trace_decorator`)
+======================================================
+
+.. currentmodule:: gateway.api.decorators.trace_decorator
+
+Gateway API decorators
+=============================
+
+.. autosummary::
+    :toctree: ../stubs/
+
+    trace_decorator_factory
+"""
+
+from functools import wraps
+from types import FunctionType
+from typing import Union
+from opentelemetry import trace
+from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
+
+
+def trace_decorator_factory(traced_feature: str):
+    """Factory for generate decorators for classes or features."""
+
+    def generated_decorator(traced_function: Union[FunctionType, str]):
+        """
+        The decorator wrapper to generate optional arguments
+        if traced_function is string it will be used in the span,
+        the function.__name__ attribute will be used otherwise
+        """
+
+        def decorator_trace(func: FunctionType):
+            """The decorator that python call"""
+
+            @wraps(func)
+            def wrapper(*args, **kwargs):
+                """The wrapper"""
+                tracer = trace.get_tracer("gateway.tracer")
+                function_name = (
+                    traced_function
+                    if isinstance(traced_function, str)
+                    else func.__name__
+                )
+                request = args[0]
+                ctx = TraceContextTextMapPropagator().extract(carrier=request.headers)
+                with tracer.start_as_current_span(
+                    f"gateway.{traced_feature}.{function_name}", context=ctx
+                ):
+                    result = func(*args, **kwargs)
+                return result
+
+            return wrapper
+
+        if callable(traced_function):
+            return decorator_trace(traced_function)
+        return decorator_trace
+
+    return generated_decorator

gateway/api/decorators/__init__.py

@@ -24,7 +24,7 @@ def handle(self, *args, **options):
 
         for compute_resource in compute_resources:
             alive_jobs = Job.objects.filter(
-                status__in=Job.RUNNING_STATES, compute_resource=compute_resource
+                status__in=Job.RUNNING_STATUSES, compute_resource=compute_resource
             )
 
             # only kill cluster if not in local mode and no jobs are running there