API: Basic Dockerisation

.env.example

@@ -0,0 +1,8 @@
+
+# Database. Fill in the missing fields with secure values
+POSTGRES_USER=
+POSTGRES_PASSWORD=
+POSTGRES_DB=blee
+
+# Internal Stuff, modify iff you know what you are doing
+CONFIG_DIR=/data

.gitignore

@@ -0,0 +1 @@
+.env

README.md

@@ -1,2 +1,3 @@
-# Vidix
+# Blee
+
 Enjoy your Concert movies, Music Videos and music DVD Extras, all in one place

api/.dockerignore

@@ -0,0 +1,2 @@
+target/
+Dockerfile*

api/.gitignore

@@ -1 +1,2 @@
-target
+target
+.vscode/

api/Dockerfile

@@ -0,0 +1,12 @@
+FROM rust:1.76-slim-buster as builder
+RUN apt update -y && apt install libpq-dev -y
+WORKDIR /usr/src/api
+COPY . .
+RUN cargo install --path api
+
+FROM debian:bullseye-slim as runner
+RUN apt update -y && apt install libpq-dev -y
+COPY --from=builder /usr/local/cargo/bin/api /usr/local/bin/api
+ENV ROCKET_ADDRESS=0.0.0.0
+EXPOSE 8000
+CMD DB_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}" ROCKET_DATABASES="{db={url=$DB_URL}}" api

api/Dockerfile.dev

@@ -0,0 +1,8 @@
+FROM rust:1.76-slim-buster as builder
+RUN apt update -y && apt install libpq-dev -y
+WORKDIR /app
+RUN cargo install cargo-watch
+ENV ROCKET_ADDRESS=0.0.0.0
+EXPOSE 8000
+# We reduce the pool_size because of this: https://github.com/rwf2/Rocket/issues/1931#issuecomment-955945953
+CMD cargo build && DB_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}" ROCKET_DATABASES="{db={url=$DB_URL, pool_size=2}}" cargo watch -x run

api/api/Cargo.toml

@@ -14,7 +14,7 @@ serde = { version = "1.0", features = ["derive"] }
 rocket_okapi = { version = "0.8.0", features = ["swagger", "uuid"] }
 serde_json = "1.0"
 schemars = { version = "0.8", features = ["chrono", "uuid1"] }
-diesel = { version = "2.1.0" }
+diesel = { version = "2.1.0", features = ["postgres"] }
 chrono = { version = "0.4.34", features = ["serde"] }
 slug = "0.1.5"
 blurhash = "0.2.1"

api/api/src/controllers/images.rs

@@ -1,4 +1,3 @@
-use std::path::Path;
 use crate::config::Config;
 use crate::error_handling::ApiError;
 use crate::services;
@@ -9,6 +8,7 @@ use rocket::State;
 use rocket_okapi::okapi::openapi3::OpenApi;
 use rocket_okapi::settings::OpenApiSettings;
 use rocket_okapi::{openapi, openapi_get_routes_spec};
