csctracker-py-core 26.37.3__tar.gz → 26.47.1__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.
Files changed (28) hide show
  1. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/PKG-INFO +64 -5
  2. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/README.md +62 -4
  3. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/models/emuns/config.py +3 -0
  4. csctracker_py_core-26.47.1/csctracker_py_core/starter.py +107 -0
  5. csctracker_py_core-26.47.1/csctracker_py_core/utils/graceful_shutdown.py +162 -0
  6. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/interceptor.py +6 -1
  7. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/PKG-INFO +64 -5
  8. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/SOURCES.txt +4 -1
  9. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/requires.txt +1 -0
  10. csctracker_py_core-26.47.1/tests/test_graceful_shutdown.py +131 -0
  11. csctracker_py_core-26.47.1/tests/test_starter_wsgi.py +143 -0
  12. csctracker_py_core-26.37.3/csctracker_py_core/starter.py +0 -63
  13. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/LICENSE +0 -0
  14. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/__init__.py +0 -0
  15. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/models/__init__.py +0 -0
  16. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/models/emuns/__init__.py +0 -0
  17. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/repository/__init__.py +0 -0
  18. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/repository/http_repository.py +0 -0
  19. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/repository/remote_repository.py +0 -0
  20. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/__init__.py +0 -0
  21. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/configs.py +0 -0
  22. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/request_info.py +0 -0
  23. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/utils.py +0 -0
  24. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core/utils/version.py +0 -0
  25. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/dependency_links.txt +0 -0
  26. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/csctracker_py_core.egg-info/top_level.txt +0 -0
  27. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/setup.cfg +0 -0
  28. {csctracker_py_core-26.37.3 → csctracker_py_core-26.47.1}/setup.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: csctracker-py-core
3
- Version: 26.37.3
3
+ Version: 26.47.1
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
@@ -35,6 +35,7 @@ Requires-Dist: flask-cors~=3.0.7
35
35
  Requires-Dist: prometheus-flask-exporter==0.22.4
36
36
  Requires-Dist: flask-swagger-init==23.52.4
37
37
  Requires-Dist: pytz~=2023.3.post1
38
+ Requires-Dist: waitress>=3.0.0
38
39
  Dynamic: author
39
40
  Dynamic: classifier
40
41
  Dynamic: description
@@ -59,13 +60,14 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
59
60
 
60
61
  ## Principais Funcionalidades
61
62
 
62
- - **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS e tratamento de variáveis de ambiente.
63
+ - **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
64
  - **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
64
65
  - **Observabilidade**:
65
66
  - Integração nativa com **Prometheus** para coleta de métricas de endpoints.
66
67
  - **Interceptor de Requisições**: Registro detalhado de chamadas HTTP (método, path, status, duração) com opção de persistência remota para auditoria.
67
68
  - **Documentação Automática**: Geração de especificação **Swagger (OpenAPI)** simplificada.
68
69
  - **Processamento em Background**: Integração com `csctracker-queue-scheduler` para execução de tarefas assíncronas e agendadas.
70
+ - **Graceful Shutdown para Docker Swarm**: Encerramento controlado em rolling updates, aguardando término de requisições HTTP e esvaziamento total da fila do scheduler antes do encerramento do processo.
69
71
  - **Repositórios Remotos**: Abstração para comunicação entre serviços via HTTP com tratamento de headers e correlação.
70
72
 
71
73
  ## Requisitos
@@ -73,6 +75,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
73
75
  - Python 3.9+
74
76
  - Flask
75
77
  - Flask-CORS
78
+ - Waitress (WSGI de produção)
76
79
  - Prometheus Flask Exporter
77
80
  - Flask Swagger Generator
78
81
  - Python JSON Logger
@@ -107,7 +110,10 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
107
110
  | `LOG_RESPONSE_BODY` | Se `True`, inclui o corpo da resposta nos logs | `False` |
108
111
  | `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
109
112
  | `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
110
- | `DEBUG` | Ativa o modo debug do Flask se definido como `1` | `0` |
113
+ | `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
114
+ | `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
115
+ | `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
116
+ | `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
111
117
 
112
118
  ## Uso Didático
113
119
 
@@ -130,6 +136,7 @@ def hello():
130
136
  return {"message": "CscTrackerPyCore is running!"}
131
137
 
132
138
  if __name__ == '__main__':
139
+ # Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
133
140
  starter.start()
134
141
  ```
135
142
 
@@ -144,11 +151,63 @@ Uma vez iniciado o `Starter`, todos os logs do sistema usarão o formato JSON e
144
151
  http_repo = starter.get_http_repository()
145
152
  ```
146
153
 
