logdetective 2.7.0__py3-none-any.whl → 2.9.0__py3-none-any.whl

logdetective/server/compressors.py

@@ -36,20 +36,17 @@ class TextCompressor:
         zip_buffer.seek(0)
         return zip_buffer.getvalue()
 
-    def unzip(self, zip_data: Union[bytes, io.BytesIO]) -> str:
+    def unzip(self, zip_data: bytes) -> Dict[str, str]:
         """
         Uncompress data created by TextCompressor.zip().
 
         Args:
-            zip_data: A zipped stream of bytes or BytesIO object
+            zip_data: A zipped stream of bytes
 
         Returns:
             {file_name: str}: The decompressed content as a dict of file names and UTF-8 strings
         """
-        if isinstance(zip_data, bytes):
-            zip_buffer = io.BytesIO(zip_data)
-        else:
-            zip_buffer = zip_data
+        zip_buffer = io.BytesIO(zip_data)
 
         content = {}
         with zipfile.ZipFile(zip_buffer, "r") as zip_file:
@@ -95,12 +92,12 @@ class RemoteLogCompressor:
         return self.zip_text(content_text)
 
     @classmethod
-    def unzip(cls, zip_data: Union[bytes, io.BytesIO]) -> str:
+    def unzip(cls, zip_data: bytes) -> str:
         """
         Uncompress the zipped content of the remote log.
 
         Args:
-            zip_data: Compressed data as bytes or BytesIO
+            zip_data: Compressed data as bytes
 
         Returns:
             str: The decompressed log content
@@ -147,13 +144,13 @@ class LLMResponseCompressor:
 
     @classmethod
     def unzip(
-        cls, zip_data: Union[bytes, io.BytesIO]
+        cls, zip_data: bytes
     ) -> Union[StagedResponse, Response]:
         """
         Uncompress the zipped content of the LLM response.
 
         Args:
-            zip_data: Compressed data as bytes or BytesIO
+            zip_data: Compressed data as bytes
 
         Returns:
             Union[StagedResponse, Response]: The decompressed (partial) response object,

logdetective/server/database/models/exceptions.py

@@ -11,3 +11,7 @@ class KojiTaskNotAnalyzedError(Exception):
 
 class KojiTaskAnalysisTimeoutError(Exception):
     """Exception raised when a koji task analysis has timed out"""
+
+
+class AnalyzeRequestMetricsNotFroundError(Exception):
+    """Exception raised when AnalyzeRequestMetrics is not found"""

logdetective/server/database/models/koji.py

@@ -15,6 +15,7 @@ from logdetective.server.database.models.exceptions import (
     KojiTaskNotFoundError,
     KojiTaskNotAnalyzedError,
     KojiTaskAnalysisTimeoutError,
+    AnalyzeRequestMetricsNotFroundError,
 )
 from logdetective.server.models import KojiStagedResponse
 
@@ -86,6 +87,9 @@ class KojiTaskAnalysis(Base):
         async with transaction(commit=True) as session:
             query_result = await session.execute(query)
             koji_task_analysis = query_result.scalars().first()
+            if not koji_task_analysis:
+                raise AnalyzeRequestMetricsNotFroundError(
+                    f"No AnalyzeRequestMetrics record found for id {metric_id}")
             # Ensure that the task analysis doesn't already have a response
             if koji_task_analysis.response:
                 # This is probably due to an analysis that took so long that

logdetective/server/database/models/metrics.py

@@ -1,5 +1,4 @@
 from __future__ import annotations
-import io
 import enum
 import datetime
 from typing import Optional, List, Self, Tuple, TYPE_CHECKING
