Projets génériques, logs Apache du vhost et fenêtre de projet
- Un projet est un dossier quelconque avec ses dossiers de logs (proposés d'après le projet : storage/logs, var/log, logs…) ; le format de chaque fichier est détecté (Monolog, erreurs Apache, accès, une ligne par entrée). - Le vhost Apache d'un projet ajoute ses ErrorLog et CustomLog ; les logs d'accès ne comptent jamais dans les non-lus. - Ajout, modification et retrait d'un projet dans une fenêtre modale. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
6af0bbe0c0
commit
86c8f1bb49
13 files changed
+1979
-304
No files matched your search
+88
-25
@@ -9,8 +9,8 @@
|
||||
|
||||
Logs Reader est une application web **locale et mono-utilisateur** qui permet à un développeur de :
|
||||
|
||||
1. enregistrer un ou plusieurs projets Laravel par leur chemin sur le disque ;
|
||||
2. voir tous les fichiers de log de chaque projet et en lire les entrées ;
|
||||
1. enregistrer un ou plusieurs projets (Laravel, Symfony, Node… : n'importe quel dossier) par leur chemin sur le disque et leurs dossiers de logs ;
|
||||
2. voir tous les fichiers de log de chaque projet et en lire les entrées, y compris les logs Apache du vhost du projet ;
|
||||
3. être prévenu, via le **favicon** et le titre de l'onglet, de toute nouvelle entrée apparue depuis sa dernière consultation ;
|
||||
4. choisir l'intervalle de rafraîchissement.
|
||||
|
||||
@@ -19,7 +19,8 @@ Logs Reader est une application web **locale et mono-utilisateur** qui permet à
|
||||
| Dans le périmètre | Hors périmètre (v1) |
|
||||
|---|---|
|
||||
| Fichiers de log sur le disque local | Logs distants (SSH, S3, Papertrail…) |
|
||||
| Format Monolog par défaut de Laravel (`single`, `daily`, channels custom en fichier) | Formats JSON, syslog, stderr |
|
||||
| Formats Monolog (Laravel, Symfony), erreurs Apache, accès Apache/nginx, et tout format texte (une ligne par entrée), détectés par fichier | Découpage des entrées JSON multi-lignes, syslog, stderr |
|
||||
| Logs Apache (`ErrorLog`, `CustomLog`) déclarés par le vhost d'un projet | Fichiers rotés (`.1`, `.gz`), logs envoyés à un programme (`\|…`) ou à syslog |
|
||||
| Lecture seule des logs | Édition, suppression ou vidage des logs |
|
||||
| Un seul utilisateur, sans authentification | Comptes, rôles, partage |
|
||||
| Notification par favicon et titre d'onglet | E-mail, Slack, notifications natives de l'OS |
|
||||
@@ -30,17 +31,20 @@ Logs Reader est une application web **locale et mono-utilisateur** qui permet à
|
||||
|
||||
| Terme | Définition |
|
||||
|---|---|
|
||||
| **Projet** | Un projet Laravel enregistré, identifié par son chemin racine **canonique** (absolu, symlinks résolus, sans `/` final). |
|
||||
| **Répertoire de logs** | `<racine>/storage/logs`. |
|
||||
| **Fichier de log** | Tout fichier `*.log` situé (récursivement) dans le répertoire de logs. |
|
||||
| **Entrée** | Une écriture de log. Elle commence par une ligne d'en-tête Monolog et contient toutes les lignes suivantes jusqu'à la prochaine ligne d'en-tête (stack trace comprise). |
|
||||
| **Ligne d'en-tête** | Ligne qui correspond à `^\[(\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:[+-]\d{2}:?\d{2})?)\] (\w+)\.(\w+): ` → horodatage, environnement, niveau. |
|
||||
| **Projet** | Un dossier enregistré, identifié par son chemin racine **canonique** (absolu, symlinks résolus, sans `/` final). |
|
||||
| **Dossier de logs** | Sous-dossier du projet déclaré par l'utilisateur (`storage/logs`, `var/log`, `logs`…), relatif à la racine. |
|
||||
| **Format** | Manière de découper un fichier en entrées : `monolog`, `apache_error`, `access` ou `lines`, détectée sur ses premières lignes (cf. 5.3). |
|
||||
| **Fichier de log** | Tout fichier `*.log` situé (récursivement) dans un dossier de logs, ou déclaré par le vhost (cf. 5.8). |
|
||||
| **Entrée** | Une écriture de log. Elle commence par une ligne d'en-tête (selon le format) et contient toutes les lignes suivantes jusqu'à la prochaine ligne d'en-tête (stack trace comprise). |
|
||||
| **Ligne d'en-tête Monolog** | Ligne qui correspond à `^\[(\d{4}-\d{2}-\d{2}[ T]\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:[+-]\d{2}:?\d{2})?)\] (\w+)\.(\w+): ` → horodatage, environnement, niveau. |
|
||||
| **Niveau** | L'un des niveaux PSR-3 : `DEBUG`, `INFO`, `NOTICE`, `WARNING`, `ERROR`, `CRITICAL`, `ALERT`, `EMERGENCY`. |
|
||||
| **Entrée complète** | Une entrée suivie d'une autre ligne d'en-tête, ou, pour la dernière du fichier, terminée par `\n` dans un fichier non modifié depuis 1 s. |
|
||||
| **Offset de scan** | Position (en octets) jusqu'à laquelle le fichier a été lu et découpé en entrées complètes. |
|
||||
| **Curseur de lecture** | Position (en octets) de fin de la dernière entrée **consultée** par l'utilisateur, une par fichier. |
|
||||
| **Non-lu** | Une entrée complète qui commence à un offset ≥ curseur de lecture. |
|
||||
| **Intervalle** | Délai en secondes entre deux rafraîchissements côté client. |
|
||||
| **Vhost** | Fichier de configuration Apache rattaché à un projet (au plus un), identifié par son chemin canonique. |
|
||||
| **Log Apache** | Fichier déclaré par une directive `ErrorLog` (log d'erreurs) ou `CustomLog`/`TransferLog` (log d'accès) du vhost. |
|
||||
|
||||
---
|
||||
|
||||
@@ -60,7 +64,7 @@ Logs Reader est une application web **locale et mono-utilisateur** qui permet à
|
||||
│ - Repository SQLite (sqlx, migrations) │
|
||||
└──────┬───────────────────────────┬─────────┘
|
||||
│ lecture seule │
|
||||
<projet>/storage/logs/*.log data.sqlite
|
||||
<projet>/<dossiers>/*.log data.sqlite
|
||||
```
|
||||
|
||||
- **Build** : `cargo-leptos` (features `ssr` / `hydrate`), Tailwind CSS intégré via la config `tailwind-input-file` de cargo-leptos.
|
||||
@@ -76,7 +80,9 @@ Chaque fonction est exposée en `POST /api/<nom>`.
|
||||
|
||||
| Fonction | Entrée | Sortie |
|
||||
|---|---|---|
|
||||
| `add_project` | `path: String`, `name: Option<String>` | `Project` |
|
||||
| `add_project` | `path`, `name`, `log_dirs` (un par ligne), `vhost` (vides = défaut / aucun) | `()` |
|
||||
| `update_project` | `project_id`, `path`, `name`, `log_dirs`, `vhost` (vhost vide = retirer) | `()` |
|
||||
| `suggest_log_dirs` | `path` | `Vec<String>` (cf. 5.1) |
|
||||
| `remove_project` | `project_id` | `()` |
|
||||
| `read_entries` | `file_id`, `limit` (≤ 2000), `levels: Vec<String>`, `query: String` | `EntriesPage { entries, has_more, scan_offset, read_offset, levels }` |
|
||||
| `mark_read` | `file_id`, `up_to` | `()` |
|
||||
@@ -95,13 +101,19 @@ CREATE TABLE projects (
|
||||
id INTEGER PRIMARY KEY,
|
||||
name TEXT NOT NULL,
|
||||
root_path TEXT NOT NULL UNIQUE, -- chemin canonique
|
||||
last_error TEXT, -- projet introuvable sur le disque
|
||||
vhost_path TEXT, -- vhost Apache, chemin canonique
|
||||
vhost_error TEXT, -- vhost illisible
|
||||
log_dirs TEXT NOT NULL DEFAULT 'storage/logs', -- dossiers de logs, un par ligne
|
||||
created_at TEXT NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE log_files (
|
||||
id INTEGER PRIMARY KEY,
|
||||
project_id INTEGER NOT NULL REFERENCES projects(id) ON DELETE CASCADE,
|
||||
relative_path TEXT NOT NULL, -- relatif à storage/logs
|
||||
relative_path TEXT NOT NULL, -- relatif à la racine ; absolu pour un log Apache
|
||||
kind TEXT NOT NULL, -- origine : 'project' | 'apache_error' | 'apache_access'
|
||||
format TEXT, -- 'monolog' | 'apache_error' | 'access' | 'lines' ; NULL = pas encore détecté
|
||||
file_identity TEXT, -- inode+device (Unix) / file index (Windows)
|
||||
size INTEGER NOT NULL DEFAULT 0,
|
||||
modified_at INTEGER, -- mtime, secondes Unix (tri)
|
||||
@@ -146,15 +158,26 @@ CREATE TABLE settings (
|
||||
|
||||
1. Le chemin saisi est nettoyé (trim) ; `~` en tête est remplacé par `$HOME`.
|
||||
2. Il est canonicalisé (`std::fs::canonicalize`).
|
||||
3. Il est valide si : c'est un répertoire, il contient un fichier `artisan` **et** un répertoire `storage/logs` lisible.
|
||||
3. Il est valide si c'est un répertoire (aucun fichier particulier n'est exigé).
|
||||
4. Le nom par défaut est le nom du dernier segment du chemin.
|
||||
5. Les fichiers de log existants sont découverts et indexés. **Leur curseur de lecture est placé à la fin** (`read_offset = scan_offset`) : l'historique n'est pas compté comme non-lu.
|
||||
5. **Dossiers de logs** : un par ligne (ou séparés par des virgules), relatifs à la racine ; espaces, `./` en tête et `/` final retirés, doublons ignorés. Chacun doit être un sous-dossier (ni `.`, ni `..`, ni chemin absolu) existant et lisible.
|
||||
6. **Proposition** : quand le chemin est saisi (et tant que l'utilisateur n'a pas modifié le champ), la fenêtre propose les dossiers existants parmi : `storage/logs` si `artisan` existe (Laravel), `var/log` si `bin/console` existe (Symfony), puis `storage/logs`, `var/log`, `var/logs`, `logs`, `log`.
|
||||
7. Un vhost Apache peut être indiqué (optionnel, cf. 5.8). Il faut au moins un dossier de logs ou un vhost. Si un champ est invalide, rien n'est enregistré.
|
||||
8. Les fichiers de log existants sont découverts et indexés. **Leur curseur de lecture est placé à la fin** (`read_offset = scan_offset`) : l'historique n'est pas compté comme non-lu.
|
||||
|
||||
### 5.1 bis Modification d'un projet
|
||||
|
||||
- Le nom, le chemin, les dossiers de logs et le vhost se modifient avec les mêmes règles qu'à l'ajout (nom vide → dernier segment du chemin ; vhost vide → aucun vhost).
|
||||
- Un nouveau chemin déjà enregistré par un autre projet est refusé (« Ce projet est déjà enregistré. »).
|
||||
- Changer de chemin supprime les fichiers suivis de l'ancien chemin ; ceux du nouveau sont indexés avec leur curseur en fin de fichier. Retirer un dossier de logs supprime ses fichiers. Les fichiers qui deviennent suivis (nouveau chemin, nouveau dossier, nouveau vhost) ne comptent pas leur historique en non-lu ; les autres gardent leurs curseurs.
|
||||
- La modification et le scan qui suit se font sous le verrou du scanner.
|
||||
|
||||
### 5.2 Découverte des fichiers
|
||||
|
||||
- Parcours récursif de `storage/logs`, à chaque scan.
|
||||
- Parcours récursif de chaque dossier de logs, à chaque scan ; rien d'autre du projet n'est parcouru (`vendor/`, `node_modules/`… sont ignorés sauf s'ils sont déclarés). Deux dossiers imbriqués ne suivent un fichier qu'une fois.
|
||||
- Retenus : fichiers réguliers dont le nom se termine par `.log`. Ignorés : fichiers cachés (`.gitignore`…), répertoires, autres extensions (`.gz`…).
|
||||
- Liens symboliques : suivis uniquement si la cible canonique reste sous `storage/logs`.
|
||||
- Liens symboliques : suivis uniquement si la cible canonique reste sous le même dossier de logs.
|
||||
- Si la racine ou un dossier de logs disparaît, le projet est marqué en erreur et ses fichiers restent en l'état jusqu'au retour du dossier (E09).
|
||||
- Un fichier **apparu après l'ajout du projet** (ex. nouveau `laravel-2026-10-22.log` en mode daily) est créé avec `read_offset = 0` : tout son contenu est non-lu.
|
||||
- Un fichier disparu reçoit `missing_since` ; ses entrées ne comptent plus dans les non-lus ; il réapparaît normalement s'il revient (traité comme une rotation, cf. 5.4).
|
||||
|
||||
@@ -162,7 +185,9 @@ CREATE TABLE settings (
|
||||
|
||||
- Le fichier est ouvert en **lecture seule**, lu à partir de `scan_offset` par blocs (ex. 64 Kio), sans jamais le charger en entier.
|
||||
- Les octets sont décodés en UTF-8 avec remplacement (`from_utf8_lossy`) ; les offsets restent des offsets d'octets.
|
||||
- **Détection du format** : à la première lecture d'un fichier du projet (et après une rotation), sur ses 50 premières lignes complètes (64 Kio au plus) : `monolog` si l'une est une ligne d'en-tête Monolog, sinon `apache_error` si l'une est un en-tête d'erreur Apache, sinon `access` si l'une est une ligne de log d'accès (`common`/`combined`), sinon `lines`. Un fichier sans ligne complète non vide n'est pas indexé ; la détection est retentée au scan suivant. Les fichiers du vhost ont le format de leur directive.
|
||||
- Une ligne d'en-tête ouvre une nouvelle entrée. Toute autre ligne est rattachée à l'entrée courante.
|
||||
- **Format `lines`** : toute ligne non indentée ouvre une entrée ; une ligne qui commence par un espace ou une tabulation (stack trace Python, Java, Node…) est rattachée à la précédente. Date : la première `YYYY-MM-DD[ T]HH:MM:SS` dans les 40 premiers caractères, sinon la date de modification. Niveau : le premier mot `EMERGENCY`, `ALERT`, `CRITICAL`/`CRIT`/`FATAL`, `ERROR`/`ERR`, `WARNING`/`WARN`, `NOTICE`, `INFO`, `DEBUG`/`TRACE` en majuscules, ou `level=…` / `"level":"…"`, sinon `UNKNOWN`.
|
||||
- Des lignes avant la première ligne d'en-tête du fichier forment une entrée de niveau `UNKNOWN`, horodatée à la date de modification du fichier.
|
||||
- La dernière entrée du fichier n'est indexée que si elle est **complète** : elle se termine par `\n` **et** le fichier n'a pas été modifié depuis au moins 1 s (sinon une stack trace à moitié écrite serait coupée en deux). Sinon `scan_offset` reste à son début et elle sera relue au scan suivant.
|
||||
- Taille maximale d'une entrée affichée : 1 Mio ; au-delà le contenu est tronqué à l'affichage avec la mention « entrée tronquée » (l'index garde les vrais offsets).
|
||||
@@ -196,13 +221,26 @@ Au scan, si `taille actuelle < scan_offset` **ou** `file_identity` a changé :
|
||||
|
||||
### 5.7 Interface
|
||||
|
||||
- **Barre latérale** : liste des projets, chacun dépliable en liste de fichiers (chemin relatif, taille, badge de non-lus). Fichiers manquants grisés. Un projet replié le reste aux rafraîchissements.
|
||||
- **Barre latérale** : liste des projets, chacun dépliable en liste de fichiers (chemin relatif à la racine, ou au dossier de logs s'il n'y en a qu'un ; taille ; badge de non-lus). Fichiers manquants grisés. Un projet replié le reste aux rafraîchissements.
|
||||
- **Tri des fichiers** : par nom (alphabétique, défaut) ou par date de dernière modification (le plus récent en premier, sans date en dernier, nom en départage). Trié par date, l'ancienneté (« il y a 3 h ») remplace la taille. Le choix s'applique à tous les projets et est enregistré dans `settings` (`file_sort`).
|
||||
- **Formulaire d'ajout** : champ chemin + nom optionnel, message d'erreur sous le champ.
|
||||
- **Fenêtre de projet** (modale, `<dialog>` natif) : ouverte par « + Ajouter un projet » ou par le bouton ✎ d'un projet (pré-remplie). Champs : chemin du projet, nom (optionnel), dossiers de logs (zone de texte, un par ligne, proposés d'après le chemin, cf. 5.1), vhost Apache (optionnel). En modification, un bouton « Retirer ce projet » en bas à gauche le supprime après confirmation (c'est le seul moyen de retirer un projet). Message d'erreur dans la fenêtre ; elle se ferme quand l'enregistrement ou le retrait réussit, par « Annuler », Échap ou un clic sur le fond.
|
||||
- **Vue fichier** : entrées triées du plus récent au plus ancien, 50 par page, bouton « Charger plus ». Chaque entrée : date, niveau (badge coloré), environnement, première ligne ; le reste (stack trace) est repliable. Filtres par niveau (cases à cocher ; les niveaux absents du fichier sont grisés et désactivés, et se réactivent dès qu'une entrée de ce niveau apparaît) et recherche texte (insensible à la casse, sur le contenu complet de l'entrée).
|
||||
- **Bouton marche/arrêt de la lecture** : à gauche du titre. Lecture active : un engrenage qui tourne lentement (6 s par tour, immobile si l'utilisateur a demandé moins d'animations). Lecture arrêtée : un bouton rouge avec l'icône « power ». L'arrêt supprime le polling et le rafraîchissement au retour sur l'onglet ; « · lecture arrêtée » s'affiche en rouge à côté du compteur. L'état est enregistré dans `settings` (`paused`). À la reprise, un rafraîchissement part immédiatement. Les actions de l'utilisateur (ouvrir un fichier, marquer comme lu, charger la page) rafraîchissent toujours.
|
||||
- **Logs Apache** : les logs Apache sont listés sous le titre « Apache », après les logs du projet, par nom de fichier suivi de leur rôle (« erreurs » ou « accès »), le chemin complet en info-bulle.
|
||||
- **Réglages** : intervalle en secondes (champ numérique, 1–3600).
|
||||
|
||||
### 5.8 Logs Apache du vhost
|
||||
|
||||
- Le chemin saisi est nettoyé, `~` remplacé par `$HOME`, puis canonicalisé. Il est valide si c'est un fichier lisible qui déclare au moins un log.
|
||||
- Le vhost est relu à chaque scan : un log ajouté au vhost est suivi, un log retiré du vhost n'est plus suivi (ses lignes sont supprimées). Si le vhost devient illisible, `vhost_error` est renseigné et ses fichiers connus restent en l'état.
|
||||
- Directives lues (insensibles à la casse, lignes commentées ignorées) : `ErrorLog` → log d'erreurs ; `CustomLog`, `TransferLog` → log d'accès. Seul le premier argument compte (entre guillemets ou non). Ignorés : `|programme`, `syslog…`. Un même fichier déclaré deux fois (vhosts `:80` et `:443`) n'est suivi qu'une fois.
|
||||
- Les variables `${NOM}` sont remplacées par les `export NOM=…` de `/etc/apache2/envvars` (une variable inconnue vaut la chaîne vide) ; un chemin relatif part de `/etc/apache2`.
|
||||
- À la configuration du vhost, le curseur des fichiers nouvellement suivis est placé à la fin : l'historique n'est pas non-lu. La mise à jour du vhost et ce premier scan se font sous le verrou du scanner.
|
||||
- **Log d'erreurs** : une ligne d'en-tête correspond à `[Wed Oct 21 11:29:09.705795 2026] [module:niveau] [pid …] message` (module facultatif). Les lignes suivantes sans en-tête sont rattachées à l'entrée. Niveaux : `emerg` → `EMERGENCY`, `alert` → `ALERT`, `crit` → `CRITICAL`, `error` → `ERROR`, `warn` → `WARNING`, `notice` → `NOTICE`, `info` → `INFO`, `debug` et `trace1`…`trace8` → `DEBUG`. Le module s'affiche à la place de l'environnement.
|
||||
- **Log d'accès** : chaque ligne est une entrée, complète dès son `\n` (sans attendre 1 s). Formats `common`, `combined`, `vhost_combined`. Niveau selon le code HTTP : 5xx → `ERROR`, 4xx → `WARNING`, 1xx–3xx → `INFO`, autre ou ligne non reconnue → `UNKNOWN`. Affichage : client, puis « code requête », la ligne complète en détail repliable.
|
||||
- **Non-lus** : les entrées du log d'erreurs comptent comme celles des logs du projet. Celles d'un log d'accès (du vhost ou d'un dossier du projet, format `access`) **ne comptent jamais** (une ligne par requête) ; à l'ouverture du fichier, les lignes arrivées depuis la dernière consultation sont tout de même surlignées.
|
||||
- Les dates Apache sont converties au format `YYYY-MM-DD HH:MM:SS` (heure locale du log, sans fuseau).
|
||||
|
||||
---
|
||||
|
||||
## 6. User stories et critères d'acceptation
|
||||
@@ -211,9 +249,11 @@ Convention : `Given / When / Then`. « Écrire une entrée » signifie ajouter a
|
||||
|
||||
### US-01 — Ajouter un projet
|
||||
|
||||
> En tant que développeur, je veux ajouter un projet Laravel en saisissant son chemin, afin de surveiller ses logs.
|
||||
> En tant que développeur, je veux ajouter un projet en saisissant son chemin et ses dossiers de logs, afin de surveiller ses logs.
|
||||
|
||||
- **AC-01.1** Given un répertoire `/tmp/app` avec `artisan` et `storage/logs/laravel.log`, When j'ajoute `/tmp/app`, Then le projet `app` apparaît dans la liste avec le fichier `laravel.log`.
|
||||
- **AC-01.1** Given un répertoire `/tmp/app` avec `artisan` et `storage/logs/laravel.log`, When je saisis `/tmp/app`, Then le champ des dossiers propose `storage/logs` ; When j'ajoute le projet, Then `app` apparaît dans la liste avec le fichier `laravel.log`.
|
||||
- **AC-01.7** Given un projet Node `/tmp/api` avec `logs/app.log` et `node_modules/x/debug.log`, When je l'ajoute avec le dossier `logs`, Then seul `app.log` est listé ; ses lignes `… ERROR …` sont des entrées `ERROR` et ses lignes indentées sont rattachées à l'entrée précédente.
|
||||
- **AC-01.8** When j'ajoute un projet sans dossier de logs ni vhost, Then l'ajout est refusé avec « Indiquez au moins un dossier de logs ou un vhost. » ; When je saisis le dossier `../x`, Then il est refusé avec « « ../x » doit être un sous-dossier du projet. ».
|
||||
- **AC-01.2** Given le même répertoire, When j'ajoute `/tmp/app/` puis `/tmp/../tmp/app`, Then la 2ᵉ et la 3ᵉ tentative sont refusées avec « Ce projet est déjà enregistré ».
|
||||
- **AC-01.3** Given un lien `/tmp/link → /tmp/app` et `/tmp/app` déjà enregistré, When j'ajoute `/tmp/link`, Then l'ajout est refusé (même chemin canonique).
|
||||
- **AC-01.4** Given `laravel.log` contient 10 entrées, When j'ajoute le projet, Then le compteur de non-lus du projet vaut 0.
|
||||
@@ -273,7 +313,7 @@ Convention : `Given / When / Then`. « Écrire une entrée » signifie ajouter a
|
||||
|
||||
> En tant que développeur, je veux retirer un projet que je ne surveille plus.
|
||||
|
||||
- **AC-07.1** Given un projet avec 5 non-lus, When je le supprime et confirme, Then il disparaît de la liste, le total diminue de 5, et aucune ligne liée ne reste dans `log_files`, `log_entries_index`, `read_cursors`.
|
||||
- **AC-07.1** Given un projet avec 5 non-lus, When j'ouvre sa fenêtre (✎), clique « Retirer ce projet » et confirme, Then il disparaît de la liste, le total diminue de 5, et aucune ligne liée ne reste dans `log_files`, `log_entries_index`, `read_cursors`.
|
||||
- **AC-07.2** Given un projet supprimé, When je l'ajoute à nouveau, Then l'ajout réussit et les entrées existantes ne sont pas comptées comme non-lues (cf. AC-01.4).
|
||||
- **AC-07.3** When je supprime un projet, Then aucun fichier du projet sur le disque n'est modifié (mtime et contenu identiques).
|
||||
|
||||
@@ -304,6 +344,25 @@ Convention : `Given / When / Then`. « Écrire une entrée » signifie ajouter a
|
||||
- **AC-11.2** Given la lecture arrêtée, When je recharge la page, Then le bouton est toujours rouge, le favicon toujours en pause, et aucun polling ne reprend.
|
||||
- **AC-11.3** Given la lecture arrêtée et 1 entrée écrite entre-temps, When je clique sur le bouton rouge, Then l'engrenage réapparaît et le compteur et le favicon sont mis à jour en moins de 1 s.
|
||||
|
||||
### US-12 — Consulter les logs Apache du vhost
|
||||
|
||||
> En tant que développeur, je veux voir les logs Apache du vhost de mon projet à côté de ses autres logs, pour diagnostiquer une erreur 500 sans ouvrir un terminal.
|
||||
|
||||
- **AC-12.1** Given un vhost déclarant `ErrorLog ${APACHE_LOG_DIR}/error.app.log` et `CustomLog ${APACHE_LOG_DIR}/access.app.log combined`, When je l'enregistre sur le projet, Then les deux fichiers apparaissent sous « Apache » avec les rôles « erreurs » et « accès », et le total de non-lus ne change pas.
|
||||
- **AC-12.2** Given le vhost enregistré, When une ligne `[php:error]` est écrite dans le log d'erreurs, Then le total augmente de 1 ; When 10 requêtes sont faites, Then le total ne change pas.
|
||||
- **AC-12.3** Given le log d'accès ouvert, Then chaque requête est une entrée, une 404 en `WARNING` et une 500 en `ERROR`, et le filtre par niveau s'applique.
|
||||
- **AC-12.4** When je saisis `/etc/hosts`, Then l'enregistrement est refusé avec « Aucune directive ErrorLog ni CustomLog dans « /etc/hosts ». ».
|
||||
- **AC-12.5** Given le vhost enregistré, When je vide le champ vhost du projet et j'enregistre, Then les fichiers Apache disparaissent de la liste et leurs non-lus ne comptent plus.
|
||||
|
||||
### US-13 — Modifier un projet
|
||||
|
||||
> En tant que développeur, je veux corriger le nom, le chemin ou le vhost d'un projet sans le supprimer, pour garder ses compteurs.
|
||||
|
||||
- **AC-13.1** Given un projet « app », When je clique ✎, Then la fenêtre s'ouvre avec son chemin, son nom et son vhost.
|
||||
- **AC-13.2** Given 3 non-lus dans `laravel.log`, When je renomme le projet en « API », Then il s'affiche « API » et garde ses 3 non-lus.
|
||||
- **AC-13.3** Given deux projets A et B, When je donne à B le chemin de A, Then l'enregistrement est refusé avec « Ce projet est déjà enregistré. » et la fenêtre reste ouverte.
|
||||
- **AC-13.4** Given un projet, When je change son chemin vers un autre projet dont le dossier de logs contient 10 entrées, Then ses fichiers sont ceux du nouveau chemin et son compteur de non-lus vaut 0.
|
||||
|
||||
### US-09 — Conserver l'état entre deux redémarrages
|
||||
|
||||
> En tant que développeur, je veux retrouver mes projets et mes compteurs après un redémarrage.
|
||||
@@ -321,8 +380,9 @@ Convention : `Given / When / Then`. « Écrire une entrée » signifie ajouter a
|
||||
| E01 | Chemin vide | Validation client et serveur | Refus | « Veuillez saisir un chemin. » |
|
||||
| E02 | Chemin inexistant | `canonicalize` → `NotFound` | Refus, rien en base | « Le chemin `<p>` n'existe pas. » |
|
||||
| E03 | Chemin vers un fichier | `!is_dir()` | Refus | « `<p>` n'est pas un répertoire. » |
|
||||
| E04 | Pas un projet Laravel | `artisan` absent | Refus | « `<p>` ne semble pas être un projet Laravel (fichier `artisan` introuvable). » |
|
||||
| E05 | `storage/logs` absent | Absence du répertoire | Refus | « Répertoire `storage/logs` introuvable. » |
|
||||
| E04 | Dossier de logs hors du projet | `.`, `..` ou chemin absolu | Refus | « « `<d>` » doit être un sous-dossier du projet. » |
|
||||
| E05 | Dossier de logs absent ou illisible | Absence du répertoire, `PermissionDenied` | Refus | « Dossier « `<d>` » introuvable dans le projet. », « Accès refusé à « `<d>` ». » |
|
||||
| E05 bis | Ni dossier de logs ni vhost | Champs vides | Refus | « Indiquez au moins un dossier de logs ou un vhost. » |
|
||||
| E06 | Permission refusée à l'ajout | `PermissionDenied` | Refus | « Accès refusé à `<p>`. » |
|
||||
| E07 | Projet déjà enregistré | Contrainte `UNIQUE(root_path)` après canonicalisation | Refus, projet existant mis en évidence | « Ce projet est déjà enregistré. » |
|
||||
| E08 | Aucun fichier `.log` | Découverte vide | Ajout accepté, liste vide | « Aucun fichier de log pour l'instant. » |
|
||||
@@ -343,6 +403,9 @@ Convention : `Given / When / Then`. « Écrire une entrée » signifie ajouter a
|
||||
| E23 | Port déjà utilisé | `bind` échoue | Arrêt, code de sortie ≠ 0 | « L'adresse `<addr>` est déjà utilisée. » |
|
||||
| E24 | Serveur injoignable côté client | Échec réseau du poll | Favicon gris « ! », bandeau discret ; on continue de poller au même intervalle | « Serveur injoignable. » |
|
||||
| E25 | Scans simultanés (plusieurs onglets) | Mutex par projet | Un seul scan à la fois, résultats partagés ; pas de double indexation | — |
|
||||
| E26 | Vhost inexistant, illisible ou sans directive de log | Validation serveur | Refus, vhost précédent conservé | « Le fichier « p » n'existe pas. », « Accès refusé à « p ». », « Aucune directive ErrorLog ni CustomLog dans « p ». » |
|
||||
| E27 | Vhost supprimé ou illisible après configuration | Lecture au scan | `vhost_error` renseigné, fichiers Apache connus conservés en l'état | Message sous le titre « Apache » |
|
||||
| E28 | Log Apache illisible (droits `root:adm 640`) | `PermissionDenied` | Comme E10 ; l'utilisateur qui lance le serveur doit être dans le groupe `adm` | Icône d'alerte sur le fichier |
|
||||
|
||||
---
|
||||
|
||||
@@ -354,10 +417,10 @@ Ces propriétés doivent être vraies après toute opération et peuvent être v
|
||||
- **INV-02 Ordre des offsets** — Pour tout fichier présent : `0 ≤ read_offset ≤ scan_offset ≤ size`.
|
||||
- **INV-03 Index cohérent** — Les entrées indexées d'un fichier sont disjointes, contiguës et triées : pour deux entrées consécutives `e1, e2`, `e1.end_offset = e2.start_offset` ; la dernière se termine à `scan_offset` ; `entries_count` = nombre de lignes d'index.
|
||||
- **INV-04 Aucune entrée partielle ni doublon** — Chaque entrée complète du fichier est indexée exactement une fois ; aucune entrée incomplète n'est indexée.
|
||||
- **INV-05 Calcul des non-lus** — `unread(f)` = nombre d'entrées indexées de `f` avec `start_offset ≥ read_offset` ; `unread(f) ≥ 0` ; `unread(f) = 0` si `f` est manquant ; `total = Σ unread(f)` sur les fichiers présents des projets accessibles.
|
||||
- **INV-05 Calcul des non-lus** — `unread(f)` = nombre d'entrées indexées de `f` avec `start_offset ≥ read_offset` ; `unread(f) ≥ 0` ; `unread(f) = 0` si `f` est manquant ou est un log d'accès Apache ; `total = Σ unread(f)` sur les fichiers présents des projets accessibles.
|
||||
- **INV-06 Le curseur n'avance que par l'utilisateur** — Un scan ne fait jamais avancer `read_offset` ; seuls `mark_read`, `mark_all_read` et l'ajout initial d'un projet (5.1) le font avancer. Seule une rotation (5.4) le fait reculer (à 0).
|
||||
- **INV-07 Monotonie hors rotation** — En l'absence de rotation, `scan_offset` et `read_offset` sont croissants dans le temps.
|
||||
- **INV-08 Confinement** — Tout fichier suivi a un chemin canonique sous `<root_path>/storage/logs`.
|
||||
- **INV-08 Confinement** — Tout fichier du projet suivi a un chemin canonique sous l'un de ses dossiers de logs ; tout log Apache suivi est déclaré par le vhost du projet.
|
||||
- **INV-09 Unicité** — Un chemin canonique correspond à au plus un projet ; un couple (projet, chemin relatif) à au plus un fichier.
|
||||
- **INV-10 Cascade** — Après suppression d'un projet, aucune ligne de `log_files`, `log_entries_index` ou `read_cursors` ne le référence.
|
||||
- **INV-11 Bornes de l'intervalle** — `refresh_interval_seconds` stocké est toujours un entier dans `[1, 3600]`.
|
||||
@@ -384,7 +447,7 @@ Ces propriétés doivent être vraies après toute opération et peuvent être v
|
||||
|
||||
- **Unitaires** : parser (en-têtes valides/invalides, multi-lignes, entrée partielle, UTF-8 invalide, fuseaux horaires, microsecondes), détection de rotation, validation de chemin et d'intervalle, calcul de `mark_read` (non-régression du curseur).
|
||||
- **Propriétés** (`proptest`) : écrire des séquences aléatoires d'entrées en morceaux arbitraires, scanner entre chaque morceau, vérifier INV-02 à INV-05 et INV-13.
|
||||
- **Intégration** : serveur axum sur port aléatoire + SQLite temporaire + projet Laravel factice dans un `tempdir` ; dérouler les AC des US-01 à US-09 via les server functions.
|
||||
- **Intégration** : serveur axum sur port aléatoire + SQLite temporaire + projet factice dans un `tempdir` ; dérouler les AC des US-01 à US-09 via les server functions.
|
||||
- **E2E** (Playwright) : AC-04.2, AC-05.1, AC-05.3, AC-05.4, AC-05.5, AC-06.2, AC-06.3 — lecture de `document.title` et de l'attribut `href` du `<link rel="icon">`.
|
||||
|
||||
---
|
||||
|
||||
Reference in new issue
Block a user