154
+ ### 4. Graceful Shutdown e Ganchos Customizados
155
+
156
+ Ao receber sinais como `SIGTERM` (pelo Docker Swarm) ou `SIGINT` (Ctrl+C), a aplicação:
157
+ 1. Aguarda a finalização de todas as requisições HTTP ativas.
158
+ 2. Aguarda o esvaziamento completo e processamento da fila do `SchedulerService`.
159
+ 3. Executa ganchos de limpeza customizados registrados via `starter.register_shutdown_hook(...)`.
160
+ 4. Finaliza o processo com segurança respeitando o `SHUTDOWN_TIMEOUT`.
161
+
162
+ ```python
163
+ def cleanup_resources():
164
+ print("Fechando conexões e pools externos...")
165
+
166
+ starter.register_shutdown_hook(cleanup_resources)
167
+ ```
168
+
169
+ ## Implantação no Docker Swarm
170
+
171
+ 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:
172
+
173
+ ```dockerfile
174
+ FROM python:3.11-slim
175
+ WORKDIR /app
176
+ COPY requirements.txt .
177
+ RUN pip install --no-cache-dir -r requirements.txt
178
+ COPY . /app
179
+ CMD ["python", "-u", "app.py"]
180
+ ```
181
+
182
+ 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`:
183
+
184
+ ```yaml
185
+ version: "3.8"
186
+
187
+ services:
188
+ notification-ai:
189
+ image: krlsedu/csctracker-notification-ai:26.37.002
190
+ stop_grace_period: 45s # Superior ao SHUTDOWN_TIMEOUT da aplicação
191
+ environment:
192
+ - SHUTDOWN_TIMEOUT=30
193
+ - URL_REPOSITORY=http://bff:8080/repository-clickhouse/
194
+ - URL_BFF=http://bff:8080/
195
+ networks:
196
+ - swarm_network
197
+ deploy:
198
+ replicas: 2
199
+ update_config:
200
+ parallelism: 1
201
+ delay: 10s
202
+ order: start-first
203
+ ```
204
+
147
205
  ## Estrutura do Projeto
148
206
 
149
- - `Starter`: Orquestrador principal que configura Flask, CORS, Métricas e Swagger.
207
+ - `Starter`: Orquestrador principal que configura Flask, CORS, Métricas, Swagger e Graceful Shutdown.
150
208
  - `Configs`: Gerencia o carregamento de variáveis de ambiente e a configuração do logger JSON.
151
- - `Interceptor`: Middleware Flask que captura dados de performance e logs de entrada/saída.
209
+ - `GracefulShutdown`: Gerenciador de encerramento suave e sincronização de tarefas/requisições.
210
+ - `Interceptor`: Middleware Flask que captura dados de performance, telemetria e controla requisições ativas.
152
211
  - `HttpRepository`: Facilita requisições HTTP externas com injeção de headers de segurança e rastreio.
153
212
  - `RequestInfo`: Utilitário para gerenciar IDs de correlação (Correlation IDs) entre threads.
154
213
 
@@ -9,13 +9,14 @@ 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 e tratamento de variáveis de ambiente.
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.
16
16
  - **Interceptor de Requisições**: Registro detalhado de chamadas HTTP (método, path, status, duração) com opção de persistência remota para auditoria.
17
17
  - **Documentação Automática**: Geração de especificação **Swagger (OpenAPI)** simplificada.
18
18
  - **Processamento em Background**: Integração com `csctracker-queue-scheduler` para execução de tarefas assíncronas e agendadas.
19
+ - **Graceful Shutdown para Docker Swarm**: Encerramento controlado em rolling updates, aguardando término de requisições HTTP e esvaziamento total da fila do scheduler antes do encerramento do processo.
19
20
  - **Repositórios Remotos**: Abstração para comunicação entre serviços via HTTP com tratamento de headers e correlação.
20
21
 
21
22
  ## Requisitos
@@ -23,6 +24,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
23
24
  - Python 3.9+
24
25
  - Flask
25
26
  - Flask-CORS
27
+ - Waitress (WSGI de produção)
26
28
  - Prometheus Flask Exporter
27
29
  - Flask Swagger Generator
28
30
  - Python JSON Logger
@@ -57,7 +59,10 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
57
59
  | `LOG_RESPONSE_BODY` | Se `True`, inclui o corpo da resposta nos logs | `False` |
58
60
  | `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
59
61
  | `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
60
- | `DEBUG` | Ativa o modo debug do Flask se definido como `1` | `0` |
62
+ | `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
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` |
61
66
 
62
67
  ## Uso Didático
63
68
 
@@ -80,6 +85,7 @@ def hello():
80
85
  return {"message": "CscTrackerPyCore is running!"}
81
86
 
82
87
  if __name__ == '__main__':
88
+ # Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
83
89
  starter.start()
84
90
  ```
85
91
 
@@ -94,11 +100,63 @@ Uma vez iniciado o `Starter`, todos os logs do sistema usarão o formato JSON e
94
100
  http_repo = starter.get_http_repository()
95
101
  ```
96
102
 
103
+ ### 4. Graceful Shutdown e Ganchos Customizados
104
+
105
+ Ao receber sinais como `SIGTERM` (pelo Docker Swarm) ou `SIGINT` (Ctrl+C), a aplicação:
106
+ 1. Aguarda a finalização de todas as requisições HTTP ativas.
107
+ 2. Aguarda o esvaziamento completo e processamento da fila do `SchedulerService`.
108
+ 3. Executa ganchos de limpeza customizados registrados via `starter.register_shutdown_hook(...)`.
109
+ 4. Finaliza o processo com segurança respeitando o `SHUTDOWN_TIMEOUT`.
110
+
111
+ ```python
112
+ def cleanup_resources():
113
+ print("Fechando conexões e pools externos...")
114
+
115
+ starter.register_shutdown_hook(cleanup_resources)
116
+ ```
117
+
118
+ ## Implantação no Docker Swarm
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.11-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
+
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`:
132
+
133
+ ```yaml
134
+ version: "3.8"
135
+
136
+ services:
137
+ notification-ai:
138
+ image: krlsedu/csctracker-notification-ai:26.37.002
139
+ stop_grace_period: 45s # Superior ao SHUTDOWN_TIMEOUT da aplicação
140
+ environment:
141
+ - SHUTDOWN_TIMEOUT=30
142
+ - URL_REPOSITORY=http://bff:8080/repository-clickhouse/
143
+ - URL_BFF=http://bff:8080/
144
+ networks:
145
+ - swarm_network
146
+ deploy:
147
+ replicas: 2
148
+ update_config:
149
+ parallelism: 1
150
+ delay: 10s
151
+ order: start-first
152
+ ```
153
+
97
154
  ## Estrutura do Projeto
98
155
 
