diracx-db 0.0.1a33__tar.gz → 0.0.1a35__tar.gz

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diracx-db
-Version: 0.0.1a33
+Version: 0.0.1a35
 Summary: TODO
 License: GPL-3.0-only
 Classifier: Intended Audience :: Science/Research

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/src/diracx/db/os/job_parameters.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from DIRAC.Core.Utilities import TimeUtilities
+
 from diracx.db.os.utils import BaseOSDB
 
 
@@ -18,8 +20,17 @@ class JobParametersDB(BaseOSDB):
         "Status": {"type": "keyword"},
         "JobType": {"type": "keyword"},
     }
-    index_prefix = "mysetup_elasticjobparameters_index_"
+    # TODO: Does this need to be configurable?
+    index_prefix = "job_parameters"
+
+    def index_name(self, vo, doc_id: int) -> str:
+        split = int(int(doc_id) // 1e6)
+        return f"{self.index_prefix}_{vo}_{split}m"
 
-    def index_name(self, doc_id: int) -> str:
-        # TODO: Remove setup and replace "123.0m" with "120m"?
-        return f"{self.index_prefix}_{doc_id // 1e6:.1f}m"
+    def upsert(self, vo, doc_id, document):
+        document = {
+            "JobID": doc_id,
+            "timestamp": TimeUtilities.toEpochMilliSeconds(),
+            **document,
+        }
+        return super().upsert(vo, doc_id, document)

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/src/diracx/db/os/utils.py

@@ -77,7 +77,7 @@ class BaseOSDB(metaclass=ABCMeta):
     index_prefix: str
 
     @abstractmethod
-    def index_name(self, doc_id: int) -> str: ...
+    def index_name(self, vo: str, doc_id: int) -> str: ...
 
     def __init__(self, connection_kwargs: dict[str, Any]) -> None:
         self._client: AsyncOpenSearch | None = None
@@ -182,15 +182,20 @@ class BaseOSDB(metaclass=ABCMeta):
         )
         assert result["acknowledged"]
 
-    async def upsert(self, doc_id, document) -> None:
-        # TODO: Implement properly
+    async def upsert(self, vo: str, doc_id: int, document: Any) -> None:
+        index_name = self.index_name(vo, doc_id)
         response = await self.client.update(
-            index=self.index_name(doc_id),
+            index=index_name,
             id=doc_id,
             body={"doc": document, "doc_as_upsert": True},
             params=dict(retry_on_conflict=10),
         )
-        print(f"{response=}")
+        logger.debug(
+            "Upserted document %s in index %s with response: %s",
+            doc_id,
+            index_name,
+            response,
+        )
 
     async def search(
         self, parameters, search, sorts, *, per_page: int = 100, page: int | None = None

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/src/diracx/db/sql/job/db.py

@@ -1,7 +1,9 @@
 from __future__ import annotations
 
+__all__ = ["JobDB"]
+
 from datetime import datetime, timezone
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, Iterable
 
 from sqlalchemy import bindparam, case, delete, func, insert, select, update
 
@@ -9,13 +11,12 @@ if TYPE_CHECKING:
     from sqlalchemy.sql.elements import BindParameter
 
 from diracx.core.exceptions import InvalidQueryError
-from diracx.core.models import (
-    SearchSpec,
-    SortSpec,
-)
+from diracx.core.models import JobCommand, SearchSpec, SortSpec
 
 from ..utils import BaseSQLDB, apply_search_filters, apply_sort_constraints
+from ..utils.functions import utcnow
 from .schema import (
+    HeartBeatLoggingInfo,
     InputData,
     JobCommands,
     JobDBBase,
@@ -38,6 +39,16 @@ def _get_columns(table, parameters):
 class JobDB(BaseSQLDB):
     metadata = JobDBBase.metadata
 
+    # Field names which should be stored in the HeartBeatLoggingInfo table
+    heartbeat_fields = {
+        "LoadAverage",
+        "MemoryUsed",
+        "Vsize",
+        "AvailableDiskSpace",
+        "CPUConsumed",
+        "WallClockTime",
+    }
+
     # TODO: this is copied from the DIRAC JobDB
     # but is overwriten in LHCbDIRAC, so we need
     # to find a way to make it dynamic
@@ -156,6 +167,24 @@ class JobDB(BaseSQLDB):
             ],
         )
 
