v2.13.1 (#1418)

antarest/__init__.py

@@ -7,9 +7,9 @@
 
 # Standard project metadata
 
-__version__ = "2.13.0"
+__version__ = "2.13.1"
 __author__ = "RTE, Antares Web Team"
-__date__ = "2023-03-09"
+__date__ = "2023-04-11"
 # noinspection SpellCheckingInspection
 __credits__ = "(c) Réseau de Transport de l’Électricité (RTE)"
 

antarest/core/core_blueprint.py

@@ -1,39 +1,26 @@
 import logging
-import subprocess
-from pathlib import Path
-from typing import Any, Optional
+from typing import Any
 
-from fastapi import APIRouter, Depends
-from pydantic import BaseModel
-
-from antarest import __version__
 from antarest.core.config import Config
 from antarest.core.jwt import JWTUser
 from antarest.core.requests import UserHasNotPermissionError
-from antarest.core.utils.utils import get_commit_id
 from antarest.core.utils.web import APITag
+from antarest.core.version_info import VersionInfoDTO, get_commit_id
 from antarest.login.auth import Auth
+from fastapi import APIRouter, Depends
+from pydantic import BaseModel
 
 
 class StatusDTO(BaseModel):
     status: str
 
 
-class VersionDTO(BaseModel):
-    version: str
-    gitcommit: Optional[str]
-
-
 def create_utils_routes(config: Config) -> APIRouter:
     """
     Utility endpoints
 
     Args:
-        storage_service: study service facade to handle request
         config: main server configuration
-
-    Returns:
-
     """
     bp = APIRouter()
     auth = Auth(config)
@@ -46,11 +33,24 @@ def health() -> Any:
         "/version",
         tags=[APITag.misc],
         summary="Get application version",
-        response_model=VersionDTO,
+        response_model=VersionInfoDTO,
     )
