quapp-common 0.0.14.dev5__tar.gz → 0.0.14.dev6__tar.gz

{quapp_common-0.0.14.dev5/quapp_common.egg-info → quapp_common-0.0.14.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quapp-common
-Version: 0.0.14.dev5
+Version: 0.0.14.dev6
 Summary: Quapp common library supporting Quapp Platform for Quantum Computing
 Author-email: "CITYNOW Co. Ltd. " <corp@citynow.vn>
 License: The MIT License (MIT)

{quapp_common-0.0.14.dev5 → quapp_common-0.0.14.dev6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "quapp-common"
-version = "0.0.14.dev5"
+version = "0.0.14.dev6"
 description = "Quapp common library supporting Quapp Platform for Quantum Computing"
 readme = "README.md"
 authors = [{ name = "CITYNOW Co. Ltd. ", email = "corp@citynow.vn" }]

{quapp_common-0.0.14.dev5 → quapp_common-0.0.14.dev6}/quapp_common/async_tasks/post_processing_task.py

@@ -4,6 +4,7 @@
 from .async_task import AsyncTask
 from ..config.logging_config import job_logger
 from ..data.promise.post_processing_promise import PostProcessingPromise
+from ..config.log_context import phase
 from ..enum.media_type import MediaType
 from ..enum.runtime_phase import RuntimePhase
 from ..util.http_utils import get_job_id_from_url
@@ -32,15 +33,19 @@ class PostProcessingTask(AsyncTask):
         job_response.content_type = MediaType.APPLICATION_JSON
 
         try:
-            self.logger.info("Execute post_processing ...")
-            job_result_post_processing = self.post_processing_fn(
-                    self.promise.job_result)
-
-            # print() cũ ghi thẳng ra stdout, không qua sink nên không được
-            # redact và không có job_id.
-            self.logger.debug(
-                    f"Parsing job result: type={type(job_result_post_processing).__name__}")
-            job_response.job_result = parse(job_result_post_processing)
+            # RuntimePhase.POST_PROCESSING duoc dinh nghia nhung truoc day khong
+            # noi nao dung, nen code user chay trong post_processing_fn khong he
+            # co phase trong log lan trong ErrorReport.
+            with phase(RuntimePhase.POST_PROCESSING):
+                self.logger.info("Execute post_processing ...")
+                job_result_post_processing = self.post_processing_fn(
+                        self.promise.job_result)
+
+                # print() cũ ghi thẳng ra stdout, không qua sink nên không được
+                # redact và không có job_id.
+                self.logger.debug(
+                        f"Parsing job result: type={type(job_result_post_processing).__name__}")
+                job_response.job_result = parse(job_result_post_processing)
 
             update_job_metadata(job_response, self.promise.callback_url.on_done)
 

{quapp_common-0.0.14.dev5 → quapp_common-0.0.14.dev6}/quapp_common/config/log_context.py

@@ -69,8 +69,16 @@ def bind_job(job_id: str = None, *, sdk=None, provider=None, device=None,
     @param trace_id: tự sinh nếu không truyền; dùng để join Function Log <-> Job Log
     @return: logger đã bind toàn bộ context
     """
+    # Một job bị bind hai lần (AsyncInvocationTask rồi Handler.__init__), trước
+    # đây mỗi lần sinh một trace_id mới nên cùng một job có hai traceId khác
+    # nhau và filter theo traceId mất các dòng ở cửa vào. Giữ lại trace đang có
+    # khi vẫn là job đó; job khác thì phải sinh trace mới, không được trộn.
+    current = _JOB_CONTEXT.get()
+    inherited = (current.get(TRACE_ID)
+                 if current.get(JOB_ID) in (None, job_id) else None)
+
     context = {JOB_ID          : job_id,
-               TRACE_ID        : trace_id or uuid.uuid4().hex[:16],
+               TRACE_ID        : trace_id or inherited or uuid.uuid4().hex[:16],
                'sdk'           : sdk,
                'provider'      : provider,
                'device'        : device,

{quapp_common-0.0.14.dev5 → quapp_common-0.0.14.dev6}/quapp_common/model/device/custom_device.py

@@ -8,6 +8,7 @@ from ...component.callback.update_job_metadata import update_job_metadata
 from ...data.callback.callback_url import CallbackUrl
 from ...data.response.job_response import JobResponse
 from ...enum.runtime_phase import RuntimePhase
+from ...config.log_context import phase
 from ...model.device.device import Device
 from ...model.provider.provider import Provider
 from ...util.response_utils import build_error_job_response
@@ -34,21 +35,28 @@ class CustomDevice(Device, ABC):
         update_job_metadata(job_response, analysis_callback.on_start)
 
         try:
-            self.logger.debug(
-                    "Producing histogram data from original job result")
-
-            job_response.job_histogram = self._produce_histogram_data(
-                    original_job_result)
-
-            self.logger.debug("Parsing original job result")
-            original_job_result_dict = parse(original_job_result)
-
-            self.logger.debug("Calculating execution time from parsed results")
-            self._calculate_execution_time(original_job_result_dict)
-            job_response.execution_time = self.execution_time
-
-            self.logger.debug("Retrieving shot count from job result")
-            job_response.shots = self._get_shots(original_job_result)
+            # Device._on_analysis co `with phase(...)`, ban override nay khong --
+            # va day moi la ban thuc su chay: QiskitDevice, OqcCloudDevice...
+            # deu ke thua CustomDevice. Thieu no thi log cua analysis khong co
+            # field `phase`, Grafana khong loc duoc va ErrorReport cua loi trong
+            # analysis ra phase=None.
+            with phase(RuntimePhase.ANALYSIS):
+                self.logger.debug(
+                        "Producing histogram data from original job result")
+
+                job_response.job_histogram = self._produce_histogram_data(
+                        original_job_result)
+
+                self.logger.debug("Parsing original job result")
+                original_job_result_dict = parse(original_job_result)
+
+                self.logger.debug(
+                        "Calculating execution time from parsed results")
+                self._calculate_execution_time(original_job_result_dict)
+                job_response.execution_time = self.execution_time
+
+                self.logger.debug("Retrieving shot count from job result")
+                job_response.shots = self._get_shots(original_job_result)
 
             update_job_metadata(job_response, analysis_callback.on_done)
 

{quapp_common-0.0.14.dev5 → quapp_common-0.0.14.dev6/quapp_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quapp-common
-Version: 0.0.14.dev5
+Version: 0.0.14.dev6
 Summary: Quapp common library supporting Quapp Platform for Quantum Computing
 Author-email: "CITYNOW Co. Ltd. " <corp@citynow.vn>
 License: The MIT License (MIT)

{quapp_common-0.0.14.dev5 → quapp_common-0.0.14.dev6}/quapp_common.egg-info/SOURCES.txt

@@ -101,4 +101,5 @@ tests/test_language_dispatcher.py
 tests/test_log_secret_leak.py
 tests/test_logging_config.py
 tests/test_no_sdk_dependency.py
+tests/test_phase_coverage.py
 tests/test_result_serializer.py

quapp_common-0.0.14.dev6/tests/test_phase_coverage.py

@@ -0,0 +1,196 @@
+#  Quapp Platform Project
+#  test_phase_coverage.py
+#  Copyright © CITYNOW Co. Ltd. All rights reserved.
+
+"""Mọi giai đoạn của một job phải mang `phase` trong log và trong ErrorReport.
+
+Ba bug bị khoá ở đây, cả ba đều phát hiện từ log thật của job
+4a5d2c56-f248-41e7-974f-a1bbea6db1c0 trên dev:
+
+1. `CustomDevice._on_analysis` không có `with phase(...)`. `Device._on_analysis`
+   thì có, nhưng bản CHẠY THẬT là bản override trong CustomDevice --
+   QiskitDevice, OqcCloudDevice... đều kế thừa nó. Log của analysis vì thế
+   không có field `phase`, và lỗi trong analysis ra `phase=None`.
+
+2. `RuntimePhase.POST_PROCESSING` được định nghĩa nhưng không nơi nào dùng, nên
+   code user chạy trong `post_processing_fn` không có phase.
+
+3. `bind_job()` sinh trace_id mới mỗi lần gọi. Một job bị bind hai lần
+   (AsyncInvocationTask rồi Handler.__init__) nên cùng một job có hai traceId,
+   filter theo traceId mất các dòng ở cửa vào.
+"""
+
+import ast
+import pathlib
+
+import pytest
+from loguru import logger
+from quapp_common.config import log_context
+from quapp_common.config.log_context import (
+    TRACE_ID, bind_job, effective_phase, trace_id,
+)
+from quapp_common.config.logging_config import _prepare_record, configure_logging
+from quapp_common.enum.runtime_phase import RuntimePhase
+
+PACKAGE_ROOT = pathlib.Path(__file__).resolve().parent.parent / 'quapp_common'
+
+
+@pytest.fixture(autouse=True)
+def clean_context():
+    log_context.reset()
+    yield
+    log_context.reset()
+    configure_logging(force=True)
+
+
+@pytest.fixture
+def captured():
+    records = []
+    logger.remove()
+    sink_id = logger.add(lambda message: records.append(message.record['extra']),
+                         level='DEBUG', filter=_prepare_record)
+    yield records
+    logger.remove(sink_id)
+
+
+def phases_wrapped_in(relative_path):
+    """Tập RuntimePhase được mở bằng `with phase(...)` trong một file."""
+    tree = ast.parse((PACKAGE_ROOT / relative_path).read_text(encoding='utf-8'))
+
+    found = set()
+    for node in ast.walk(tree):
+        if not isinstance(node, ast.With):
+            continue
+        for item in node.items:
+            call = item.context_expr
+            if not isinstance(call, ast.Call):
+                continue
+            name = getattr(call.func, 'id', None) or getattr(call.func, 'attr',
+                                                             None)
+            if name != 'phase' or not call.args:
+                continue
+            argument = call.args[0]
+            if isinstance(argument, ast.Attribute):
+                found.add(argument.attr)
+    return found
+
+
+# ------------------------------------------- (1) CustomDevice phai co ANALYSIS
+
+def test_custom_device_analysis_is_wrapped():
+    """Ban override moi la ban chay that, no phai mo phase nhu ban goc."""
+    assert 'ANALYSIS' in phases_wrapped_in('model/device/custom_device.py'), (
+        'CustomDevice._on_analysis khong co `with phase(RuntimePhase.ANALYSIS)`; '
+        'moi device Qiskit dung ban nay nen log analysis se mat field phase')
+
+
+def test_base_device_still_wraps_its_phases():
+    """Khong duoc lam hong ban goc khi sua ban override."""
+    wrapped = phases_wrapped_in('model/device/device.py')
+    assert {'COMPILATION', 'EXECUTION', 'ANALYSIS'} <= wrapped
+
+
+# ------------------------------------ (2) post_processing phai co POST_PROCESSING
+
+def test_post_processing_task_is_wrapped():
+    wrapped = phases_wrapped_in('async_tasks/post_processing_task.py')
+    assert 'POST_PROCESSING' in wrapped, (
+        'post_processing_fn (code cua user) chay ngoai moi phase, nen loi trong '
+        'do khong biet thuoc giai doan nao')
+
+
+def test_every_declared_phase_is_actually_used():
+    """RuntimePhase khai bao ra thi phai co noi mo -- tru CALLBACK/POLLING.
+
+    CALLBACK va POLLING duoc dat qua `phase=` cua build_error_job_response chu
+    khong qua `with phase(...)`, nen khong tinh o day.
+    """
+    used = set()
+    for path in PACKAGE_ROOT.rglob('*.py'):
+        used |= phases_wrapped_in(path.relative_to(PACKAGE_ROOT))
+
+    declared = {member.name for member in RuntimePhase}
+    never_opened = declared - used - {'CALLBACK', 'POLLING'}
+    assert not never_opened, (
+        f'RuntimePhase khong bao gio duoc mo: {sorted(never_opened)}')
+
+
+# --------------------------------------------------- hanh vi khi chay that
+
+def test_analysis_phase_reaches_the_log_record(captured):
+    """Trong `with phase(ANALYSIS)`, dong log phai mang phase=ANALYSIS."""
+    from quapp_common.config.log_context import phase
+
+    bind_job('job_A', sdk='qiskit')
+    with phase(RuntimePhase.ANALYSIS):
+        logger.bind(**log_context.job_context()).debug('producing histogram')
+
+    record = next(r for r in captured if r.get('event') is None)
+    assert record.get('phase') == 'ANALYSIS'
+    assert record.get('job_id') == 'job_A'
+
+
+def test_failure_inside_analysis_keeps_the_phase():
+    """`phase()` reset contextvar trong finally, nen ErrorReport phai doc duoc
+    phase da that bai qua _FAILED_PHASE."""
+    from quapp_common.config.log_context import phase
+
+    bind_job('job_B')
+    with pytest.raises(ValueError):
+        with phase(RuntimePhase.ANALYSIS):
+            raise ValueError('histogram vo')
+
+    assert effective_phase() is RuntimePhase.ANALYSIS
+
+
+def test_failure_inside_post_processing_keeps_the_phase():
+    from quapp_common.config.log_context import phase
+
+    bind_job('job_C')
+    with pytest.raises(KeyError):
+        with phase(RuntimePhase.POST_PROCESSING):
+            raise KeyError('counts')
+
+    assert effective_phase() is RuntimePhase.POST_PROCESSING
+
+
+# ------------------------------------------------- (3) trace_id khong bi tach
+
+def test_rebinding_same_job_keeps_one_trace_id():
+    """AsyncInvocationTask bind roi Handler.__init__ bind lai -- van mot trace."""
+    bind_job('job_SAME')
+    first = trace_id()
+
+    bind_job('job_SAME', sdk='qiskit', provider='QUAO_QUANTUM_SIMULATOR')
+    assert trace_id() == first, 'cung mot job ma co hai traceId'
+
+
+def test_binding_without_job_id_then_with_it_keeps_the_trace():
+    """Cua vao HTTP bind truoc khi biet job_id; trace phai duoc mang theo."""
+    bind_job(None)
+    first = trace_id()
+
+    bind_job('job_LATE')
+    assert trace_id() == first
+
+
+def test_different_job_gets_a_fresh_trace_id():
+    """Khong duoc tron trace giua hai job khac nhau."""
+    bind_job('job_ONE')
+    first = trace_id()
+
+    bind_job('job_TWO')
+    assert trace_id() != first
+
+
+def test_explicit_trace_id_always_wins():
+    bind_job('job_X')
+    bind_job('job_X', trace_id='deadbeefdeadbeef')
+    assert trace_id() == 'deadbeefdeadbeef'
+
+
+def test_trace_id_is_present_on_every_record(captured):
+    bind_job('job_T')
+    logger.bind(**log_context.job_context()).info('mot dong bat ky')
+
+    assert captured[-1].get(TRACE_ID)