Make serving static pages optional (#22)

* Make serving static pages optional

* Customize API configs provider

* Update Dockerfile

* Update Dockerfile

* Remove package dotenvy

* Update diesel.toml

* Update deployments/docker-compose/docker-compose.yaml

* Update .github/workflows/CI.yml

* Update README.md

* Update .github/workflows/CI.yml

* Update .github/workflows/CI.yml

* Update .github/workflows/CI.yml

* Update ./scripts/cli.sh

* Fix docker deployment

.github/workflows/CI.yml

@@ -7,16 +7,16 @@ on:
       - .github/workflows/CI.yml
       - .cargo/config.toml
       - Cargo.toml
-      - ./**/*.rs
-      - ./scripts/cli.sh
+      - bearmark-*/**/*.rs
+      - scripts/cli.sh
   pull_request:
     branches: ["main"]
     paths:
       - .github/workflows/CI.yml
       - .cargo/config.toml
       - Cargo.toml
-      - ./**/*.rs
-      - ./scripts/cli.sh
+      - bearmark-*/**/*.rs
+      - scripts/cli.sh
 
 env:
   CARGO_TERM_COLOR: always
@@ -81,6 +81,7 @@ jobs:
 
       - name: Run tests with coverage
         run: |
+          source .envrc
           ./scripts/cli.sh coverage-xml
         env:
           CARGO_BUILD_TARGET: x86_64-unknown-linux-musl

Dockerfile

@@ -6,6 +6,8 @@ COPY ./server /usr/local/bin/server
 COPY ./static /app/static
 
 EXPOSE 8000
+ENV BM_UI_PATH=./static
+ENV BM_ADDRESS=0.0.0.0
 
 WORKDIR /app
 

README.md

@@ -53,16 +53,17 @@ open http://localhost:2284
 
 ## Developments
 
-Use nix to setup development environment.
+Use nix to setup development environment,
+or use `direnv` to load nix environment automatically.
 
 ```bash
-nix develop
-```
-
-Or use `direnv` to load nix environment automatically.
+# setup database by docker compose
+# and generate .envrc file
+./scripts/cli.sh setup
 
-```bash
-echo "use flake" > .envrc
+# activate manually
+nix develop
+source .envrc
 ```
 
 ### Helpful Scripts

bearmark-api/Cargo.toml

@@ -31,8 +31,6 @@ rand = "0.8.5"
 itertools = "0.13.0"
 time = { version = "0.3.36", features = ["local-offset", "macros", "serde"] }
 percent-encoding = "2.3.1"
-# read settings from the dotenv file
-dotenvy = "0.15.7"
 # logging
 tracing.workspace = true
 tracing-appender.workspace = true

bearmark-api/src/api/bookmark.rs

@@ -201,7 +201,7 @@ pub fn routes() -> Vec<rocket::Route> {
 #[cfg(test)]
 mod test {
     use super::*;
-    use crate::api::configs::Config;
+    use crate::api::configs::{self, Config};
     use crate::db::bookmark::test::rand_bookmark;
     use crate::utils::rand::rand_str;
 
@@ -213,7 +213,7 @@ mod test {
     use tracing::info;
 
     fn test_app() -> rocket::Rocket<rocket::Build> {
-        rocket::build()
+        rocket::custom(configs::config_provider())
             .attach(Db::init())
             .mount("/", routes())
             .attach(AdHoc::config::<Config>())

bearmark-api/src/api/configs.rs

@@ -1,7 +1,26 @@
-use rocket::serde::{Deserialize, Serialize};
+use rocket::{
+    figment::Figment,
+    serde::{Deserialize, Serialize},
+};
 
-#[derive(Debug, Deserialize, Serialize)]
+#[derive(Debug, Default, Deserialize, Serialize)]
 #[serde(crate = "rocket::serde")]
 pub struct Config {
+    pub ui_path: Option<String>,
     pub api_key: Option<String>,
 }
+
+pub fn config_provider() -> Figment {
+    use rocket::figment::providers::{Env, Serialized};
+
+    rocket::figment::Figment::from(rocket::Config::default())
+        .merge(Serialized::defaults(Config::default()))
+        .merge(("databases.main", rocket_db_pools::Config::default()))
+        .merge(Env::prefixed("BM_").global())
+}
+
+pub fn get_database_url() -> String {
+    config_provider()
+        .extract_inner("databases.main.url")
+        .unwrap()
+}

bearmark-api/src/api/fairings/db.rs

@@ -6,7 +6,6 @@ use diesel_async::{
     },
     AsyncConnection, AsyncPgConnection,
 };
-use dotenvy::dotenv;
 use rocket::figment::Figment;
 use rocket_db_pools::{Database, Error};
 
@@ -21,10 +20,10 @@ impl rocket_db_pools::Pool for DBPool {
 
     type Error = Error<InitError, GetError>;
 
-    async fn init(_figment: &Figment) -> Result<Self, Self::Error> {
-        dotenv().ok();
-
-        let url = std::env::var("DATABASE_URL").expect("env DATABASE_URL must be set");
+    async fn init(figment: &Figment) -> Result<Self, Self::Error> {
+        let url = figment
+            .extract_inner::<String>("url")
+            .expect("database_url must be set");
         let config = AsyncDieselConnectionManager::<Connection>::new(url);
         match Pool::builder(config).build() {
             Ok(pool) => Ok(Self(pool)),
@@ -57,5 +56,5 @@ impl rocket_db_pools::Pool for DBPool {
 }
 
 #[derive(Database)]
-#[database("deadpool_diesel_postgres")]
+#[database("main")]
 pub struct Db(DBPool);

bearmark-api/src/api/folder.rs

@@ -108,6 +108,7 @@ pub fn routes() -> Vec<rocket::Route> {
 #[cfg(test)]
 pub(crate) mod test {
     use super::*;
+    use crate::api::configs;
     use crate::api::configs::Config;
     use crate::db::bookmark::test::create_rand_bookmark;
     use crate::db::connection;
@@ -122,7 +123,7 @@ pub(crate) mod test {
     use tracing::info;
 
     fn test_app() -> rocket::Rocket<rocket::Build> {
-        rocket::build()
+        rocket::custom(configs::config_provider())
             .attach(Db::init())
             .mount("/", routes())
             .attach(AdHoc::config::<Config>())

bearmark-api/src/api/guards/mod.rs

@@ -72,7 +72,10 @@ mod test {
 
     #[test]
     fn test_disable_auth() {
-        let client = test_client(Config { api_key: None });
+        let client = test_client(Config {
+            api_key: None,
+            ..Default::default()
+        });
         let response = client.get(uri!(required_auth)).dispatch();
         assert_eq!(response.status(), Status::Ok);
     }
@@ -82,6 +85,7 @@ mod test {
         let key = rand_str(32);
         let client = test_client(Config {
             api_key: Some(key.clone()),
+            ..Default::default()
         });
 
         let response = client.get(uri!(required_auth)).dispatch();

bearmark-api/src/bin/serve.rs

@@ -1,7 +1,7 @@
 #[macro_use]
 extern crate rocket;
 
-use bearmark_api::api::configs::Config;
+use bearmark_api::api::configs::{self, Config};
 use bearmark_api::api::fairings::db::Db;
 use bearmark_api::api::{bookmark, folder, tag};
 
@@ -15,8 +15,17 @@ async fn rocket() -> _ {
     bearmark_api::utils::logging::setup_console_log();
     bearmark_api::db::connection::run_migrations().await;
 
-    rocket::build()
-        .mount("/", FileServer::from("./static"))
+    let cfg_provider = configs::config_provider();
+    let ui_path = cfg_provider
+        .extract_inner::<Option<String>>("ui_path")
+        .unwrap();
+
+    let mut builder = rocket::custom(cfg_provider);
+    if let Some(ui_path) = ui_path {
+        // Serve the UI files if the path is provided
+        builder = builder.mount("/", FileServer::from(ui_path));
+    }
+    builder
         .attach(Db::init())
         .mount("/api/bookmarks", bookmark::routes())
         .mount("/api/tags", tag::routes())

bearmark-api/src/db/connection.rs

@@ -1,15 +1,15 @@
 use diesel_async::AsyncPgConnection;
-use dotenvy::dotenv;
-use std::env;
+
+use crate::api::configs;
 
 pub async fn establish() -> AsyncPgConnection {
     use diesel_async::AsyncConnection;
-    dotenv().ok();
 
-    let database_url = env::var("DATABASE_URL").expect("DATABASE_URL must be set");
-    let mut conn = AsyncPgConnection::establish(&database_url)
+    let url = configs::get_database_url();
+
+    let mut conn = AsyncPgConnection::establish(&url)
         .await
-        .unwrap_or_else(|_| panic!("Error connecting to {}", database_url));
+        .unwrap_or_else(|_| panic!("Error connecting database",));
 
     if cfg!(debug_assertions) {
         use diesel::connection::InstrumentationEvent;

deployments/docker-compose/docker-compose.yaml

@@ -14,9 +14,8 @@ services:
     environment:
       RUST_BACKTRACE: full
       RUST_LOG: ${RUST_LOG}
-      DATABASE_URL: postgres://${DB_USERNAME}:${DB_PASSWORD}@database:5432/${DB_DATABASE_NAME}
-      ROCKET_ADDRESS: 0.0.0.0
-      ROCKET_API_KEY: ${API_KEY}
+      BM_DATABASES: '{main={url="postgres://${DB_USERNAME}:${DB_PASSWORD}@database:5432/${DB_DATABASE_NAME}"}}'
+      BM_API_KEY: ${API_KEY}
   database:
     container_name: bearmark_postgres
     image: postgres:12

diesel.toml

@@ -2,5 +2,5 @@
 # see https://diesel.rs/guides/configuring-diesel-cli
 
 [print_schema]
-file = "src/db/schema.rs"
+file = "bearmark-api/src/db/schema.rs"
 custom_type_derives = ["diesel::query_builder::QueryId", "Clone"]

scripts/cli.sh

@@ -56,15 +56,17 @@ main() {
 			echo ">>> Setting up the project development environment"
 			docker compose up -d --wait
 
-			echo "DATABASE_URL=postgres://postgres:example@${POSTGRES_HOST-localhost}:${POSTGRES_PORT-5432}/${POSTGRES_DB-bearmark}" >.env
+			url=postgres://postgres:example@${POSTGRES_HOST-localhost}:${POSTGRES_PORT-5432}/${POSTGRES_DB-bearmark}
+			echo "use flake
+export BM_DATABASES='{main={url=\"$url\"}}'" >.envrc
 			echo ">>> Setting up database"
-			./scripts/bin/diesel migration run
+			DATABASE_URL=$url ./scripts/bin/diesel migration run
 		else
 			echo ">>> Skip setting up the project development environment"
-
-			echo "DATABASE_URL=postgres://postgres:example@${POSTGRES_HOST-db}:${POSTGRES_PORT-5432}/${POSTGRES_DB-bearmark}" >.env
+			url=postgres://postgres:example@${POSTGRES_HOST-db}:${POSTGRES_PORT-5432}/${POSTGRES_DB-bearmark}
+			echo "export BM_DATABASES='{main={url=\"$url\"}}'" >.envrc
 			echo ">>> Setting up database"
-			diesel migration run
+			DATABASE_URL=$url diesel migration run
 		fi
 		echo ">>> Done"
 		;;