test: improve test coverage

feat: send confirmation email to sender
When users submit a contact form, they now receive a confirmation email acknowlledging receipt of their message. The backend also continues to send a notification email to the configured recipient. If the backend fails to send the acknowledgement email to the sender, it will assume the email is not valid and will therefore not transmit the contact request to the configured recipient. Changes: - Refactor `send_email()` to `send_emails()` that sends two emails: - Confirmation email from the submitter - Notification email to the configured recipient - Add `From<T>` implementations of various errors for new error type `ContactError`. - Errors now return a translation identifier for the frontend.
2025-11-15 23:23:33 +01:00 · 2025-11-15 23:23:33 +01:00
11 changed files with 81 additions and 82 deletions
--- a/.github/workflows/README.md
+++ b/.github/workflows/README.md
@@ -7,7 +7,7 @@ The `publish-docker.yml` workflow automatically builds and publishes Docker imag
 ### Triggers and Tagging Strategy

 | Event        | Condition                   | Published Tags         | Example           |
-|--------------|-----------------------------|------------------------|-------------------|
+|--------------+-----------------------------+------------------------+-------------------|
 | Tag push     | Tag pushed to `main` branch | `latest` + version tag | `latest`, `1.0.0` |
 | Branch push  | Push to `develop` branch    | `develop`              | `develop`         |
 | Pull request | PR opened or updated        | `pr<number>`           | `pr12`            |
@@ -18,7 +18,7 @@ The `publish-docker.yml` workflow automatically builds and publishes Docker imag
 Configure these secrets in your repository settings (`Settings` → `Secrets and variables` → `Actions`):

 | Secret Name         | Description                                 | Example Value                           |
-|---------------------|---------------------------------------------|-----------------------------------------|
+|---------------------+---------------------------------------------+-----------------------------------------|
 | `DOCKER_USERNAME`   | Username for Docker registry authentication | `phundrak`                              |
 | `DOCKER_PASSWORD`   | Password or token for Docker registry       | Personal Access Token (PAT) or password |
 | `CACHIX_AUTH_TOKEN` | (Optional) Token for Cachix caching         | Your Cachix auth token                  |
@@ -84,7 +84,7 @@ Cachix is a Nix binary cache that dramatically speeds up builds by caching build
 Configure these in the workflow's `env` section or as repository variables:

 | Variable           | Description                                    | Default Value | Example            |
-|--------------------|------------------------------------------------|---------------|--------------------|
+|--------------------+------------------------------------------------+---------------+--------------------|
 | `CACHIX_NAME`      | Name of the Cachix cache to use                | `devenv`      | `phundrak-dot-com` |
 | `CACHIX_SKIP_PUSH` | Whether to skip pushing artifacts to the cache | `true`        | `false`            |

--- a/.github/workflows/publish-docker.yml
+++ b/.github/workflows/publish-docker.yml
@@ -39,16 +39,6 @@ jobs:
          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
          skipPush: ${{ github.event_name == 'pull_request' }}

-      - name: Coverage
-        run: |
-            nix develop --no-pure-eval --command just coverage
-
-      - name: Sonar analysis
-        uses: SonarSource/sonarqube-scan-action@v6
-        env:
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
-
      - name: Build Docker image with Nix
        run: |
          echo "Building Docker image..."
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -134,26 +134,6 @@ dependencies = [
 "fs_extra",
 ]

-[[package]]
-name = "bakit"
-version = "0.1.0"
-dependencies = [
- "chrono",
- "config",
- "dotenvy",
- "governor",
- "lettre",
- "poem",
- "poem-openapi",
- "serde",
- "serde_json",
- "thiserror",
- "tokio",
- "tracing",
- "tracing-subscriber",
- "validator",
-]
-
 [[package]]
 name = "base64"
 version = "0.21.7"
@@ -1593,6 +1573,26 @@ dependencies = [
 "sha2",
 ]

+[[package]]
+name = "phundrak-dot-com-backend"
+version = "0.1.0"
+dependencies = [
+ "chrono",
+ "config",
+ "dotenvy",
+ "governor",
+ "lettre",
+ "poem",
+ "poem-openapi",
+ "serde",
+ "serde_json",
+ "thiserror",
+ "tokio",
+ "tracing",
+ "tracing-subscriber",
+ "validator",
+]
+
 [[package]]
 name = "pin-project"
 version = "0.4.30"
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "bakit"
+name = "phundrak-dot-com-backend"
 version = "0.1.0"
 edition = "2024"
 publish = false
@@ -11,7 +11,7 @@ path = "src/lib.rs"

 [[bin]]
 path = "src/main.rs"
-name = "bakit"
+name = "phundrak-dot-com-backend"

 [dependencies]
 chrono = { version = "0.4.42", features = ["serde"] }
--- a/README.md
+++ b/README.md
@@ -1,30 +1,44 @@
---
-include_toc: true
-gitea: none
---
+# phundrak.com Backend