+    @staticmethod
+    def _set_job_attributes_fix_value(column, value):
+        """Apply corrections to the values before inserting them into the database.
+
+        TODO: Move this logic into the sqlalchemy model.
+        """
+        if column == "VerifiedFlag":
+            value_str = str(value)
+            if value_str in ("True", "False"):
+                return value_str
+        if column == "AccountedFlag":
+            value_str = str(value)
+            if value_str in ("True", "False", "Failed"):
+                return value_str
+        else:
+            return value
+        raise NotImplementedError(f"Unrecognized value for column {column}: {value}")
+
     async def set_job_attributes(self, job_data):
         """Update the parameters of the given jobs."""
         # TODO: add myDate and force parameters.
@@ -168,7 +197,10 @@ class JobDB(BaseSQLDB):
         case_expressions = {
             column: case(
                 *[
-                    (Jobs.__table__.c.JobID == job_id, attrs[column])
+                    (
+                        Jobs.__table__.c.JobID == job_id,
+                        self._set_job_attributes_fix_value(column, attrs[column]),
+                    )
                     for job_id, attrs in job_data.items()
                     if column in attrs
                 ],
@@ -197,7 +229,7 @@ class JobDB(BaseSQLDB):
 
         return {jobid: jdl for jobid, jdl in (await self.conn.execute(stmt)) if jdl}
 
-    async def set_job_commands(self, commands: list[tuple[int, str, str]]):
+    async def set_job_commands(self, commands: list[tuple[int, str, str]]) -> None:
         """Store a command to be passed to the job together with the next heart beat."""
         await self.conn.execute(
             insert(JobCommands),
@@ -246,3 +278,58 @@ class JobDB(BaseSQLDB):
         rows = await self.conn.execute(stmt, update_parameters)
 
         return rows.rowcount
+
+    async def add_heartbeat_data(
+        self, job_id: int, dynamic_data: dict[str, str]
+    ) -> None:
+        """Add the job's heartbeat data to the database.
+
+        NOTE: This does not update the HeartBeatTime column in the Jobs table.
+        This is instead handled by the `diracx.logic.jobs.status.set_job_statuses`
+        as it involves updating multiple databases.
+
+        :param job_id: the job id
+        :param dynamic_data: mapping of the dynamic data to store,
+            e.g. {"AvailableDiskSpace": 123}
+        """
+        if extra_fields := set(dynamic_data) - self.heartbeat_fields:
+            raise InvalidQueryError(
+                f"Not allowed to store heartbeat data for: {extra_fields}. "
+                f"Allowed keys are: {self.heartbeat_fields}"
+            )
+        values = [
+            {
+                "JobID": job_id,
+                "Name": key,
+                "Value": value,
+                "HeartBeatTime": utcnow(),
+            }
+            for key, value in dynamic_data.items()
+        ]
+        await self.conn.execute(HeartBeatLoggingInfo.__table__.insert().values(values))
+
+    async def get_job_commands(self, job_ids: Iterable[int]) -> list[JobCommand]:
+        """Get a command to be passed to the job together with the next heartbeat.
+
+        :param job_ids: the job ids
+        :return: mapping of job id to list of commands
+        """
+        # Get the commands
+        stmt = (
+            select(JobCommands.job_id, JobCommands.command, JobCommands.arguments)
+            .where(JobCommands.job_id.in_(job_ids), JobCommands.status == "Received")
+            .order_by(JobCommands.job_id)
+        )
+        commands = await self.conn.execute(stmt)
+        # Update the status of the commands
+        stmt = (
+            update(JobCommands)
+            .where(JobCommands.job_id.in_(job_ids))
+            .values(Status="Sent")
+        )
+        await self.conn.execute(stmt)
+        # Return the commands grouped by job id
+        return [
+            JobCommand(job_id=cmd.JobID, command=cmd.Command, arguments=cmd.Arguments)
+            for cmd in commands
+        ]

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/src/diracx/db/sql/job/schema.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
+import sqlalchemy.types as types
 from sqlalchemy import (
     DateTime,
-    Enum,
     ForeignKey,
     Index,
     Integer,
@@ -16,6 +16,36 @@ from ..utils import Column, EnumBackedBool, NullColumn
 JobDBBase = declarative_base()
 
 
+class AccountedFlagEnum(types.TypeDecorator):
+    """Maps a ``AccountedFlagEnum()`` column to True/False in Python."""
+
+    impl = types.Enum
+    cache_ok: bool = True
+
+    def __init__(self) -> None:
+        super().__init__("True", "False", "Failed")
+
+    def process_bind_param(self, value, dialect) -> str:
+        if value is True:
+            return "True"
+        elif value is False:
+            return "False"
+        elif value == "Failed":
+            return "Failed"
+        else:
+            raise NotImplementedError(value, dialect)
+
+    def process_result_value(self, value, dialect) -> bool | str:
+        if value == "True":
+            return True
+        elif value == "False":
+            return False
+        elif value == "Failed":
+            return "Failed"
+        else:
+            raise NotImplementedError(f"Unknown {value=}")
+
+
 class Jobs(JobDBBase):
     __tablename__ = "Jobs"
 
@@ -45,10 +75,7 @@ class Jobs(JobDBBase):
     user_priority = Column("UserPriority", Integer, default=0)
     reschedule_counter = Column("RescheduleCounter", Integer, default=0)
     verified_flag = Column("VerifiedFlag", EnumBackedBool(), default=False)
-    # TODO: Should this be True/False/"Failed"? Or True/False/Null?
-    accounted_flag = Column(
-        "AccountedFlag", Enum("True", "False", "Failed"), default="False"
-    )
+    accounted_flag = Column("AccountedFlag", AccountedFlagEnum(), default=False)
 
     __table_args__ = (
         Index("JobType", "JobType"),

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/src/diracx_db.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diracx-db
-Version: 0.0.1a33
+Version: 0.0.1a35
 Summary: TODO
 License: GPL-3.0-only
 Classifier: Intended Audience :: Science/Research

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/tests/opensearch/test_index_template.py

@@ -31,15 +31,16 @@ async def dummy_opensearch_db_without_template(dummy_opensearch_db: DummyOSDB):
 
 
 async def _get_test_index_mappings(dummy_opensearch_db: DummyOSDB):
+    vo = "dummyvo"
     document_id = 1
-    index_name = dummy_opensearch_db.index_name(document_id)
+    index_name = dummy_opensearch_db.index_name(vo, document_id)
 
     # At this point the index should not exist yet
     with pytest.raises(opensearchpy.exceptions.NotFoundError):
         await dummy_opensearch_db.client.indices.get_mapping(index_name)
 
     # Insert document which will automatically create the index based on the template
-    await dummy_opensearch_db.upsert(document_id, DUMMY_DOCUMENT)
+    await dummy_opensearch_db.upsert(vo, document_id, DUMMY_DOCUMENT)
 
     # Ensure the result looks as expected and return the mappings
     index_mapping = await dummy_opensearch_db.client.indices.get_mapping(index_name)

{diracx_db-0.0.1a33 → diracx_db-0.0.1a35}/tests/opensearch/test_search.py

@@ -104,9 +104,9 @@ async def prefilled_db(request):
     """Fill the database with dummy records for testing."""
     impl = request.param
     async with resolve_fixtures_hack(request, impl) as dummy_opensearch_db:
-        await dummy_opensearch_db.upsert(798811211, DOC1)
-        await dummy_opensearch_db.upsert(998811211, DOC2)
-        await dummy_opensearch_db.upsert(798811212, DOC3)
+        await dummy_opensearch_db.upsert("dummyvo", 798811211, DOC1)
+        await dummy_opensearch_db.upsert("dummyvo", 998811211, DOC2)
+        await dummy_opensearch_db.upsert("dummyvo", 798811212, DOC3)
 
         # Force a refresh to make sure the documents are available
         if not impl == "sql_opensearch_db":