From 05c3934b28b4b61ba881eab397b71f493c74c7d7 Mon Sep 17 00:00:00 2001 From: Romulus21 Date: Wed, 21 Oct 2026 11:17:20 +0200 Subject: [PATCH] =?UTF-8?q?Renommage=20en=20Logs=20Reader=20et=20bouton=20?= =?UTF-8?q?marche/arr=C3=AAt=20de=20la=20lecture?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 5.5 --- .spec/specification.md | 29 ++++++--- Cargo.lock | 40 ++++++------ Cargo.toml | 4 +- README.md | 8 +-- src/api.rs | 8 +++ src/app.rs | 142 ++++++++++++++++++++++++++++++++++++++--- src/main.rs | 10 +-- src/model.rs | 18 ++++-- src/server.rs | 2 + 9 files changed, 207 insertions(+), 54 deletions(-) diff --git a/.spec/specification.md b/.spec/specification.md index 4275a83..624d515 100644 --- a/.spec/specification.md +++ b/.spec/specification.md @@ -1,4 +1,4 @@ -# Lara Logs Reader — Spécification +# Logs Reader — Spécification > Document dérivé du brief `.spec/spec.md`. > Statut : brouillon v1 — 2026-10-21. @@ -7,7 +7,7 @@ ## 1. Vue d'ensemble -Lara Logs Reader est une application web **locale et mono-utilisateur** qui permet à un développeur de : +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 ; @@ -67,8 +67,8 @@ Lara Logs Reader est une application web **locale et mono-utilisateur** qui perm - **Persistance** : SQLite via `sqlx`, migrations embarquées (`sqlx::migrate!`) appliquées au démarrage, `PRAGMA foreign_keys = ON`, mode WAL. - **Scan** : déclenché par chaque appel `unread_summary` (donc au rythme du polling). Les scans concurrents d'un même projet sont sérialisés (mutex par projet) ; un appel qui arrive pendant un scan attend son résultat au lieu d'en relancer un. - **Configuration** (variables d'environnement) : - - `LLR_DATABASE_URL` — défaut `sqlite://./lara_logs_reader.sqlite?mode=rwc` - - `LLR_ADDR` — défaut `127.0.0.1:3000` + - `LOGS_READER_DATABASE_URL` — défaut `sqlite://./logs_reader.sqlite?mode=rwc` + - `LOGS_READER_ADDR` — défaut `127.0.0.1:3000` ### 3.1 API (server functions) @@ -83,6 +83,7 @@ Chaque fonction est exposée en `POST /api/`. | `mark_all_read` | `project_id: Option<_>` | `()` | | `unread_summary` | — | `Summary { total, projects[{…, unread, files[{…, unread}]}] }` | | `get_settings` / `set_refresh_interval` | `seconds: String` | `Settings { refresh_interval_seconds, file_sort }` | +| `set_paused` | `paused: bool` | `()` | | `set_file_sort` | `sort: "name" \| "modified"` | `()` | --- @@ -181,8 +182,9 @@ Au scan, si `taille actuelle < scan_offset` **ou** `file_identity` a changé : - Le favicon est un SVG 32×32 généré côté client (URL `data:`) : - `total = 0` → icône normale ; - `total ≥ 1` → icône + pastille rouge avec le nombre (`99+` au-delà de 99) ; - - serveur injoignable → icône + pastille grise « ! ». -- Le titre de l'onglet devient `(N) Lara Logs Reader` quand `N ≥ 1`, `Lara Logs Reader` sinon. + - serveur injoignable → icône + pastille grise « ! » ; + - lecture arrêtée → icône + pastille rouge avec le symbole pause (prioritaire sur les autres états). +- Le titre de l'onglet devient `(N) Logs Reader` quand `N ≥ 1`, `Logs Reader` sinon. - Le favicon change même si l'onglet est en arrière-plan (les timers en arrière-plan peuvent être ralentis par le navigateur jusqu'à 1 fois par minute : comportement accepté). ### 5.6 Marquage comme lu @@ -198,6 +200,7 @@ Au scan, si `taille actuelle < scan_offset` **ou** `file_identity` a changé : - **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. - **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. - **Réglages** : intervalle en secondes (champ numérique, 1–3600). --- @@ -249,10 +252,10 @@ Convention : `Given / When / Then`. « Écrire une entrée » signifie ajouter a > En tant que développeur, je veux voir dans l'onglet du navigateur s'il y a de nouveaux logs, sans avoir à regarder l'application. -- **AC-05.1** Given 0 non-lu, When 3 entrées sont écrites dans un fichier suivi, Then en ≤ intervalle + 1 s le favicon porte une pastille « 3 » et le titre est `(3) Lara Logs Reader`. +- **AC-05.1** Given 0 non-lu, When 3 entrées sont écrites dans un fichier suivi, Then en ≤ intervalle + 1 s le favicon porte une pastille « 3 » et le titre est `(3) Logs Reader`. - **AC-05.2** Given 2 non-lus dans `a.log` et 1 dans `b.log` (même projet ou non), Then la pastille affiche « 3 ». -- **AC-05.3** Given 150 non-lus, Then la pastille affiche « 99+ » et le titre `(150) Lara Logs Reader`. -- **AC-05.4** Given des non-lus, When tout est marqué comme lu, Then le favicon redevient normal et le titre `Lara Logs Reader` sans attendre le prochain poll. +- **AC-05.3** Given 150 non-lus, Then la pastille affiche « 99+ » et le titre `(150) Logs Reader`. +- **AC-05.4** Given des non-lus, When tout est marqué comme lu, Then le favicon redevient normal et le titre `Logs Reader` sans attendre le prochain poll. - **AC-05.5** Given le serveur arrêté, When un poll échoue, Then le favicon affiche la pastille grise « ! » ; When le serveur redémarre, Then au poll suivant le favicon reflète à nouveau le nombre de non-lus. - **AC-05.6** Given `laravel.log` vidé (`> laravel.log`) puis 2 entrées écrites, Then le fichier compte 2 non-lus. @@ -293,6 +296,14 @@ Convention : `Given / When / Then`. « Écrire une entrée » signifie ajouter a - **AC-10.3** Given le tri « Date », When je recharge la page ou redémarre le serveur, Then le tri « Date » est conservé. - **AC-10.4** Given un projet replié, When je change de tri, Then il reste replié. +### US-11 — Mettre la lecture en pause + +> En tant que développeur, je veux arrêter temporairement la lecture des logs, par exemple pendant une session de debug bruyante. + +- **AC-11.1** Given la lecture active (engrenage qui tourne), When je clique dessus, Then le bouton devient rouge, le favicon affiche la pastille rouge « pause », « · lecture arrêtée » est affiché, et aucun appel `unread_summary` n'est fait pendant 3 intervalles, même si des entrées sont écrites. +- **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-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. diff --git a/Cargo.lock b/Cargo.lock index 0885a6d..3a8da9a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1125,26 +1125,6 @@ version = "0.2.19" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a4933f3f57a8e9d9da04db23fb153356ecaf00cbd14aee46279c33dc80925c37" -[[package]] -name = "lara_logs_reader" -version = "0.1.0" -dependencies = [ - "axum", - "console_error_panic_hook", - "leptos", - "leptos_axum", - "leptos_meta", - "leptos_router", - "regex", - "serde", - "sqlx", - "tempfile", - "time", - "tokio", - "wasm-bindgen", - "web-sys", -] - [[package]] name = "lazy_static" version = "1.5.1" @@ -1436,6 +1416,26 @@ version = "0.4.34" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f9f8bd3e56ce4dfc153cf470fffbfa98c7620958b312ca5c3a4b8d5181fd13c6" +[[package]] +name = "logs_reader" +version = "0.1.0" +dependencies = [ + "axum", + "console_error_panic_hook", + "leptos", + "leptos_axum", + "leptos_meta", + "leptos_router", + "regex", + "serde", + "sqlx", + "tempfile", + "time", + "tokio", + "wasm-bindgen", + "web-sys", +] + [[package]] name = "manyhow" version = "0.14.1" diff --git a/Cargo.toml b/Cargo.toml index 66804e5..f7e57ef 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "lara_logs_reader" +name = "logs_reader" version = "0.1.0" edition = "2024" @@ -56,7 +56,7 @@ codegen-units = 1 panic = "abort" [package.metadata.leptos] -output-name = "lara_logs_reader" +output-name = "logs_reader" site-root = "target/site" site-pkg-dir = "pkg" tailwind-input-file = "style/tailwind.css" diff --git a/README.md b/README.md index 17e97eb..7075ddd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Lara Logs Reader +# Logs Reader Lecteur local de logs Laravel. Il signale les nouvelles entrées par l'icône et le titre de l'onglet. Spécification : [`.spec/specification.md`](.spec/specification.md). @@ -9,15 +9,15 @@ Stack : axum, Leptos 0.8 (SSR + hydratation), Tailwind CSS v4, SQLite (sqlx). ```sh cargo leptos watch # développement, http://127.0.0.1:3000 -cargo leptos build --release && ./target/release/lara_logs_reader +cargo leptos build --release && ./target/release/logs_reader ``` Variables d'environnement : | Variable | Défaut | |---|---| -| `LLR_DATABASE_URL` | `sqlite://./lara_logs_reader.sqlite?mode=rwc` | -| `LLR_ADDR` | `127.0.0.1:3000` | +| `LOGS_READER_DATABASE_URL` | `sqlite://./logs_reader.sqlite?mode=rwc` | +| `LOGS_READER_ADDR` | `127.0.0.1:3000` | En release, lancer le binaire depuis la racine du dépôt (ou définir `LEPTOS_SITE_ROOT=target/site`). diff --git a/src/api.rs b/src/api.rs index 6a237ce..5e8a9a0 100644 --- a/src/api.rs +++ b/src/api.rs @@ -255,6 +255,14 @@ pub async fn set_refresh_interval(seconds: String) -> Result Result<(), ServerFnError> { + crate::server::set_setting(&pool()?, "paused", if paused { "1" } else { "0" }) + .await + .map_err(internal_error) +} + /// Ordre des fichiers dans la barre latérale, conservé entre deux sessions. #[server(input = Json, endpoint = "set_file_sort")] pub async fn set_file_sort(sort: FileSort) -> Result<(), ServerFnError> { diff --git a/src/app.rs b/src/app.rs index f14b035..313688d 100644 --- a/src/app.rs +++ b/src/app.rs @@ -1,7 +1,7 @@ use crate::{ api::{ - AddProject, MarkAllRead, MarkRead, RemoveProject, SetFileSort, SetRefreshInterval, - get_settings, read_entries, unread_summary, + AddProject, MarkAllRead, MarkRead, RemoveProject, SetFileSort, SetPaused, + SetRefreshInterval, get_settings, read_entries, unread_summary, }, model::{ DEFAULT_INTERVAL, EntriesPage, Entry, FaviconState, FileSort, LEVELS, PAGE_SIZE, @@ -72,6 +72,31 @@ struct SettingsCtx { save: ServerAction, } +/// Interrupteur de lecture automatique des logs. +#[derive(Clone, Copy)] +struct Pause { + /// Choix fait dans cette page : il s'applique sans attendre la relecture des réglages. + chosen: RwSignal>, + save: ServerAction, + settings: Resource>, +} + +impl Pause { + fn get(&self) -> bool { + self.chosen.get().unwrap_or_else(|| { + self.settings + .get() + .and_then(Result::ok) + .is_some_and(|s| s.paused) + }) + } + + fn set(&self, paused: bool) { + self.chosen.set(Some(paused)); + self.save.dispatch(SetPaused { paused }); + } +} + /// Extrait le message lisible d'une erreur de server function. fn error_message(error: &ServerFnError) -> String { match error { @@ -109,6 +134,13 @@ pub fn App() -> impl IntoView { let settings = Resource::new(move || save.version().get(), |_| get_settings()); provide_context(SettingsCtx { settings, save }); + let pause = Pause { + chosen: RwSignal::new(None), + save: ServerAction::::new(), + settings, + }; + provide_context(pause); + let interval = move || { settings .get() @@ -117,18 +149,36 @@ pub fn App() -> impl IntoView { .unwrap_or(DEFAULT_INTERVAL) }; - // Polling : le timer est recréé à chaque changement d'intervalle. + // Polling : le timer est recréé à chaque changement d'intervalle, et supprimé en pause. Effect::new(move |previous: Option>| { if let Some(Some(handle)) = previous { handle.clear(); } + if pause.get() { + return None; + } let seconds = interval(); set_interval_with_handle(move || live.bump(), Duration::from_secs(seconds.into())).ok() }); + // À la reprise, rafraîchit tout de suite sans attendre la fin du premier intervalle. + Effect::watch( + move || pause.get(), + move |paused, previous, _| { + if previous == Some(&true) && !paused { + live.bump(); + } + }, + false, + ); + // Retour sur l'onglet : rafraîchit tout de suite (et marque lu le fichier ouvert). Effect::new(move |_| { - let _ = window_event_listener(leptos::ev::focus, move |_| live.bump()); + let _ = window_event_listener(leptos::ev::focus, move |_| { + if !untrack(move || pause.get()) { + live.bump(); + } + }); }); Effect::new(move |_| { @@ -137,9 +187,11 @@ pub fn App() -> impl IntoView { } }); - // Favicon : pastille rouge avec le nombre de non-lus, grise si le serveur est injoignable. + // Favicon : pastille rouge avec le nombre de non-lus, grise si le serveur est injoignable, + // rouge avec le symbole pause si la lecture est arrêtée (prioritaire : plus rien n'est lu). Effect::new(move |_| { let state = match summary.get() { + _ if pause.get() => FaviconState::Paused, Some(Ok(s)) if s.total > 0 => FaviconState::Unread(s.total), Some(Err(_)) => FaviconState::Offline, _ => FaviconState::Idle, @@ -152,7 +204,7 @@ pub fn App() -> impl IntoView { let total = move || live.current().map(|s| s.total).unwrap_or(0); view! { - + // Routes en `SsrMode::Async` : le serveur attend le résumé avant d'envoyer ``, // le titre contient donc déjà le nombre de non-lus. @@ -244,14 +296,21 @@ fn Sidebar() -> impl IntoView { } }); + let pause = expect_context::(); let total = move || live.current().map(|s| s.total).unwrap_or(0); view! {