Skip to content

Commit e331eac

Browse files
net0wellclaude
andcommitted
docs: painel Vue, desenvolvimento do painel e testes E2E no README (spec 008)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 98958ad commit e331eac

1 file changed

Lines changed: 35 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ cron e painel Vue opcional.
66

77
> Projeto em desenvolvimento. Esta versão entrega o **Core Runner** (execução síncrona de Stages e de
88
> trilhas), o SDK Python **`psrunner`**, a **persistência em PostgreSQL** (catálogo versionado e histórico), a
9-
> **execução assíncrona** com RabbitMQ, worker e agendamento cron e o **painel embutível** (API, tempo real e acesso
10-
> configurável; a interface Vue chega numa próxima versão).
9+
> **execução assíncrona** com RabbitMQ, worker e agendamento cron e o **painel embutível** (interface Vue, API, tempo
10+
> real e acesso configurável).
1111
1212
## Como funciona
1313

@@ -159,7 +159,12 @@ O host `hosts/PythonScriptRunner.WorkerHost` é um worker pronto, configurado po
159159
## Painel (Dashboard)
160160

161161
Com `PythonScriptRunner.Dashboard`, o painel é embutido na sua aplicação, no estilo do Hangfire: API interna, atualizações
162-
em tempo real (SignalR) e a interface servida no prefixo escolhido. Sem `MapPythonScriptRunnerDashboard` não existe painel.
162+
em tempo real (SignalR) e a interface Vue servida no prefixo escolhido. Sem `MapPythonScriptRunnerDashboard` não existe painel.
163+
164+
A interface (em pt-BR, tema claro/escuro) cobre a visão geral, Etapas (editor Monaco com construtor de campos, testar
165+
pela fila e publicar), Trilhas (editor visual com *handles* tipados, ou lista editável, testar e publicar), execuções ao
166+
vivo (fluxo por status, logs, arquivos, linha do tempo, cancelar e reprocessar), agendamentos com prévia do cron,
167+
auditoria e administração. Ela vai dentro do pacote: não há nada para hospedar à parte.
163168

164169
```csharp
165170
builder.Services
@@ -222,6 +227,7 @@ O host `hosts/PythonScriptRunner.DashboardHost` é um painel pronto: login fixo
222227
- .NET 10 SDK
223228
- [uv](https://docs.astral.sh/uv/) no PATH (cria e cacheia um ambiente Python por conjunto de dependências)
224229
- PostgreSQL 16+ apenas para o pacote de persistência e RabbitMQ 3.13+ para a fila (os testes usam Docker/Testcontainers)
230+
- Node.js 24 só para compilar em Release ou empacotar o `PythonScriptRunner.Dashboard` (o build embute o painel de `panel/`)
225231

226232
## Estrutura
227233

@@ -233,11 +239,12 @@ O host `hosts/PythonScriptRunner.DashboardHost` é um painel pronto: login fixo
233239
| `src/PythonScriptRunner.RabbitMQ` | topologia, relay do outbox, `IRunQueue`, comando público, eventos e assinaturas |
234240
| `src/PythonScriptRunner.Worker` | execução dos passos enfileirados, *lease*, retry, cancelamento, cron |
235241
| `src/PythonScriptRunner.Dashboard` | painel embutível: API interna, hub SignalR, modos de acesso (login fixo, filtro, host, local) |
242+
| `panel` | interface do painel: Vue 3, Vuetify 4, Vue Flow e Monaco (TypeScript, Vite, Vitest) |
236243
| `src/PythonScriptRunner.Tool` | dotnet tool `psr` (`psr hash-password`) |
237244
| `hosts` | `WorkerHost`, `DashboardHost` e `ServiceDefaults` (Serilog, OpenTelemetry, health checks) |
238245
| `python/psrunner` | SDK Python (`@stage`, `Context`, `File`, `StageError`, `psrunner.testing`, CLI) |
239246
| `schemas` | JSON Schemas do `stage.json`, do `*.pipeline.json` e das mensagens públicas |
240-
| `tests` | testes .NET (unitários e de integração com Python real) e fixtures de trilha |
247+
| `tests` | testes .NET (unitários, de integração com Python real e E2E do painel com Playwright) e fixtures de trilha |
241248

242249
## Desenvolvimento
243250

@@ -254,6 +261,30 @@ uv sync
254261
uv run pytest
255262
```
256263

264+
O painel fica em `panel/` (Node 24). Os builds em Debug embutem uma página provisória; em Release (ou com
265+
`-p:PsrBuildPanel=true`) o MSBuild roda `npm ci` e `npm run build` e embute `panel/dist`.
266+
267+
```bash
268+
cd panel
269+
npm ci
270+
npm run dev # Vite em http://localhost:5173/; /api e /hubs vão para o DashboardHost em PSR_DASHBOARD_URL (padrão http://localhost:5080, prefixo /psr)
271+
npm test # Vitest
272+
npm run lint # ESLint + Prettier
273+
npm run build # checagem de tipos, build e orçamento do bundle inicial (≤ 500 KB gzip)
274+
npm run api # regera src/api/schema.d.ts a partir do snapshot OpenAPI
275+
```
276+
277+
Os testes E2E do painel sobem o `DashboardHost` com 4 usuários de login fixo, um worker, PostgreSQL e RabbitMQ e dirigem
278+
o Chromium com Playwright (precisam de Docker e do painel embutido):
279+
280+
```bash
281+
dotnet build tests/PythonScriptRunner.Panel.E2E.Tests -p:PsrBuildPanel=true
282+
dotnet test --project tests/PythonScriptRunner.Panel.E2E.Tests --no-build # PSR_E2E_HEADED=1 mostra o navegador
283+
```
284+
285+
Quando um teste falha, o *trace* do Playwright fica em `TestResults/traces` ao lado do assembly de testes
286+
(`npx playwright show-trace <arquivo>.zip`).
287+
257288
O teste de desempenho do painel usa ~200 mil execuções; `PSR_PERF_RUNS_PER_DAY=50000` roda o volume médio completo (90 dias).
258289
O documento OpenAPI do painel é comparado com `tests/PythonScriptRunner.Dashboard.Tests/Snapshots/openapi-v1.verified.json`;
259290
depois de revisar uma mudança intencional, `PSR_ACCEPT_SNAPSHOTS=1` atualiza o snapshot.

0 commit comments

Comments
 (0)