@@ -107,7 +106,7 @@ class AnalyzeRequestMetrics(Base):
     async def create(
         cls,
         endpoint: EndpointType,
-        compressed_log: io.BytesIO,
+        compressed_log: bytes,
         request_received_at: Optional[datetime.datetime] = None,
     ) -> int:
         """Create AnalyzeRequestMetrics new line

logdetective/server/emoji.py

@@ -42,6 +42,10 @@ async def collect_emojis_for_mr(
     mr_jobs = await GitlabMergeRequestJobs.get_by_mr_iid(url, project_id, mr_iid) or []
 
     comments = [await Comments.get_by_mr_job(mr_job) for mr_job in mr_jobs]
+    # Filter all cases when no comments were found. This shouldn't happen if the database
+    # is in good order. But checking for it can't hurt.
+    comments = [comment for comment in comments if isinstance(comment, Comments)]
+
     await collect_emojis_in_comments(comments, gitlab_conn)
 
 

logdetective/server/exceptions.py

@@ -31,3 +31,7 @@ class LogDetectiveConnectionError(LogDetectiveKojiException):
 
 class LogsTooLargeError(LogDetectiveKojiException):
     """The log archive exceeds the configured maximum size"""
+
+
+class LogDetectiveMetricsError(LogDetectiveException):
+    """Exception was encountered while recording metrics"""

logdetective/server/metric.py

@@ -1,4 +1,3 @@
-import io
 import inspect
 import datetime
 
@@ -13,14 +12,15 @@ from logdetective.remote_log import RemoteLog
 from logdetective.server.config import LOG
 from logdetective.server.compressors import LLMResponseCompressor, RemoteLogCompressor
 from logdetective.server.database.models import EndpointType, AnalyzeRequestMetrics
+from logdetective.server.exceptions import LogDetectiveMetricsError
 
 
 async def add_new_metrics(
-    api_name: str,
+    api_name: EndpointType,
     url: Optional[str] = None,
     http_session: Optional[aiohttp.ClientSession] = None,
     received_at: Optional[datetime.datetime] = None,
-    compressed_log_content: Optional[io.BytesIO] = None,
+    compressed_log_content: Optional[bytes] = None,
 ) -> int:
     """Add a new database entry for a received request.
 