99
- - `Starter`: Orquestrador principal que configura Flask, CORS, Métricas e Swagger.
156
+ - `Starter`: Orquestrador principal que configura Flask, CORS, Métricas, Swagger e Graceful Shutdown.
100
157
  - `Configs`: Gerencia o carregamento de variáveis de ambiente e a configuração do logger JSON.
101
- - `Interceptor`: Middleware Flask que captura dados de performance e logs de entrada/saída.
158
+ - `GracefulShutdown`: Gerenciador de encerramento suave e sincronização de tarefas/requisições.
159
+ - `Interceptor`: Middleware Flask que captura dados de performance, telemetria e controla requisições ativas.
102
160
  - `HttpRepository`: Facilita requisições HTTP externas com injeção de headers de segurança e rastreio.
103
161
  - `RequestInfo`: Utilitário para gerenciar IDs de correlação (Correlation IDs) entre threads.
104
162
 
@@ -19,3 +19,6 @@ class Config(Enum):
19
19
  API_TOKEN = "API_TOKEN"
20
20
  GITHUB_USER = "GITHUB_USER"
21
21
  GITHUB_PASS = "GITHUB_PASS"
22
+ SHUTDOWN_TIMEOUT = "SHUTDOWN_TIMEOUT"
23
+ WSGI_THREADS = "WSGI_THREADS"
24
+ WSGI_CHANNEL_TIMEOUT = "WSGI_CHANNEL_TIMEOUT"
@@ -0,0 +1,107 @@
1
+ import logging
2
+ import os
3
+
4
+ import waitress
5
+ from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
6
+ from flask import Flask
7
+ from flask_cors import CORS
8
+ from flask_swagger_generator.generators.swagger_view import SwaggerView
9
+ from prometheus_flask_exporter import PrometheusMetrics
10
+
11
+ from csctracker_py_core.models.emuns.config import Config
12
+ from csctracker_py_core.repository.http_repository import HttpRepository
13
+ from csctracker_py_core.repository.remote_repository import RemoteRepository
14
+ from csctracker_py_core.utils.configs import Configs
15
+ from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
16
+ from csctracker_py_core.utils.interceptor import Interceptor
17
+ from csctracker_py_core.utils.version import Version
18
+
19
+
20
+ class Starter:
21
+ def __init__(self, static_folder="static", save_request=False, is_bff=False):
22
+ self.logger = logging.getLogger()
23
+ self.app = Flask(__name__, static_folder=static_folder)
24
+ try:
25
+ os.environ.pop("FLASK_RUN_FROM_CLI")
26
+ except:
27
+ pass
28
+ try:
29
+ os.environ.pop("FLASK_ENV")
30
+ except:
31
+ pass
32
+ SchedulerService.init(10)
33
+ self.cors = CORS(self.app)
34
+ self.app.config["CORS_HEADERS"] = "Content-Type"
35
+ self.config = Configs(os.getenv("PROFILE", "dev"))
36
+ shutdown_timeout = Configs.get_env_variable(Config.SHUTDOWN_TIMEOUT, default=30)
37
+ self.graceful_shutdown = GracefulShutdown.get_instance(timeout=shutdown_timeout)
38
+ self.graceful_shutdown.register_signals()
39
+ self.remote_repository = RemoteRepository()
40
+ self.http_repository = HttpRepository(remote_repository=self.remote_repository)
41
+ self.interceptor = Interceptor(
42
+ self.app, self.http_repository, save_request=save_request, is_bff=is_bff,
43
+ )
44
+ self.metrics = PrometheusMetrics(
45
+ self.app,
46
+ group_by="endpoint",
47
+ default_labels={"application": Version.get_app_name()},
48
+ )
49
+ self._swagger_initialized = False
50
+
51
+ @staticmethod
52
+ def _get_int_env(key: Config, default: int) -> int:
53
+ value = Configs.get_env_variable(key, default=default)
54
+ try:
55
+ return int(value)
56
+ except (TypeError, ValueError):
57
+ return default
58
+
59
+ def register_shutdown_hook(self, callback):
60
+ self.graceful_shutdown.register_shutdown_hook(callback)
61
+
62
+ def get_graceful_shutdown(self):
63
+ return self.graceful_shutdown
64
+
65
+ def get_remote_repository(self):
66
+ return self.remote_repository
67
+
68
+ def get_http_repository(self):
69
+ return self.http_repository
70
+
71
+ def get_app(self):
72
+ return self.app
73
+
74
+ def start(self):
75
+ if not self._swagger_initialized:
76
+ SwaggerView.init(
77
+ self.app,
78
+ application_name=Version.get_app_name(),
79
+ application_version=Version.get_version(),
80
+ swagger_destination_path="swagger.yaml",
81
+ )
82
+ self._swagger_initialized = True
83
+
84
+ port = self._get_int_env(Config.PORT, default=5000)
85
+
86
+ if Configs.is_debug():
87
+ self.logger.info(
88
+ f"Starting Flask development server (DEBUG=1) on 0.0.0.0:{port}"
89
+ )
90
+ self.app.run(host="0.0.0.0", port=port)
91
+ return
92
+
93
+ threads = self._get_int_env(Config.WSGI_THREADS, default=32)
94
+ channel_timeout = self._get_int_env(Config.WSGI_CHANNEL_TIMEOUT, default=600)
95
+ self.logger.info(
96
+ f"Starting Waitress WSGI server on 0.0.0.0:{port} "
97
+ f"(threads={threads}, channel_timeout={channel_timeout}s)"
98
+ )
99
+ server = waitress.create_server(
100
+ self.app,
101
+ host="0.0.0.0",
102
+ port=port,
103
+ threads=threads,
104
+ channel_timeout=channel_timeout,
105
+ )
106
+ self.graceful_shutdown.set_server_close_hook(server.close)
107
+ server.run()
@@ -0,0 +1,162 @@
1
+ import logging
2
+ import os
3
+ import signal
4
+ import threading
5
+ import time
6
+ from typing import Callable, List, Optional
7
+
8
+ from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
9
+
10
+
11
+ class GracefulShutdown:
12
+ _instance: Optional["GracefulShutdown"] = None
13
+ _lock = threading.Lock()
14
+
15
+ def __init__(self, timeout: int = 30):
16
+ self.timeout = timeout
17
+ self.is_shutting_down = False
18
+ self.active_requests = 0
19
+ self._condition = threading.Condition(self._lock)
20
+ self._shutdown_hooks: List[Callable] = []
21
+ self._server_close_hook: Optional[Callable] = None
22
+ self.logger = logging.getLogger()
23
+
24
+ @classmethod
25
+ def get_instance(cls, timeout: Optional[int] = None) -> "GracefulShutdown":
26
+ with cls._lock:
27
+ if cls._instance is None:
28
+ cls._instance = cls(timeout=timeout if timeout is not None else 30)
29
+ elif timeout is not None:
30
+ cls._instance.timeout = timeout
31
+ assert cls._instance is not None
32
+ return cls._instance
33
+
34
+ @classmethod
35
+ def reset_instance(cls):
36
+ with cls._lock:
37
+ cls._instance = None
38
+
39
+ def register_signals(self):
40
+ try:
41
+ signal.signal(signal.SIGTERM, self._handle_signal)
42
+ except (ValueError, AttributeError) as e:
43
+ self.logger.warning(f"Could not register SIGTERM handler: {e}")
44
+
45
+ try:
46
+ signal.signal(signal.SIGINT, self._handle_signal)
47
+ except (ValueError, AttributeError) as e:
48
+ self.logger.warning(f"Could not register SIGINT handler: {e}")
49
+
50
+ def start_request(self):
51
+ with self._condition:
52
+ self.active_requests += 1
53
+
54
+ def end_request(self):
55
+ with self._condition:
56
+ self.active_requests = max(0, self.active_requests - 1)
57
+ self._condition.notify_all()
58
+
59
+ def register_shutdown_hook(self, callback: Callable):
60
+ with self._lock:
61
+ self._shutdown_hooks.append(callback)
62
+
63
+ def set_server_close_hook(self, callback: Optional[Callable]):
64
+ with self._lock:
65
+ self._server_close_hook = callback
66
+
67
+ def _handle_signal(self, signum, frame):
68
+ signal_name = "SIGTERM" if signum == signal.SIGTERM else ("SIGINT" if signum == signal.SIGINT else str(signum))
69
+ self.logger.info(f"Signal {signal_name} received. Starting graceful shutdown...")
70
+ with self._lock:
71
+ if self.is_shutting_down:
72
+ return
73
+ self.is_shutting_down = True
74
+
75
+ threading.Thread(target=self._wait_and_exit, args=(True,), daemon=False).start()
76
+
77
+ def wait_for_drain(self, timeout: Optional[int] = None, exit_process: bool = False):
78
+ self._wait_and_exit(exit_process=exit_process, override_timeout=timeout)
79
+
80
+ def _wait_and_exit(self, exit_process: bool = True, override_timeout: Optional[int] = None):
81
+ timeout = override_timeout if override_timeout is not None else self.timeout
82
+ start_time = time.time()
83
+
84
+ # 0. Stop accepting new HTTP connections if a WSGI server close hook is registered
85
+ with self._lock:
86
+ server_close_hook = self._server_close_hook
87
+ self._server_close_hook = None
88
+
89
+ if server_close_hook is not None:
90
+ try:
91
+ server_close_hook()
92
+ except Exception as e:
93
+ self.logger.error(f"Error closing WSGI server listener: {e}")
94
+
95
+ # 1. Wait for active HTTP requests to reach 0
96
+ with self._condition:
97
+ while self.active_requests > 0:
98
+ elapsed = time.time() - start_time
99
+ remaining = timeout - elapsed
100
+ if remaining <= 0:
101
+ self.logger.warning(
102
+ f"Timeout reached ({timeout}s) with {self.active_requests} active HTTP requests."
103
+ )
104
+ break
105
+ self._condition.wait(timeout=min(remaining, 0.5))
106
+
107
+ # 2. Wait for SchedulerService queue to be empty and pending tasks to finish
108
+ self._wait_for_scheduler_queue(start_time, timeout)
109
+
110
+ # 3. Execute custom shutdown hooks
111
+ with self._lock:
112
+ hooks = list(self._shutdown_hooks)
113
+
114
+ for hook in hooks:
115
+ try:
116
+ hook()
117
+ except Exception as e:
118
+ self.logger.error(f"Error executing shutdown hook: {e}")
119
+
120
+ self.logger.info("Graceful shutdown completed successfully. Exiting process.")
121
+ if exit_process:
122
+ os._exit(0)
123
+
124
+ def _wait_for_scheduler_queue(self, start_time: float, timeout: int):
125
+ while True:
126
+ elapsed = time.time() - start_time
127
+ if elapsed >= timeout:
128
+ self.logger.warning(
129
+ f"Timeout reached ({timeout}s) waiting for SchedulerService queue."
130
+ )
131
+ break
132
+
133
+ queue_empty = True
134
+ try:
135
+ queue_service = SchedulerService.get_queue_service()
136
+ if queue_service is not None:
137
+ normal_unfinished = getattr(
138
+ getattr(queue_service, "normal_queue", None), "unfinished_tasks", 0
139
+ )
140
+ priority_unfinished = getattr(
141
+ getattr(queue_service, "priority_queue", None), "unfinished_tasks", 0
142
+ )
143
+ normal_empty = (
144
+ queue_service.normal_queue.empty()
145
+ if hasattr(queue_service, "normal_queue")
146
+ else True
147
+ )
148
+ priority_empty = (
149
+ queue_service.priority_queue.empty()
150
+ if hasattr(queue_service, "priority_queue")
151
+ else True
152
+ )
153
+
154
+ if not (normal_empty and priority_empty and normal_unfinished == 0 and priority_unfinished == 0):
155
+ queue_empty = False
156
+ except Exception as e:
157
+ self.logger.debug(f"Error checking SchedulerService: {e}")
158
+
159
+ if queue_empty:
160
+ self.logger.info("SchedulerService queue drained successfully.")
161
+ break
162
+ time.sleep(0.5)
@@ -1,7 +1,6 @@
1
1
  import logging
