Add testing, new Profyle options, port and host

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Tests
+on:
+  push:
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Install poetry
+        run: pip install poetry
+
+      - name: Install dependencies
+        run: |
+          poetry config virtualenvs.create false
+          poetry install
+
+      - name: Run tests
+        run: |
+          poetry run pytest

README.md

@@ -40,8 +40,13 @@ $ pip install profyle
 ### 1. Implement
 In order to track all your API requests you must implement the <code>ProfyleMiddleware</code>
 #### ProfyleMiddleware
-* enabled : Default true. You can use an env variable to decide if profyle is enabled.
-* pattern: Profyle only will trace those paths that match with pattern (<a href="https://en.wikipedia.org/wiki/Glob_(programming)" class="external-link" target="_blank">glob pattern</a>)
+| Attribute | Required | Default | Description |
+| --- | --- | --- | --- |
+| `enabled` | No | `True` | Enable or disable Profyle |
+| `pattern` | No | `None` | 0nly trace those paths that match with pattern (<a href="https://en.wikipedia.org/wiki/Glob_(programming)" class="external-link" target="_blank">glob pattern</a>)  |
+| `max_stack_depth` | No | `-1` | Limit maximum stack trace depth |
+| `min_duration` | No | `0` (milisecons) | Only record traces with a greather duration than the limit. |
+
 
 <details markdown="1" open>
 <summary>FastAPI</summary>
@@ -51,7 +56,27 @@ from fastapi import FastAPI
 from profyle.fastapi import ProfyleMiddleware
 
 app = FastAPI()
-app.add_middleware(ProfyleMiddleware, pattern='*/api/v2/*')
+# Trace all requests
+app.add_middleware(ProfyleMiddleware)
+
+@app.get("/items/{item_id}")
+async def read_item(item_id: int):
+    return {"item_id": item_id}
+```
+
+```Python
+from fastapi import FastAPI
+from profyle.fastapi import ProfyleMiddleware
+
+app = FastAPI()
+# Trace all requests that match that start with /api/products 
+# with a minimum duration of 100ms and a maximum stack depth of 20
+app.add_middleware(
+    ProfyleMiddleware,
+    pattern="/api/products*",
+    max_stack_depth=20,
+    min_duration=100
+)
 
 @app.get("/items/{item_id}")
 async def read_item(item_id: int):
@@ -68,7 +93,7 @@ from profyle.flask import ProfyleMiddleware
 
 app = Flask(__name__)
 
-app.wsgi_app = ProfyleMiddleware(app.wsgi_app, pattern='*/api/products*')
+app.wsgi_app = ProfyleMiddleware(app.wsgi_app, pattern="*/api/products*")
 
 @app.route("/")
 def hello_world():
@@ -120,12 +145,19 @@ INFO:     Application startup complete.
 ## CLI Commands
 ### start
 * Start the web server and view profile traces