@@ -29,6 +29,10 @@ async def add_new_metrics(
     and the log (in a zip format) for which analysis is requested.
     """
     if not compressed_log_content:
+        if not (url and http_session):
+            raise LogDetectiveMetricsError(
+                f"""Remote log can not be retrieved without URL and http session.
+                URL: {url}, http session:{http_session}""")
         remote_log = RemoteLog(url, http_session)
         compressed_log_content = await RemoteLogCompressor(remote_log).zip_content()
 
@@ -109,7 +113,8 @@ def track_request(name=None):
         async def async_decorated_function(*args, **kwargs):
             log_url = kwargs["build_log"].url
             metrics_id = await add_new_metrics(
-                name if name else f.__name__, log_url, kwargs["http_session"]
+                api_name=EndpointType(name if name else f.__name__),
+                url=log_url, http_session=kwargs["http_session"]
             )
             response = await f(*args, **kwargs)
             await update_metrics(metrics_id, response)

logdetective/server/models.py

@@ -500,8 +500,8 @@ class LogConfig(BaseModel):
 class GeneralConfig(BaseModel):
     """General config options for Log Detective"""
 
-    packages: List[str] = None
-    excluded_packages: List[str] = None
+    packages: List[str] = []
+    excluded_packages: List[str] = []
     devmode: bool = False
     sentry_dsn: HttpUrl | None = None
     collect_emojis_interval: int = 60 * 60  # seconds
@@ -568,7 +568,8 @@ class TimePeriod(BaseModel):
     @model_validator(mode="before")
     @classmethod
     def check_exclusive_fields(cls, data):
-        """Check that only one key between weeks, days and hours is defined"""
+        """Check that only one key between weeks, days and hours is defined,
+        if no period is specified, fall back to 2 days."""
         if isinstance(data, dict):
             how_many_fields = sum(
                 1
@@ -594,6 +595,7 @@ class TimePeriod(BaseModel):
 
     def get_time_period(self) -> datetime.timedelta:
         """Get the period of time represented by this input model.
+        Will default to 2 days, if no period is set.
 
         Returns:
             datetime.timedelta: The time period as a timedelta object.
@@ -605,10 +607,12 @@ class TimePeriod(BaseModel):
             delta = datetime.timedelta(days=self.days)
         elif self.hours:
             delta = datetime.timedelta(hours=self.hours)
+        else:
+            delta = datetime.timedelta(days=2)
         return delta
 
     def get_period_start_time(
-        self, end_time: datetime.datetime = None
+        self, end_time: Optional[datetime.datetime] = None
     ) -> datetime.datetime:
         """Calculate the start time of this period based on the end time.
 
@@ -621,5 +625,5 @@ class TimePeriod(BaseModel):
         """
         time = end_time or datetime.datetime.now(datetime.timezone.utc)
         if time.tzinfo is None:
-            end_time = end_time.replace(tzinfo=datetime.timezone.utc)
+            time = time.replace(tzinfo=datetime.timezone.utc)
         return time - self.get_time_period()

logdetective/server/plot.py

@@ -69,7 +69,7 @@ def create_time_series_arrays(
     plot_def: Definition,
     start_time: datetime.datetime,
     end_time: datetime.datetime,
-    value_type: Optional[Union[int, float]] = int,
+    value_type: Optional[Union[type[int], type[float]]] = int,
 ) -> tuple[numpy.ndarray, numpy.ndarray]:
     """Create time series arrays from a dictionary of values.
 

logdetective/server/server.py

@@ -139,7 +139,19 @@ def requires_token_when_set(authorization: Annotated[str | None, Header()] = Non
     raise HTTPException(status_code=401, detail="No token provided.")
 
 
-app = FastAPI(dependencies=[Depends(requires_token_when_set)], lifespan=lifespan)
+app = FastAPI(
+    title="Log Detective",
+    contact={
+        "name": "Log Detective developers",
+        "url": "https://github.com/fedora-copr/logdetective",
+        "email": "copr-devel@lists.fedorahosted.org"
+    },
+    license_info={
+        "name": "Apache-2.0",
+        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+    },
+    version=get_version(),
+    dependencies=[Depends(requires_token_when_set)], lifespan=lifespan)
 
 
 @app.post("/analyze", response_model=Response)
@@ -302,7 +314,7 @@ async def analyze_koji_task(task_id: int, koji_instance_config: KojiInstanceConf
     # to retrieve the metric ID to associate it with the koji task analysis.
 
     metrics_id = await add_new_metrics(
-        "analyze_koji_task",
+        EndpointType.ANALYZE_KOJI_TASK,
         log_text,
         received_at=datetime.datetime.now(datetime.timezone.utc),
         compressed_log_content=RemoteLogCompressor.zip_text(log_text),
@@ -357,10 +369,10 @@ async def async_log(msg):
     return msg
 
 
-@app.get("/version")
+@app.get("/version", response_class=BasicResponse)
 async def get_version_wrapper():
     """Get the version of logdetective"""
-    return get_version()
+    return BasicResponse(content=get_version())
 
 
 @app.post("/analyze/stream", response_class=StreamingResponse)
@@ -529,7 +541,7 @@ async def schedule_emoji_collection_for_mr(
     key = (forge, project_id, mr_iid)
 
     # FIXME: Look up the connection from the Forge  # pylint: disable=fixme
-    gitlab_conn = SERVER_CONFIG.gitlab.instances[forge.value]
+    gitlab_conn = SERVER_CONFIG.gitlab.instances[forge.value].get_connection()
 
     LOG.debug("Looking up emojis for %s, %d, %d", forge, project_id, mr_iid)
     await collect_emojis_for_mr(project_id, mr_iid, gitlab_conn)

logdetective/server/templates/gitlab_full_comment.md.j2

@@ -4,20 +4,21 @@ Please know that the explanation was provided by AI and may be incorrect.
     In this case, we are {{ "%.2f" | format(certainty) }}% certain of the response {{ emoji_face }}.
 {% endif %}
 
-<b>Snippets:</b>
-
-<ul>
-{% for snippet in snippets %}
-<li>
-<b>Line {{ snippet.line_number }}:</b> <code>{{ snippet.text }}</code>
-{{ snippet.explanation.text }}
-</li>
-{% endfor %}
-</ul>
-<details>
+<details open>
     <summary>Description</summary>
     {{ explanation }}
 </details>
+<details>
+{#
+    Formatted so that we don't trigger GitLab markdown
+#}
+<summary>Snippets</summary>
+<ul>
+{% for snippet in snippets -%}
+<li><div><b>Line {{ snippet.line_number }}:</b> <code>{{ snippet.text | e }}</code><br>{{ snippet.explanation.text | e }}</div></li>
+{%- endfor %}
+</ul>
+</details>
 <details>
     <summary>Logs</summary>
     <p>Log Detective analyzed the following logs files to provide an explanation:</p>
@@ -60,7 +61,8 @@ Please know that the explanation was provided by AI and may be incorrect.
 
 <hr>
 
-This comment was created by <a href="https://logdetective.com">Log Detective</a>.
+This explanation was provided by AI (<a href="https://logdetective.com">Log Detective</a>).
+Always review AI generated content prior to use.
 Was the provided feedback accurate and helpful?
 <br>
 Please vote with :thumbsup:

logdetective/server/templates/gitlab_short_comment.md.j2

@@ -3,7 +3,8 @@ Please know that the explanation was provided by AI and may be incorrect.
 {% if certainty > 0 %}
     In this case, we are {{ "%.2f" | format(certainty) }}% certain of the response {{ emoji_face }}.
 {% endif %}
-<details>
+
+<details open>
     <summary>Description</summary>
     {{ explanation }}
 </details>
@@ -49,7 +50,8 @@ Please know that the explanation was provided by AI and may be incorrect.
 
 <hr>
 
-This comment was created by <a href="https://logdetective.com">Log Detective</a>.
+This explanation was provided by AI (<a href="https://logdetective.com">Log Detective</a>).
+Always review AI generated content prior to use.
 Was the provided feedback accurate and helpful?
 <br>
 Please vote with :thumbsup:

logdetective/server/utils.py

@@ -3,7 +3,6 @@ from importlib.metadata import version
 
 import aiohttp
 from fastapi import HTTPException
-from fastapi.responses import Response as BasicResponse
 
 from logdetective.constants import SNIPPET_DELIMITER
 from logdetective.server.config import LOG
@@ -106,6 +105,6 @@ def construct_final_prompt(formatted_snippets: str, prompt_template: str) -> str
     return final_prompt
 
 
-def get_version() -> BasicResponse:
+def get_version() -> str:
     """Obtain the version number using importlib"""
-    return BasicResponse(content=version('logdetective'))
+    return version('logdetective')

logdetective/utils.py

@@ -192,22 +192,21 @@ def format_snippets(snippets: list[str] | list[Tuple[int, str]]) -> str:
     Line number must be first element in the tuple. Mixed format of snippets
     is permitted, but may have impact on inference.
     """
-    summary = ""
+    summary = "\n"
     for i, s in enumerate(snippets):
         if isinstance(s, tuple):
-            summary += f"""
-            Snippet No. {i} at line #{s[0]}:
-
-            {s[1]}
-            {SNIPPET_DELIMITER}
-            """
+            line_number, snippet_content = s
+            header = f"Snippet No. {i} at line #{line_number}:"
         else:
-            summary += f"""
-            Snippet No. {i}:
-
-            {s}
-            {SNIPPET_DELIMITER}
-            """
+            header = f"Snippet No. {i}:"
+            snippet_content = s
+        summary += (
+            f"{header}\n"
+            "\n"
+            f"{snippet_content}\n"
+            f"{SNIPPET_DELIMITER}\n"
+            f"\n"
+        )
     return summary
 
 

{logdetective-2.7.0.dist-info → logdetective-2.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: logdetective
-Version: 2.7.0
+Version: 2.9.0
 Summary: Log using LLM AI to search for build/test failures and provide ideas for fixing these.
 License: Apache-2.0
 License-File: LICENSE
@@ -325,6 +325,32 @@ podman-compose up server
 
 - Run Visual Stdio Code debug configuration named *Python Debug: Remote Attach*
 
+Visual Studio Code CLI debugging
+--------------------------------
+
+When debugging the CLI application, the `./scripts/debug_runner.py` script can be used
+as a stand in for stump script created during package installation.
+
+Using `launch.json`, or similar alternative, arguments can be specified for testing.
+
+Example:
+
+```
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Debug Installed Module",
+            "type": "debugpy",
+            "request": "launch",
+            "console": "integratedTerminal",
+            "program": "${workspaceFolder}/scripts/debug_runner.py",
+            "args": [<URL_OF_A_LOG>]
+        }
+    ]
+}
+```
+
 Server
 ======
 

{logdetective-2.7.0.dist-info → logdetective-2.9.0.dist-info}/RECORD

@@ -9,32 +9,32 @@ logdetective/prompts-summary-only.yml,sha256=8U9AMJV8ePW-0CoXOXlQoO92DAJDeutIT8n
 logdetective/prompts.yml,sha256=i3z6Jcb4ScVi7LsxOpDlKiXrcvql3qO_JnLzkAKMn1c,3870
 logdetective/remote_log.py,sha256=28QvdQiy7RBnd86EKCq_A75P21gSNlCbgxJe5XAe9MA,2258
 logdetective/server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-logdetective/server/compressors.py,sha256=qzrT-BPSksXY6F2L6ger04GGrgdBsGOfK2YuCFRs0Q4,5427
+logdetective/server/compressors.py,sha256=y4aFYJ_9CbYdKuAI39Kc9GQSdPN8cSJ2c_VAz3T47EE,5249
 logdetective/server/config.py,sha256=cKUmNCJyNyEid0bPTiUjr8CQuBYBab5bC79Axk2h0z8,2525
 logdetective/server/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 logdetective/server/database/base.py,sha256=HSV2tgye7iYTDzJD1Q5X7_nlLuTMIFP-hRVQMYxngHQ,2073
 logdetective/server/database/models/__init__.py,sha256=zoZMCt1_7tewDa6eEIIX_xrdN-tLegSiPNg5NiYaV3o,850
-logdetective/server/database/models/exceptions.py,sha256=AXQPZRgt-r2vboxP9SGYelngP6YIFpHlwELKcZ1FD3Y,384
-logdetective/server/database/models/koji.py,sha256=3soiJQ3L-H09cVO-BeRDEcP-HrSa-Z6qp3kwePUZsbo,6216
+logdetective/server/database/models/exceptions.py,sha256=4ED7FSSA1liV9-7VIN2BwUiz6XlmP97Y1loKnsoNdD8,507
+logdetective/server/database/models/koji.py,sha256=HNWxHYDxf4JN9K2ue8-V8dH-0XY5ZmxqH7Y9lAIbILA,6436
 logdetective/server/database/models/merge_request_jobs.py,sha256=MxiAVKQIsQMbFylBsmYBmVXYvid-4_5mwwXLfWdp6_w,19965
-logdetective/server/database/models/metrics.py,sha256=zzTRo67qwLyDj1GKbclZm1UXt1nNU-G662-y5XyGshE,15458
-logdetective/server/emoji.py,sha256=CoaAiZA_JgtUJe41YOsQRqd_QpgVeQ8szJt_bQ3d_JM,4837
-logdetective/server/exceptions.py,sha256=piV7wVKc-rw_pHrThbZbUjtmjuO5qUbjVNFwjdfcP3Q,864
+logdetective/server/database/models/metrics.py,sha256=4xsUdbtlp5PI1-iJQc5Dd8EPDgVVplD9hJRWeRDn43k,15443
+logdetective/server/emoji.py,sha256=nt3i_D5bk67RF4SlIetlLhLcgcxz9TEniC2iRYJx81w,5066
+logdetective/server/exceptions.py,sha256=WN715KLL3ya6FiZ95v70VSbNuVhGuHFzxm2OeEPWQCw,981
 logdetective/server/gitlab.py,sha256=putpnf8PfGsCZJsqWZA1rMovRGnyagoQmgpKLqtA-aQ,16743
 logdetective/server/koji.py,sha256=LG1pRiKUFvYFRKzgQoUG3pUHfcEwMoaMNjUSMKw_pBA,5640
 logdetective/server/llm.py,sha256=bmA6LsV80OdO60q4WLoKuehuVDEYq-HhBAYcZeLfrv8,10150
-logdetective/server/metric.py,sha256=-gqdd6LBUs_K6Sk30TZ7FJYE7Htp8d-uhVY5NwYgD3g,4186
-logdetective/server/models.py,sha256=BoiiUYI6BcVDOqtIcUgNRsCyjcWNCKyEfVtYOLYgr1Y,20929
-logdetective/server/plot.py,sha256=lFKOTXlLJ3aZtZGYXceA4OqUt1z18BpLITTI39fOMx4,14685
-logdetective/server/server.py,sha256=Qx8mqkrRq-nlOnmOmICbaXxUWq2J60K4dHKiJtQJuE0,24938
+logdetective/server/metric.py,sha256=wLOpgcAch3rwhPA5P2YWUeMNAPsvRGseRjH5HlTb7JM,4529
+logdetective/server/models.py,sha256=V2QCKF_zB9FLaZjiBnUlmOZc5c8SsS4uhUmxrhqcJSY,21098
+logdetective/server/plot.py,sha256=8LERgY3vQckaHZV2PZfOrZT8CjCAiji57QCmRW24Rfo,14697
+logdetective/server/server.py,sha256=JueU-5c8t9h1CZy4gtoEeT8VSEirpeS0K3wrfqTPvAc,25381
 logdetective/server/templates/base_response.html.j2,sha256=BJGGV_Xb0Lnue8kq32oG9lI5CQDf9vce7HMYsP-Pvb4,2040
-logdetective/server/templates/gitlab_full_comment.md.j2,sha256=hSWEj_a7KZpzfbgoPhWA9KBwa25daDCb6S3cuBqclss,2143
-logdetective/server/templates/gitlab_short_comment.md.j2,sha256=d396HR2DJuS8XLu2FNgVAg1CrOW8_LySQX2f6opOjp8,1957
-logdetective/server/utils.py,sha256=KiyzzUIVssBc61LhGS0QNC5EY29In3NsG9j58ZRtoNI,4104
+logdetective/server/templates/gitlab_full_comment.md.j2,sha256=4UujUzl3lmdbNEADsxn3HVrjfUiUu2FvUlp9MDFGXQI,2321
+logdetective/server/templates/gitlab_short_comment.md.j2,sha256=2krnMlGqqju2V_6pE0UqUR1P674OFaeX5BMyY5htTOQ,2022
+logdetective/server/utils.py,sha256=0BZ8WmzXNEtkUty1kOyFbBxDZWL0Icc8BUrxuHw9uvs,4015
 logdetective/skip_snippets.yml,sha256=reGlhPPCo06nNUJWiC2LY-OJOoPdcyOB7QBTSMeh0eg,487
-logdetective/utils.py,sha256=_hiRCqFv-CSTTlMKha2uzQ0TX7LZhDcx4ITPqnvGMHo,9718
-logdetective-2.7.0.dist-info/METADATA,sha256=v3XvUztZlLeO2_rKC-VP9g1wej2tvROBiRE8wUaAeSM,22598
-logdetective-2.7.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-logdetective-2.7.0.dist-info/entry_points.txt,sha256=3K_vXja6PmcA8sNdUi63WdImeiNhVZcEGPTaoJmltfA,63
-logdetective-2.7.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-logdetective-2.7.0.dist-info/RECORD,,
+logdetective/utils.py,sha256=yalhySOF_Gzmqx_Ft9qad3TplAfZ6LOmauGXEJfKWiE,9803
+logdetective-2.9.0.dist-info/METADATA,sha256=cTc0MOpLusXA5aQ7qH_lHFr3IuQMldFiL5Sgc17XIUU,23273
+logdetective-2.9.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+logdetective-2.9.0.dist-info/entry_points.txt,sha256=3K_vXja6PmcA8sNdUi63WdImeiNhVZcEGPTaoJmltfA,63
+logdetective-2.9.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+logdetective-2.9.0.dist-info/RECORD,,