+use std::path::Path;
 
 pub fn get_routes_and_docs(settings: &OpenApiSettings) -> (Vec<rocket::Route>, OpenApi) {
 	openapi_get_routes_spec![settings: serve_image]
@@ -25,7 +25,9 @@ async fn serve_image(
 	let image_row = db
 		.run(move |conn| services::image::get(&uuid, conn).map_err(|e| ApiError::from(e)))
 		.await?;
-	let image_path = Path::new(&config.data_folder).join(image_row.id.to_string()).join("image.webp");
+	let image_path = Path::new(&config.data_folder)
+		.join(image_row.id.to_string())
+		.join("image.webp");
 	NamedFile::open(&image_path)
 		.await
 		.map_err(|_| ApiError::ImageServingError)

api/api/src/controllers/index.rs

@@ -1,18 +1,15 @@
-use crate::responses::index::IndexResponse;
 use infrastructure::Database;
 use rocket::{get, serde::json::Json};
-use rocket_okapi::okapi::openapi3::OpenApi;
-use rocket_okapi::settings::OpenApiSettings;
-use rocket_okapi::{openapi, openapi_get_routes_spec};
+use serde::Serialize;
 
-pub fn get_routes_and_docs(settings: &OpenApiSettings) -> (Vec<rocket::Route>, OpenApi) {
-	openapi_get_routes_spec![settings: index]
+#[derive(Serialize)]
+pub struct IndexResponse {
+	pub message: &'static str,
 }
 
-#[openapi(tag = "Index")]
 #[get("/")]
-async fn index(_db: Database) -> Json<IndexResponse> {
+pub fn index(_db: Database) -> Json<IndexResponse> {
 	Json(IndexResponse {
-		message: "Hello World".to_owned(),
+		message: "Welcome to Blee's API. Hit '/swagger' for more!",
 	})
 }

api/api/src/controllers/mod.rs

@@ -1,5 +1,5 @@
 pub mod artists;
 pub mod extras;
+pub mod images;
 pub mod index;
 pub mod movies;
-pub mod images;

api/api/src/main.rs

@@ -1,7 +1,8 @@
 use crate::config::Config;
+use crate::controllers::index::index;
 use crate::error_handling::not_found;
 use crate::swagger::custom_openapi_spec;
-use infrastructure::Database;
+use infrastructure::{apply_migrations, Database};
 use rocket::fairing::AdHoc;
 use rocket::figment::providers::Serialized;
 use rocket::figment::Figment;
@@ -28,22 +29,34 @@ fn rocket() -> Rocket<Build> {
 	create_server()
 }
 
+async fn run_migrations(rocket: Rocket<Build>) -> Rocket<Build> {
+	let _ = Database::get_one(&rocket)
+		.await
+		.expect("Get DB Handle from Rocket")
+		.run(|conn| apply_migrations(conn))
+		.await;
+
+	rocket
+}
+
 pub fn create_server() -> Rocket<Build> {
-	let data_dir = env::var("DATA_DIR").expect("env variable `DATA_DIR` not set.");
+	let data_dir = env::var("CONFIG_DIR").expect("env variable `CONFIG_DIR` not set.");
 	let figment = Figment::from(rocket::Config::figment()).merge(Serialized::defaults(Config {
 		data_folder: data_dir,
 	}));
 	let mut building_rocket = rocket::custom(figment)
 		.attach(Database::fairing())
 		.attach(AdHoc::config::<Config>())
+		.attach(AdHoc::on_ignite("Run migrations", run_migrations))
 		.register("/", catchers![not_found])
 		.mount(
 			"/swagger",
 			make_swagger_ui(&SwaggerUIConfig {
 				url: "./openapi.json".to_owned(),
 				..Default::default()
 			}),
-		);
+		)
+		.mount("/", routes![index]);
 
 	let openapi_settings = OpenApiSettings {
 		json_path: "/swagger/openapi.json".to_owned(),
@@ -54,7 +67,6 @@ pub fn create_server() -> Rocket<Build> {
 		"/artists" => controllers::artists::get_routes_and_docs(&openapi_settings),
 		"/extras" => controllers::extras::get_routes_and_docs(&openapi_settings),
 		"/images" => controllers::images::get_routes_and_docs(&openapi_settings),
-		"/index" => controllers::index::get_routes_and_docs(&openapi_settings),
 		"/movies" => controllers::movies::get_routes_and_docs(&openapi_settings),
 		"/swagger" => (vec![], custom_openapi_spec()),
 	};

api/api/src/responses/mod.rs

@@ -1,4 +1,3 @@
 pub mod artist;
 pub mod extra_creation;
-pub mod index;
 pub mod movie_creation;

api/infrastructure/Cargo.toml

@@ -6,7 +6,8 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-diesel = { version = "2.0.0", features = ["postgres"] }
+diesel = { version = "2.1.0", features = ["postgres"] }
+diesel_migrations = "2.0.0"
 rocket_sync_db_pools = { version = "0.1.0", features = [
 	"diesel_postgres_pool",
 ] }

api/infrastructure/src/lib.rs

@@ -1,3 +1,4 @@
+use diesel_migrations::{embed_migrations, EmbeddedMigrations, MigrationHarness};
 use rocket_okapi::{gen::OpenApiGenerator, request::*};
 use rocket_sync_db_pools::{database, diesel};
 
@@ -14,3 +15,16 @@ impl<'r> OpenApiFromRequest<'r> for Database {
 		Ok(RequestHeaderInput::None)
 	}
 }
+
+pub const MIGRATIONS: EmbeddedMigrations = embed_migrations!("./migrations");
+
+pub fn apply_migrations(connection: &mut impl MigrationHarness<diesel::pg::Pg>) {
+	match connection.run_pending_migrations(MIGRATIONS) {
+		Ok(_) => {
+			println!("Migrations successfully completed");
+		}
+		Err(e) => {
+			panic!("error running pending migrations {}", e)
+		}
+	};
+}

docker-compose.dev.yml

@@ -0,0 +1,31 @@
+services:
+  api:
+    build:
+      context: ./api
+      dockerfile: Dockerfile.dev
+    ports:
+      - "8000:8000"
+    restart: on-failure
+    depends_on:
+      db:
+        condition: service_healthy
+    environment:
+      - POSTGRES_HOST=db
+      - POSTGRES_PORT=5432
+      - CONFIG_DIR=/data
+    env_file:
+      - .env
+    volumes:
+      - ./api:/app
+      - ./data:/data
+  db:
+    image: postgres:alpine3.16
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}"]
+      interval: 3s
+      timeout: 5s
+      retries: 5
+    env_file:
+      - .env
+volumes:
+  db: