csctracker-py-core 26.37.4__tar.gz → 26.47.3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- csctracker_py_core-26.47.3/MANIFEST.in +5 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/PKG-INFO +34 -17
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/README.md +18 -3
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/models/emuns/config.py +2 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/repository/http_repository.py +1 -1
- csctracker_py_core-26.47.3/csctracker_py_core/starter.py +247 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/configs.py +2 -2
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/graceful_shutdown.py +33 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/interceptor.py +17 -3
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core.egg-info/PKG-INFO +34 -17
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core.egg-info/SOURCES.txt +6 -1
- csctracker_py_core-26.47.3/csctracker_py_core.egg-info/requires.txt +11 -0
- csctracker_py_core-26.47.3/requirements.txt +11 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/setup.cfg +1 -1
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/setup.py +6 -5
- csctracker_py_core-26.47.3/tests/test_starter_wsgi.py +276 -0
- csctracker_py_core-26.47.3/version.py +2 -0
- csctracker_py_core-26.47.3/version.txt +1 -0
- csctracker_py_core-26.37.4/csctracker_py_core/starter.py +0 -73
- csctracker_py_core-26.37.4/csctracker_py_core.egg-info/requires.txt +0 -10
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/LICENSE +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/models/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/models/emuns/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/repository/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/repository/remote_repository.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/__init__.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/request_info.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/utils.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/version.py +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core.egg-info/dependency_links.txt +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core.egg-info/top_level.txt +0 -0
- {csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/tests/test_graceful_shutdown.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: csctracker-py-core
|
|
3
|
-
Version: 26.
|
|
3
|
+
Version: 26.47.3
|
|
4
4
|
Summary: A base library for microservices with Flask, JSON logging, and Prometheus telemetry.
|
|
5
5
|
Home-page: https://github.com/krlsedu/CscTrackerPyCore
|
|
6
6
|
Author: Carlos Eduardo
|
|
@@ -17,24 +17,26 @@ Classifier: Topic :: System :: Monitoring
|
|
|
17
17
|
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
|
|
18
18
|
Classifier: License :: OSI Approved :: MIT License
|
|
19
19
|
Classifier: Programming Language :: Python :: 3
|
|
20
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
21
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
22
20
|
Classifier: Programming Language :: Python :: 3.11
|
|
23
21
|
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
24
25
|
Classifier: Operating System :: OS Independent
|
|
25
|
-
Requires-Python: >=3.
|
|
26
|
+
Requires-Python: >=3.11
|
|
26
27
|
Description-Content-Type: text/markdown
|
|
27
28
|
License-File: LICENSE
|
|
28
|
-
Requires-Dist: csctracker-queue-scheduler
|
|
29
|
-
Requires-Dist: flask
|
|
30
|
-
Requires-Dist:
|
|
31
|
-
Requires-Dist: python-
|
|
32
|
-
Requires-Dist:
|
|
33
|
-
Requires-Dist:
|
|
34
|
-
Requires-Dist:
|
|
35
|
-
Requires-Dist:
|
|
36
|
-
Requires-Dist: flask-
|
|
37
|
-
Requires-Dist: pytz
|
|
29
|
+
Requires-Dist: csctracker-queue-scheduler>=26.47.1
|
|
30
|
+
Requires-Dist: flask-swagger-init>=26.47.2
|
|
31
|
+
Requires-Dist: flask<4,>=3.1
|
|
32
|
+
Requires-Dist: python-json-logger<5,>=3.0
|
|
33
|
+
Requires-Dist: python-dotenv<2,>=1.0
|
|
34
|
+
Requires-Dist: requests<3,>=2.32
|
|
35
|
+
Requires-Dist: beautifulsoup4<5,>=4.12
|
|
36
|
+
Requires-Dist: flask-cors<7,>=6.0
|
|
37
|
+
Requires-Dist: prometheus-flask-exporter<1,>=0.23.2
|
|
38
|
+
Requires-Dist: pytz>=2026.1
|
|
39
|
+
Requires-Dist: waitress<4,>=3.0.0
|
|
38
40
|
Dynamic: author
|
|
39
41
|
Dynamic: classifier
|
|
40
42
|
Dynamic: description
|
|
@@ -59,7 +61,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
59
61
|
|
|
60
62
|
## Principais Funcionalidades
|
|
61
63
|
|
|
62
|
-
- **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS
|
|
64
|
+
- **Starter Facilitado (WSGI Nativo)**: Inicialização rápida de aplicações Flask com suporte a CORS, servidor WSGI de produção (**Waitress**, multi-thread e sem `fork()`) por padrão no `starter.start()` e fallback automático para Werkzeug em desenvolvimento local via `DEBUG=1`.
|
|
63
65
|
- **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
|
|
64
66
|
- **Observabilidade**:
|
|
65
67
|
- Integração nativa com **Prometheus** para coleta de métricas de endpoints.
|
|
@@ -71,9 +73,10 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
71
73
|
|
|
72
74
|
## Requisitos
|
|
73
75
|
|
|
74
|
-
- Python 3.
|
|
76
|
+
- Python 3.11+ (validado em Python 3.15)
|
|
75
77
|
- Flask
|
|
76
78
|
- Flask-CORS
|
|
79
|
+
- Waitress (WSGI de produção)
|
|
77
80
|
- Prometheus Flask Exporter
|
|
78
81
|
- Flask Swagger Generator
|
|
79
82
|
- Python JSON Logger
|
|
@@ -109,7 +112,9 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
|
|
|
109
112
|
| `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
|
|
110
113
|
| `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
|
|
111
114
|
| `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
|
|
112
|
-
| `
|
|
115
|
+
| `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
|
|
116
|
+
| `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
|
|
117
|
+
| `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
|
|
113
118
|
|
|
114
119
|
## Uso Didático
|
|
115
120
|
|
|
@@ -132,6 +137,7 @@ def hello():
|
|
|
132
137
|
return {"message": "CscTrackerPyCore is running!"}
|
|
133
138
|
|
|
134
139
|
if __name__ == '__main__':
|
|
140
|
+
# Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
|
|
135
141
|
starter.start()
|
|
136
142
|
```
|
|
137
143
|
|
|
@@ -163,6 +169,17 @@ starter.register_shutdown_hook(cleanup_resources)
|
|
|
163
169
|
|
|
164
170
|
## Implantação no Docker Swarm
|
|
165
171
|
|
|
172
|
+
Nos serviços que consomem `csctracker-py-core`, recomenda-se manter `CMD ["python", "-u", "app.py"]` (que inicia o Waitress automaticamente via `starter.start()` quando `DEBUG` não é `1`) e copiar `requirements.txt` antes do código-fonte no `Dockerfile` para aproveitar o cache de layers:
|
|
173
|
+
|
|
174
|
+
```dockerfile
|
|
175
|
+
FROM python:3.15-slim
|
|
176
|
+
WORKDIR /app
|
|
177
|
+
COPY requirements.txt .
|
|
178
|
+
RUN pip install --no-cache-dir -r requirements.txt
|
|
179
|
+
COPY . /app
|
|
180
|
+
CMD ["python", "-u", "app.py"]
|
|
181
|
+
```
|
|
182
|
+
|
|
166
183
|
Para garantir atualizações contínuas (*rolling updates zero-downtime*), configure o `docker-compose.yml` da stack no Swarm utilizando `order: start-first` e defina `stop_grace_period` com um valor superior ao `SHUTDOWN_TIMEOUT`:
|
|
167
184
|
|
|
168
185
|
```yaml
|
|
@@ -9,7 +9,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
9
9
|
|
|
10
10
|
## Principais Funcionalidades
|
|
11
11
|
|
|
12
|
-
- **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS
|
|
12
|
+
- **Starter Facilitado (WSGI Nativo)**: Inicialização rápida de aplicações Flask com suporte a CORS, servidor WSGI de produção (**Waitress**, multi-thread e sem `fork()`) por padrão no `starter.start()` e fallback automático para Werkzeug em desenvolvimento local via `DEBUG=1`.
|
|
13
13
|
- **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
|
|
14
14
|
- **Observabilidade**:
|
|
15
15
|
- Integração nativa com **Prometheus** para coleta de métricas de endpoints.
|
|
@@ -21,9 +21,10 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
21
21
|
|
|
22
22
|
## Requisitos
|
|
23
23
|
|
|
24
|
-
- Python 3.
|
|
24
|
+
- Python 3.11+ (validado em Python 3.15)
|
|
25
25
|
- Flask
|
|
26
26
|
- Flask-CORS
|
|
27
|
+
- Waitress (WSGI de produção)
|
|
27
28
|
- Prometheus Flask Exporter
|
|
28
29
|
- Flask Swagger Generator
|
|
29
30
|
- Python JSON Logger
|
|
@@ -59,7 +60,9 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
|
|
|
59
60
|
| `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
|
|
60
61
|
| `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
|
|
61
62
|
| `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
|
|
62
|
-
| `
|
|
63
|
+
| `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
|
|
64
|
+
| `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
|
|
65
|
+
| `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
|
|
63
66
|
|
|
64
67
|
## Uso Didático
|
|
65
68
|
|
|
@@ -82,6 +85,7 @@ def hello():
|
|
|
82
85
|
return {"message": "CscTrackerPyCore is running!"}
|
|
83
86
|
|
|
84
87
|
if __name__ == '__main__':
|
|
88
|
+
# Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
|
|
85
89
|
starter.start()
|
|
86
90
|
```
|
|
87
91
|
|
|
@@ -113,6 +117,17 @@ starter.register_shutdown_hook(cleanup_resources)
|
|
|
113
117
|
|
|
114
118
|
## Implantação no Docker Swarm
|
|
115
119
|
|
|
120
|
+
Nos serviços que consomem `csctracker-py-core`, recomenda-se manter `CMD ["python", "-u", "app.py"]` (que inicia o Waitress automaticamente via `starter.start()` quando `DEBUG` não é `1`) e copiar `requirements.txt` antes do código-fonte no `Dockerfile` para aproveitar o cache de layers:
|
|
121
|
+
|
|
122
|
+
```dockerfile
|
|
123
|
+
FROM python:3.15-slim
|
|
124
|
+
WORKDIR /app
|
|
125
|
+
COPY requirements.txt .
|
|
126
|
+
RUN pip install --no-cache-dir -r requirements.txt
|
|
127
|
+
COPY . /app
|
|
128
|
+
CMD ["python", "-u", "app.py"]
|
|
129
|
+
```
|
|
130
|
+
|
|
116
131
|
Para garantir atualizações contínuas (*rolling updates zero-downtime*), configure o `docker-compose.yml` da stack no Swarm utilizando `order: start-first` e defina `stop_grace_period` com um valor superior ao `SHUTDOWN_TIMEOUT`:
|
|
117
132
|
|
|
118
133
|
```yaml
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
import logging
|
|
2
|
+
import os
|
|
3
|
+
import socket
|
|
4
|
+
import threading
|
|
5
|
+
import time
|
|
6
|
+
|
|
7
|
+
import waitress
|
|
8
|
+
from waitress import server as waitress_server
|
|
9
|
+
from waitress import wasyncore
|
|
10
|
+
from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
|
|
11
|
+
from flask import Flask
|
|
12
|
+
from flask_cors import CORS
|
|
13
|
+
from flask_swagger_generator.generators.swagger_view import SwaggerView
|
|
14
|
+
from prometheus_flask_exporter import PrometheusMetrics
|
|
15
|
+
|
|
16
|
+
from csctracker_py_core.models.emuns.config import Config
|
|
17
|
+
from csctracker_py_core.repository.http_repository import HttpRepository
|
|
18
|
+
from csctracker_py_core.repository.remote_repository import RemoteRepository
|
|
19
|
+
from csctracker_py_core.utils.configs import Configs
|
|
20
|
+
from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
|
|
21
|
+
from csctracker_py_core.utils.interceptor import Interceptor
|
|
22
|
+
from csctracker_py_core.utils.version import Version
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class Starter:
|
|
26
|
+
def __init__(self, static_folder="static", save_request=False, is_bff=False):
|
|
27
|
+
self.logger = logging.getLogger()
|
|
28
|
+
self.app = Flask(__name__, static_folder=static_folder)
|
|
29
|
+
try:
|
|
30
|
+
os.environ.pop("FLASK_RUN_FROM_CLI")
|
|
31
|
+
except:
|
|
32
|
+
pass
|
|
33
|
+
try:
|
|
34
|
+
os.environ.pop("FLASK_ENV")
|
|
35
|
+
except:
|
|
36
|
+
pass
|
|
37
|
+
SchedulerService.init(10)
|
|
38
|
+
self.cors = CORS(self.app)
|
|
39
|
+
self.app.config["CORS_HEADERS"] = "Content-Type"
|
|
40
|
+
self.config = Configs(os.getenv("PROFILE", "dev"))
|
|
41
|
+
shutdown_timeout = Configs.get_env_variable(Config.SHUTDOWN_TIMEOUT, default=30)
|
|
42
|
+
self.graceful_shutdown = GracefulShutdown.get_instance(timeout=shutdown_timeout)
|
|
43
|
+
self.graceful_shutdown.register_signals()
|
|
44
|
+
self.remote_repository = RemoteRepository()
|
|
45
|
+
self.http_repository = HttpRepository(remote_repository=self.remote_repository)
|
|
46
|
+
self.interceptor = Interceptor(
|
|
47
|
+
self.app, self.http_repository, save_request=save_request, is_bff=is_bff,
|
|
48
|
+
)
|
|
49
|
+
self.metrics = PrometheusMetrics(
|
|
50
|
+
self.app,
|
|
51
|
+
group_by="endpoint",
|
|
52
|
+
default_labels={"application": Version.get_app_name()},
|
|
53
|
+
)
|
|
54
|
+
self._swagger_initialized = False
|
|
55
|
+
|
|
56
|
+
@staticmethod
|
|
57
|
+
def _get_int_env(key: Config, default: int) -> int:
|
|
58
|
+
value = Configs.get_env_variable(key, default=default)
|
|
59
|
+
try:
|
|
60
|
+
return int(value)
|
|
61
|
+
except (TypeError, ValueError):
|
|
62
|
+
return default
|
|
63
|
+
|
|
64
|
+
@staticmethod
|
|
65
|
+
def _run_on_waitress_loop(triggers, callback, timeout: float = 1.5):
|
|
66
|
+
executed = False
|
|
67
|
+
exec_lock = threading.Lock()
|
|
68
|
+
|
|
69
|
+
def _run_once():
|
|
70
|
+
nonlocal executed
|
|
71
|
+
with exec_lock:
|
|
72
|
+
if executed:
|
|
73
|
+
return
|
|
74
|
+
executed = True
|
|
75
|
+
callback()
|
|
76
|
+
|
|
77
|
+
for trigger in triggers:
|
|
78
|
+
if not getattr(trigger, "_closed", False) and hasattr(trigger, "pull_trigger"):
|
|
79
|
+
done = threading.Event()
|
|
80
|
+
|
|
81
|
+
def _thunk():
|
|
82
|
+
try:
|
|
83
|
+
_run_once()
|
|
84
|
+
finally:
|
|
85
|
+
done.set()
|
|
86
|
+
|
|
87
|
+
try:
|
|
88
|
+
trigger.pull_trigger(_thunk)
|
|
89
|
+
if done.wait(timeout=timeout):
|
|
90
|
+
return
|
|
91
|
+
except Exception:
|
|
92
|
+
pass
|
|
93
|
+
|
|
94
|
+
_run_once()
|
|
95
|
+
|
|
96
|
+
@staticmethod
|
|
97
|
+
def _register_waitress_shutdown_hooks(graceful_shutdown: GracefulShutdown, server):
|
|
98
|
+
server_map = getattr(server, "_map", None)
|
|
99
|
+
if server_map is None:
|
|
100
|
+
server_map = getattr(server, "map", None)
|
|
101
|
+
|
|
102
|
+
def _collect_servers_and_triggers():
|
|
103
|
+
servers = []
|
|
104
|
+
triggers = []
|
|
105
|
+
if isinstance(server_map, dict):
|
|
106
|
+
for obj in list(server_map.values()):
|
|
107
|
+
if isinstance(obj, waitress_server.BaseWSGIServer):
|
|
108
|
+
servers.append(obj)
|
|
109
|
+
trig = getattr(obj, "trigger", None)
|
|
110
|
+
if trig is not None and trig not in triggers:
|
|
111
|
+
triggers.append(trig)
|
|
112
|
+
if not servers and isinstance(server, wasyncore.dispatcher):
|
|
113
|
+
servers.append(server)
|
|
114
|
+
trig = getattr(server, "trigger", None)
|
|
115
|
+
if trig is not None and trig not in triggers:
|
|
116
|
+
triggers.append(trig)
|
|
117
|
+
return servers, triggers
|
|
118
|
+
|
|
119
|
+
known_servers, known_triggers = _collect_servers_and_triggers()
|
|
120
|
+
|
|
121
|
+
def _get_servers_and_triggers():
|
|
122
|
+
servers, triggers = _collect_servers_and_triggers()
|
|
123
|
+
for srv in known_servers:
|
|
124
|
+
if srv not in servers:
|
|
125
|
+
servers.append(srv)
|
|
126
|
+
for trig in known_triggers:
|
|
127
|
+
if trig not in triggers:
|
|
128
|
+
triggers.append(trig)
|
|
129
|
+
return servers, triggers
|
|
130
|
+
|
|
131
|
+
def close_listener():
|
|
132
|
+
servers, triggers = _get_servers_and_triggers()
|
|
133
|
+
|
|
134
|
+
def _close_listeners_sync():
|
|
135
|
+
# Close only accepting sockets on the wasyncore thread so select() releases
|
|
136
|
+
# kernel socket refs immediately on Linux while keeping trigger open for drain.
|
|
137
|
+
for srv in servers:
|
|
138
|
+
sock = getattr(srv, "socket", None)
|
|
139
|
+
if sock is not None:
|
|
140
|
+
try:
|
|
141
|
+
sock.shutdown(socket.SHUT_RDWR)
|
|
142
|
+
except OSError:
|
|
143
|
+
pass
|
|
144
|
+
wasyncore.dispatcher.close(srv)
|
|
145
|
+
|
|
146
|
+
Starter._run_on_waitress_loop(triggers, _close_listeners_sync, timeout=1.5)
|
|
147
|
+
|
|
148
|
+
def finalize_server(remaining_timeout: float):
|
|
149
|
+
deadline = time.time() + max(0.0, remaining_timeout)
|
|
150
|
+
task_dispatcher = getattr(server, "task_dispatcher", None)
|
|
151
|
+
if task_dispatcher is not None:
|
|
152
|
+
task_dispatcher.shutdown(
|
|
153
|
+
cancel_pending=False,
|
|
154
|
+
timeout=max(0.1, deadline - time.time()),
|
|
155
|
+
)
|
|
156
|
+
|
|
157
|
+
if isinstance(server_map, dict):
|
|
158
|
+
while time.time() < deadline:
|
|
159
|
+
if not any(
|
|
160
|
+
getattr(ch, "total_outbufs_len", 0) > 0
|
|
161
|
+
for ch in list(server_map.values())
|
|
162
|
+
):
|
|
163
|
+
break
|
|
164
|
+
time.sleep(0.01)
|
|
165
|
+
|
|
166
|
+
servers, triggers = _get_servers_and_triggers()
|
|
167
|
+
if not triggers:
|
|
168
|
+
trig = getattr(server, "trigger", None)
|
|
169
|
+
if trig is not None:
|
|
170
|
+
triggers.append(trig)
|
|
171
|
+
|
|
172
|
+
def _close_remaining_sync():
|
|
173
|
+
if isinstance(server_map, dict):
|
|
174
|
+
for ch in list(server_map.values()):
|
|
175
|
+
if ch in servers or ch in triggers:
|
|
176
|
+
continue
|
|
177
|
+
if hasattr(ch, "close"):
|
|
178
|
+
try:
|
|
179
|
+
ch.close()
|
|
180
|
+
except Exception:
|
|
181
|
+
pass
|
|
182
|
+
|
|
183
|
+
for trig in triggers:
|
|
184
|
+
if hasattr(trig, "close"):
|
|
185
|
+
try:
|
|
186
|
+
trig.close()
|
|
187
|
+
except Exception:
|
|
188
|
+
pass
|
|
189
|
+
|
|
190
|
+
Starter._run_on_waitress_loop(
|
|
191
|
+
triggers,
|
|
192
|
+
_close_remaining_sync,
|
|
193
|
+
timeout=min(1.5, max(0.2, deadline - time.time())),
|
|
194
|
+
)
|
|
195
|
+
|
|
196
|
+
graceful_shutdown.set_server_close_hook(close_listener)
|
|
197
|
+
graceful_shutdown.set_server_post_drain_hook(finalize_server)
|
|
198
|
+
|
|
199
|
+
def register_shutdown_hook(self, callback):
|
|
200
|
+
self.graceful_shutdown.register_shutdown_hook(callback)
|
|
201
|
+
|
|
202
|
+
def get_graceful_shutdown(self):
|
|
203
|
+
return self.graceful_shutdown
|
|
204
|
+
|
|
205
|
+
def get_remote_repository(self):
|
|
206
|
+
return self.remote_repository
|
|
207
|
+
|
|
208
|
+
def get_http_repository(self):
|
|
209
|
+
return self.http_repository
|
|
210
|
+
|
|
211
|
+
def get_app(self):
|
|
212
|
+
return self.app
|
|
213
|
+
|
|
214
|
+
def start(self):
|
|
215
|
+
if not self._swagger_initialized:
|
|
216
|
+
SwaggerView.init(
|
|
217
|
+
self.app,
|
|
218
|
+
application_name=Version.get_app_name(),
|
|
219
|
+
application_version=Version.get_version(),
|
|
220
|
+
swagger_destination_path="swagger.yaml",
|
|
221
|
+
)
|
|
222
|
+
self._swagger_initialized = True
|
|
223
|
+
|
|
224
|
+
port = self._get_int_env(Config.PORT, default=5000)
|
|
225
|
+
|
|
226
|
+
if Configs.is_debug():
|
|
227
|
+
self.logger.info(
|
|
228
|
+
f"Starting Flask development server (DEBUG=1) on 0.0.0.0:{port}"
|
|
229
|
+
)
|
|
230
|
+
self.app.run(host="0.0.0.0", port=port)
|
|
231
|
+
return
|
|
232
|
+
|
|
233
|
+
threads = self._get_int_env(Config.WSGI_THREADS, default=32)
|
|
234
|
+
channel_timeout = self._get_int_env(Config.WSGI_CHANNEL_TIMEOUT, default=600)
|
|
235
|
+
self.logger.info(
|
|
236
|
+
f"Starting Waitress WSGI server on 0.0.0.0:{port} "
|
|
237
|
+
f"(threads={threads}, channel_timeout={channel_timeout}s)"
|
|
238
|
+
)
|
|
239
|
+
server = waitress.create_server(
|
|
240
|
+
self.app,
|
|
241
|
+
host="0.0.0.0",
|
|
242
|
+
port=port,
|
|
243
|
+
threads=threads,
|
|
244
|
+
channel_timeout=channel_timeout,
|
|
245
|
+
)
|
|
246
|
+
self._register_waitress_shutdown_hooks(self.graceful_shutdown, server)
|
|
247
|
+
server.run()
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/configs.py
RENAMED
|
@@ -4,14 +4,14 @@ import logging
|
|
|
4
4
|
import os
|
|
5
5
|
|
|
6
6
|
from dotenv import load_dotenv
|
|
7
|
-
from pythonjsonlogger import
|
|
7
|
+
from pythonjsonlogger.json import JsonFormatter
|
|
8
8
|
|
|
9
9
|
from csctracker_py_core.models.emuns.config import Config
|
|
10
10
|
from csctracker_py_core.utils.request_info import RequestInfo
|
|
11
11
|
from csctracker_py_core.utils.version import Version
|
|
12
12
|
|
|
13
13
|
|
|
14
|
-
class CustomJsonFormatter(
|
|
14
|
+
class CustomJsonFormatter(JsonFormatter):
|
|
15
15
|
def add_fields(self, log_record, record, message_dict):
|
|
16
16
|
super().add_fields(log_record, record, message_dict)
|
|
17
17
|
log_record["requestId"] = RequestInfo.get_request_id()
|
|
@@ -18,6 +18,8 @@ class GracefulShutdown:
|
|
|
18
18
|
self.active_requests = 0
|
|
19
19
|
self._condition = threading.Condition(self._lock)
|
|
20
20
|
self._shutdown_hooks: List[Callable] = []
|
|
21
|
+
self._server_close_hook: Optional[Callable] = None
|
|
22
|
+
self._server_post_drain_hook: Optional[Callable[[float], None]] = None
|
|
21
23
|
self.logger = logging.getLogger()
|
|
22
24
|
|
|
23
25
|
@classmethod
|
|
@@ -59,6 +61,14 @@ class GracefulShutdown:
|
|
|
59
61
|
with self._lock:
|
|
60
62
|
self._shutdown_hooks.append(callback)
|
|
61
63
|
|
|
64
|
+
def set_server_close_hook(self, callback: Optional[Callable]):
|
|
65
|
+
with self._lock:
|
|
66
|
+
self._server_close_hook = callback
|
|
67
|
+
|
|
68
|
+
def set_server_post_drain_hook(self, callback: Optional[Callable[[float], None]]):
|
|
69
|
+
with self._lock:
|
|
70
|
+
self._server_post_drain_hook = callback
|
|
71
|
+
|
|
62
72
|
def _handle_signal(self, signum, frame):
|
|
63
73
|
signal_name = "SIGTERM" if signum == signal.SIGTERM else ("SIGINT" if signum == signal.SIGINT else str(signum))
|
|
64
74
|
self.logger.info(f"Signal {signal_name} received. Starting graceful shutdown...")
|
|
@@ -76,6 +86,17 @@ class GracefulShutdown:
|
|
|
76
86
|
timeout = override_timeout if override_timeout is not None else self.timeout
|
|
77
87
|
start_time = time.time()
|
|
78
88
|
|
|
89
|
+
# 0. Stop accepting new HTTP connections if a WSGI server close hook is registered
|
|
90
|
+
with self._lock:
|
|
91
|
+
server_close_hook = self._server_close_hook
|
|
92
|
+
self._server_close_hook = None
|
|
93
|
+
|
|
94
|
+
if server_close_hook is not None:
|
|
95
|
+
try:
|
|
96
|
+
server_close_hook()
|
|
97
|
+
except Exception as e:
|
|
98
|
+
self.logger.error(f"Error closing WSGI server listener: {e}")
|
|
99
|
+
|
|
79
100
|
# 1. Wait for active HTTP requests to reach 0
|
|
80
101
|
with self._condition:
|
|
81
102
|
while self.active_requests > 0:
|
|
@@ -88,6 +109,18 @@ class GracefulShutdown:
|
|
|
88
109
|
break
|
|
89
110
|
self._condition.wait(timeout=min(remaining, 0.5))
|
|
90
111
|
|
|
112
|
+
# 1.5. Finalize WSGI server (flush response buffers and close wake-up trigger)
|
|
113
|
+
with self._lock:
|
|
114
|
+
post_drain_hook = self._server_post_drain_hook
|
|
115
|
+
self._server_post_drain_hook = None
|
|
116
|
+
|
|
117
|
+
if post_drain_hook is not None:
|
|
118
|
+
try:
|
|
119
|
+
remaining = max(0.0, timeout - (time.time() - start_time))
|
|
120
|
+
post_drain_hook(remaining)
|
|
121
|
+
except Exception as e:
|
|
122
|
+
self.logger.error(f"Error finalizing WSGI server shutdown: {e}")
|
|
123
|
+
|
|
91
124
|
# 2. Wait for SchedulerService queue to be empty and pending tasks to finish
|
|
92
125
|
self._wait_for_scheduler_queue(start_time, timeout)
|
|
93
126
|
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/interceptor.py
RENAMED
|
@@ -4,7 +4,7 @@ import time
|
|
|
4
4
|
from datetime import datetime
|
|
5
5
|
|
|
6
6
|
from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
|
|
7
|
-
from flask import Flask, request, g
|
|
7
|
+
from flask import Flask, Response, request, g
|
|
8
8
|
|
|
9
9
|
from csctracker_py_core.models.emuns.config import Config
|
|
10
10
|
from csctracker_py_core.repository.http_repository import HttpRepository
|
|
@@ -27,16 +27,30 @@ class Interceptor:
|
|
|
27
27
|
def __init(self):
|
|
28
28
|
@self.app.before_request
|
|
29
29
|
def start_timer():
|
|
30
|
-
GracefulShutdown.get_instance().start_request()
|
|
31
30
|
g.start = time.time()
|
|
32
31
|
correlation_id = RequestInfo.get_correlation_id()
|
|
33
32
|
g.correlation_id = correlation_id
|
|
33
|
+
g._counted_request = False
|
|
34
34
|
thread = threading.current_thread()
|
|
35
35
|
thread.correlation_id = correlation_id
|
|
36
36
|
|
|
37
|
+
shutdown = GracefulShutdown.get_instance()
|
|
38
|
+
if shutdown.is_shutting_down:
|
|
39
|
+
return Response(
|
|
40
|
+
'{"error": "Service shutting down"}',
|
|
41
|
+
status=503,
|
|
42
|
+
mimetype="application/json",
|
|
43
|
+
headers={"Connection": "close"},
|
|
44
|
+
)
|
|
45
|
+
|
|
46
|
+
shutdown.start_request()
|
|
47
|
+
g._counted_request = True
|
|
48
|
+
|
|
37
49
|
@self.app.teardown_request
|
|
38
50
|
def teardown_request(exception=None):
|
|
39
|
-
|
|
51
|
+
if getattr(g, "_counted_request", False):
|
|
52
|
+
g._counted_request = False
|
|
53
|
+
GracefulShutdown.get_instance().end_request()
|
|
40
54
|
|
|
41
55
|
@self.app.after_request
|
|
42
56
|
def log_request(response):
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core.egg-info/PKG-INFO
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: csctracker-py-core
|
|
3
|
-
Version: 26.
|
|
3
|
+
Version: 26.47.3
|
|
4
4
|
Summary: A base library for microservices with Flask, JSON logging, and Prometheus telemetry.
|
|
5
5
|
Home-page: https://github.com/krlsedu/CscTrackerPyCore
|
|
6
6
|
Author: Carlos Eduardo
|
|
@@ -17,24 +17,26 @@ Classifier: Topic :: System :: Monitoring
|
|
|
17
17
|
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
|
|
18
18
|
Classifier: License :: OSI Approved :: MIT License
|
|
19
19
|
Classifier: Programming Language :: Python :: 3
|
|
20
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
21
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
22
20
|
Classifier: Programming Language :: Python :: 3.11
|
|
23
21
|
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
24
25
|
Classifier: Operating System :: OS Independent
|
|
25
|
-
Requires-Python: >=3.
|
|
26
|
+
Requires-Python: >=3.11
|
|
26
27
|
Description-Content-Type: text/markdown
|
|
27
28
|
License-File: LICENSE
|
|
28
|
-
Requires-Dist: csctracker-queue-scheduler
|
|
29
|
-
Requires-Dist: flask
|
|
30
|
-
Requires-Dist:
|
|
31
|
-
Requires-Dist: python-
|
|
32
|
-
Requires-Dist:
|
|
33
|
-
Requires-Dist:
|
|
34
|
-
Requires-Dist:
|
|
35
|
-
Requires-Dist:
|
|
36
|
-
Requires-Dist: flask-
|
|
37
|
-
Requires-Dist: pytz
|
|
29
|
+
Requires-Dist: csctracker-queue-scheduler>=26.47.1
|
|
30
|
+
Requires-Dist: flask-swagger-init>=26.47.2
|
|
31
|
+
Requires-Dist: flask<4,>=3.1
|
|
32
|
+
Requires-Dist: python-json-logger<5,>=3.0
|
|
33
|
+
Requires-Dist: python-dotenv<2,>=1.0
|
|
34
|
+
Requires-Dist: requests<3,>=2.32
|
|
35
|
+
Requires-Dist: beautifulsoup4<5,>=4.12
|
|
36
|
+
Requires-Dist: flask-cors<7,>=6.0
|
|
37
|
+
Requires-Dist: prometheus-flask-exporter<1,>=0.23.2
|
|
38
|
+
Requires-Dist: pytz>=2026.1
|
|
39
|
+
Requires-Dist: waitress<4,>=3.0.0
|
|
38
40
|
Dynamic: author
|
|
39
41
|
Dynamic: classifier
|
|
40
42
|
Dynamic: description
|
|
@@ -59,7 +61,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
59
61
|
|
|
60
62
|
## Principais Funcionalidades
|
|
61
63
|
|
|
62
|
-
- **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS
|
|
64
|
+
- **Starter Facilitado (WSGI Nativo)**: Inicialização rápida de aplicações Flask com suporte a CORS, servidor WSGI de produção (**Waitress**, multi-thread e sem `fork()`) por padrão no `starter.start()` e fallback automático para Werkzeug em desenvolvimento local via `DEBUG=1`.
|
|
63
65
|
- **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
|
|
64
66
|
- **Observabilidade**:
|
|
65
67
|
- Integração nativa com **Prometheus** para coleta de métricas de endpoints.
|
|
@@ -71,9 +73,10 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
|
|
|
71
73
|
|
|
72
74
|
## Requisitos
|
|
73
75
|
|
|
74
|
-
- Python 3.
|
|
76
|
+
- Python 3.11+ (validado em Python 3.15)
|
|
75
77
|
- Flask
|
|
76
78
|
- Flask-CORS
|
|
79
|
+
- Waitress (WSGI de produção)
|
|
77
80
|
- Prometheus Flask Exporter
|
|
78
81
|
- Flask Swagger Generator
|
|
79
82
|
- Python JSON Logger
|
|
@@ -109,7 +112,9 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
|
|
|
109
112
|
| `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
|
|
110
113
|
| `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
|
|
111
114
|
| `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
|
|
112
|
-
| `
|
|
115
|
+
| `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
|
|
116
|
+
| `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
|
|
117
|
+
| `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
|
|
113
118
|
|
|
114
119
|
## Uso Didático
|
|
115
120
|
|
|
@@ -132,6 +137,7 @@ def hello():
|
|
|
132
137
|
return {"message": "CscTrackerPyCore is running!"}
|
|
133
138
|
|
|
134
139
|
if __name__ == '__main__':
|
|
140
|
+
# Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
|
|
135
141
|
starter.start()
|
|
136
142
|
```
|
|
137
143
|
|
|
@@ -163,6 +169,17 @@ starter.register_shutdown_hook(cleanup_resources)
|
|
|
163
169
|
|
|
164
170
|
## Implantação no Docker Swarm
|
|
165
171
|
|
|
172
|
+
Nos serviços que consomem `csctracker-py-core`, recomenda-se manter `CMD ["python", "-u", "app.py"]` (que inicia o Waitress automaticamente via `starter.start()` quando `DEBUG` não é `1`) e copiar `requirements.txt` antes do código-fonte no `Dockerfile` para aproveitar o cache de layers:
|
|
173
|
+
|
|
174
|
+
```dockerfile
|
|
175
|
+
FROM python:3.15-slim
|
|
176
|
+
WORKDIR /app
|
|
177
|
+
COPY requirements.txt .
|
|
178
|
+
RUN pip install --no-cache-dir -r requirements.txt
|
|
179
|
+
COPY . /app
|
|
180
|
+
CMD ["python", "-u", "app.py"]
|
|
181
|
+
```
|
|
182
|
+
|
|
166
183
|
Para garantir atualizações contínuas (*rolling updates zero-downtime*), configure o `docker-compose.yml` da stack no Swarm utilizando `order: start-first` e defina `stop_grace_period` com um valor superior ao `SHUTDOWN_TIMEOUT`:
|
|
167
184
|
|
|
168
185
|
```yaml
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core.egg-info/SOURCES.txt
RENAMED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
LICENSE
|
|
2
|
+
MANIFEST.in
|
|
2
3
|
README.md
|
|
4
|
+
requirements.txt
|
|
3
5
|
setup.cfg
|
|
4
6
|
setup.py
|
|
7
|
+
version.py
|
|
8
|
+
version.txt
|
|
5
9
|
csctracker_py_core/__init__.py
|
|
6
10
|
csctracker_py_core/starter.py
|
|
7
11
|
csctracker_py_core.egg-info/PKG-INFO
|
|
@@ -22,4 +26,5 @@ csctracker_py_core/utils/interceptor.py
|
|
|
22
26
|
csctracker_py_core/utils/request_info.py
|
|
23
27
|
csctracker_py_core/utils/utils.py
|
|
24
28
|
csctracker_py_core/utils/version.py
|
|
25
|
-
tests/test_graceful_shutdown.py
|
|
29
|
+
tests/test_graceful_shutdown.py
|
|
30
|
+
tests/test_starter_wsgi.py
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
csctracker-queue-scheduler>=26.47.1
|
|
2
|
+
flask-swagger-init>=26.47.2
|
|
3
|
+
flask<4,>=3.1
|
|
4
|
+
python-json-logger<5,>=3.0
|
|
5
|
+
python-dotenv<2,>=1.0
|
|
6
|
+
requests<3,>=2.32
|
|
7
|
+
beautifulsoup4<5,>=4.12
|
|
8
|
+
flask-cors<7,>=6.0
|
|
9
|
+
prometheus-flask-exporter<1,>=0.23.2
|
|
10
|
+
pytz>=2026.1
|
|
11
|
+
waitress<4,>=3.0.0
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
csctracker-queue-scheduler>=26.47.1
|
|
2
|
+
flask-swagger-init>=26.47.2
|
|
3
|
+
flask>=3.1,<4
|
|
4
|
+
python-json-logger>=3.0,<5
|
|
5
|
+
python-dotenv>=1.0,<2
|
|
6
|
+
requests>=2.32,<3
|
|
7
|
+
beautifulsoup4>=4.12,<5
|
|
8
|
+
flask-cors>=6.0,<7
|
|
9
|
+
prometheus-flask-exporter>=0.23.2,<1
|
|
10
|
+
pytz>=2026.1
|
|
11
|
+
waitress>=3.0.0,<4
|
|
@@ -6,8 +6,8 @@ VERSION = get_version()
|
|
|
6
6
|
with open("README.md", "r", encoding="utf-8") as fh:
|
|
7
7
|
long_description = fh.read()
|
|
8
8
|
|
|
9
|
-
with open("requirements.txt") as f:
|
|
10
|
-
required =
|
|
9
|
+
with open("requirements.txt", encoding="utf-8") as f:
|
|
10
|
+
required = [line.strip() for line in f if line.strip()]
|
|
11
11
|
|
|
12
12
|
setuptools.setup(
|
|
13
13
|
name="csctracker-py-core",
|
|
@@ -47,13 +47,14 @@ setuptools.setup(
|
|
|
47
47
|
"Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware",
|
|
48
48
|
"License :: OSI Approved :: MIT License",
|
|
49
49
|
"Programming Language :: Python :: 3",
|
|
50
|
-
"Programming Language :: Python :: 3.9",
|
|
51
|
-
"Programming Language :: Python :: 3.10",
|
|
52
50
|
"Programming Language :: Python :: 3.11",
|
|
53
51
|
"Programming Language :: Python :: 3.12",
|
|
52
|
+
"Programming Language :: Python :: 3.13",
|
|
53
|
+
"Programming Language :: Python :: 3.14",
|
|
54
|
+
"Programming Language :: Python :: 3.15",
|
|
54
55
|
"Operating System :: OS Independent",
|
|
55
56
|
],
|
|
56
57
|
install_requires=required,
|
|
57
|
-
python_requires=">=3.
|
|
58
|
+
python_requires=">=3.11",
|
|
58
59
|
include_package_data=True,
|
|
59
60
|
)
|
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
import json
|
|
2
|
+
import logging
|
|
3
|
+
import os
|
|
4
|
+
import socket
|
|
5
|
+
import threading
|
|
6
|
+
import time
|
|
7
|
+
import unittest
|
|
8
|
+
import urllib.request
|
|
9
|
+
import warnings
|
|
10
|
+
from unittest.mock import MagicMock, patch
|
|
11
|
+
|
|
12
|
+
import waitress
|
|
13
|
+
from bs4 import BeautifulSoup
|
|
14
|
+
from flask import Flask
|
|
15
|
+
|
|
16
|
+
from csctracker_py_core.repository.http_repository import HttpRepository
|
|
17
|
+
from csctracker_py_core.repository.remote_repository import RemoteRepository
|
|
18
|
+
from csctracker_py_core.starter import Starter
|
|
19
|
+
from csctracker_py_core.utils.configs import CustomJsonFormatter
|
|
20
|
+
from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
|
|
21
|
+
from csctracker_py_core.utils.interceptor import Interceptor
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
class TestStarterWsgi(unittest.TestCase):
|
|
25
|
+
def setUp(self):
|
|
26
|
+
GracefulShutdown.reset_instance()
|
|
27
|
+
self._env_backup = os.environ.copy()
|
|
28
|
+
for key in ("DEBUG", "PORT", "WSGI_THREADS", "WSGI_CHANNEL_TIMEOUT"):
|
|
29
|
+
os.environ.pop(key, None)
|
|
30
|
+
|
|
31
|
+
def tearDown(self):
|
|
32
|
+
os.environ.clear()
|
|
33
|
+
os.environ.update(self._env_backup)
|
|
34
|
+
GracefulShutdown.reset_instance()
|
|
35
|
+
|
|
36
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
37
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
38
|
+
def test_start_uses_waitress_by_default(self, mock_create_server, mock_swagger_init):
|
|
39
|
+
mock_server = MagicMock()
|
|
40
|
+
mock_create_server.return_value = mock_server
|
|
41
|
+
|
|
42
|
+
starter = Starter(save_request=False)
|
|
43
|
+
with patch.object(starter.app, "run") as mock_flask_run:
|
|
44
|
+
starter.start()
|
|
45
|
+
|
|
46
|
+
mock_swagger_init.assert_called_once()
|
|
47
|
+
mock_flask_run.assert_not_called()
|
|
48
|
+
mock_create_server.assert_called_once_with(
|
|
49
|
+
starter.app,
|
|
50
|
+
host="0.0.0.0",
|
|
51
|
+
port=5000,
|
|
52
|
+
threads=32,
|
|
53
|
+
channel_timeout=600,
|
|
54
|
+
)
|
|
55
|
+
mock_server.run.assert_called_once()
|
|
56
|
+
shutdown = starter.get_graceful_shutdown()
|
|
57
|
+
self.assertTrue(callable(shutdown._server_close_hook))
|
|
58
|
+
self.assertTrue(callable(shutdown._server_post_drain_hook))
|
|
59
|
+
|
|
60
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
61
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
62
|
+
def test_start_respects_wsgi_env_overrides(self, mock_create_server, mock_swagger_init):
|
|
63
|
+
os.environ["PORT"] = "8085"
|
|
64
|
+
os.environ["WSGI_THREADS"] = "64"
|
|
65
|
+
os.environ["WSGI_CHANNEL_TIMEOUT"] = "900"
|
|
66
|
+
mock_server = MagicMock()
|
|
67
|
+
mock_create_server.return_value = mock_server
|
|
68
|
+
|
|
69
|
+
starter = Starter(save_request=False)
|
|
70
|
+
starter.start()
|
|
71
|
+
|
|
72
|
+
mock_create_server.assert_called_once_with(
|
|
73
|
+
starter.app,
|
|
74
|
+
host="0.0.0.0",
|
|
75
|
+
port=8085,
|
|
76
|
+
threads=64,
|
|
77
|
+
channel_timeout=900,
|
|
78
|
+
)
|
|
79
|
+
mock_server.run.assert_called_once()
|
|
80
|
+
|
|
81
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
82
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
83
|
+
def test_start_falls_back_to_defaults_on_invalid_int_envs(
|
|
84
|
+
self, mock_create_server, mock_swagger_init
|
|
85
|
+
):
|
|
86
|
+
os.environ["PORT"] = ""
|
|
87
|
+
os.environ["WSGI_THREADS"] = "invalid"
|
|
88
|
+
os.environ["WSGI_CHANNEL_TIMEOUT"] = ""
|
|
89
|
+
mock_server = MagicMock()
|
|
90
|
+
mock_create_server.return_value = mock_server
|
|
91
|
+
|
|
92
|
+
starter = Starter(save_request=False)
|
|
93
|
+
starter.start()
|
|
94
|
+
|
|
95
|
+
mock_create_server.assert_called_once_with(
|
|
96
|
+
starter.app,
|
|
97
|
+
host="0.0.0.0",
|
|
98
|
+
port=5000,
|
|
99
|
+
threads=32,
|
|
100
|
+
channel_timeout=600,
|
|
101
|
+
)
|
|
102
|
+
|
|
103
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
104
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
105
|
+
def test_start_uses_werkzeug_when_debug_is_1(
|
|
106
|
+
self, mock_create_server, mock_swagger_init
|
|
107
|
+
):
|
|
108
|
+
os.environ["DEBUG"] = "1"
|
|
109
|
+
os.environ["PORT"] = "5050"
|
|
110
|
+
|
|
111
|
+
starter = Starter(save_request=False)
|
|
112
|
+
with patch.object(starter.app, "run") as mock_flask_run:
|
|
113
|
+
starter.start()
|
|
114
|
+
|
|
115
|
+
mock_swagger_init.assert_called_once()
|
|
116
|
+
mock_create_server.assert_not_called()
|
|
117
|
+
mock_flask_run.assert_called_once_with(host="0.0.0.0", port=5050)
|
|
118
|
+
|
|
119
|
+
@patch("csctracker_py_core.starter.SwaggerView.init")
|
|
120
|
+
@patch("csctracker_py_core.starter.waitress.create_server")
|
|
121
|
+
def test_swagger_init_is_idempotent(self, mock_create_server, mock_swagger_init):
|
|
122
|
+
mock_create_server.return_value = MagicMock()
|
|
123
|
+
|
|
124
|
+
starter = Starter(save_request=False)
|
|
125
|
+
starter.start()
|
|
126
|
+
starter.start()
|
|
127
|
+
|
|
128
|
+
mock_swagger_init.assert_called_once()
|
|
129
|
+
|
|
130
|
+
def test_graceful_shutdown_closes_server_before_hooks(self):
|
|
131
|
+
shutdown = GracefulShutdown.get_instance(timeout=5)
|
|
132
|
+
events = []
|
|
133
|
+
|
|
134
|
+
shutdown.set_server_close_hook(lambda: events.append("server_close"))
|
|
135
|
+
shutdown.set_server_post_drain_hook(lambda rem: events.append("post_drain"))
|
|
136
|
+
shutdown.register_shutdown_hook(lambda: events.append("shutdown_hook"))
|
|
137
|
+
|
|
138
|
+
shutdown.wait_for_drain(timeout=2, exit_process=False)
|
|
139
|
+
self.assertEqual(events, ["server_close", "post_drain", "shutdown_hook"])
|
|
140
|
+
|
|
141
|
+
# Subsequent drain must not call server_close or post_drain again
|
|
142
|
+
events.clear()
|
|
143
|
+
shutdown.wait_for_drain(timeout=2, exit_process=False)
|
|
144
|
+
self.assertEqual(events, ["shutdown_hook"])
|
|
145
|
+
|
|
146
|
+
def test_graceful_shutdown_continues_if_server_close_raises(self):
|
|
147
|
+
shutdown = GracefulShutdown.get_instance(timeout=5)
|
|
148
|
+
hook_called = []
|
|
149
|
+
|
|
150
|
+
def broken_close():
|
|
151
|
+
raise RuntimeError("socket already closed")
|
|
152
|
+
|
|
153
|
+
shutdown.set_server_close_hook(broken_close)
|
|
154
|
+
shutdown.register_shutdown_hook(lambda: hook_called.append(True))
|
|
155
|
+
|
|
156
|
+
shutdown.wait_for_drain(timeout=2, exit_process=False)
|
|
157
|
+
self.assertEqual(hook_called, [True])
|
|
158
|
+
|
|
159
|
+
def test_custom_json_formatter_python_json_logger_v4(self):
|
|
160
|
+
formatter = CustomJsonFormatter(
|
|
161
|
+
"%(levelname)s %(name)s %(requestId)s %(appName)s %(message)s"
|
|
162
|
+
)
|
|
163
|
+
record = logging.LogRecord(
|
|
164
|
+
"test_logger", logging.INFO, __file__, 42, "hello json", (), None
|
|
165
|
+
)
|
|
166
|
+
parsed = json.loads(formatter.format(record))
|
|
167
|
+
|
|
168
|
+
self.assertEqual(parsed["message"], "hello json")
|
|
169
|
+
self.assertEqual(parsed["levelname"], "INFO")
|
|
170
|
+
self.assertIn("requestId", parsed)
|
|
171
|
+
self.assertIn("appName", parsed)
|
|
172
|
+
self.assertIn("appVersion", parsed)
|
|
173
|
+
self.assertIn("name", parsed)
|
|
174
|
+
|
|
175
|
+
def test_interceptor_returns_503_connection_close_when_shutting_down(self):
|
|
176
|
+
shutdown = GracefulShutdown.get_instance(timeout=5)
|
|
177
|
+
app = Flask(__name__)
|
|
178
|
+
Interceptor(app, HttpRepository(RemoteRepository()), save_request=False)
|
|
179
|
+
|
|
180
|
+
@app.route("/ping")
|
|
181
|
+
def ping():
|
|
182
|
+
return {"status": "ok"}
|
|
183
|
+
|
|
184
|
+
shutdown.is_shutting_down = True
|
|
185
|
+
resp = app.test_client().get("/ping")
|
|
186
|
+
|
|
187
|
+
self.assertEqual(resp.status_code, 503)
|
|
188
|
+
self.assertEqual(resp.headers.get("Connection"), "close")
|
|
189
|
+
self.assertEqual(resp.get_json(), {"error": "Service shutting down"})
|
|
190
|
+
self.assertEqual(shutdown.active_requests, 0)
|
|
191
|
+
|
|
192
|
+
def test_http_repository_find_value_text_with_modern_bs4(self):
|
|
193
|
+
html = "<div><span>Label</span><strong>42,50</strong></div>"
|
|
194
|
+
soup = BeautifulSoup(html, "html.parser")
|
|
195
|
+
repo = HttpRepository(RemoteRepository())
|
|
196
|
+
|
|
197
|
+
with warnings.catch_warnings(record=True) as caught:
|
|
198
|
+
warnings.simplefilter("always", DeprecationWarning)
|
|
199
|
+
value = repo.find_value(soup, "Label", "text", parents=2, children=0)
|
|
200
|
+
|
|
201
|
+
self.assertEqual(value, "42,50")
|
|
202
|
+
bs4_deprecations = [
|
|
203
|
+
w for w in caught if issubclass(w.category, DeprecationWarning)
|
|
204
|
+
]
|
|
205
|
+
self.assertEqual(bs4_deprecations, [])
|
|
206
|
+
|
|
207
|
+
def test_waitress_real_drain_flushes_inflight_request_without_trigger_error(self):
|
|
208
|
+
shutdown = GracefulShutdown.get_instance(timeout=5)
|
|
209
|
+
app = Flask(__name__)
|
|
210
|
+
Interceptor(app, HttpRepository(RemoteRepository()), save_request=False)
|
|
211
|
+
|
|
212
|
+
started = threading.Event()
|
|
213
|
+
release = threading.Event()
|
|
214
|
+
|
|
215
|
+
@app.route("/slow")
|
|
216
|
+
def slow():
|
|
217
|
+
started.set()
|
|
218
|
+
release.wait(timeout=4)
|
|
219
|
+
return {"status": "completed"}
|
|
220
|
+
|
|
221
|
+
server = waitress.create_server(app, host="127.0.0.1", port=0, threads=4)
|
|
222
|
+
Starter._register_waitress_shutdown_hooks(shutdown, server)
|
|
223
|
+
port = getattr(server, "effective_port", None) or server.getsockname()[1]
|
|
224
|
+
|
|
225
|
+
server_thread = threading.Thread(target=server.run, daemon=True)
|
|
226
|
+
server_thread.start()
|
|
227
|
+
|
|
228
|
+
response_result = {}
|
|
229
|
+
|
|
230
|
+
def do_request():
|
|
231
|
+
try:
|
|
232
|
+
with urllib.request.urlopen(
|
|
233
|
+
f"http://127.0.0.1:{port}/slow", timeout=5
|
|
234
|
+
) as resp:
|
|
235
|
+
response_result["status"] = resp.status
|
|
236
|
+
response_result["body"] = json.loads(resp.read().decode("utf-8"))
|
|
237
|
+
except Exception as exc:
|
|
238
|
+
response_result["error"] = exc
|
|
239
|
+
|
|
240
|
+
req_thread = threading.Thread(target=do_request, daemon=True)
|
|
241
|
+
req_thread.start()
|
|
242
|
+
self.assertTrue(started.wait(timeout=2))
|
|
243
|
+
|
|
244
|
+
shutdown.is_shutting_down = True
|
|
245
|
+
drain_thread = threading.Thread(
|
|
246
|
+
target=shutdown.wait_for_drain,
|
|
247
|
+
kwargs={"timeout": 5, "exit_process": False},
|
|
248
|
+
daemon=True,
|
|
249
|
+
)
|
|
250
|
+
drain_thread.start()
|
|
251
|
+
|
|
252
|
+
deadline = time.time() + 2
|
|
253
|
+
while (server.accepting or server.socket is not None) and time.time() < deadline:
|
|
254
|
+
time.sleep(0.01)
|
|
255
|
+
self.assertFalse(server.accepting)
|
|
256
|
+
self.assertIsNone(server.socket)
|
|
257
|
+
|
|
258
|
+
with self.assertRaises(OSError):
|
|
259
|
+
with socket.create_connection(("127.0.0.1", port), timeout=0.5):
|
|
260
|
+
pass
|
|
261
|
+
|
|
262
|
+
release.set()
|
|
263
|
+
req_thread.join(timeout=5)
|
|
264
|
+
drain_thread.join(timeout=5)
|
|
265
|
+
server_thread.join(timeout=5)
|
|
266
|
+
|
|
267
|
+
self.assertNotIn("error", response_result)
|
|
268
|
+
self.assertEqual(response_result.get("status"), 200)
|
|
269
|
+
self.assertEqual(response_result.get("body"), {"status": "completed"})
|
|
270
|
+
self.assertEqual(shutdown.active_requests, 0)
|
|
271
|
+
self.assertFalse(drain_thread.is_alive())
|
|
272
|
+
self.assertFalse(server_thread.is_alive())
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
if __name__ == "__main__":
|
|
276
|
+
unittest.main()
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
26.47.003
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
import logging
|
|
2
|
-
import os
|
|
3
|
-
|
|
4
|
-
from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
|
|
5
|
-
from flask import Flask
|
|
6
|
-
from flask_cors import CORS
|
|
7
|
-
from flask_swagger_generator.generators.swagger_view import SwaggerView
|
|
8
|
-
from prometheus_flask_exporter import PrometheusMetrics
|
|
9
|
-
|
|
10
|
-
from csctracker_py_core.models.emuns.config import Config
|
|
11
|
-
from csctracker_py_core.repository.http_repository import HttpRepository
|
|
12
|
-
from csctracker_py_core.repository.remote_repository import RemoteRepository
|
|
13
|
-
from csctracker_py_core.utils.configs import Configs
|
|
14
|
-
from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
|
|
15
|
-
from csctracker_py_core.utils.interceptor import Interceptor
|
|
16
|
-
from csctracker_py_core.utils.version import Version
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
class Starter:
|
|
20
|
-
def __init__(self, static_folder="static", save_request=False, is_bff=False):
|
|
21
|
-
self.logger = logging.getLogger()
|
|
22
|
-
self.app = Flask(__name__, static_folder=static_folder)
|
|
23
|
-
try:
|
|
24
|
-
os.environ.pop("FLASK_RUN_FROM_CLI")
|
|
25
|
-
except:
|
|
26
|
-
pass
|
|
27
|
-
try:
|
|
28
|
-
os.environ.pop("FLASK_ENV")
|
|
29
|
-
except:
|
|
30
|
-
pass
|
|
31
|
-
SchedulerService.init(10)
|
|
32
|
-
self.cors = CORS(self.app)
|
|
33
|
-
self.app.config["CORS_HEADERS"] = "Content-Type"
|
|
34
|
-
self.config = Configs(os.getenv("PROFILE", "dev"))
|
|
35
|
-
shutdown_timeout = Configs.get_env_variable(Config.SHUTDOWN_TIMEOUT, default=30)
|
|
36
|
-
self.graceful_shutdown = GracefulShutdown.get_instance(timeout=shutdown_timeout)
|
|
37
|
-
self.graceful_shutdown.register_signals()
|
|
38
|
-
self.remote_repository = RemoteRepository()
|
|
39
|
-
self.http_repository = HttpRepository(remote_repository=self.remote_repository)
|
|
40
|
-
self.interceptor = Interceptor(
|
|
41
|
-
self.app, self.http_repository, save_request=save_request, is_bff=is_bff,
|
|
42
|
-
)
|
|
43
|
-
self.metrics = PrometheusMetrics(
|
|
44
|
-
self.app,
|
|
45
|
-
group_by="endpoint",
|
|
46
|
-
default_labels={"application": Version.get_app_name()},
|
|
47
|
-
)
|
|
48
|
-
|
|
49
|
-
def register_shutdown_hook(self, callback):
|
|
50
|
-
self.graceful_shutdown.register_shutdown_hook(callback)
|
|
51
|
-
|
|
52
|
-
def get_graceful_shutdown(self):
|
|
53
|
-
return self.graceful_shutdown
|
|
54
|
-
|
|
55
|
-
def get_remote_repository(self):
|
|
56
|
-
return self.remote_repository
|
|
57
|
-
|
|
58
|
-
def get_http_repository(self):
|
|
59
|
-
return self.http_repository
|
|
60
|
-
|
|
61
|
-
def get_app(self):
|
|
62
|
-
return self.app
|
|
63
|
-
|
|
64
|
-
def start(self):
|
|
65
|
-
SwaggerView.init(
|
|
66
|
-
self.app,
|
|
67
|
-
application_name=Version.get_app_name(),
|
|
68
|
-
application_version=Version.get_version(),
|
|
69
|
-
swagger_destination_path="swagger.yaml",
|
|
70
|
-
)
|
|
71
|
-
self.app.run(
|
|
72
|
-
host="0.0.0.0", port=Configs.get_env_variable(Config.PORT, default=5000)
|
|
73
|
-
)
|
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/models/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/repository/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/__init__.py
RENAMED
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/request_info.py
RENAMED
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core/utils/version.py
RENAMED
|
File without changes
|
|
File without changes
|
{csctracker_py_core-26.37.4 → csctracker_py_core-26.47.3}/csctracker_py_core.egg-info/top_level.txt
RENAMED
|
File without changes
|
|
File without changes
|