-    def version() -> Any:
-        return VersionDTO(
-            version=__version__, gitcommit=get_commit_id(config.resources_path)
+    def version_info() -> Any:
+        """
+        Returns the current version of the application, along with relevant dependency information.
+
+        - `version`: The current version of the application.
+        - `gitcommit`: The commit ID of the current version's Git repository.
+        - `dependencies`: A dictionary of dependencies, where the key is
+          the dependency name and the value is its version number.
+        """
+        from antareslauncher import __version__ as antares_launcher_version
+        from antarest import __version__ as antarest_version
+
+        return VersionInfoDTO(
+            version=antarest_version,
+            gitcommit=get_commit_id(config.resources_path),
+            dependencies={"Antares_Launcher": antares_launcher_version},
         )
 
     @bp.get("/kill", include_in_schema=False)

antarest/core/logging/utils.py

@@ -1,21 +1,18 @@
 import logging
 import logging.config
-import os
 import re
 import uuid
-from pythonjsonlogger.jsonlogger import JsonFormatter
 from contextvars import ContextVar, Token
-from typing import Optional, Type, Any, Dict
+from typing import Any, Dict, Optional, Type
 
+from antarest.core.config import Config
 from starlette.middleware.base import (
     BaseHTTPMiddleware,
     RequestResponseEndpoint,
 )
 from starlette.requests import Request
 from starlette.responses import Response
 
-from antarest.core.config import Config
-
 _request: ContextVar[Optional[Request]] = ContextVar("_request", default=None)
 _request_id: ContextVar[Optional[str]] = ContextVar(
     "_request_id", default=None
@@ -41,11 +38,29 @@ def configure_logger(config: Config) -> None:
         "formatters": {
             "console": {
                 "class": "antarest.core.logging.utils.CustomDefaultFormatter",
-                "format": "%(asctime)s - %(trace_id)s - %(threadName)s - %(name)s - %(ip)s - %(user)s - %(pid)s - %(levelname)s - %(message)s",
+                "format": (
+                    "[%(asctime)s] [%(process)s] [%(name)s]"
+                    " - %(trace_id)s"
+                    " - %(threadName)s"
+                    " - %(ip)s"
+                    " - %(user)s"
+                    " - %(levelname)s"
+                    " - %(message)s"
+                ),
             },
             "json": {
-                "class": f"{JsonFormatter.__module__}.{JsonFormatter.__name__}",
-                "format": "%(asctime)s - %(trace_id)s - %(threadName)s - %(name)s - %(ip)s - %(user)s - %(pid)s - %(levelname)s - %(message)s",
+                "class": "pythonjsonlogger.jsonlogger.JsonFormatter",
+                "format": (
+                    "%(asctime)s"
+                    " - %(process)s"
+                    " - %(name)s"
+                    " - %(trace_id)s"
+                    " - %(threadName)s"
+                    " - %(ip)s"
+                    " - %(user)s"
+                    " - %(levelname)s"
+                    " - %(message)s"
+                ),
             },
         },
         "handlers": {
@@ -110,9 +125,8 @@ def filter(self, record: logging.LogRecord) -> bool:
         request: Optional[Request] = _request.get()
         request_id: Optional[str] = _request_id.get()
         if request is not None:
-            record.ip = request.scope.get("client", ("undefined"))[0]
+            record.ip = request.scope.get("client", "undefined")[0]
         record.trace_id = request_id
-        record.pid = os.getpid()
         return True
 
 

antarest/core/utils/utils.py

@@ -1,37 +1,17 @@
 import logging
 import os
 import shutil
-import subprocess
 import tempfile
 import time
 from glob import escape
 from pathlib import Path
-from typing import (
-    IO,
-    Any,
-    Optional,
-    Callable,
-    TypeVar,
-    List,
-    Union,
-    Awaitable,
-    Tuple,
-)
-from zipfile import (
-    ZipFile,
-    BadZipFile,
-    ZIP_STORED,
-    ZIP_DEFLATED,
-    ZIP_BZIP2,
-    ZIP_LZMA,
-)
+from typing import IO, Any, Callable, List, Optional, Tuple, TypeVar
+from zipfile import ZIP_DEFLATED, BadZipFile, ZipFile
 
 import redis
-
 from antarest.core.config import RedisConfig
 from antarest.core.exceptions import BadZipBinary, ShouldNotHappenException
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -105,28 +85,6 @@ def get_local_path() -> Path:
     return filepath
 
 
-def get_commit_id(path_resources: Path) -> Optional[str]:
-    commit_id = None
-
-    path_commit_id = path_resources / "commit_id"
-    if path_commit_id.exists():
-        commit_id = path_commit_id.read_text()[:-1]
-    else:
-        command = "git log -1 HEAD --format=%H"
-        process = subprocess.run(command, stdout=subprocess.PIPE, shell=True)
-        if process.returncode == 0:
-            commit_id = process.stdout.decode("utf-8")
-
-    if commit_id is not None:
-
-        def remove_carriage_return(value: str) -> str:
-            return value[:-1]
-
-        commit_id = remove_carriage_return(commit_id)
-
-    return commit_id
-
-
 def new_redis_instance(config: RedisConfig) -> redis.Redis:  # type: ignore
     redis_client = redis.Redis(
         host=config.host,

antarest/core/version_info.py

@@ -0,0 +1,45 @@
+"""
+Python module that is dedicated to printing application version and dependencies information
+"""
+import subprocess
+from pathlib import Path
+from typing import Dict, Optional
+
+from pydantic import BaseModel
+
+
+class VersionInfoDTO(BaseModel):
+    name: str = "AntaREST"
+    version: str
+    gitcommit: str
+    dependencies: Dict[str, str]
+
+
+def get_commit_id(resources_dir: Path) -> str:
+    """
+    Returns the contents of the file :file:`resources/commit_id`
+    if it exists and is not empty, or the commit ID of the current Git HEAD, if available.
+    If neither the commit ID nor the file is available, returns "".
+
+    Note:
+        The :file:`commit_id` is generated during the "deploy" stage
+        in the :file:`.github/workflows/deploy.yml` GitHub workflow.
+
+    Args:
+        resources_dir: The path to the ``resources`` directory.
+
+    Returns:
+        The contents of the file :file:`resources/commit_id`,
+        the commit ID of the current Git HEAD, or "".
+    """
+    path_commit_id = resources_dir.joinpath("commit_id")
+    try:
+        return path_commit_id.read_text(encoding="utf-8").strip()
+    except FileNotFoundError:
+        command = "git log -1 HEAD --format=%H"
+        try:
+            return subprocess.check_output(
+                command, encoding="utf-8", shell=True
+            ).strip()
+        except (subprocess.CalledProcessError, FileNotFoundError):
+            return ""

antarest/eventbus/business/redis_eventbus.py

@@ -35,8 +35,8 @@ def get_events(self) -> List[Event]:
             event = self.pubsub.get_message(ignore_subscribe_messages=True)
             if event is not None:
                 return [Event.parse_raw(event["data"])]
-        except Exception as e:
-            logger.error("Failed to retrieve or parse event !", exc_info=e)
+        except Exception:
+            logger.error("Failed to retrieve or parse event !", exc_info=True)
 
         return []