Merge pull request 'Setup de SeaORM + SQLite comme base de données' (#64) from feat/9_setup_db into main

### Détails

Comme défini dans le ticket #9 j'ai mis en place l'ORM "SeaORM" et une base de donnée en SQLite.

La PR contient également quelques modif annexes dont j'avais besoin :
- Un petit fix dans l'usage de get_router
- Une amélioration du système de chargement des fichiers de config (migration de ce module de anyhow à thiserror et système pour éviter les initialisations multiples)
- L'ajout d'un onglet "DEBUG" dans l'interface graphique, pour ajouter un exemple d'intéraction (Read & Write) avec la base de données

Il reste un comportement étrange : lorsqu'on érit dans la base de donnée, ça trigger l'autoreload/hotreload. Je n'ai pas cherché à résoudre le bug, car la suppression de HTMx devrait chambouler tout ça, donc ça ne me parait pas utile d'y passer du temps.

Closes #9

### Documentation

J'ai principalement suivi la documentation d'installation de SeaORM : https://www.sea-ql.org/SeaORM/docs/index/

Reviewed-on: #64
Reviewed-by: kosssi <simon@p4pillon.org>

.env.linux.example

@@ -1,2 +1,3 @@
 SESAM_FSV_VERSION=1.40.13
 SESAM_INI_PATH=/etc/opt/santesocial/fsv/${SESAM_FSV_VERSION}/conf/sesam.ini
+DATABASE_URL=sqlite://p4pillon.sqlite?mode=rwc

.env.win.example

@@ -1,2 +1,3 @@
 SESAM_FSV_VERSION=1.40.13
 SESAM_INI_PATH=${ALLUSERSPROFILE}\\santesocial\\fsv\\${SESAM_FSV_VERSION}\\conf\\sesam.ini
+DATABASE_URL=sqlite://p4pillon.sqlite?mode=rwc

.gitignore

@@ -23,3 +23,6 @@ target/
 
 # Ignore .env files
 .env
+
+# Development Database
+*.sqlite

Cargo.toml

@@ -5,4 +5,15 @@ members = [
     "crates/desktop",
     "crates/sesam-vitale",
     "crates/utils",
+    "migration",
+    "entity",
+    ".",
 ]
+
+[workspace.dependencies]
+anyhow = "1.0"
+dotenv = "0.15"
+sea-orm-cli = "1.0.1"
+sea-orm = "1.0.1"
+serde = { version = "1.0.210", features = ["derive"] }
+thiserror = "1.0"

README.md

@@ -43,6 +43,24 @@ La CLI Tauri est nécessaire au lancement du client `desktop`. Elle peut être i
 cargo install tauri-cli --version "^2.0.0-rc"
 ```
 
+#### SeaORM CLI
+
+SeaORM est notre ORM. Le CLI SeaORM est nécessaire pour la génération des modèles de la base de données et des migrations associées. Elle peut être installée via Cargo :
+
+```bash
+cargo install sea-orm-cli
+```
+
+L'applicatif va chercher les informations de connexion à la base de données dans la variable `DATABASE_URL` importée depuis les [fichiers de configuration](#fichiers-de-configuration).
+
+```.env
+DATABASE_URL=sqlite://p4pillon.sqlite?mode=rwc
+```
+
+Toutefois, l'usage de la CLI de SeaORM nécessite de renseigner les informations de connexion à la base de données dans un fichier `.env` situé à la racine du projet.
+
+> Astuce : utilisé un lien symbolique pour éviter de dupliquer le fichier `.env`.
+
 #### SESAM-Vitale
 
 La crate `sesam-vitale` nécessite la présence des librairies dynamiques fournies par le package FSV et la CryptolibCPS. Les instructions d'installation sont disponibles dans le [README](crates/sesam-vitale/README.md) de la crate `sesam-vitale`.
@@ -57,7 +75,7 @@ Pour lancer l'application en mode développement, il est nécessaire d'exécuter
 
 ```bash
 # Lancement du serveur backend
-systemfd --no-pid -s http::3030 -- cargo watch -x 'run --bin backend'
+systemfd --no-pid -s http::8080 -- cargo watch -w crates/backend -x 'run --bin backend'
 ```
 
 ```bash
@@ -65,9 +83,13 @@ systemfd --no-pid -s http::3030 -- cargo watch -x 'run --bin backend'
 # - frontend (serveur web, accessible via navigateur)
 bun run --cwd frontend/ dev
 # - desktop (client desktop, basé sur Tauri)
-cargo tauri dev
+cargo tauri dev --no-watch
 ```
 
+> Pour circonscrire les hot-reloads intempestifs mais peu utiles :
+> - le `backend` n'est rechargé que si des modifications sont détectées dans le dossier précisé par `-w crates/backend`
+> - le rechargement du `desktop` est désactivé par l'option `--no-watch` ; en effet, le rechargement du `frontend` est déjà pris en charge par `bun` et ne nécessite pas de rechargement du `desktop`
+
 ## Build
 
 Pour packager le client `desktop`, il est nécessaire de faire appel à la CLI Tauri, qui se charge de gérer le build du `frontend` et son intégration au bundle :
@@ -75,3 +97,25 @@ Pour packager le client `desktop`, il est nécessaire de faire appel à la CLI T
 ```bash
 cargo tauri build
 ```
+
+## Gestion de la base de données
+
+### Création d'une migration
+
+```bash
+sea-orm-cli migrate generate <nom_de_la_migration>
+```
+
+Cette commande génère un fichier de migration à adapter dans le dossier `migration/src`.
+
+### Appliquer les migrations
+
+```bash
+sea-orm-cli migrate up
+```
+
+### Génération des entitées
+
+```bash
+sea-orm-cli generate entity -o entity/src/entities --with-serde both
+```

crates/app/.gitignore

@@ -1,4 +0,0 @@
-/target
-
-# Tailwind CSS CLI
-tailwindcss

crates/app/Cargo.toml

@@ -1,21 +0,0 @@
-[package]
-name = "app"
-version = "0.1.0"
-edition = "2021"
-
-[dependencies]
-askama = "0.12.1"
-askama_axum = "0.4.0"
-axum = "0.7.5"
-axum-htmx = { version = "0.6", features = ["auto-vary"] }
-listenfd = "1.0.1"
-notify = "6.1.1"
-serde = { version = "1.0.204", features = ["derive"] }
-thiserror = "1.0.63"
-tokio = { version = "1.39.1", features = ["macros", "rt-multi-thread"] }
-tower-http = { version = "0.5.2", features = ["fs"] }
-tower-livereload = "0.9.3"
-
-[dev-dependencies]
-cargo-watch = "8.5.1"
-systemfd = "0.4.0"

crates/app/README.md

@@ -1,35 +0,0 @@
-## Pré-requis
-
-- Récupérer le binaire TailwindCSS : https://tailwindcss.com/blog/standalone-cli
-
-## Exécution
-
-- Lancer tailwindcss en mode watch dans un terminal : 
-```bash
-./tailwindcss -i css/input.css -o assets/css/style.css --watch
-```
-
-- Lancer le serveur web dans un autre terminal :
-```bash
-cargo run --bin app
-```
-
-## Rechargement automatique (_auto-reload_)
-
-Pour le projet `app`, nous utilisons en plus de `cargo-watch` ses librairies :
-- [`systemfd`](https://github.com/mitsuhiko/systemfd) permet de redémarrer un serveur sans interrompre les connexions en cours, il transmet le descripteur de fichier du socket à une nouvelle instance du serveur (exemple: `cargo watch -x run` --> `systemfd --no-pid -s http::3000 -- cargo watch -x run`). Si le port est déjà pris il en prendra un autre.
-- [`listenfd`](https://github.com/mitsuhiko/listenfd) permet, côté _Rust_, de démarrer un serveur en utilisant des connexions déjà ouvertes.
-
-Pour notre application voici la commande à lancer :
-
-```bash
-systemfd --no-pid -s http::3000 -- cargo watch -x 'run --bin app'
-```
-
-## Chargement à chaud (_livereload_)
-
-Pour que notre navigateur rafraîchisse automatique notre page lorsque le serveur a été recompilé, nous utilisons la librairie [`tower-livereload`](https://github.com/leotaku/tower-livereload).
-
-A chaque changement, que ça soit sur du code en _Rust_, _HTML_, _CSS_ ou _JS_ alors le navigateur va recharger entièrement la page.
-
-En Rust, il n'existe pas encore d'outil de _Hot Reload_ complet et intégré comme on en trouve dans d'autres environnements de développement web, comme pour _Node.js_.

crates/app/askama.toml

@@ -1,6 +0,0 @@
-[general]
-# Directories to search for templates, relative to the crate root.
-dirs = [
-    "src/pages",
-    "src/components",
-]

crates/app/css/input.css

@@ -1,3 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;

crates/app/src/components/base.html

@@ -1,23 +0,0 @@
-{% if hx_request %}
-  <title>{% block title %}{{ title }}{% endblock %}</title>
-  {% block body %}{% endblock %}
-{% else %}
-<!doctype html>
-<html lang="fr" class="h-full">
-  <head>
-    <title>{% block title %}{{ title }}{% endblock %}</title>
-
-    <script src="/assets/js/htmx@2.0.1.min.js"></script>
-    <script src="/assets/js/alpinejs@3.14.1.min.js" defer></script>
-    <script src="/assets/js/flowbite@2.5.1.min.js"></script>
-    <link href="/assets/css/style.css" rel="stylesheet">
-
-    {% block head %}{% endblock %}
-  </head>
-  <body class="h-full">
-    <div class="min-h-full">
-      {% block body %}{% endblock %}
-    </div>
-  </body>
-</html>
-{% endif %}

crates/app/src/components/navbar/menu-item.html

@@ -1,18 +0,0 @@
-{% set selected = item.id == current %}
-<li>
-    <a
-        href="{{ item.href }}"
-        {% if selected -%}
-            class="block py-2 px-3 text-white bg-blue-700 rounded md:bg-transparent md:text-blue-700 md:p-0 md:dark:text-blue-500"
-            aria-current="page"
-        {% else -%}
-            class="block py-2 px-3 text-gray-900 rounded hover:bg-gray-100 md:hover:bg-transparent md:hover:text-blue-700 md:p-0 dark:text-white md:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white md:dark:hover:bg-transparent dark:border-gray-700"
-        {% endif -%}
-        hx-get="{{ item.href }}"
-        hx-push-url="true"
-        hx-swap="outerHTML"
-        hx-select-oob="#menu-items,#page-header,#page-main"
-    >
-        {{ item.label }}
-    </a>
-</li>

crates/app/src/components/navbar/navbar.html

@@ -1,50 +0,0 @@
-{% macro navbar(current) %}
-
-{% let items=crate::menu::get_menu_items() %}
-
-<nav class="bg-white border-gray-200 dark:bg-gray-900">
-  <div class="max-w-screen-xl flex flex-wrap items-center justify-between mx-auto p-4">
-  <a href="/" class="flex items-center space-x-3 rtl:space-x-reverse">
-      <img src="https://flowbite.com/docs/images/logo.svg" class="h-8" alt="Flowbite Logo" />
-      <span class="self-center text-2xl font-semibold whitespace-nowrap dark:text-white">Krys4lide</span>
-  </a>
-  <div class="flex items-center md:order-2 space-x-3 md:space-x-0 rtl:space-x-reverse">
-      <button type="button" class="flex text-sm bg-gray-800 rounded-full md:me-0 focus:ring-4 focus:ring-gray-300 dark:focus:ring-gray-600" id="user-menu-button" aria-expanded="false" data-dropdown-toggle="user-dropdown" data-dropdown-placement="bottom">
-        <span class="sr-only">Ouvrir le menu de profil</span>
-        <img class="w-8 h-8 rounded-full" src="https://flowbite.com/docs/images/people/profile-picture-3.jpg" alt="user photo">
-      </button>
-      <!-- Dropdown menu -->
-      <div class="z-50 hidden my-4 text-base list-none bg-white divide-y divide-gray-100 rounded-lg shadow dark:bg-gray-700 dark:divide-gray-600" id="user-dropdown">
-        <div class="px-4 py-3">
-          <span class="block text-sm text-gray-900 dark:text-white">Bonnie Green</span>
-          <span class="block text-sm  text-gray-500 truncate dark:text-gray-400">name@flowbite.com</span>
-        </div>
-        <ul class="py-2" aria-labelledby="user-menu-button">
-          <li>
-            <a href="#" class="block px-4 py-2 text-sm text-gray-700 hover:bg-gray-100 dark:hover:bg-gray-600 dark:text-gray-200 dark:hover:text-white">Profile</a>
-          </li>
-          <li>
-            <a href="#" class="block px-4 py-2 text-sm text-gray-700 hover:bg-gray-100 dark:hover:bg-gray-600 dark:text-gray-200 dark:hover:text-white">Settings</a>
-          </li>
-          <li>
-            <a href="#" class="block px-4 py-2 text-sm text-gray-700 hover:bg-gray-100 dark:hover:bg-gray-600 dark:text-gray-200 dark:hover:text-white">Sign out</a>
-          </li>
-        </ul>
-      </div>
-      <button data-collapse-toggle="navbar-user" type="button" class="inline-flex items-center p-2 w-10 h-10 justify-center text-sm text-gray-500 rounded-lg md:hidden hover:bg-gray-100 focus:outline-none focus:ring-2 focus:ring-gray-200 dark:text-gray-400 dark:hover:bg-gray-700 dark:focus:ring-gray-600" aria-controls="navbar-user" aria-expanded="false">
-        <span class="sr-only">Ouvrir le menu de navigation</span>
-        <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 17 14">
-            <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M1 1h15M1 7h15M1 13h15"/>
-        </svg>
-    </button>
-  </div>
-  <div class="items-center justify-between hidden w-full md:flex md:w-auto md:order-1" id="navbar-user">
-    <ul id="menu-items" class="flex flex-col font-medium p-4 md:p-0 mt-4 border border-gray-100 rounded-lg bg-gray-50 md:space-x-8 rtl:space-x-reverse md:flex-row md:mt-0 md:border-0 md:bg-white dark:bg-gray-800 md:dark:bg-gray-900 dark:border-gray-700">
-      {% for item in items %}
-        {% include "navbar/menu-item.html" %}
-      {% endfor %}
-    </ul>
-  </div>
-  </div>
-</nav>
-{% endmacro %}

crates/app/src/components/skeletons/card.html

@@ -1,22 +0,0 @@
-<div role="status" class="animate-pulse max-w-sm p-4 border border-gray-200 rounded shadow md:p-6 dark:border-gray-700">
-    <div class="flex items-center justify-center h-48 mb-4 bg-gray-300 rounded dark:bg-gray-700">
-        <svg class="w-10 h-10 text-gray-200 dark:text-gray-600" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 16 20">
-            <path d="M14.066 0H7v5a2 2 0 0 1-2 2H0v11a1.97 1.97 0 0 0 1.934 2h12.132A1.97 1.97 0 0 0 16 18V2a1.97 1.97 0 0 0-1.934-2ZM10.5 6a1.5 1.5 0 1 1 0 2.999A1.5 1.5 0 0 1 10.5 6Zm2.221 10.515a1 1 0 0 1-.858.485h-8a1 1 0 0 1-.9-1.43L5.6 10.039a.978.978 0 0 1 .936-.57 1 1 0 0 1 .9.632l1.181 2.981.541-1a.945.945 0 0 1 .883-.522 1 1 0 0 1 .879.529l1.832 3.438a1 1 0 0 1-.031.988Z"/>
-            <path d="M5 5V.13a2.96 2.96 0 0 0-1.293.749L.879 3.707A2.98 2.98 0 0 0 .13 5H5Z"/>
-        </svg>
-    </div>
-    <div class="h-2.5 bg-gray-200 rounded-full dark:bg-gray-700 w-48 mb-4"></div>
-    <div class="h-2 bg-gray-200 rounded-full dark:bg-gray-700 mb-2.5"></div>
-    <div class="h-2 bg-gray-200 rounded-full dark:bg-gray-700 mb-2.5"></div>
-    <div class="h-2 bg-gray-200 rounded-full dark:bg-gray-700"></div>
-    <div class="flex items-center mt-4">
-       <svg class="w-10 h-10 me-3 text-gray-200 dark:text-gray-700" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 20 20">
-            <path d="M10 0a10 10 0 1 0 10 10A10.011 10.011 0 0 0 10 0Zm0 5a3 3 0 1 1 0 6 3 3 0 0 1 0-6Zm0 13a8.949 8.949 0 0 1-4.951-1.488A3.987 3.987 0 0 1 9 13h2a3.987 3.987 0 0 1 3.951 3.512A8.949 8.949 0 0 1 10 18Z"/>
-        </svg>
-        <div>
-            <div class="h-2.5 bg-gray-200 rounded-full dark:bg-gray-700 w-32 mb-2"></div>
-            <div class="w-48 h-2 bg-gray-200 rounded-full dark:bg-gray-700"></div>
-        </div>
-    </div>
-    <span class="sr-only">Loading...</span>
-</div>

crates/app/src/components/skeletons/menu-items.html

@@ -1,4 +0,0 @@
-<div role="status" class="animate-pulse flex items-center justify-center h-full">
-    <div class="w-32 h-4 bg-gray-200 rounded-full dark:bg-gray-700 me-3"></div>
-    <div class="w-32 h-4 bg-gray-200 rounded-full dark:bg-gray-700"></div>
-</div>

crates/app/src/components/skeletons/page-title.html

@@ -1 +0,0 @@
-<div role="status" class="animate-pulse h-7 bg-gray-200 rounded-full dark:bg-gray-700 w-48 mt-3"></div>

crates/app/src/lib.rs

@@ -1,21 +0,0 @@
-use std::path::PathBuf;
-
-use axum::http::{StatusCode, Uri};
-use axum_htmx::AutoVaryLayer;
-use tower_http::services::ServeDir;
-
-mod menu;
-mod pages;
-
-async fn fallback(uri: Uri) -> (StatusCode, String) {
-    (StatusCode::NOT_FOUND, format!("No route for {uri}"))
-}
-
-pub async fn get_router(assets_path: PathBuf) -> axum::Router<()> {
-    axum::Router::new()
-        .nest_service("/assets", ServeDir::new(assets_path))
-        .merge(pages::get_routes())
-        .fallback(fallback)
-        // The AutoVaryLayer is used to avoid cache issues with htmx (cf: https://github.com/robertwayne/axum-htmx?tab=readme-ov-file#auto-caching-management)
-        .layer(AutoVaryLayer)
-}

crates/app/src/main.rs

@@ -1,84 +0,0 @@
-use std::path::{Path, PathBuf};
-use std::{env, io};
-
-use axum::body::Body;
-use axum::http::Request;
-use listenfd::ListenFd;
-use notify::Watcher;
-use thiserror::Error;
-use tokio::net::TcpListener;
-use tower_livereload::predicate::Predicate;
-use tower_livereload::LiveReloadLayer;
-
-use ::app::get_router;
-
-#[derive(Error, Debug)]
-pub enum AppError {
-    #[error("Unable to bind to TCP listener")]
-    TCPListener(#[from] std::io::Error),
-    #[error("Error with the notify watcher")]
-    NotifyWatcher(#[from] notify::Error),
-    #[error("Missing environment variable {var}")]
-    MissingEnvVar { var: &'static str },
-}
-
-/// Nous filtrons les requêtes de `htmx` pour ne pas inclure le script _JS_ qui gère le rechargement
-/// Voir https://github.com/leotaku/tower-livereload/pull/3
-#[derive(Copy, Clone)]
-struct NotHtmxPredicate;
-impl<T> Predicate<Request<T>> for NotHtmxPredicate {
-    fn check(&mut self, req: &Request<T>) -> bool {
-        !(req.headers().contains_key("hx-request"))
-    }
-}
-
-const DEFAULT_LISTENER: &str = "localhost:3000";
-async fn get_tcp_listener() -> Result<TcpListener, io::Error> {
-    let mut listenfd = ListenFd::from_env();
-
-    match listenfd.take_tcp_listener(0)? {
-        // if we are given a tcp listener on listen fd 0, we use that one
-        Some(listener) => {
-            listener.set_nonblocking(true)?;
-            Ok(TcpListener::from_std(listener)?)
-        }
-        // otherwise fall back to local listening
-        None => Ok(TcpListener::bind(DEFAULT_LISTENER).await?),
-    }
-}
-
-fn get_livereload_layer(
-    templates_paths: Vec<PathBuf>,
-) -> Result<LiveReloadLayer<NotHtmxPredicate>, notify::Error> {
-    let livereload = LiveReloadLayer::new();
-    let reloader = livereload.reloader();
-    let mut watcher = notify::recommended_watcher(move |_| reloader.reload())?;
-    for templates_path in templates_paths {
-        watcher.watch(templates_path.as_path(), notify::RecursiveMode::Recursive)?;
-    }
-    Ok(livereload.request_predicate::<Body, NotHtmxPredicate>(NotHtmxPredicate))
-}
-
-#[tokio::main]
-async fn main() -> Result<(), AppError> {
-    let manifest_dir = env::var("CARGO_MANIFEST_DIR").map_err(|_| AppError::MissingEnvVar {
-        var: "CARGO_MANIFEST_DIR",
-    })?;
-    let assets_path = Path::new(&manifest_dir).join("assets");
-    let templates_paths = vec![
-        Path::new(&manifest_dir).join("src/pages"),
-        Path::new(&manifest_dir).join("src/components"),
-    ];
-
-    let livereload_layer =
-        get_livereload_layer(templates_paths).map_err(AppError::NotifyWatcher)?;
-    let router = get_router(assets_path).await.layer(livereload_layer);
-
-    let listener: TcpListener = get_tcp_listener().await.map_err(AppError::TCPListener)?;
-    let local_addr = listener.local_addr().map_err(AppError::TCPListener)?;
-    println!("Listening on: http://{}", local_addr);
-
-    // Run the server with the router
-    axum::serve(listener, router.into_make_service()).await?;
-    Ok(())
-}

crates/app/src/menu.rs

@@ -1,23 +0,0 @@
-pub struct MenuItem {
-    pub id: String,
-    pub label: String,
-    pub href: String,
-}
-
-/// Get the menu items
-/// This function is the central place to define the menu items
-/// It can be used directly in templates, for example in the `navbar` component to render the menu
-pub fn get_menu_items() -> Vec<MenuItem> {
-    vec![
-        MenuItem {
-            id: "home".to_string(),
-            label: "Accueil".to_string(),
-            href: "/".to_string(),
-        },
-        MenuItem {
-            id: "cps".to_string(),
-            label: "CPS".to_string(),
-            href: "/cps".to_string(),
-        },
-    ]
-}

crates/app/src/pages/cps.html

@@ -1,43 +0,0 @@
-{% extends "base.html" %}
-{% import "navbar/navbar.html" as navbar -%}
-
-{% block title %}Pharma Libre - CPS{% endblock %}
-
-{% block body %}
-{% call navbar::navbar(current="cps") %}
-<div class="py-10">
-  <header id="page-header">
-    <div class="mx-auto max-w-7xl px-4 sm:px-6 lg:px-8">
-      <h1
-        id="page-title"
-        class="text-3xl font-bold leading-tight tracking-tight text-gray-900"
-      >
-        CPS
-      </h1>
-    </div>
-  </header>
-  <main id="page-main">
-    <div
-      class="mx-auto max-w-7xl px-4 py-8 sm:px-6 lg:px-8"
-    >
-      <div
-        class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-96 mb-4"
-      >A</div>
-      <div class="grid grid-cols-1 sm:grid-cols-2 lg:grid-cols-4 gap-4 mb-4">
-        <div
-          class="border-2 border-dashed border-gray-300 rounded-lg dark:border-gray-600 h-32 md:h-64"
-        >B</div>
-        <div
-          class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-32 md:h-64"
-        >C</div>
-        <div
-          class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-32 md:h-64"
-        >D</div>
-        <div
-          class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-32 md:h-64"
-        >E</div>
-      </div>
-    </div>
-  </main>
-</div>
-{% endblock %}

crates/app/src/pages/cps.rs

@@ -1,12 +0,0 @@
-use askama_axum::Template;
-use axum_htmx::HxRequest;
-
-#[derive(Template)]
-#[template(path = "cps.html")]
-pub struct CpsTemplate {
-    hx_request: bool,
-}
-
-pub async fn cps(HxRequest(hx_request): HxRequest) -> CpsTemplate {
-    CpsTemplate { hx_request }
-}

crates/app/src/pages/home.html

@@ -1,43 +0,0 @@
-{% extends "base.html" %}
-{% import "navbar/navbar.html" as navbar -%}
-
-{% block title %}Pharma Libre - Accueil{% endblock %}
-
-{% block body %}
-{% call navbar::navbar(current="home") %}
-<div class="py-10">
-  <header id="page-header">
-    <div class="mx-auto max-w-7xl px-4 sm:px-6 lg:px-8">
-      <h1
-        id="page-title"
-        class="text-3xl font-bold leading-tight tracking-tight text-gray-900"
-      >
-        Accueil
-      </h1>
-    </div>
-  </header>
-  <main id="page-main">
-    <div
-      class="mx-auto max-w-7xl px-4 py-8 sm:px-6 lg:px-8"
-    >
-      <div class="grid grid-cols-1 sm:grid-cols-2 lg:grid-cols-4 gap-4 mb-4">
-        <div
-          class="border-2 border-dashed border-gray-300 rounded-lg dark:border-gray-600 h-32 md:h-64"
-        >A</div>
-        <div
-          class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-32 md:h-64"
-        >B</div>
-        <div
-          class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-32 md:h-64"
-        >C</div>
-        <div
-          class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-32 md:h-64"
-        >D</div>
-      </div>
-      <div
-        class="border-2 border-dashed rounded-lg border-gray-300 dark:border-gray-600 h-96 mb-4"
-      >E</div>
-    </div>
-  </main>
-</div>
-{% endblock %}

crates/app/src/pages/home.rs

@@ -1,12 +0,0 @@
-use askama_axum::Template;
-use axum_htmx::HxRequest;
-
-#[derive(Template)]
-#[template(path = "home.html")]
-pub struct GetHomeTemplate {
-    hx_request: bool,
-}
-
-pub async fn home(HxRequest(hx_request): HxRequest) -> GetHomeTemplate {
-    GetHomeTemplate { hx_request }
-}

crates/app/src/pages/mod.rs

@@ -1,10 +0,0 @@
-use axum::{routing, Router};
-
-mod cps;
-mod home;
-
-pub fn get_routes() -> Router {
-    Router::new()
-        .route("/", routing::get(home::home))
-        .route("/cps", routing::get(cps::cps))
-}

crates/app/tailwind.config.js

@@ -1,12 +0,0 @@
-/** @type {import('tailwindcss').Config} */
-module.exports = {
-  content: [
-    './src/**/*.html',
-    './css/**/*.css',
-  ],
-  theme: {
-    extend: {},
-  },
-  plugins: [],
-}
-

crates/backend/Cargo.toml

@@ -5,10 +5,25 @@ edition = "2021"
 
 [dependencies]
 anyhow = "1.0.89"
-axum = "0.7.6"
+axum = { version = "0.7.6", features = ["macros"] }
 listenfd = "1.0.1"
 tokio = { version = "1.40.0", features = ["macros", "rt-multi-thread"] }
+tower-http = { version = "0.6.1", features = ["cors"] }
+
+sea-orm = { workspace = true, features = [
+    # Same `ASYNC_RUNTIME` and `DATABASE_DRIVER` as in the migration crate
+    "sqlx-sqlite",
+    "runtime-tokio-rustls",
+    "macros",
+] }
+serde.workspace = true
+thiserror.workspace = true
+
+entity = { path = "../../entity" }
+migration = { path = "../../migration" }
+utils = { path = "../utils" }
 
 [dev-dependencies]
 cargo-watch = "8.5.2"
+sea-orm-cli.workspace = true
 systemfd = "0.4.3"

crates/backend/README.md

@@ -10,10 +10,19 @@ En développement, le mécanisme de hot-reload nécessite de disposer de `cargo-
 cargo install cargo-watch systemfd
 ```
 
+## Configuration
+
+> Astuce : lorsqu'on exécute directement la crate `backend` à des fins de développement, le système de configuration n'utilisera pas l'éventuel fichier `.env` situé à la racine du workspace Rust. Pour éviter de dupliquer le fichier `.env`, il est possible de créer un lien symbolique vers le fichier `.env` de la crate `backend` :
+
+```bash
+cd crates/backend
+ln -s ../../.env .env
+```
+
 ## Développement
 
 Pour lancer le serveur en mode développement, exécutez la commande suivante :
 
 ```bash
-systemfd --no-pid -s http::3030 -- cargo watch -x 'run --bin backend'
+systemfd --no-pid -s http::8080 -- cargo watch -w crates/backend -x 'run --bin backend'
 ```

crates/backend/src/api/debug.rs

@@ -0,0 +1,48 @@
+use axum::{extract::State, routing, Json};
+use sea_orm::*;
+use serde::Serialize;
+
+use ::entity::{debug, debug::Entity as DebugEntity};
+
+use crate::{AppError, AppState};
+
+// DATABASE DEBUG CONTROLLERS
+
+async fn get_debug_entries(db: &DatabaseConnection) -> Result<Vec<debug::Model>, DbErr> {
+    DebugEntity::find().all(db).await
+}
+
+async fn add_random_debug_entry(State(AppState { db_connection }): State<AppState>) {
+    let random_entry = debug::ActiveModel {
+        title: Set("Random title".to_string()),
+        text: Set("Random text".to_string()),
+        ..Default::default()
+    };
+    random_entry.insert(&db_connection).await.unwrap();
+}
+
+// API HANDLER
+
+#[derive(Serialize, Debug)]
+struct DebugResponse {
+    db_ping_status: bool,
+    entries: Vec<debug::Model>,
+}
+
+#[axum::debug_handler]
+async fn debug(
+    State(AppState { db_connection }): State<AppState>,
+) -> Result<Json<DebugResponse>, AppError> {
+    let db_ping_status = db_connection.ping().await.is_ok();
+    let debug_entries = get_debug_entries(&db_connection).await?;
+    Ok(Json(DebugResponse {
+        db_ping_status,
+        entries: debug_entries,
+    }))
+}
+
+pub fn get_routes() -> axum::Router<crate::AppState> {
+    axum::Router::new()
+        .route("/", routing::get(debug))
+        .route("/add_random", routing::post(add_random_debug_entry))
+}

crates/backend/src/api/mod.rs

@@ -0,0 +1,9 @@
+use axum::Router;
+
+use crate::AppState;
+
+mod debug;
+
+pub fn get_routes() -> Router<AppState> {
+    Router::new().nest("/debug", debug::get_routes())
+}

crates/backend/src/db.rs

@@ -0,0 +1,11 @@
+use migration::{Migrator, MigratorTrait};
+use sea_orm::{Database, DatabaseConnection, DbErr};
+use std::env;
+
+pub async fn get_connection() -> Result<DatabaseConnection, DbErr> {
+    let database_url = env::var("DATABASE_URL").expect("DATABASE_URL must be set");
+
+    let db_connection = Database::connect(database_url).await?;
+    Migrator::up(&db_connection, None).await?;
+    Ok(db_connection)
+}

crates/backend/src/lib.rs

@@ -1,12 +1,47 @@
 use anyhow::Error as AnyError;
-use axum::http::{StatusCode, Uri};
+use axum::http::{header, StatusCode, Uri};
 use axum::response::{IntoResponse, Response};
 use axum::{routing::get, Router};
+use sea_orm::{DatabaseConnection, DbErr};
+use thiserror::Error;
+use tower_http::cors::{Any, CorsLayer};
 
-pub fn get_router() -> Router {
+use ::utils::config::{load_config, ConfigError};
-    Router::new()
+
+mod api;
+mod db;
+
+#[derive(Error, Debug)]
+pub enum InitError {
+    #[error(transparent)]
+    ConfigError(#[from] ConfigError),
+}
+
+pub fn init() -> Result<(), InitError> {
+    load_config(None)?;
+    Ok(())
+}
+
+#[derive(Clone)]
+pub struct AppState {
+    db_connection: DatabaseConnection,
+}
+
+pub async fn get_router() -> Result<Router, DbErr> {
+    let db_connection = db::get_connection().await?;
+    let state: AppState = AppState { db_connection };
+
+    let cors = CorsLayer::new()
+        .allow_methods(Any)
+        .allow_origin(Any)
+        .allow_headers([header::CONTENT_TYPE]);
+
+    Ok(Router::new()
         .route("/", get(|| async { "Hello, world!" }))
+        .merge(api::get_routes())
         .fallback(fallback)
+        .with_state(state)
+        .layer(cors))
 }
 
 async fn fallback(uri: Uri) -> (StatusCode, String) {

crates/backend/src/main.rs

@@ -1,24 +1,39 @@
 use listenfd::ListenFd;
+use thiserror::Error;
 use tokio::net::TcpListener;
 
-use backend::get_router;
+use backend::{get_router, init, InitError};
+
+#[derive(Error, Debug)]
+pub enum BackendError {
+    #[error("Error while setting up or serving the TCP listener")]
+    ServeTCPListener(#[from] std::io::Error),
+    #[error("Error while initialising the backend")]
+    InitError(#[from] InitError),
+    #[error("Error with the database connection")]
+    DatabaseConnection(#[from] sea_orm::DbErr),
+}
 
 #[tokio::main]
-async fn main() {
+async fn main() -> Result<(), BackendError> {
-    let app = get_router();
+    init()?;
+
+    let app = get_router().await?;
 
     let mut listenfd = ListenFd::from_env();
-
+    let listener = match listenfd.take_tcp_listener(0)? {
-    let listener = match listenfd.take_tcp_listener(0).unwrap() {
         // if we are given a tcp listener on listen fd 0, we use that one
         Some(listener) => {
-            listener.set_nonblocking(true).unwrap();
+            listener.set_nonblocking(true)?;
-            TcpListener::from_std(listener).unwrap()
+            TcpListener::from_std(listener)?
         }
         // otherwise fall back to local listening
-        None => TcpListener::bind("0.0.0.0:8080").await.unwrap(),
+        None => TcpListener::bind("0.0.0.0:8080").await?,
     };
 
-    println!("Listening on {}", listener.local_addr().unwrap());
+    let local_addr = listener.local_addr()?;
-    axum::serve(listener, app).await.unwrap();
+    println!("Listening on http://{}", local_addr);
+    axum::serve(listener, app).await?;
+
+    Ok(())
 }

crates/desktop/Cargo.toml

@@ -13,8 +13,12 @@ crate-type = ["lib", "cdylib", "staticlib"]
 tauri-build = { version = "2.0.0-rc", features = [] }
 
 [dependencies]
-tauri = { version = "2.0.0-rc", features = [] }
+bytes = "1.6.1"
-tauri-plugin-shell = "2.0.0-rc"
+http = "1.1.0"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
+tauri = { version = "2.0.0-rc", features = [] }
+tauri-plugin-shell = "2.0.0-rc"
+tower = "0.4.13"
 
+thiserror.workspace = true

crates/sesam-vitale/Cargo.toml

@@ -4,10 +4,11 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-anyhow = "1.0"
+anyhow.workspace = true
 libc = "0.2"
-thiserror = "1.0"
+thiserror.workspace = true
+
 utils = { path = "../utils" }
 
 [build-dependencies]
-dotenv = "0.15"
+dotenv.workspace = true

crates/sesam-vitale/src/ssvlib_demo.rs

@@ -9,7 +9,7 @@ use thiserror::Error;
 use crate::cps::lire_carte;
 use crate::libssv::{SSV_InitLIB2, SSV_LireConfig};
 
-use ::utils::config::load_config;
+use ::utils::config::{load_config, ConfigError};
 
 #[derive(Error, Debug)]
 pub enum SSVDemoError {
@@ -18,7 +18,7 @@ pub enum SSVDemoError {
     #[error(transparent)]
     SSVLibErrorCode(#[from] crate::libssv::LibSSVError),
     #[error(transparent)]
-    Anyhow(#[from] anyhow::Error),
+    Configuration(#[from] ConfigError),
 }
 
 fn ssv_init_lib_2() -> Result<(), SSVDemoError> {
@@ -71,7 +71,7 @@ pub fn demo() -> Result<(), SSVDemoError> {
 
     println!("------- Demo for the SSV library --------");
 
-    load_config()?;
+    load_config(None)?;
 
     ssv_init_lib_2()?;
 

crates/utils/Cargo.toml

@@ -4,6 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-anyhow = "1.0"
+anyhow.workspace = true
 directories = "5.0"
-dotenv = "0.15"
+dotenv.workspace = true
+thiserror.workspace = true

crates/utils/src/config.rs

@@ -1,11 +1,23 @@
-use std::{env, path::PathBuf};
+use std::{env, path::PathBuf, sync::atomic::AtomicBool};
 
-use anyhow::{bail, Context, Result};
 use directories::ProjectDirs;
 use dotenv::from_path;
+use thiserror::Error;
 
 const CONFIG_FILE_NAME: &str = ".env";
 
+static CONFIG_INITIALIZED: AtomicBool = AtomicBool::new(false);
+
+#[derive(Debug, Error)]
+pub enum ConfigError {
+    #[error("No config file {0} found in the following directories: {1:#?}")]
+    ConfigFileNotFound(String, Vec<PathBuf>),
+    #[error("Failed to load config file: {0}")]
+    LoadConfigError(#[from] dotenv::Error),
+    #[error("Environment variable error: {0}")]
+    EnvVarError(#[from] std::env::VarError),
+}
+
 pub fn get_config_dirs() -> Vec<PathBuf> {
     let mut config_dirs = vec![
         PathBuf::from(""), // Current directory
@@ -19,7 +31,7 @@ pub fn get_config_dirs() -> Vec<PathBuf> {
     config_dirs
 }
 
-pub fn get_config_files() -> Result<Vec<PathBuf>> {
+pub fn get_config_files() -> Result<Vec<PathBuf>, ConfigError> {
     let config_dirs = get_config_dirs();
     let mut config_files = Vec::new();
     for config_dir in config_dirs.iter() {
@@ -29,14 +41,20 @@ pub fn get_config_files() -> Result<Vec<PathBuf>> {
         }
     }
     if config_files.is_empty() {
-        bail!(
+        return Err(ConfigError::ConfigFileNotFound(
-            "No config file {CONFIG_FILE_NAME} found in the following directories: {config_dirs:#?}"
+            CONFIG_FILE_NAME.to_string(),
-        );
+            config_dirs,
+        ));
     }
     Ok(config_files)
 }
 
-pub fn load_config() -> Result<()> {
+pub fn load_config(force: Option<bool>) -> Result<(), ConfigError> {
+    let force = force.unwrap_or(false);
+    if CONFIG_INITIALIZED.load(std::sync::atomic::Ordering::Relaxed) && force {
+        println!("DEBUG: Config already initialized, skipping");
+        return Ok(());
+    }
     let config_files = get_config_files()?;
     // Load the first config file found
     // TODO: add a verbose log to list all config files found
@@ -44,5 +62,7 @@ pub fn load_config() -> Result<()> {
         "DEBUG: Config files found (1st loaded): {:#?}",
         config_files
     );
-    from_path(config_files[0].as_path()).context("Failed to load config file")
+    from_path(config_files[0].as_path()).map_err(ConfigError::LoadConfigError)?;
+    CONFIG_INITIALIZED.store(true, std::sync::atomic::Ordering::Relaxed);
+    Ok(())
 }

entity/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "entity"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+name = "entity"
+path = "src/lib.rs"
+
+[dependencies]
+sea-orm.workspace = true
+serde.workspace = true
+
+[dev-dependencies]
+sea-orm-cli.workspace = true

entity/src/entities/debug.rs

@@ -0,0 +1,18 @@
+//! `SeaORM` Entity, @generated by sea-orm-codegen 1.0.1
+
+use sea_orm::entity::prelude::*;
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq, Serialize, Deserialize)]
+#[sea_orm(table_name = "debug")]
+pub struct Model {
+    #[sea_orm(primary_key)]
+    pub id: i32,
+    pub title: String,
+    pub text: String,
+}
+
+#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
+pub enum Relation {}
+
+impl ActiveModelBehavior for ActiveModel {}

entity/src/entities/mod.rs

@@ -0,0 +1,5 @@
+//! `SeaORM` Entity, @generated by sea-orm-codegen 1.0.1
+
+pub mod prelude;
+
+pub mod debug;

entity/src/entities/prelude.rs

@@ -0,0 +1,3 @@
+//! `SeaORM` Entity, @generated by sea-orm-codegen 1.0.1
+
+pub use super::debug::Entity as Debug;

entity/src/lib.rs

@@ -0,0 +1,2 @@
+mod entities;
+pub use entities::*;

frontend/app.vue

@@ -1,5 +1,6 @@
 <template>
   <div>
+    <NuxtLoadingIndicator />
     <NuxtRouteAnnouncer />
     <NavBar />
     <NuxtPage />

frontend/components/NavBar.vue

@@ -6,6 +6,7 @@
         <nav class="navbar-center">
             <NuxtLink to="/" class="btn btn-ghost">Accueil</NuxtLink>
             <NuxtLink to="/CPS" class="btn btn-ghost">Carte CPS</NuxtLink>
+            <NuxtLink to="/debug" class="btn btn-ghost">Debug</NuxtLink>
         </nav>
         <div class="navbar-end">
             <template v-if="!current_user">

frontend/pages/debug.vue

@@ -0,0 +1,67 @@
+<template>
+    <div>
+        <h1 class="text-3xl mb-8">Debug</h1>
+        <div class="stats shadow mb-8">
+            <div class="stat">
+                <div class="stat-title">DB Ping Status</div>
+                <div class="stat-value">{{ data?.db_ping_status || "?" }}</div>
+            </div>
+            <div class="stat">
+                <div class="stat-title">Entries Count</div>
+                <div class="stat-value">{{ data?.entries.length || "?" }}</div>
+                <div class="stat-actions">
+                    <button class="btn btn-sm" @click="addRandomEntry">Add entry</button>
+                </div>
+            </div>
+            <div class="stat">
+                <div class="stat-title">Network status</div>
+                <div class="stat-value">{{ status }}</div>
+                <div class="stat-description">{{ error }}</div>
+            </div>
+        </div>
+        <div>
+            <h2 class="text-2xl mb-4">Entries</h2>
+            <table class="table">
+                <thead>
+                    <tr>
+                        <th>Id</th>
+                        <th>Title</th>
+                        <th>Text</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    <tr v-for="entry in data?.entries" :key="entry.id">
+                        <td>{{ entry.id }}</td>
+                        <td>{{ entry.title }}</td>
+                        <td>{{ entry.text }}</td>
+                    </tr>
+                </tbody>
+            </table>
+        </div>
+    </div>
+</template>
+
+<script setup lang="ts">
+    type Entry = {
+        id: number;
+        title: string;
+        text: string;
+    };
+    type DebugResponse = {
+        db_ping_status: string;
+        entries: Entry[];
+    };
+
+    
+    // TODO : handle a default backend URL by building a custom `$fetch` and `useFetch` functions with a `baseURL` option : https://nuxt.com/docs/guide/recipes/custom-usefetch#custom-fetch
+    
+    const { data, refresh, error, status } = await useFetch<DebugResponse>('http://127.0.0.1:8080/debug');
+
+    async function addRandomEntry() {
+        await $fetch('http://127.0.0.1:8080/debug/add_random', {
+            method: 'POST',
+        });
+        refresh();
+    }
+
+</script>

migration/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "migration"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+name = "migration"
+path = "src/lib.rs"
+
+[dependencies]
+async-std = { version = "1", features = ["attributes", "tokio1"] }
+
+[dev-dependencies]
+sea-orm-cli.workspace = true
+
+[dependencies.sea-orm-migration]
+version = "1.0.0"
+features = [
+  # `ASYNC_RUNTIME` and `DATABASE_DRIVER` are required to run migration using the cli
+  # They must be the same as the features in the `sea-orm` dependency in the `app` crate
+  "sqlx-sqlite",          # `DATABASE_DRIVER` feature
+  "runtime-tokio-rustls", # `ASYNC_RUNTIME` feature
+]

migration/README.md

@@ -0,0 +1,41 @@
+# Running Migrator CLI
+
+- Generate a new migration file
+    ```sh
+    cargo run -- generate MIGRATION_NAME
+    ```
+- Apply all pending migrations
+    ```sh
+    cargo run
+    ```
+    ```sh
+    cargo run -- up
+    ```
+- Apply first 10 pending migrations
+    ```sh
+    cargo run -- up -n 10
+    ```
+- Rollback last applied migrations
+    ```sh
+    cargo run -- down
+    ```
+- Rollback last 10 applied migrations
+    ```sh
+    cargo run -- down -n 10
+    ```
+- Drop all tables from the database, then reapply all migrations
+    ```sh
+    cargo run -- fresh
+    ```
+- Rollback all applied migrations, then reapply all migrations
+    ```sh
+    cargo run -- refresh
+    ```
+- Rollback all applied migrations
+    ```sh
+    cargo run -- reset
+    ```
+- Check the status of all migrations
+    ```sh
+    cargo run -- status
+    ```

migration/src/lib.rs

@@ -0,0 +1,12 @@
+pub use sea_orm_migration::prelude::*;
+
+mod m20220101_000001_create_debug_table;
+
+pub struct Migrator;
+
+#[async_trait::async_trait]
+impl MigratorTrait for Migrator {
+    fn migrations() -> Vec<Box<dyn MigrationTrait>> {
+        vec![Box::new(m20220101_000001_create_debug_table::Migration)]
+    }
+}

migration/src/m20220101_000001_create_debug_table.rs

@@ -0,0 +1,35 @@
+use sea_orm_migration::{prelude::*, schema::*};
+
+#[derive(DeriveMigrationName)]
+pub struct Migration;
+
+#[async_trait::async_trait]
+impl MigrationTrait for Migration {
+    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .create_table(
+                Table::create()
+                    .table(Debug::Table)
+                    .if_not_exists()
+                    .col(pk_auto(Debug::Id))
+                    .col(string(Debug::Title))
+                    .col(string(Debug::Text))
+                    .to_owned(),
+            )
+            .await
+    }
+
+    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        manager
+            .drop_table(Table::drop().table(Debug::Table).to_owned())
+            .await
+    }
+}
+
+#[derive(DeriveIden)]
+enum Debug {
+    Table,
+    Id,
+    Title,
+    Text,
+}

migration/src/main.rs

@@ -0,0 +1,6 @@
+use sea_orm_migration::prelude::*;
+
+#[async_std::main]
+async fn main() {
+    cli::run_cli(migration::Migrator).await;
+}