2
2
  import threading
3
3
  import time
4
- import token
5
4
  from datetime import datetime
6
5
 
7
6
  from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
@@ -10,6 +9,7 @@ from flask import Flask, request, g
10
9
  from csctracker_py_core.models.emuns.config import Config
11
10
  from csctracker_py_core.repository.http_repository import HttpRepository
12
11
  from csctracker_py_core.utils.configs import Configs
12
+ from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
13
13
  from csctracker_py_core.utils.request_info import RequestInfo
14
14
  from csctracker_py_core.utils.utils import Utils
15
15
  from csctracker_py_core.utils.version import Version
@@ -27,12 +27,17 @@ class Interceptor:
27
27
  def __init(self):
28
28
  @self.app.before_request
29
29
  def start_timer():
30
+ GracefulShutdown.get_instance().start_request()
30
31
  g.start = time.time()
31
32
  correlation_id = RequestInfo.get_correlation_id()
32
33
  g.correlation_id = correlation_id
33
34
  thread = threading.current_thread()
34
35
  thread.correlation_id = correlation_id
35
36
 
37
+ @self.app.teardown_request
38
+ def teardown_request(exception=None):
39
+ GracefulShutdown.get_instance().end_request()
40
+
36
41
  @self.app.after_request
37
42
  def log_request(response):