-<h1 align="center">Bakit</h1>
-<div align="center">
- <strong>
-   A backend for my personal website
- </strong>
-</div>
-<br/>
+<!--toc:start-->
+- [phundrak.com Backend](#phundrakcom-backend)
+  - [Features](#features)
+  - [API Endpoints](#api-endpoints)
+  - [Configuration](#configuration)
+    - [Configuration Example](#configuration-example)
+    - [Rate Limiting](#rate-limiting)
+  - [Development](#development)
+    - [Prerequisites](#prerequisites)
+    - [Running the Server](#running-the-server)
+    - [Building](#building)
+  - [Testing](#testing)
+    - [Testing Notes](#testing-notes)
+  - [Code Quality](#code-quality)
+    - [Linting](#linting)
+    - [Continuous Checking with Bacon](#continuous-checking-with-bacon)
+  - [Code Style](#code-style)
+    - [Error Handling](#error-handling)
+    - [Logging](#logging)
+    - [Imports](#imports)
+    - [Testing Conventions](#testing-conventions)
+  - [Project Structure](#project-structure)
+  - [Architecture](#architecture)
+    - [Application Initialization Flow](#application-initialization-flow)
+    - [Email Handling](#email-handling)
+  - [Docker Deployment](#docker-deployment)
+    - [Using Pre-built Images](#using-pre-built-images)
+    - [Available Image Tags](#available-image-tags)
+    - [Building Images Locally](#building-images-locally)
+    - [Docker Compose Example](#docker-compose-example)
+  - [CI/CD Pipeline](#cicd-pipeline)
+    - [Automated Docker Publishing](#automated-docker-publishing)
+    - [Workflow Details](#workflow-details)
+    - [Registry Configuration](#registry-configuration)
+    - [Required Secrets](#required-secrets)
+  - [License](#license)
+<!--toc:end-->

-<div align="center">
-  <a href="https://sonar.phundrak.com/dashboard?id=bakit" target="_blank">
-    <img src="https://sonar.phundrak.com/api/project_badges/measure?project=bakit&metric=coverage&token=sqb_bda24bf36825576d6c6b76048044e103339c3c5f" alt="Sonar Coverage" />
-  </a>
-  <a href="https://sonar.phundrak.com/dashboard?id=bakit" target="_blank">
-    <img src="https://sonar.phundrak.com/api/project_badges/measure?project=bakit&metric=alert_status&token=sqb_bda24bf36825576d6c6b76048044e103339c3c5f" alt="Sonar Quality Gate Status" />
-  </a>
-  <a href="#license">
-    <img src="https://img.shields.io/badge/License-AGPL--3.0--only-blue" alt="License" />
-  </a>
-  <a href="https://www.gnu.org/software/emacs/" target="_blank">
-    <img src="https://img.shields.io/badge/Made%20with-GNU%2FEmacs-blueviolet.svg?logo=GNU%20Emacs&logoColor=white" alt="Made with GNU/Emacs" />
-  </a>
-</div>
+The backend for [phundrak.com](https://phundrak.com), built with Rust and the [Poem](https://github.com/poem-web/poem) web framework.

 ## Features

@@ -141,14 +155,14 @@ For optimized production builds:
 cargo build --release
 ```

-The compiled binary will be at `target/release/bakit`.
+The compiled binary will be at `target/release/backend`.

 **With Nix:**

 Build the backend binary:
 ```bash
 nix build .#backend
-# Binary available at: ./result/bin/bakit
+# Binary available at: ./result/bin/backend
 ```

 Build Docker images:
@@ -161,7 +175,7 @@ nix build .#backendDockerLatest

 # Load into Docker
 docker load < result
-# Image will be available as: localhost/phundrak/bakit:latest
+# Image will be available as: localhost/phundrak/backend-rust:latest
 ```

 The Nix build ensures reproducible builds with all dependencies pinned.
@@ -202,7 +216,6 @@ just coverage
 - Tests use `get_test_app()` helper for consistent test setup
 - Telemetry is automatically disabled during tests
 - Tests are organized in `#[cfg(test)]` modules within each file
- Email sending is tested using lettre's `StubTransport` for mocking SMTP operations

 ## Code Quality

@@ -281,15 +294,12 @@ backend/
 │   ├── startup.rs       # Application builder, server setup
 │   ├── settings.rs      # Configuration management
 │   ├── telemetry.rs     # Logging and tracing setup
-│   ├── errors.rs        # Error type re-exports
 │   ├── middleware/      # Custom middleware
 │   │   ├── mod.rs       # Middleware module
 │   │   └── rate_limit.rs # Rate limiting middleware
 │   └── route/           # API route handlers
 │       ├── mod.rs       # Route organization
-│       ├── contact/     # Contact form module
-│       │   ├── mod.rs   # Contact form endpoint
-│       │   └── errors.rs # Contact form error types
+│       ├── contact.rs   # Contact form endpoint
 │       ├── health.rs    # Health check endpoint
 │       └── meta.rs      # Metadata endpoint
 ├── settings/            # Configuration files
@@ -336,7 +346,7 @@ Docker images are automatically built and published via GitHub Actions to the co
 Pull and run the latest image:
 ```bash
 # Pull from Phundrak Labs (labs.phundrak.com)
-docker pull labs.phundrak.com/phundrak/bakit:latest
+docker pull labs.phundrak.com/phundrak/phundrak-dot-com-backend:latest

 # Run the container
 docker run -d \
@@ -349,7 +359,7 @@ docker run -d \
  -e APP__EMAIL__PASSWORD=your_password \
  -e APP__EMAIL__FROM="Contact Form <noreply@example.com>" \
  -e APP__EMAIL__RECIPIENT="Admin <admin@example.com>" \
-  labs.phundrak.com/phundrak/bakit:latest
+  labs.phundrak.com/phundrak/phundrak-dot-com-backend:latest
 ```

 ### Available Image Tags
@@ -367,7 +377,7 @@ Build with Nix (recommended for reproducibility):
 ```bash
 nix build .#backendDockerLatest
 docker load < result
-docker run -p 3100:3100 localhost/phundrak/bakit:latest
+docker run -p 3100:3100 localhost/phundrak/backend-rust:latest
 ```

 Build with Docker directly:
@@ -383,7 +393,7 @@ version: '3.8'

 services:
  backend:
-    image: labs.phundrak.com/phundrak/bakit:latest
+    image: labs.phundrak.com/phundrak/phundrak-dot-com-backend:latest
    ports:
      - "3100:3100"
    environment:
@@ -435,7 +445,7 @@ To use the published images, authenticate with the registry:
 echo $GITHUB_TOKEN | docker login labs.phundrak.com -u USERNAME --password-stdin

 # Pull the image
-docker pull labs.phundrak.com/phundrak/bakit:latest
+docker pull labs.phundrak.com/phundrak/phundrak-dot-com-backend:latest
 ```

 ### Required Secrets
@@ -449,4 +459,4 @@ See [.github/workflows/README.md](./.github/workflows/README.md) for detailed se

 ## License

-AGPL-3.0-only - See [LICENSE.md](./LICENSE.md) for full license information.
+AGPL-3.0-only - See the root repository for full license information.
--- a/settings/development.yaml
+++ b/settings/development.yaml
@@ -5,7 +5,7 @@ application:
  protocol: http
  host: 127.0.0.1
  base_url: http://127.0.0.1:3100
-  name: "bakit-dev"
+  name: "com.phundrak.backend.dev"

 email:
  host: localhost
--- a/settings/production.yaml
+++ b/settings/production.yaml
@@ -2,7 +2,7 @@ debug: false
 frontend_url: ""

 application:
-  name: "bakit-prod"
+  name: "com.phundrak.backend.prod"
  protocol: https
  host: 0.0.0.0
  base_url: ""
--- a/sonar-project.properties
+++ b/sonar-project.properties
@@ -1 +0,0 @@
-sonar.projectKey=bakit
--- a/src/main.rs
+++ b/src/main.rs
@@ -3,5 +3,5 @@
 #[cfg(not(tarpaulin_include))]
 #[tokio::main]
 async fn main() -> Result<(), std::io::Error> {
-    bakit::run(None).await
+    phundrak_dot_com_backend::run(None).await
 }
--- a/src/route/contact/errors.rs
+++ b/src/route/contact/errors.rs
@@ -268,7 +268,7 @@ mod tests {

    #[test]
    fn from_validation_errors_with_name_error() {
-        use validator::Validate;
+        use validator::{Validate, ValidationError};

        #[derive(Validate)]
        struct TestStruct {
--- a/src/route/contact/mod.rs
+++ b/src/route/contact/mod.rs
@@ -933,7 +933,7 @@ mod tests {
        assert!(result.is_err());
        match result.unwrap_err() {
            ContactError::CouldNotParseSettingsEmail(_) => (),
-            e => panic!("Expected CouldNotParseSettingsEmail, got {e:?}"),
+            e => panic!("Expected CouldNotParseSettingsEmail, got {:?}", e),
        }
    }

@@ -964,7 +964,7 @@ mod tests {
        assert!(result.is_err());
        match result.unwrap_err() {
            ContactError::CouldNotParseRequestEmailAddress(_) => (),
-            e => panic!("Expected CouldNotParseRequestEmailAddress, got {e:?}"),
+            e => panic!("Expected CouldNotParseRequestEmailAddress, got {:?}", e),
        }
    }

@@ -996,7 +996,7 @@ mod tests {
        assert!(result.is_err());
        match result.unwrap_err() {
            ContactError::CouldNotSendEmail(_) => (),
-            e => panic!("Expected CouldNotSendEmail, got {e:?}"),
+            e => panic!("Expected CouldNotSendEmail, got {:?}", e),
        }
    }
 }