feat: refactor

Author: KrLite

.dockerignore

@@ -0,0 +1,5 @@
+target/
+.git/
+.gitignore
+Dockerfile
+docker-compose.yml

.github/workflows/build_and_update.yml

@@ -0,0 +1,59 @@
+name: Release
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+concurrency:
+  group: "release"
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    name: Release Docker image
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Get Git SHA
+        id: git_sha
+        run: |
+          echo "full=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/${{ vars.DOCKER_IMAGE_NAME }}:latest
+          build-args: |
+            GIT_COMMIT=${{ steps.git_sha.outputs.full }}
+
+  post:
+    name: Remote deployment
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+      - uses: KessokuTeaTime/action-kessoku-private-ci@main
+        with:
+          auth: ${{ secrets.KTT_API_TOKEN }}
+          endpoint: ${{ vars.KTT_API_ENDPOINT }}
+          payload: |
+            {
+              "service_label": "${{ vars.SERVICE_LABEL }}"
+            }

.github/workflows/release.yml

@@ -39,6 +39,7 @@ sea-orm = { version = "1.1.14", features = [
     "with-json",
 ] }
 toml = "0.9.5"
+config-file = "0.2.3"
 
 [build-dependencies]
 anyhow = "1.0.98"
@@ -71,11 +72,31 @@ future-not-send = "warn"
 if-not-else = "warn"
 if-then-some-else-none = "warn"
 impl-trait-in-params = "warn"
-macro-use-imports = "forbid"
+macro-use-imports = "deny"
 exhaustive-enums = "warn"
 str-to-string = "warn"
 iter-without-into-iter = "warn"
 decimal-literal-representation = "warn"
+ref-as-ptr = "warn"
+unused-trait-names = "warn"
+unnecessary-semicolon = "warn"
+unnecessary-debug-formatting = "warn"
+too-long-first-doc-paragraph = "warn"
+ref-option = "warn"
+redundant-test-prefix = "warn"
+map-with-unused-argument-over-ranges = "warn"
+manual-midpoint = "warn"
+manual-is-power-of-two = "warn"
+ip-constant = "warn"
+elidable-lifetime-names = "warn"
+coerce-container-to-any = "warn"
+todo = "warn"
+inline-always = "warn"
+# multiple-crate-versions = "warn"
+use-self = "warn"
+useless-let-if-seq = "warn"
+suboptimal-flops = "warn"
+redundant-clone = "warn"
 
 [profile.release]
 opt-level = 3

Cargo.toml

@@ -0,0 +1,38 @@
+# rust builder
+
+FROM rust:bookworm AS rust_builder
+
+ARG GIT_COMMIT
+
+ENV GIT_COMMIT=$GIT_COMMIT
+
+WORKDIR /app
+
+COPY rust-toolchain.toml ./
+RUN rustup toolchain install --profile minimal $(grep "channel" rust-toolchain.toml | cut -d'"' -f2)
+
+COPY . .
+RUN cargo build --release
+
+# runtime image
+
+FROM debian:bookworm-slim
+
+WORKDIR /app
+
+COPY --from=rust_builder /app/target/release/api-main .
+RUN apt-get update && \
+    apt-get install -y ca-certificates curl gnupg lsb-release && \
+    install -m 0755 -d /etc/apt/keyrings && \
+    curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg && \
+    echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian $(lsb_release -cs) stable" \
+      > /etc/apt/sources.list.d/docker.list && \
+    apt-get update && \
+    apt-get install -y docker-ce-cli && \
+    rm -rf /var/lib/apt/lists/*
+
+# commands
+
+EXPOSE 8080
+
+CMD ["./api-wordle"]

Dockerfile