38
43
  now = time.time()
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: csctracker-py-core
3
- Version: 26.37.3
3
+ Version: 26.47.1
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
@@ -35,6 +35,7 @@ Requires-Dist: flask-cors~=3.0.7
35
35
  Requires-Dist: prometheus-flask-exporter==0.22.4
36
36
  Requires-Dist: flask-swagger-init==23.52.4
37
37
  Requires-Dist: pytz~=2023.3.post1
38
+ Requires-Dist: waitress>=3.0.0
38
39
  Dynamic: author
39
40
  Dynamic: classifier
40
41
  Dynamic: description
@@ -59,13 +60,14 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
59
60
 
60
61
  ## Principais Funcionalidades
61
62
 
62
- - **Starter Facilitado**: Inicialização rápida de aplicações Flask com suporte a CORS e tratamento de variáveis de ambiente.
63
+ - **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
64
  - **Logging Estruturado**: Formatação automática de logs em JSON com inclusão de `requestId`, `appName` e `appVersion` para melhor rastreabilidade.
64
65
  - **Observabilidade**:
65
66
  - Integração nativa com **Prometheus** para coleta de métricas de endpoints.
66
67
  - **Interceptor de Requisições**: Registro detalhado de chamadas HTTP (método, path, status, duração) com opção de persistência remota para auditoria.
67
68
  - **Documentação Automática**: Geração de especificação **Swagger (OpenAPI)** simplificada.
68
69
  - **Processamento em Background**: Integração com `csctracker-queue-scheduler` para execução de tarefas assíncronas e agendadas.
70
+ - **Graceful Shutdown para Docker Swarm**: Encerramento controlado em rolling updates, aguardando término de requisições HTTP e esvaziamento total da fila do scheduler antes do encerramento do processo.
69
71
  - **Repositórios Remotos**: Abstração para comunicação entre serviços via HTTP com tratamento de headers e correlação.
70
72
 
71
73
  ## Requisitos
@@ -73,6 +75,7 @@ CscTrackerPyCore é uma biblioteca Python base desenvolvida para padronizar e ac
73
75
  - Python 3.9+
74
76
  - Flask
75
77
  - Flask-CORS
78
+ - Waitress (WSGI de produção)
76
79
  - Prometheus Flask Exporter
77
80
  - Flask Swagger Generator
78
81
  - Python JSON Logger
@@ -107,7 +110,10 @@ A biblioteca é configurada principalmente via variáveis de ambiente, suportand
107
110
  | `LOG_RESPONSE_BODY` | Se `True`, inclui o corpo da resposta nos logs | `False` |
108
111
  | `URL_BFF` | URL base para persistência de logs de requisição | `http://api-gateway/` |
109
112
  | `API_TOKEN` | Token de autorização para chamadas externas | `seu_token_aqui` |
110
- | `DEBUG` | Ativa o modo debug do Flask se definido como `1` | `0` |
113
+ | `SHUTDOWN_TIMEOUT` | Tempo limite (segundos) para conclusão de requisições e tarefas em background durante o shutdown | `30` |
114
+ | `WSGI_THREADS` | Número de threads do pool WSGI do Waitress em produção | `32` |
115
+ | `WSGI_CHANNEL_TIMEOUT` | Timeout de ociosidade de canal HTTP (segundos) no Waitress | `600` |
116
+ | `DEBUG` | Quando `1`, utiliza o servidor de desenvolvimento Werkzeug (`app.run()`) no `starter.start()`; caso contrário, sobe via Waitress | `0` |
111
117
 
112
118
  ## Uso Didático
113
119
 
@@ -130,6 +136,7 @@ def hello():
130
136
  return {"message": "CscTrackerPyCore is running!"}
131
137
 
132
138
  if __name__ == '__main__':
139
+ # Produção (padrão): sobe Waitress WSGI. Local dev (DEBUG=1): sobe Werkzeug.
133
140
  starter.start()
134
141
  ```
135
142
 
@@ -144,11 +151,63 @@ Uma vez iniciado o `Starter`, todos os logs do sistema usarão o formato JSON e
144
151
  http_repo = starter.get_http_repository()
145
152
  ```
146
153
 
154
+ ### 4. Graceful Shutdown e Ganchos Customizados
155
+
156
+ Ao receber sinais como `SIGTERM` (pelo Docker Swarm) ou `SIGINT` (Ctrl+C), a aplicação:
157
+ 1. Aguarda a finalização de todas as requisições HTTP ativas.
158
+ 2. Aguarda o esvaziamento completo e processamento da fila do `SchedulerService`.
159
+ 3. Executa ganchos de limpeza customizados registrados via `starter.register_shutdown_hook(...)`.
160
+ 4. Finaliza o processo com segurança respeitando o `SHUTDOWN_TIMEOUT`.
161
+
162
+ ```python
163
+ def cleanup_resources():
164
+ print("Fechando conexões e pools externos...")
165
+
166
+ starter.register_shutdown_hook(cleanup_resources)
167
+ ```
168
+
169
+ ## Implantação no Docker Swarm
170
+
171
+ 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:
172
+
173
+ ```dockerfile
174
+ FROM python:3.11-slim
175
+ WORKDIR /app
176
+ COPY requirements.txt .
177
+ RUN pip install --no-cache-dir -r requirements.txt
178
+ COPY . /app
179
+ CMD ["python", "-u", "app.py"]
180
+ ```
181
+
182
+ 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`:
183
+
184
+ ```yaml
185
+ version: "3.8"
186
+
187
+ services:
188
+ notification-ai:
189
+ image: krlsedu/csctracker-notification-ai:26.37.002
190
+ stop_grace_period: 45s # Superior ao SHUTDOWN_TIMEOUT da aplicação
191
+ environment:
192
+ - SHUTDOWN_TIMEOUT=30
193
+ - URL_REPOSITORY=http://bff:8080/repository-clickhouse/
194
+ - URL_BFF=http://bff:8080/
195
+ networks:
196
+ - swarm_network
197
+ deploy:
198
+ replicas: 2
199
+ update_config:
200
+ parallelism: 1
201
+ delay: 10s
202
+ order: start-first
203
+ ```
204
+
147
205
  ## Estrutura do Projeto
148
206
 
149
- - `Starter`: Orquestrador principal que configura Flask, CORS, Métricas e Swagger.
207
+ - `Starter`: Orquestrador principal que configura Flask, CORS, Métricas, Swagger e Graceful Shutdown.
150
208
  - `Configs`: Gerencia o carregamento de variáveis de ambiente e a configuração do logger JSON.
151
- - `Interceptor`: Middleware Flask que captura dados de performance e logs de entrada/saída.
209
+ - `GracefulShutdown`: Gerenciador de encerramento suave e sincronização de tarefas/requisições.
210
+ - `Interceptor`: Middleware Flask que captura dados de performance, telemetria e controla requisições ativas.
152
211
  - `HttpRepository`: Facilita requisições HTTP externas com injeção de headers de segurança e rastreio.
153
212
  - `RequestInfo`: Utilitário para gerenciar IDs de correlação (Correlation IDs) entre threads.
154
213
 
@@ -17,7 +17,10 @@ csctracker_py_core/repository/http_repository.py
17
17
  csctracker_py_core/repository/remote_repository.py
18
18
  csctracker_py_core/utils/__init__.py
19
19
  csctracker_py_core/utils/configs.py
20
+ csctracker_py_core/utils/graceful_shutdown.py
20
21
  csctracker_py_core/utils/interceptor.py
21
22
  csctracker_py_core/utils/request_info.py
22
23
  csctracker_py_core/utils/utils.py
23
- csctracker_py_core/utils/version.py
24
+ csctracker_py_core/utils/version.py
25
+ tests/test_graceful_shutdown.py
26
+ tests/test_starter_wsgi.py
@@ -8,3 +8,4 @@ flask-cors~=3.0.7
8
8
  prometheus-flask-exporter==0.22.4
9
9
  flask-swagger-init==23.52.4
10
10
  pytz~=2023.3.post1
11
+ waitress>=3.0.0
@@ -0,0 +1,131 @@
1
+ import time
2
+ import unittest
3
+
4
+ from flask import Flask
5
+
6
+ from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
7
+ from csctracker_py_core.repository.http_repository import HttpRepository
8
+ from csctracker_py_core.repository.remote_repository import RemoteRepository
9
+ from csctracker_py_core.starter import Starter
10
+ from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
11
+ from csctracker_py_core.utils.interceptor import Interceptor
12
+
13
+
14
+ class TestGracefulShutdown(unittest.TestCase):
15
+ def setUp(self):
16
+ GracefulShutdown.reset_instance()
17
+
18
+ def tearDown(self):
19
+ GracefulShutdown.reset_instance()
20
+
21
+ def test_active_requests_tracking(self):
22
+ shutdown = GracefulShutdown.get_instance(timeout=10)
23
+ self.assertEqual(shutdown.active_requests, 0)
24
+
25
+ shutdown.start_request()
26
+ shutdown.start_request()
27
+ self.assertEqual(shutdown.active_requests, 2)
28
+
29
+ shutdown.end_request()
30
+ self.assertEqual(shutdown.active_requests, 1)
31
+
32
+ shutdown.end_request()
33
+ self.assertEqual(shutdown.active_requests, 0)
34
+
35
+ # Ensure counter does not go below 0
36
+ shutdown.end_request()
37
+ self.assertEqual(shutdown.active_requests, 0)
38
+
39
+ def test_interceptor_request_lifecycle(self):
40
+ shutdown = GracefulShutdown.get_instance(timeout=10)
41
+ app = Flask(__name__)
42
+ remote_repo = RemoteRepository()
43
+ http_repo = HttpRepository(remote_repository=remote_repo)
44
+ Interceptor(app, http_repo, save_request=False)
45
+
46
+ @app.route("/ok")
47
+ def ok():
48
+ self.assertEqual(shutdown.active_requests, 1)
49
+ return {"status": "ok"}
50
+
51
+ @app.route("/error")
52
+ def error():
53
+ self.assertEqual(shutdown.active_requests, 1)
54
+ raise RuntimeError("Test simulated error")
55
+
56
+ client = app.test_client()
57
+
58
+ # Test normal request
59
+ resp = client.get("/ok")
60
+ self.assertEqual(resp.status_code, 200)
61
+ self.assertEqual(shutdown.active_requests, 0)
62
+
63
+ # Test error request (teardown_request must still decrement)
64
+ try:
65
+ client.get("/error")
66
+ except RuntimeError:
67
+ pass
68
+ self.assertEqual(shutdown.active_requests, 0)
69
+
70
+ def test_shutdown_hooks_execution(self):
71
+ shutdown = GracefulShutdown.get_instance(timeout=5)
72
+ call_order = []
73
+
74
+ def hook1():
75
+ call_order.append(1)
76
+
77
+ def faulty_hook():
78
+ call_order.append(2)
79
+ raise ValueError("Error in hook")
80
+
81
+ def hook3():
82
+ call_order.append(3)
83
+
84
+ shutdown.register_shutdown_hook(hook1)
85
+ shutdown.register_shutdown_hook(faulty_hook)
86
+ shutdown.register_shutdown_hook(hook3)
87
+
88
+ shutdown.wait_for_drain(timeout=2, exit_process=False)
89
+ self.assertEqual(call_order, [1, 2, 3])
90
+
91
+ def test_timeout_safeguard(self):
92
+ shutdown = GracefulShutdown.get_instance(timeout=1)
93
+ shutdown.start_request() # Stalled request
94
+
95
+ start = time.time()
96
+ shutdown.wait_for_drain(timeout=1, exit_process=False)
97
+ duration = time.time() - start
98
+
99
+ self.assertGreaterEqual(duration, 0.9)
100
+ self.assertLess(duration, 3.0)
101
+
102
+ def test_scheduler_queue_draining(self):
103
+ SchedulerService.init(threads=2)
104
+ shutdown = GracefulShutdown.get_instance(timeout=15)
105
+
106
+ processed = []
107
+
108
+ def sample_job(val):
109
+ time.sleep(0.1)
110
+ processed.append(val)
111
+
112
+ SchedulerService.put_in_queue(sample_job, args={"val": "job1"}, priority=False)
113
+ SchedulerService.put_in_queue(sample_job, args={"val": "job2"}, priority=True)
114
+
115
+ shutdown.wait_for_drain(timeout=15, exit_process=False)
116
+
117
+ self.assertIn("job1", processed)
118
+ self.assertIn("job2", processed)
119
+
120
+ def test_starter_graceful_shutdown_integration(self):
121
+ starter = Starter(save_request=False)
122
+ shutdown = starter.get_graceful_shutdown()
123
+ self.assertIsNotNone(shutdown)
124
+
125
+ hook_called = []
126
+ starter.register_shutdown_hook(lambda: hook_called.append(True))
127
+ self.assertEqual(len(shutdown._shutdown_hooks), 1)
128
+
129
+
130
+ if __name__ == "__main__":
131
+ unittest.main()
@@ -0,0 +1,143 @@
1
+ import os
2
+ import unittest
3
+ from unittest.mock import MagicMock, patch
4
+
5
+ from csctracker_py_core.starter import Starter
6
+ from csctracker_py_core.utils.graceful_shutdown import GracefulShutdown
7
+
8
+
9
+ class TestStarterWsgi(unittest.TestCase):
10
+ def setUp(self):
11
+ GracefulShutdown.reset_instance()
12
+ self._env_backup = os.environ.copy()
13
+ for key in ("DEBUG", "PORT", "WSGI_THREADS", "WSGI_CHANNEL_TIMEOUT"):
14
+ os.environ.pop(key, None)
15
+
16
+ def tearDown(self):
17
+ os.environ.clear()
18
+ os.environ.update(self._env_backup)
19
+ GracefulShutdown.reset_instance()
20
+
21
+ @patch("csctracker_py_core.starter.SwaggerView.init")
22
+ @patch("csctracker_py_core.starter.waitress.create_server")
23
+ def test_start_uses_waitress_by_default(self, mock_create_server, mock_swagger_init):
24
+ mock_server = MagicMock()
25
+ mock_create_server.return_value = mock_server
26
+
27
+ starter = Starter(save_request=False)
28
+ with patch.object(starter.app, "run") as mock_flask_run:
29
+ starter.start()
30
+
31
+ mock_swagger_init.assert_called_once()
32
+ mock_flask_run.assert_not_called()
33
+ mock_create_server.assert_called_once_with(
34
+ starter.app,
35
+ host="0.0.0.0",
36
+ port=5000,
37
+ threads=32,
38
+ channel_timeout=600,
39
+ )
40
+ mock_server.run.assert_called_once()
41
+ self.assertIs(starter.get_graceful_shutdown()._server_close_hook, mock_server.close)
42
+
43
+ @patch("csctracker_py_core.starter.SwaggerView.init")
44
+ @patch("csctracker_py_core.starter.waitress.create_server")
45
+ def test_start_respects_wsgi_env_overrides(self, mock_create_server, mock_swagger_init):
46
+ os.environ["PORT"] = "8085"
47
+ os.environ["WSGI_THREADS"] = "64"
48
+ os.environ["WSGI_CHANNEL_TIMEOUT"] = "900"
49
+ mock_server = MagicMock()
50
+ mock_create_server.return_value = mock_server
51
+
52
+ starter = Starter(save_request=False)
53
+ starter.start()
54
+
55
+ mock_create_server.assert_called_once_with(
56
+ starter.app,
57
+ host="0.0.0.0",
58
+ port=8085,
59
+ threads=64,
60
+ channel_timeout=900,
61
+ )
62
+ mock_server.run.assert_called_once()
63
+
64
+ @patch("csctracker_py_core.starter.SwaggerView.init")
65
+ @patch("csctracker_py_core.starter.waitress.create_server")
66
+ def test_start_falls_back_to_defaults_on_invalid_int_envs(
67
+ self, mock_create_server, mock_swagger_init
68
+ ):
69
+ os.environ["PORT"] = ""
70
+ os.environ["WSGI_THREADS"] = "invalid"
71
+ os.environ["WSGI_CHANNEL_TIMEOUT"] = ""
72
+ mock_server = MagicMock()
73
+ mock_create_server.return_value = mock_server
74
+
75
+ starter = Starter(save_request=False)
76
+ starter.start()
77
+
78
+ mock_create_server.assert_called_once_with(
79
+ starter.app,
80
+ host="0.0.0.0",
81
+ port=5000,
82
+ threads=32,
83
+ channel_timeout=600,
84
+ )
85
+
86
+ @patch("csctracker_py_core.starter.SwaggerView.init")
87
+ @patch("csctracker_py_core.starter.waitress.create_server")
88
+ def test_start_uses_werkzeug_when_debug_is_1(
89
+ self, mock_create_server, mock_swagger_init
90
+ ):
91
+ os.environ["DEBUG"] = "1"
92
+ os.environ["PORT"] = "5050"
93
+
94
+ starter = Starter(save_request=False)
95
+ with patch.object(starter.app, "run") as mock_flask_run:
96
+ starter.start()
97
+
98
+ mock_swagger_init.assert_called_once()
99
+ mock_create_server.assert_not_called()
100
+ mock_flask_run.assert_called_once_with(host="0.0.0.0", port=5050)
101
+
102
+ @patch("csctracker_py_core.starter.SwaggerView.init")
103
+ @patch("csctracker_py_core.starter.waitress.create_server")
104
+ def test_swagger_init_is_idempotent(self, mock_create_server, mock_swagger_init):
105
+ mock_create_server.return_value = MagicMock()
106
+
107
+ starter = Starter(save_request=False)
108
+ starter.start()
109
+ starter.start()
110
+
111
+ mock_swagger_init.assert_called_once()
112
+
113
+ def test_graceful_shutdown_closes_server_before_hooks(self):
114
+ shutdown = GracefulShutdown.get_instance(timeout=5)
115
+ events = []
116
+
117
+ shutdown.set_server_close_hook(lambda: events.append("server_close"))
118
+ shutdown.register_shutdown_hook(lambda: events.append("shutdown_hook"))
119
+
120
+ shutdown.wait_for_drain(timeout=2, exit_process=False)
121
+ self.assertEqual(events, ["server_close", "shutdown_hook"])
122
+
123
+ # Subsequent drain must not call server_close again
124
+ events.clear()
125
+ shutdown.wait_for_drain(timeout=2, exit_process=False)
126
+ self.assertEqual(events, ["shutdown_hook"])
127
+
128
+ def test_graceful_shutdown_continues_if_server_close_raises(self):
129
+ shutdown = GracefulShutdown.get_instance(timeout=5)
130
+ hook_called = []
131
+
132
+ def broken_close():
133
+ raise RuntimeError("socket already closed")
134
+
135
+ shutdown.set_server_close_hook(broken_close)
136
+ shutdown.register_shutdown_hook(lambda: hook_called.append(True))
137
+
138
+ shutdown.wait_for_drain(timeout=2, exit_process=False)
139
+ self.assertEqual(hook_called, [True])
140
+
141
+
142
+ if __name__ == "__main__":
143
+ unittest.main()
@@ -1,63 +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.interceptor import Interceptor
15
- from csctracker_py_core.utils.version import Version
16
-
17
-
18
- class Starter:
19
- def __init__(self, static_folder="static", save_request=False, is_bff=False):
20
- self.logger = logging.getLogger()
21
- self.app = Flask(__name__, static_folder=static_folder)
22
- try:
23
- os.environ.pop("FLASK_RUN_FROM_CLI")
24
- except:
25
- pass
26
- try:
27
- os.environ.pop("FLASK_ENV")
28
- except:
29
- pass
30
- SchedulerService.init(10)
31
- self.cors = CORS(self.app)
32
- self.app.config["CORS_HEADERS"] = "Content-Type"
33
- self.config = Configs(os.getenv("PROFILE", "dev"))
34
- self.remote_repository = RemoteRepository()
35
- self.http_repository = HttpRepository(remote_repository=self.remote_repository)
36
- self.interceptor = Interceptor(
37
- self.app, self.http_repository, save_request=save_request, is_bff=is_bff,
38
- )
39
- self.metrics = PrometheusMetrics(
40
- self.app,
41
- group_by="endpoint",
42
- default_labels={"application": Version.get_app_name()},
43
- )
44
-
45
- def get_remote_repository(self):
46
- return self.remote_repository
47
-
48
- def get_http_repository(self):
49
- return self.http_repository
50
-
51
- def get_app(self):
52
- return self.app
53
-
54
- def start(self):
55
- SwaggerView.init(
56
- self.app,
57
- application_name=Version.get_app_name(),
58
- application_version=Version.get_version(),
59
- swagger_destination_path="swagger.yaml",
60
- )
61
- self.app.run(
62
- host="0.0.0.0", port=Configs.get_env_variable(Config.PORT, default=5000)
63
- )