+
+| Options | Type | Default | Description |
+| --- | --- | --- | --- |
+| --port | INTEGER | 0 | web server port |                                                                 
+| --host | TEXT | 127.0.0.1 | web server host |                                                                 
+                                                                  
+
 <div class="termy">
 
 ```console
-$ profyle start
+$ profyle start --port 5432
 
-INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+INFO:     Uvicorn running on http://127.0.0.1:5432 (Press CTRL+C to quit)
 INFO:     Started reloader process [28720]
 INFO:     Started server process [28722]
 INFO:     Waiting for application startup.

profyle/application/profyle.py

@@ -3,6 +3,7 @@
 import re
 from typing import Optional
 from dataclasses import dataclass
+from tempfile import NamedTemporaryFile
 
 from viztracer import VizTracer
 
@@ -15,38 +16,50 @@
 class profyle:
     name: str
     repo: TraceRepository
+    max_stack_depth: int = -1
+    min_duration: float = 0
     pattern: Optional[str] = None
-    tracer: VizTracer = VizTracer(
-        verbose=0,
-        log_async=True
-    )
+    tracer: Optional[VizTracer] = None
 
-    def __enter__(self):
+    def __enter__(self) -> None:
 
         if self.should_trace():
+            self.tracer = VizTracer(
+                log_func_args=True,
+                log_print=True,
+                log_func_retval=True,
+                log_async=True,
+                file_info=True,
+                min_duration=self.min_duration,
+                max_stack_depth=self.max_stack_depth
+            )
             self.tracer.start()
 
     def __exit__(
         self,
         *args,
-    ):
-        if not  self.tracer.enable:
-            return
-        self.tracer.stop()
-        self.tracer.parse()
-        new_trace = TraceCreate(
-            data=json.dumps(self.tracer.data),
-            name=self.name
-        )
-        store_trace(
-            new_trace=new_trace,
-            repo=self.repo
-        )
+    ) -> None:
+        if self.tracer and self.tracer.enable:
+            self.tracer.stop()
+            temp_file = NamedTemporaryFile(suffix=".json")
+            self.tracer.save(temp_file.name)
+            temp_file.close()
+            new_trace = TraceCreate(
+                data=json.dumps(self.tracer.data),
+                name=self.name
+            )
+            store_trace(
+                new_trace=new_trace,
+                repo=self.repo
+            )
 
     def should_trace(self) -> bool:
         if not self.pattern:
             return True
 
         regex = fnmatch.translate(self.pattern)
         reobj = re.compile(regex)
+        method_and_name = self.name.split(' ')
+        if len(method_and_name) > 1:
+            return bool(reobj.match(method_and_name[1]))
         return bool(reobj.match(self.name))

profyle/application/trace/delete.py

@@ -4,5 +4,5 @@
 def delete_all_traces(repo: TraceRepository) -> int:
     return repo.delete_all_traces()
 
-def delete_trace_by_id(repo: TraceRepository, trace_id: int) -> int:
-    return repo.delete_trace_by_id(trace_id=trace_id)
+def delete_trace_by_id(repo: TraceRepository, trace_id: int):
+    repo.delete_trace_by_id(trace_id=trace_id)

profyle/application/trace/get.py

@@ -1,9 +1,9 @@
-from typing import List, Optional
+from typing import  Optional
 from profyle.domain.trace import Trace
 from profyle.domain.trace_repository import TraceRepository
 
 
-def get_all_traces(repo: TraceRepository) -> List[Trace]:
+def get_all_traces(repo: TraceRepository) -> list[Trace]:
     return repo.get_all_traces()
 
 

profyle/domain/trace.py

@@ -6,7 +6,7 @@ class Trace(BaseModel):
     data: Json[Any] = {}
     name: str
     duration: float = 0
-    timestamp: str = ''
+    timestamp: str = ""
     id: int
 
 
@@ -17,13 +17,21 @@ class TraceCreate(BaseModel):
     @computed_field
     @property
     def duration(self) -> float:
+        any_trace_to_analize = any(
+            True
+            for trace in self.data.get("traceEvents", [])
+            if trace.get("ts")
+        )
+        if not any_trace_to_analize:
+            return 0
+
         start = min(
-            trace.get('ts')
-            for trace in self.data.get('traceEvents', [])
-            if trace.get('ts')
+            trace.get("ts",0)
+            for trace in self.data.get("traceEvents", [])
+            if trace.get("ts")
         )
         end = max(
-            trace.get('ts', 0)
-            for trace in self.data.get('traceEvents', [])
+            trace.get("ts", 0)
+            for trace in self.data.get("traceEvents", [])
         )
         return end-start

profyle/domain/trace_repository.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import List, Optional
+from typing import Optional
 
 from profyle.domain.trace import Trace, TraceCreate
 
@@ -31,7 +31,7 @@ def store_trace(self, new_trace: TraceCreate) -> None:
         ...
 
     @abstractmethod
-    def get_all_traces(self) -> List[Trace]:
+    def get_all_traces(self) -> list[Trace]:
         ...
 
     @abstractmethod
@@ -43,5 +43,5 @@ def get_trace_selected(self) -> Optional[int]:
         ...
 
     @abstractmethod
-    def delete_trace_by_id(self, trace_id: int) -> int:
+    def delete_trace_by_id(self, trace_id: int):
         ...

profyle/fastapi.py

@@ -1 +1 @@
-from .infrastructure.middleware.fastapi import ProfyleMiddleware
+from profyle.infrastructure.middleware.fastapi import ProfyleMiddleware

profyle/flask.py

@@ -1 +1 @@
-from .infrastructure.middleware.flask import ProfyleMiddleware
+from profyle.infrastructure.middleware.flask import ProfyleMiddleware