@@ -7,12 +7,14 @@ use vergen::{BuildBuilder, CargoBuilder, Emitter, RustcBuilder, SysinfoBuilder};
 
 fn main() -> Result<(), Error> {
     {
-        let output = Command::new("git")
-            .args(["rev-parse", "HEAD"])
-            .output()
-            .unwrap();
-        let hash = String::from_utf8(output.stdout).unwrap();
-        println!("cargo:rustc-env=GIT_HASH={}", hash);
+        let git_hash = std::env::var("GIT_COMMIT").unwrap_or_else(|_| {
+            let output = Command::new("git")
+                .args(["rev-parse", "HEAD"])
+                .output()
+                .unwrap();
+            String::from_utf8(output.stdout).unwrap()
+        });
+        println!("cargo:rustc-env=GIT_HASH={}", git_hash.trim());
     }
 
     {

build.rs

@@ -1,32 +1,42 @@
 //! `SeaORM` Entity, @generated by sea-orm-codegen 1.1.14
 
+#![allow(clippy::exhaustive_enums, unused_qualifications)]
+
 use std::fmt::Display;
 
 use crate::{HISTORY_MAX_TRIES, PUZZLE_LETTERS_COUNT, PuzzleDate, PuzzleSolution, SubmitHistory};
 
 use sea_orm::entity::prelude::*;
 use serde::{Deserialize, Serialize};
 
+/// The `histories` table model.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, DeriveEntityModel)]
 #[sea_orm(table_name = "histories")]
 pub struct Model {
+    /// The puzzle date.
     #[sea_orm(primary_key, auto_increment = false)]
     pub date: PuzzleDate,
+    /// The session token.
     #[sea_orm(primary_key, auto_increment = false)]
     pub session: String,
+    /// The submit history in JSON format.
     #[sea_orm(column_type = "JsonBinary", nullable)]
     pub submit_history: Option<SubmitHistory>,
-    pub original_solution: PuzzleSolution,
-    pub is_dirty: bool,
+    /// The solution submitted.
+    pub solution: PuzzleSolution,
+    /// Whether the puzzle has been completed.
     pub is_completed: bool,
+    /// The timestamp when this history was uploaded.
     pub uploaded_at: DateTime,
 }
 
 impl Model {
+    /// Returns the number of letters in the puzzle.
     pub fn letters_count(&self) -> usize {
         PUZZLE_LETTERS_COUNT
     }
 
+    /// Returns the number of remaining tries.
     pub fn remaining_tries(&self) -> usize {
         match &self.submit_history {
             Some(submit_history) => submit_history.remaining_tries(),
@@ -39,19 +49,16 @@ impl Display for Model {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(
             f,
-            "{:?} -> {} [{} {}] {{{}}} at {}",
-            self.submit_history,
-            self.original_solution,
-            self.date,
-            if self.is_dirty { "*" } else { "~" },
-            self.session,
-            self.uploaded_at
+            "{:?} -> {} at {} [{}] {{{}}}",
+            self.submit_history, self.solution, self.uploaded_at, self.date, self.session
         )
     }
 }
 
+/// The relations of the `histories` table.
 #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
 pub enum Relation {
+    /// The relation to the `puzzles` table.
     #[sea_orm(
         belongs_to = "super::puzzles::Entity",
         from = "Column::Date",
@@ -60,6 +67,7 @@ pub enum Relation {
         on_delete = "Cascade"
     )]
     Puzzles,
+    /// The relation to the `sessions` table.
     #[sea_orm(
         belongs_to = "super::sessions::Entity",
         from = "Column::Session",

entity/src/entities/histories.rs

@@ -6,5 +6,8 @@ pub mod histories;
 pub mod puzzles;
 pub mod sessions;
 
+/// The number of letters in the puzzle.
 pub const PUZZLE_LETTERS_COUNT: usize = 5;
+
+/// The maximum number of tries allowed for a puzzle.
 pub const HISTORY_MAX_TRIES: usize = 6;

entity/src/entities/mod.rs

@@ -1,42 +1,44 @@
 //! `SeaORM` Entity, @generated by sea-orm-codegen 1.1.14
 
+#![allow(clippy::exhaustive_enums, unused_qualifications)]
+
 use crate::{PUZZLE_LETTERS_COUNT, PuzzleDate, PuzzleSolution};
 
 use std::fmt::Display;
 
 use sea_orm::entity::prelude::*;
 use serde::{Deserialize, Serialize};
 
+/// The `puzzles` table model.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, DeriveEntityModel)]
 #[sea_orm(table_name = "puzzles")]
 pub struct Model {
+    /// The puzzle date.
     #[sea_orm(primary_key, auto_increment = false)]
     pub date: PuzzleDate,
+    /// The puzzle solution.
     pub solution: PuzzleSolution,
-    pub is_deleted: bool,
 }
 
 impl Display for Model {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(
-            f,
-            "{} [{} {}]",
-            self.solution,
-            self.date,
-            if self.is_deleted { "-" } else { "+" }
-        )
+        write!(f, "{} [{}]", self.solution, self.date,)
     }
 }
 
 impl Model {
+    /// Converts this puzzle model into a [`ResultPuzzle`].
     pub fn to_result_puzzle(self) -> ResultPuzzle {
         self.into()
     }
 }
 
+/// A puzzle result containing the date and solution.
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
 pub struct ResultPuzzle<const N: usize = PUZZLE_LETTERS_COUNT> {
+    /// The puzzle date.
     pub date: PuzzleDate,
+    /// The puzzle solution.
     pub solution: PuzzleSolution<N>,
 }
 
@@ -52,8 +54,10 @@ impl From<Model> for ResultPuzzle<PUZZLE_LETTERS_COUNT> {
     }
 }
 
+/// The relations of the `puzzles` table.
 #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
 pub enum Relation {
+    /// The relation to the `histories` table.
     #[sea_orm(has_many = "super::histories::Entity")]
     Histories,
 }

entity/src/entities/puzzles.rs

@@ -1,19 +1,27 @@
 //! `SeaORM` Entity, @generated by sea-orm-codegen 1.1.14
 
+#![allow(clippy::exhaustive_enums, unused_qualifications)]
+
 use sea_orm::entity::prelude::*;
 use serde::{Deserialize, Serialize};
 
+/// The `sessions` table model.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, DeriveEntityModel)]
 #[sea_orm(table_name = "sessions")]
 pub struct Model {
+    /// The session token.
     #[sea_orm(primary_key, auto_increment = false)]
     pub session: String,
+    /// The timestamp when this session was created.
     pub created_at: DateTime,
+    /// The timestamp when this session was last updated.
     pub updated_at: DateTime,
 }
 
+/// The relations of the `sessions` table.
 #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
 pub enum Relation {
+    /// The relation to the `histories` table.
     #[sea_orm(has_many = "super::histories::Entity")]
     Histories,
 }