add guide

Actix 2 axum

.github/workflows/test.yaml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v4
 
       # Node
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
       - uses: actions/setup-node@v4
         with:
           cache: 'pnpm'
@@ -27,13 +27,16 @@ jobs:
 
       - name: Prepare
         run: |
-          pnpm install --frozen-lockfile
+          pnpm install
           pnpm exec playwright install --with-deps
           pnpm run test:prepare
 
       - name: Run your tests
         run: pnpm test
-      - uses: actions/upload-artifact@v3
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
         with:
-          name: test-results
-          path: test-results
+          name: playwright-report
+          path: test-results/
+          retention-days: 7

README.md

@@ -70,13 +70,13 @@ of the notes even if it tried to.
 | `MAX_EXPIRATION`        | `360`            | Maximal expiration in minutes.                                                                                                                                                                                |
 | `ALLOW_ADVANCED`        | `true`           | Allow custom configuration. If set to `false` all notes will be one view only.                                                                                                                                |
 | `ALLOW_FILES`           | `true`           | Allow uploading files. If set to `false`, users will only be allowed to create text notes.                                                                                                                    |
-| `THEME_NEW_NOTE_NOTICE` | `true`           | Show the message about how notes are stored in the memory and may be evicted after creating a new note. Defaults to `true`.                                                                                   |
 | `ID_LENGTH`             | `32`             | Set the size of the note `id` in bytes. By default this is `32` bytes. This is useful for reducing link size. _This setting does not affect encryption strength_.                                             |
 | `VERBOSITY`             | `warn`           | Verbosity level for the backend. [Possible values](https://docs.rs/env_logger/latest/env_logger/#enabling-logging) are: `error`, `warn`, `info`, `debug`, `trace`                                             |
 | `THEME_IMAGE`           | `""`             | Custom image for replacing the logo. Must be publicly reachable                                                                                                                                               |
 | `THEME_TEXT`            | `""`             | Custom text for replacing the description below the logo                                                                                                                                                      |
 | `THEME_PAGE_TITLE`      | `""`             | Custom text the page title                                                                                                                                                                                    |
 | `THEME_FAVICON`         | `""`             | Custom url for the favicon. Must be publicly reachable                                                                                                                                                        |
+| `THEME_NEW_NOTE_NOTICE` | `true`           | Show the message about how notes are stored in the memory and may be evicted after creating a new note. Defaults to `true`.                                                                                   |
 
 ## Deployment
 
@@ -144,6 +144,8 @@ There is a [guide](https://mariushosting.com/how-to-install-cryptgeon-on-your-sy
 ### Written Guides
 
 - French by [zarevskaya](https://belginux.com/installer-cryptgeon-avec-docker/)
+- Italian by [@nicfab](https://notes.nicfab.eu/it/posts/cryptgeon/)
+- English by [@nicfab](https://notes.nicfab.eu/en/posts/cryptgeon/)
 
 ## Development
 
@@ -178,7 +180,7 @@ Running `pnpm run dev` in the root folder will start the following things:
 - client
 - cli
 
-You can see the app under [localhost:1234](http://localhost:1234).
+You can see the app under [localhost:3000](http://localhost:3000).
 
 > There is a Postman collection with some example requests [available in the repo](./Cryptgeon.postman_collection.json)
 

README_ES.md

@@ -59,19 +59,19 @@ se usa para guardar y recuperar la nota. Después la nota es encriptada con la <
 
 ## Variables de entorno
 
-| Variable           | Default          | Descripción                                                                                                                                                                                                   |
-| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `REDIS`            | `redis://redis/` | Redis URL a la que conectarse. [Según el formato](https://docs.rs/redis/latest/redis/#connection-parameters)                                                                                                     |
+| Variable           | Default          | Descripción                                                                                                                                                                                                         |
+| ------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `REDIS`            | `redis://redis/` | Redis URL a la que conectarse. [Según el formato](https://docs.rs/redis/latest/redis/#connection-parameters)                                                                                                        |
 | `SIZE_LIMIT`       | `1 KiB`          | Tamaño máximo. Valores aceptados según la [unidad byte](https://docs.rs/byte-unit/). <br> `512 MiB` es el máximo permitido. <br> El frontend mostrará ese número, incluyendo el ~35% de sobrecarga de codificación. |
-| `MAX_VIEWS`        | `100`            | Número máximo de vistas.                                                                                                                                                                                      |
-| `MAX_EXPIRATION`   | `360`            | Tiempo máximo de expiración en minutos.                                                                                                                                                                                |
-| `ALLOW_ADVANCED`   | `true`           | Permitir configuración personalizada. Si se establece en `false` todas las notas serán de una sola vista.                                                                                                                                |
-| `ID_LENGTH`        | `32`             | Establece el tamaño en bytes de la `id` de la nota. Por defecto es de `32` bytes. Esto es util para reducir el tamaño del link. _Esta configuración no afecta el nivel de encriptación_.                                             |
-| `VERBOSITY`        | `warn`           | Nivel de verbosidad del backend. [Posibles valores](https://docs.rs/env_logger/latest/env_logger/#enabling-logging): `error`, `warn`, `info`, `debug`, `trace`                                             |
-| `THEME_IMAGE`      | `""`             | Imagen personalizada para reemplazar el logo. Debe ser accesible públicamente.                                                                                                                                               |
-| `THEME_TEXT`       | `""`             | Texto personalizado para reemplazar la descripción bajo el logo.                                                                                                                                                      |
-| `THEME_PAGE_TITLE` | `""`             | Texto personalizado para el título                                                                                                                                                                                    |
-| `THEME_FAVICON`    | `""`             | Url personalizada para el favicon. Debe ser accesible públicamente.                                                                                                                                                        |
+| `MAX_VIEWS`        | `100`            | Número máximo de vistas.                                                                                                                                                                                            |
+| `MAX_EXPIRATION`   | `360`            | Tiempo máximo de expiración en minutos.                                                                                                                                                                             |
+| `ALLOW_ADVANCED`   | `true`           | Permitir configuración personalizada. Si se establece en `false` todas las notas serán de una sola vista.                                                                                                           |
+| `ID_LENGTH`        | `32`             | Establece el tamaño en bytes de la `id` de la nota. Por defecto es de `32` bytes. Esto es util para reducir el tamaño del link. _Esta configuración no afecta el nivel de encriptación_.                            |
+| `VERBOSITY`        | `warn`           | Nivel de verbosidad del backend. [Posibles valores](https://docs.rs/env_logger/latest/env_logger/#enabling-logging): `error`, `warn`, `info`, `debug`, `trace`                                                      |
+| `THEME_IMAGE`      | `""`             | Imagen personalizada para reemplazar el logo. Debe ser accesible públicamente.                                                                                                                                      |
+| `THEME_TEXT`       | `""`             | Texto personalizado para reemplazar la descripción bajo el logo.                                                                                                                                                    |
+| `THEME_PAGE_TITLE` | `""`             | Texto personalizado para el título                                                                                                                                                                                  |
+| `THEME_FAVICON`    | `""`             | Url personalizada para el favicon. Debe ser accesible públicamente.                                                                                                                                                 |
 
 ## Despliegue
 
@@ -169,7 +169,7 @@ Ejecutando `pnpm run dev` en la carpeta raíz iniciará lo siguiente:
 - client
 - cli
 
-Puedes ver la app en [localhost:1234](http://localhost:1234).
+Puedes ver la app en [localhost:3000](http://localhost:3000).
 
 > Existe una colección de Postman con algunas peticiones de ejemplo [disponible en el repo](./Cryptgeon.postman_collection.json)
 

README_zh-CN.md

@@ -158,7 +158,7 @@ pnpm run dev
 - 无热重载的 rust 后端
 - 可热重载的客户端
 
-你可以通过 1234 端口进入该应用，即 [localhost:1234](http://localhost:1234).
+你可以通过 3000 端口进入该应用，即 [localhost:3000](http://localhost:3000).
 
 ## 测试
 

docker-compose.dev.yaml

@@ -9,12 +9,12 @@ services:
 
   app:
     build: .
-    env_file: .dev.env
+    env_file: .env.dev
     depends_on:
       - redis
     restart: unless-stopped
     ports:
-      - 1234:8000
+      - 3000:8000
 
     healthcheck:
       test: ['CMD', 'curl', '--fail', 'http://127.0.0.1:8000/api/live/']

package.json

@@ -5,8 +5,8 @@
     "dev": "run-p dev:*",
     "docker:up": "docker compose -f docker-compose.dev.yaml up",
     "docker:build": "docker compose -f docker-compose.dev.yaml build",
-    "test": "playwright test --project chrome firefox safari",
-    "test:local": "playwright test --project chrome",
+    "test": "playwright test --project=chrome --project=firefox --project=safari",
+    "test:local": "playwright test --project=chrome",
     "test:server": "run-s docker:up",
     "test:prepare": "run-p build docker:build",
     "build": "pnpm run --recursive --filter=!@cryptgeon/backend build"
@@ -17,5 +17,5 @@
     "npm-run-all": "^4.1.5",
     "shelljs": "^0.8.5"
   },
-  "packageManager": "pnpm@9.8.0"
+  "packageManager": "pnpm@9.9.0"
 }

packages/backend/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cryptgeon"
-version = "2.7.0"
+version = "2.8.0"
 authors = ["cupcakearmy <hi@nicco.io>"]
 edition = "2021"
 rust-version = "1.80"
@@ -10,16 +10,18 @@ name = "cryptgeon"
 path = "src/main.rs"
 
 [dependencies]
-actix-web = "4"
-actix-files = "0.6"
-serde = { version = "1.0", features = ["derive"] }
+# Core
+axum = "0.7.5"
+serde = { version = "1.0.208", features = ["derive"] }
+tokio = { version = "1.39.3", features = ["full"] }
+tower = "0.5.0"
+tower-http = { version = "0.5.2", features = ["full"] }
+redis = { version = "0.25.2", features = ["tls-native-tls"] }
+
+# Utility
 serde_json = "1"
 lazy_static = "1"
 ring = "0.16"
 bs62 = "0.1"
 byte-unit = "4"
 dotenv = "0.15"
-mime = "0.3"
-env_logger = "0.9"
-log = "0.4"
-redis = { version = "0.25.2", features = ["tls-native-tls"] }

packages/backend/package.json

@@ -4,7 +4,7 @@
   "scripts": {
     "dev": "cargo watch -x 'run --bin cryptgeon'",
     "build": "cargo build --release",
-    "test:server": "SIZE_LIMIT=10MiB LISTEN_ADDR=0.0.0.0:1234 cargo run",
+    "test:server": "SIZE_LIMIT=10MiB LISTEN_ADDR=0.0.0.0:3000 cargo run",
     "test:prepare": "cargo build"
   }
 }

packages/backend/src/api.rs

@@ -1,14 +0,0 @@
-use actix_web::web;
-
-use crate::health;
-use crate::note;
-use crate::status;
-
-pub fn init(cfg: &mut web::ServiceConfig) {
-    cfg.service(
-        web::scope("/api")
-            .service(note::init())
-            .service(status::init())
-            .service(health::init()),
-    );
-}

packages/backend/src/client.rs

@@ -1,17 +0,0 @@
-use actix_files::{Files, NamedFile};
-use actix_web::{web, Result};
-
-use crate::config;
-
-pub fn init(cfg: &mut web::ServiceConfig) {
-    cfg.service(
-        Files::new("/", config::FRONTEND_PATH.to_string())
-            .index_file("index.html")
-            .use_etag(true),
-    );
-}
-
-pub async fn index() -> Result<NamedFile> {
-    let index = format!("{}{}", config::FRONTEND_PATH.to_string(), "/index.html");
-    Ok(NamedFile::open(index)?)
-}

packages/backend/src/config.rs

@@ -38,10 +38,6 @@ pub static ref ALLOW_FILES: bool = std::env::var("ALLOW_FILES")
   .unwrap_or("true".to_string())
   .parse()
   .unwrap();
-pub static ref THEME_NEW_NOTE_NOTICE: bool = std::env::var("THEME_NEW_NOTE_NOTICE")
-  .unwrap_or("true".to_string())
-  .parse()
-  .unwrap();
 }
 
 // THEME
@@ -62,4 +58,8 @@ lazy_static! {
         .unwrap_or("".to_string())
         .parse()
         .unwrap();
+    pub static ref THEME_NEW_NOTE_NOTICE: bool = std::env::var("THEME_NEW_NOTE_NOTICE")
+        .unwrap_or("true".to_string())
+        .parse()
+        .unwrap();
 }

packages/backend/src/health/mod.rs

@@ -1,3 +1,10 @@
-mod routes;
+use crate::store;
+use axum::http::StatusCode;
 
-pub use routes::*;
+pub async fn report_health() -> (StatusCode,) {
+    if store::can_reach_redis() {
+        return (StatusCode::OK,);
+    } else {
+        return (StatusCode::SERVICE_UNAVAILABLE,);
+    }
+}

packages/backend/src/health/routes.rs

@@ -1,16 +0,0 @@
-use actix_web::{get, web, HttpResponse, Responder, Scope};
-
-use crate::store;
-
-#[get("/")]
-async fn get_live() -> impl Responder {
-    if store::can_reach_redis() {
-        return HttpResponse::Ok();
-    } else {
-        return HttpResponse::ServiceUnavailable();
-    }
-}
-
-pub fn init() -> Scope {
-    web::scope("/live").service(get_live)
-}

packages/backend/src/main.rs

@@ -1,44 +1,67 @@
-use actix_web::{
-    middleware::{self, Logger},
-    web::{self},
-    App, HttpServer,
+use axum::{
+    extract::{DefaultBodyLimit, Request},
+    routing::{delete, get, post},
+    Router, ServiceExt,
 };
 use dotenv::dotenv;
-use log::error;
+use tower::Layer;
+use tower_http::{
+    compression::CompressionLayer,
+    normalize_path::NormalizePathLayer,
+    services::{ServeDir, ServeFile},
+};
 
 #[macro_use]
 extern crate lazy_static;
 
-mod api;
-mod client;
 mod config;
 mod health;
 mod note;
-mod size;
 mod status;
 mod store;
 
-#[actix_web::main]
-async fn main() -> std::io::Result<()> {
+#[tokio::main]
+async fn main() {
     dotenv().ok();
-    env_logger::init_from_env(env_logger::Env::new().default_filter_or(config::VERBOSITY.as_str()));
 
     if !store::can_reach_redis() {
-        error!("cannot reach redis");
+        println!("cannot reach redis");
         panic!("canont reach redis");
     }
 
-    return HttpServer::new(|| {
-        App::new()
-            .wrap(Logger::new("\"%r\" %s %b %T"))
-            .wrap(middleware::Compress::default())
-            .wrap(middleware::DefaultHeaders::default())
-            .configure(size::init)
-            .configure(api::init)
-            .configure(client::init)
-            .default_service(web::to(client::index))
-    })
-    .bind(config::LISTEN_ADDR.to_string())?
-    .run()
-    .await;
+    let notes_routes = Router::new()
+        .route("/", post(note::create))
+        .route("/:id", delete(note::delete))
+        .route("/:id", get(note::preview));
+    let health_routes = Router::new().route("/live", get(health::report_health));
+    let status_routes = Router::new().route("/status", get(status::get_status));
+    let api_routes = Router::new()
+        .nest("/notes", notes_routes)
+        .nest("/", health_routes)
+        .nest("/", status_routes);
+
+    let index = format!("{}{}", config::FRONTEND_PATH.to_string(), "/index.html");
+    let serve_dir =
+        ServeDir::new(config::FRONTEND_PATH.to_string()).not_found_service(ServeFile::new(index));
+    let app = Router::new()
+        .nest("/api", api_routes)
+        .fallback_service(serve_dir)
+        .layer(DefaultBodyLimit::max(*config::LIMIT))
+        .layer(
+            CompressionLayer::new()
+                .br(true)
+                .deflate(true)
+                .gzip(true)
+                .zstd(true),
+        );
+
+    let app = NormalizePathLayer::trim_trailing_slash().layer(app);
+
+    let listener = tokio::net::TcpListener::bind(config::LISTEN_ADDR.to_string())
+        .await
+        .unwrap();
+    println!("listening on {}", listener.local_addr().unwrap());
+    axum::serve(listener, ServiceExt::<Request>::into_make_service(app))
+        .await
+        .unwrap();
 }

packages/backend/src/note/model.rs

@@ -12,12 +12,12 @@ pub struct Note {
     pub expiration: Option<u32>,
 }
 
-#[derive(Serialize, Deserialize, Clone)]
+#[derive(Serialize)]
 pub struct NoteInfo {
     pub meta: String,
 }
 
-#[derive(Serialize, Deserialize, Clone)]
+#[derive(Serialize)]
 pub struct NotePublic {
     pub meta: String,
     pub contents: String,

packages/backend/src/note/routes.rs

@@ -1,11 +1,18 @@
-use actix_web::{delete, get, post, web, HttpResponse, Responder, Scope};
+use axum::{
+    extract::Path,
+    http::StatusCode,
+    response::{IntoResponse, Response},
+    Json,
+};
 use serde::{Deserialize, Serialize};
 use std::time::SystemTime;
 
 use crate::config;
-use crate::note::{generate_id, Note, NoteInfo, NotePublic};
+use crate::note::{generate_id, Note, NoteInfo};
 use crate::store;
 
+use super::NotePublic;
+
 pub fn now() -> u32 {
     SystemTime::now()
         .duration_since(SystemTime::UNIX_EPOCH)
@@ -13,20 +20,18 @@ pub fn now() -> u32 {
         .as_secs() as u32
 }
 
-#[derive(Serialize, Deserialize)]
-struct NotePath {
+#[derive(Deserialize)]
+pub struct OneNoteParams {
     id: String,
 }
 
-#[get("/{id}")]
-async fn one(path: web::Path<NotePath>) -> impl Responder {
-    let p = path.into_inner();
-    let note = store::get(&p.id);
+pub async fn preview(Path(OneNoteParams { id }): Path<OneNoteParams>) -> Response {
+    let note = store::get(&id);
 
     match note {
-        Ok(Some(n)) => HttpResponse::Ok().json(NoteInfo { meta: n.meta }),
-        Ok(None) => HttpResponse::NotFound().finish(),
-        Err(e) => HttpResponse::InternalServerError().body(e.to_string()),
+        Ok(Some(n)) => (StatusCode::OK, Json(NoteInfo { meta: n.meta })).into_response(),
+        Ok(None) => (StatusCode::NOT_FOUND).into_response(),
+        Err(e) => (StatusCode::INTERNAL_SERVER_ERROR, e.to_string()).into_response(),
     }
 }
 
@@ -35,13 +40,16 @@ struct CreateResponse {
     id: String,
 }
 
-#[post("/")]
-async fn create(note: web::Json<Note>) -> impl Responder {
-    let mut n = note.into_inner();
+pub async fn create(Json(mut n): Json<Note>) -> Response {
+    // let mut n = note.into_inner();
     let id = generate_id();
-    let bad_req = HttpResponse::BadRequest().finish();
+    // let bad_req = HttpResponse::BadRequest().finish();
     if n.views == None && n.expiration == None {
-        return bad_req;
+        return (
+            StatusCode::BAD_REQUEST,
+            "At least views or expiration must be set",
+        )
+            .into_response();
     }
     if !*config::ALLOW_ADVANCED {
         n.views = Some(1);
@@ -50,7 +58,7 @@ async fn create(note: web::Json<Note>) -> impl Responder {
     match n.views {
         Some(v) => {
             if v > *config::MAX_VIEWS || v < 1 {
-                return bad_req;
+                return (StatusCode::BAD_REQUEST, "Invalid views").into_response();
             }
             n.expiration = None; // views overrides expiration
         }
@@ -58,8 +66,8 @@ async fn create(note: web::Json<Note>) -> impl Responder {
     }
     match n.expiration {
         Some(e) => {
-            if e > *config::MAX_EXPIRATION {
-                return bad_req;
+            if e > *config::MAX_EXPIRATION || e < 1 {
+                return (StatusCode::BAD_REQUEST, "Invalid expiration").into_response();
             }
             let expiration = now() + (e * 60);
             n.expiration = Some(expiration);
@@ -67,38 +75,40 @@ async fn create(note: web::Json<Note>) -> impl Responder {
         _ => {}
     }
     match store::set(&id.clone(), &n.clone()) {
-        Ok(_) => return HttpResponse::Ok().json(CreateResponse { id: id }),
-        Err(e) => return HttpResponse::InternalServerError().body(e.to_string()),
+        Ok(_) => (StatusCode::OK, Json(CreateResponse { id })).into_response(),
+        Err(e) => (StatusCode::INTERNAL_SERVER_ERROR, e.to_string()).into_response(),
     }
 }
 
-#[delete("/{id}")]
-async fn delete(path: web::Path<NotePath>) -> impl Responder {
-    let p = path.into_inner();
-    let note = store::get(&p.id);
+pub async fn delete(Path(OneNoteParams { id }): Path<OneNoteParams>) -> Response {
+    let note = store::get(&id);
     match note {
-        Err(e) => HttpResponse::InternalServerError().body(e.to_string()),
-        Ok(None) => return HttpResponse::NotFound().finish(),
+        // Err(e) => HttpResponse::InternalServerError().body(e.to_string()),
+        // Ok(None) => return HttpResponse::NotFound().finish(),
+        Err(e) => (StatusCode::INTERNAL_SERVER_ERROR, e.to_string()).into_response(),
+        Ok(None) => (StatusCode::NOT_FOUND).into_response(),
         Ok(Some(note)) => {
             let mut changed = note.clone();
             if changed.views == None && changed.expiration == None {
-                return HttpResponse::BadRequest().finish();
+                return (StatusCode::BAD_REQUEST).into_response();
             }
             match changed.views {
                 Some(v) => {
                     changed.views = Some(v - 1);
-                    let id = p.id.clone();
+                    let id = id.clone();
                     if v <= 1 {
                         match store::del(&id) {
                             Err(e) => {
-                                return HttpResponse::InternalServerError().body(e.to_string())
+                                return (StatusCode::INTERNAL_SERVER_ERROR, e.to_string())
+                                    .into_response();
                             }
                             _ => {}
                         }
                     } else {
                         match store::set(&id, &changed.clone()) {
                             Err(e) => {
-                                return HttpResponse::InternalServerError().body(e.to_string())
+                                return (StatusCode::INTERNAL_SERVER_ERROR, e.to_string())
+                                    .into_response();
                             }
                             _ => {}
                         }
@@ -111,33 +121,26 @@ async fn delete(path: web::Path<NotePath>) -> impl Responder {
             match changed.expiration {
                 Some(e) => {
                     if e < n {
-                        match store::del(&p.id.clone()) {
-                            Ok(_) => return HttpResponse::BadRequest().finish(),
+                        match store::del(&id.clone()) {
+                            Ok(_) => return (StatusCode::BAD_REQUEST).into_response(),
                             Err(e) => {
-                                return HttpResponse::InternalServerError().body(e.to_string())
+                                return (StatusCode::INTERNAL_SERVER_ERROR, e.to_string())
+                                    .into_response()
                             }
                         }
                     }
                 }
                 _ => {}
             }
-            return HttpResponse::Ok().json(NotePublic {
-                contents: changed.contents,
-                meta: changed.meta,
-            });
+
+            return (
+                StatusCode::OK,
+                Json(NotePublic {
+                    contents: changed.contents,
+                    meta: changed.meta,
+                }),
+            )
+                .into_response();
         }
     }
 }
-
-#[derive(Serialize, Deserialize)]
-struct Status {
-    version: String,
-    max_size: usize,
-}
-
-pub fn init() -> Scope {
-    web::scope("/notes")
-        .service(one)
-        .service(create)
-        .service(delete)
-}

packages/backend/src/size.rs

@@ -1,12 +0,0 @@
-use crate::config;
-use actix_web::web;
-use mime;
-
-pub fn init(cfg: &mut web::ServiceConfig) {
-    let json = web::JsonConfig::default().limit(*config::LIMIT);
-    let plain = web::PayloadConfig::default()
-        .limit(*config::LIMIT)
-        .mimetype(mime::STAR_STAR);
-    // cfg.app_data(plain);
-    cfg.app_data(json).app_data(plain);
-}

packages/backend/src/status/mod.rs

@@ -1,5 +1,39 @@
-mod model;
-mod routes;
+use crate::config;
+use axum::{http::StatusCode, Json};
+use serde::Serialize;
 
-pub use model::*;
-pub use routes::*;
+#[derive(Serialize)]
+pub struct Status {
+    // General
+    pub version: String,
+    // Config
+    pub max_size: u32,
+    pub max_views: u32,
+    pub max_expiration: u32,
+    pub allow_advanced: bool,
+    pub allow_files: bool,
+    // Theme
+    pub theme_image: String,
+    pub theme_text: String,
+    pub theme_page_title: String,
+    pub theme_favicon: String,
+    pub theme_new_note_notice: bool,
+}
+
+pub async fn get_status() -> (StatusCode, Json<Status>) {
+    let status = Status {
+        version: config::VERSION.to_string(),
+        max_size: *config::LIMIT as u32,
+        max_views: *config::MAX_VIEWS,
+        max_expiration: *config::MAX_EXPIRATION,
+        allow_advanced: *config::ALLOW_ADVANCED,
+        allow_files: *config::ALLOW_FILES,
+        theme_new_note_notice: *config::THEME_NEW_NOTE_NOTICE,
+        theme_image: config::THEME_IMAGE.to_string(),
+        theme_text: config::THEME_TEXT.to_string(),
+        theme_page_title: config::THEME_PAGE_TITLE.to_string(),
+        theme_favicon: config::THEME_FAVICON.to_string(),
+    };
+
+    (StatusCode::OK, Json(status))
+}

packages/backend/src/status/model.rs

@@ -1,19 +0,0 @@
-use serde::{Deserialize, Serialize};
-
-#[derive(Serialize, Deserialize)]
-pub struct Status {
-    // General
-    pub version: String,
-    // Config
-    pub max_size: u32,
-    pub max_views: u32,
-    pub max_expiration: u32,
-    pub allow_advanced: bool,
-    pub allow_files: bool,
-    pub theme_new_note_notice: bool,
-    // Theme
-    pub theme_image: String,
-    pub theme_text: String,
-    pub theme_page_title: String,
-    pub theme_favicon: String,
-}

packages/backend/src/status/routes.rs

@@ -1,25 +0,0 @@
-use actix_web::{get, web, HttpResponse, Responder, Scope};
-
-use crate::config;
-use crate::status::Status;
-
-#[get("/")]
-async fn get_status() -> impl Responder {
-    return HttpResponse::Ok().json(Status {
-        version: config::VERSION.to_string(),
-        max_size: *config::LIMIT as u32,
-        max_views: *config::MAX_VIEWS,
-        max_expiration: *config::MAX_EXPIRATION,
-        allow_advanced: *config::ALLOW_ADVANCED,
-        allow_files: *config::ALLOW_FILES,
-        theme_new_note_notice: *config::THEME_NEW_NOTE_NOTICE,
-        theme_image: config::THEME_IMAGE.to_string(),
-        theme_text: config::THEME_TEXT.to_string(),
-        theme_page_title: config::THEME_PAGE_TITLE.to_string(),
-        theme_favicon: config::THEME_FAVICON.to_string(),
-    });
-}
-
-pub fn init() -> Scope {
-    web::scope("/status").service(get_status)
-}

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cryptgeon",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "homepage": "https://github.com/cupcakearmy/cryptgeon",
   "repository": {
     "type": "git",

packages/frontend/src/lib/ui/Icon.svelte

@@ -18,19 +18,19 @@
 	export let icon: keyof typeof map
 </script>
 
-<div on:click {...$$restProps}>
+<button on:click {...$$restProps}>
 	{#if map[icon]}
 		<svelte:component this={map[icon]} />
 	{/if}
-</div>
+</button>
 
 <style>
-	div {
+	button {
 		display: inline-block;
 		contain: strict;
 		box-sizing: content-box;
 	}
-	div > :global(svg) {
+	button > :global(svg) {
 		display: block;
 		fill: currentColor;
 	}

packages/frontend/src/lib/ui/TextInput.svelte

@@ -39,13 +39,23 @@
 	<input bind:value {...$$restProps} class:valid={valid === true} />
 	<div class="icons">
 		{#if isPassword}
-			<Icon class="icon" icon={hidden ? 'eye' : 'eye-off'} on:click={toggle} />
+			<Icon
+				disabled={$$restProps.disabled}
+				class="icon"
+				icon={hidden ? 'eye' : 'eye-off'}
+				on:click={toggle}
+			/>
 		{/if}
 		{#if random}
-			<Icon class="icon" icon="dice" on:click={randomFN} />
+			<Icon disabled={$$restProps.disabled} class="icon" icon="dice" on:click={randomFN} />
 		{/if}
 		{#if copy}
-			<Icon class="icon" icon="copy" on:click={() => copyFN(value.toString())} />
+			<Icon
+				disabled={$$restProps.disabled}
+				class="icon"
+				icon="copy"
+				on:click={() => copyFN(value.toString())}
+			/>
 		{/if}
 	</div>
 </label>

packages/proxy/proxy.js

@@ -12,5 +12,5 @@ const server = http.createServer(function (req, res) {
   const target = req.url.startsWith('/api/') ? 'http://127.0.0.1:8000' : 'http://localhost:8001'
   proxy.web(req, res, { target, proxyTimeout: 250, timeout: 250 })
 })
-server.listen(1234)
-console.log('Proxy on http://localhost:1234')
+server.listen(3000)
+console.log('Proxy on http://localhost:3000')

packages/shared/src/api.ts

@@ -116,6 +116,7 @@ export type Status = {
   theme_text: string
   theme_favicon: string
   theme_page_title: string
+  theme_new_note_notice: boolean
 }
 
 export async function status() {

playwright.config.ts

@@ -3,18 +3,19 @@ import { devices, type PlaywrightTestConfig } from '@playwright/test'
 const config: PlaywrightTestConfig = {
   use: {
     video: 'retain-on-failure',
-    baseURL: 'http://localhost:1234',
-    actionTimeout: 10_000,
+    baseURL: 'http://localhost:3000',
+    actionTimeout: 30_000,
   },
 
   outputDir: './test-results',
   testDir: './test',
-  timeout: 10_000,
+  timeout: 30_000,
   fullyParallel: true,
+  retries: 2,
 
   webServer: {
-    command: 'docker compose -f docker-compose.dev.yaml up',
-    port: 1234,
+    command: 'pnpm run docker:up',
+    port: 3000,
     reuseExistingServer: true,
   },
 
@@ -22,10 +23,6 @@ const config: PlaywrightTestConfig = {
     { name: 'chrome', use: { ...devices['Desktop Chrome'] } },
     { name: 'firefox', use: { ...devices['Desktop Firefox'] } },
     { name: 'safari', use: { ...devices['Desktop Safari'] } },
-
-    { name: 'cli', use: { ...devices['Desktop Chrome'] }, grep: [/@cli/] },
-    { name: 'web', use: { ...devices['Desktop Chrome'] }, grep: [/@web/] },
-    { name: 'cross', use: { ...devices['Desktop Chrome'] }, grep: [/@cross/] },
   ],
 }
 

test/cli/file/simple.spec.ts

@@ -1,10 +1,11 @@
 import { test } from '@playwright/test'
 import { basename } from 'node:path'
-import { Files, getFileChecksum, rm, tmpFile } from '../../files'
+import { rm } from 'node:fs/promises'
+import { Files, getFileChecksum, tmpFile } from '../../files'
 import { CLI, getLinkFromCLI } from '../../utils'
 
 test.describe('file @cli', () => {
-  test('simple', async ({ page }) => {
+  test('simple', async () => {
     const file = await tmpFile(Files.Image)
     const checksum = await getFileChecksum(file)
     const note = await CLI('send', 'file', file)
@@ -17,7 +18,7 @@ test.describe('file @cli', () => {
     test.expect(checksum).toBe(c)
   })
 
-  test('simple with password', async ({ page }) => {
+  test('simple with password', async () => {
     const file = await tmpFile(Files.Image)
     const password = 'password'
     const checksum = await getFileChecksum(file)

test/cli/text/simple.spec.ts

@@ -2,7 +2,7 @@ import { test } from '@playwright/test'
 import { CLI, getLinkFromCLI } from '../../utils'
 
 test.describe('text @cli', () => {
-  test('simple', async ({ page }) => {
+  test('simple', async () => {
     const text = `Endless prejudice endless play derive joy eternal-return selfish burying. Of decieve play pinnacle faith disgust. Spirit reason salvation burying strong of joy ascetic selfish against merciful sea truth. Ubermensch moral prejudice derive chaos mountains ubermensch justice philosophy justice ultimate joy ultimate transvaluation. Virtues convictions war ascetic eternal-return spirit. Ubermensch transvaluation noble revaluation sexuality intentions salvation endless decrepit hope noble fearful. Justice ideal ultimate snare god joy evil sexuality insofar gains oneself ideal.`
     const note = await CLI('send', 'text', text)
     const link = getLinkFromCLI(note.stdout)
@@ -11,7 +11,7 @@ test.describe('text @cli', () => {
     test.expect(retrieved.stdout.trim()).toBe(text)
   })
 
-  test('simple with password', async ({ page }) => {
+  test('simple with password', async () => {
     const text = `Endless prejudice endless play derive joy eternal-return selfish burying.`
     const password = 'password'
     const note = await CLI('send', 'text', text, '--password', password)

test/cross/file/simple.spec.ts

@@ -1,7 +1,8 @@
 import { test } from '@playwright/test'
-import { CLI, checkLinkForDownload, checkLinkForText, createNote, getLinkFromCLI } from '../../utils'
-import { Files, getFileChecksum, rm, tmpFile } from '../../files'
-import { basename } from 'path'
+import { rm } from 'node:fs/promises'
+import { basename } from 'node:path'
+import { Files, getFileChecksum, tmpFile } from '../../files'
+import { CLI, checkLinkForDownload, createNoteSuccessfully, getLinkFromCLI } from '../../utils'
 
 const text = `Endless prejudice endless play derive joy eternal-return selfish burying. Of decieve play pinnacle faith disgust. Spirit reason salvation burying strong of joy ascetic selfish against merciful sea truth. Ubermensch moral prejudice derive chaos mountains ubermensch justice philosophy justice ultimate joy ultimate transvaluation. Virtues convictions war ascetic eternal-return spirit. Ubermensch transvaluation noble revaluation sexuality intentions salvation endless decrepit hope noble fearful. Justice ideal ultimate snare god joy evil sexuality insofar gains oneself ideal.`
 const password = 'password'
@@ -30,7 +31,7 @@ test.describe('text @cross', () => {
   test('web to cli', async ({ page }) => {
     const files = [Files.Image]
     const checksum = await getFileChecksum(files[0])
-    const link = await createNote(page, { files })
+    const link = await createNoteSuccessfully(page, { files })
 
     const filename = basename(files[0])
     await CLI('open', link, '--all')
@@ -42,7 +43,7 @@ test.describe('text @cross', () => {
   test('web to cli with password', async ({ page }) => {
     const files = [Files.Image]
     const checksum = await getFileChecksum(files[0])
-    const link = await createNote(page, { files, password })
+    const link = await createNoteSuccessfully(page, { files, password })
 
     const filename = basename(files[0])
     await CLI('open', link, '--all', '--password', password)

test/cross/text/simple.spec.ts

@@ -1,5 +1,5 @@
 import { test } from '@playwright/test'
-import { CLI, checkLinkForText, createNote, getLinkFromCLI } from '../../utils'
+import { CLI, checkLinkForText, createNoteSuccessfully, getLinkFromCLI } from '../../utils'
 
 const text = `Endless prejudice endless play derive joy eternal-return selfish burying. Of decieve play pinnacle faith disgust. Spirit reason salvation burying strong of joy ascetic selfish against merciful sea truth. Ubermensch moral prejudice derive chaos mountains ubermensch justice philosophy justice ultimate joy ultimate transvaluation. Virtues convictions war ascetic eternal-return spirit. Ubermensch transvaluation noble revaluation sexuality intentions salvation endless decrepit hope noble fearful. Justice ideal ultimate snare god joy evil sexuality insofar gains oneself ideal.`
 const password = 'password'
@@ -13,7 +13,7 @@ test.describe('text @cross', () => {
   })
 
   test('web to cli', async ({ page }) => {
-    const link = await createNote(page, { text })
+    const link = await createNoteSuccessfully(page, { text })
     const retrieved = await CLI('open', link)
     test.expect(retrieved.stdout.trim()).toBe(text)
   })
@@ -25,7 +25,7 @@ test.describe('text @cross', () => {
   })
 
   test('web to cli with password', async ({ page }) => {
-    const link = await createNote(page, { text, password })
+    const link = await createNoteSuccessfully(page, { text, password })
     const retrieved = await CLI('open', link, '--password', password)
     test.expect(retrieved.stdout.trim()).toBe(text)
   })

test/files.ts

@@ -1,10 +1,5 @@
-import { createHash } from 'crypto'
-import { cp as cpFN, rm as rmFN } from 'fs'
-import { readFile } from 'fs/promises'
-import { promisify } from 'util'
-
-export const cp = promisify(cpFN)
-export const rm = promisify(rmFN)
+import { createHash } from 'node:crypto'
+import { cp, readFile } from 'node:fs/promises'
 
 export const Files = {
   PDF: 'test/assets/AES.pdf',

test/utils.ts

@@ -6,17 +6,22 @@ import { getFileChecksum } from './files'
 const exec = promisify(execFile)
 
 type CreatePage = {
-  text?: string
-  files?: string[]
   views?: number
   expiration?: number
   error?: string
   password?: string
-}
-export async function createNote(page: Page, options: CreatePage): Promise<string> {
+} & (
+  | {
+      text: string
+    }
+  | {
+      files: string[]
+    }
+)
+async function createNote(page: Page, options: CreatePage): Promise<void> {
   await page.goto('/')
 
-  if (options.text) {
+  if ('text' in options) {
     await page.getByTestId('text-field').fill(options.text)
   } else if (options.files) {
     await page.getByTestId('switch-file').click()
@@ -31,7 +36,8 @@ export async function createNote(page: Page, options: CreatePage): Promise<strin
   if (options.views || options.expiration || options.password) await page.getByTestId('switch-advanced').click()
   if (options.views) {
     await page.getByTestId('field-views').fill(options.views.toString())
-  } else if (options.expiration) {
+  }
+  if (options.expiration) {
     await page.getByTestId('switch-advanced-toggle').click()
     await page.getByTestId('field-expiration').fill(options.expiration.toString())
   }
@@ -41,15 +47,18 @@ export async function createNote(page: Page, options: CreatePage): Promise<strin
   }
 
   await page.locator('button:has-text("create")').click()
+}
 
-  if (options.error) {
-    await expect(page.locator('.error-text')).toContainText(options.error, { timeout: 60_000 })
-  }
-
-  // Return share link
+export async function createNoteSuccessfully(page: Page, options: CreatePage): Promise<string> {
+  await createNote(page, options)
   return await page.getByTestId('share-link').inputValue()
 }
 
+export async function createNoteError(page: Page, options: CreatePage, error: string): Promise<void> {
+  await createNote(page, options)
+  await expect(page.locator('._toastContainer')).toContainText(error)
+}
+
 type CheckLinkBase = {
   link: string
   text: string
@@ -69,7 +78,7 @@ export async function checkLinkForDownload(page: Page, options: CheckLinkBase &
   const path = await download.path()
   if (!path) throw new Error('Download failed')
   const cs = await getFileChecksum(path)
-  await expect(cs).toBe(options.checksum)
+  expect(cs).toBe(options.checksum)
 }
 
 export async function checkLinkForText(page: Page, options: CheckLinkBase) {
@@ -78,7 +87,7 @@ export async function checkLinkForText(page: Page, options: CheckLinkBase) {
   if (options.password) await page.getByTestId('show-note-password').fill(options.password)
   await page.getByTestId('show-note-button').click()
   const text = await page.getByTestId('result').locator('.note').innerText()
-  await expect(text).toContain(options.text)
+  expect(text).toContain(options.text)
 }
 
 export async function checkLinkDoesNotExist(page: Page, link: string) {
@@ -91,7 +100,7 @@ export async function CLI(...args: string[]) {
   return await exec('./packages/cli/dist/cli.cjs', args, {
     env: {
       ...process.env,
-      CRYPTGEON_SERVER: 'http://localhost:1234',
+      CRYPTGEON_SERVER: 'http://localhost:3000',
     },
   })
 }

test/web/file/multiple.spec.ts

@@ -1,12 +1,12 @@
 import { test } from '@playwright/test'
 import { Files, getFileChecksum } from '../../files'
-import { checkLinkForDownload, createNote } from '../../utils'
+import { checkLinkForDownload, createNoteSuccessfully } from '../../utils'
 
 test.describe('@web', () => {
   test('multiple', async ({ page }) => {
     const files = [Files.PDF, Files.Image]
     const checksums = await Promise.all(files.map(getFileChecksum))
-    const link = await createNote(page, { files, views: 2 })
+    const link = await createNoteSuccessfully(page, { files, views: 2 })
     await checkLinkForDownload(page, { link, text: 'image.jpg', checksum: checksums[1] })
     await checkLinkForDownload(page, { link, text: 'AES.pdf', checksum: checksums[0] })
   })

test/web/file/simple.spec.ts

@@ -1,11 +1,11 @@
 import { test } from '@playwright/test'
 import { Files, getFileChecksum } from '../../files'
-import { checkLinkDoesNotExist, checkLinkForDownload, checkLinkForText, createNote } from '../../utils'
+import { checkLinkDoesNotExist, checkLinkForDownload, checkLinkForText, createNoteSuccessfully } from '../../utils'
 
 test.describe('@web', () => {
   test('simple pdf', async ({ page }) => {
     const files = [Files.PDF]
-    const link = await createNote(page, { files })
+    const link = await createNoteSuccessfully(page, { files })
     await checkLinkForText(page, { link, text: 'AES.pdf' })
     await checkLinkDoesNotExist(page, link)
   })
@@ -13,21 +13,21 @@ test.describe('@web', () => {
   test('pdf content', async ({ page }) => {
     const files = [Files.PDF]
     const checksum = await getFileChecksum(files[0])
-    const link = await createNote(page, { files })
+    const link = await createNoteSuccessfully(page, { files })
     await checkLinkForDownload(page, { link, text: 'AES.pdf', checksum })
   })
 
   test('image content', async ({ page }) => {
     const files = [Files.Image]
     const checksum = await getFileChecksum(files[0])
-    const link = await createNote(page, { files })
+    const link = await createNoteSuccessfully(page, { files })
     await checkLinkForDownload(page, { link, text: 'image.jpg', checksum })
   })
 
   test('simple pdf with password', async ({ page }) => {
     const files = [Files.PDF]
     const password = 'password'
-    const link = await createNote(page, { files, password })
+    const link = await createNoteSuccessfully(page, { files, password })
     await checkLinkForText(page, { link, text: 'AES.pdf', password })
     await checkLinkDoesNotExist(page, link)
   })

test/web/file/too-big.spec.ts

@@ -1,10 +1,10 @@
 import { test } from '@playwright/test'
-import { createNote } from '../../utils'
 import { Files } from '../../files'
+import { createNoteError } from '../../utils'
 
 test.describe('@web', () => {
   test.skip('to big zip', async ({ page }) => {
     const files = [Files.Zip]
-    const link = await createNote(page, { files, error: 'note is to big' })
+    await createNoteError(page, { files }, 'could not create note. note is too big')
   })
 })

test/web/text/expiration.spec.ts

@@ -1,13 +1,14 @@
 import { test } from '@playwright/test'
-import { checkLinkDoesNotExist, checkLinkForText, createNote } from '../../utils'
+import { checkLinkDoesNotExist, checkLinkForText, createNoteSuccessfully } from '../../utils'
 
 test.describe('@web', () => {
-  test('1 minute', async ({ page }) => {
+  test('1 minute', async ({ page, browserName }) => {
+    test.skip(browserName === 'webkit')
     const text = `Virtues value ascetic revaluation sea dead strong burying.`
     const minutes = 1
     const timeout = minutes * 60_000
     test.setTimeout(timeout * 2)
-    const link = await createNote(page, { text, expiration: minutes })
+    const link = await createNoteSuccessfully(page, { text, expiration: minutes })
     await checkLinkForText(page, { link, text })
     await checkLinkForText(page, { link, text })
     await page.waitForTimeout(timeout)

test/web/text/simple.spec.ts

@@ -1,17 +1,17 @@
 import { test } from '@playwright/test'
-import { checkLinkForText, createNote } from '../../utils'
+import { checkLinkForText, createNoteSuccessfully } from '../../utils'
 
 test.describe('@web', () => {
   test('simple', async ({ page }) => {
     const text = `Endless prejudice endless play derive joy eternal-return selfish burying. Of deceive play pinnacle faith disgust. Spirit reason salvation burying strong of joy ascetic selfish against merciful sea truth. Ubermensch moral prejudice derive chaos mountains ubermensch justice philosophy justice ultimate joy ultimate transvaluation. Virtues convictions war ascetic eternal-return spirit. Ubermensch transvaluation noble revaluation sexuality intentions salvation endless decrepit hope noble fearful. Justice ideal ultimate snare god joy evil sexuality insofar gains oneself ideal.`
-    const link = await createNote(page, { text })
+    const link = await createNoteSuccessfully(page, { text })
     await checkLinkForText(page, { link, text })
   })
 
   test('simple with password', async ({ page }) => {
     const text = 'Foo bar'
     const password = '123'
-    const shareLink = await createNote(page, { text, password })
+    const shareLink = await createNoteSuccessfully(page, { text, password })
     await checkLinkForText(page, { link: shareLink, text, password })
   })
 })

test/web/text/views.spec.ts

@@ -1,17 +1,17 @@
 import { test } from '@playwright/test'
-import { checkLinkDoesNotExist, checkLinkForText, createNote } from '../../utils'
+import { checkLinkDoesNotExist, checkLinkForText, createNoteSuccessfully } from '../../utils'
 
 test.describe('@web', () => {
   test('only shown once', async ({ page }) => {
     const text = `Christian victorious reason suicide dead. Right ultimate gains god hope truth burying selfish society joy. Ultimate.`
-    const link = await createNote(page, { text })
+    const link = await createNoteSuccessfully(page, { text })
     await checkLinkForText(page, { link, text })
     await checkLinkDoesNotExist(page, link)
   })
 
   test('view 3 times', async ({ page }) => {
     const text = `Justice holiest overcome fearful strong ultimate holiest christianity.`
-    const link = await createNote(page, { text, views: 3 })
+    const link = await createNoteSuccessfully(page, { text, views: 3 })
     await checkLinkForText(page, { link, text })
     await checkLinkForText(page, { link, text })
     await checkLinkForText(page, { link, text })