improvement: Use State extension (#28)

* feat: Use `State` extension

* chore(nix): Remove unused flake input

* chore(actions): Bump base and other actions

* fix(nix): Docker build error

* chore(action): Run actions on push

.github/workflows/release.yml

@@ -17,14 +17,14 @@ on:
 jobs:
  create-release:
  name: Create release
- runs-on: ubuntu-20.04
+ runs-on: ubuntu-22.04
 
  steps:
  - name: Checkout repo
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
 
  - name: Setup Nix
- uses: cachix/install-nix-action@v15
+ uses: cachix/install-nix-action@v19
  with:
  extra_nix_config: |
  access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
@@ -35,6 +35,9 @@ jobs:
  username: ${{ secrets.DOCKER_HUB_USERNAME }}
  password: ${{ secrets.DOCKER_HUB_PASSWORD }}
 
+ - name: Sanity check
+ run: nix flake check
+
  # DOCKER IMAGE
 
  - name: Build image

.github/workflows/test.yml

@@ -12,17 +12,31 @@ on:
  - 'src/**/*'
  - 'public/purify.min.js'
 
+ push:
+ branches: [ main ]
+ paths:
+ - '.github/workflows/test.yml'
+ - 'flake.*'
+ - 'nix/*'
+ - 'Cargo.*'
+ - 'assets/**/*'
+ - 'src/**/*'
+ - 'public/purify.min.js'
+
 jobs:
  test:
  name: Build & test
- runs-on: ubuntu-20.04
+ runs-on: ubuntu-22.04
 
  steps:
  - name: Checkout repo
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
 
  - name: Setup Nix
- uses: cachix/install-nix-action@v15
+ uses: cachix/install-nix-action@v19
+
+ - name: Sanity check
+ run: nix flake check
 
  - name: Build & test
  run: |

flake.nix

@@ -2,24 +2,15 @@
  description = "A URL shortener, except emojis";
 
  inputs = {
- nixpkgs.url = "github:NixOS/nixpkgs";
- nixospkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+ nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
  devenv.url = "github:cachix/devenv";
-
- naersk = {
- url = "github:nix-community/naersk";
- inputs.nixpkgs.follows = "nixpkgs";
- };
-
- pre-commit-hooks = {
- url = "github:cachix/pre-commit-hooks.nix";
- inputs.nixpkgs.follows = "nixpkgs";
- };
+ naersk.url = "github:nix-community/naersk";
+ pre-commit-hooks.url = "github:cachix/pre-commit-hooks.nix";
  };
 
- outputs = { self, nixpkgs, nixospkgs, devenv, naersk, pre-commit-hooks } @ inputs: (
+ outputs = { self, nixpkgs, devenv, naersk, pre-commit-hooks } @ inputs: (
  let system = "x86_64-linux";
- pkgs = nixospkgs.legacyPackages.${system};
+ pkgs = nixpkgs.legacyPackages.${system};
 
  naersk-lib = naersk.lib.${system}.override {
  cargo = pkgs.cargo;
@@ -89,7 +80,7 @@
  program = "${self.packages.${system}.emojied}/bin/emojied";
  };
 
- nixosModule = import ./nix/modules/services/emojied.nix;
+ nixosModules.default = import ./nix/modules/services/emojied.nix;
 
  devShells.${system}.default = devenv.lib.mkShell {
  inherit inputs pkgs;

src/controllers.rs

@@ -1,4 +1,4 @@
-use axum::extract::{Extension, Form, Path, Query};
+use axum::extract::{Form, Path, Query, State};
 use axum::http::StatusCode;
 use axum::response::Json;
 use hyper::{
@@ -11,10 +11,10 @@ use std::collections::HashMap;
 use std::fs;
 use std::sync::Arc;
 
-use crate::config::AppConfig;
+use crate::state::AppState;
 use crate::url::CreateUrl;
 use crate::views::url::{AutogeneratedUrl, CustomUrl, RootData};
-use crate::{db, emoji, leaderboard, url, views};
+use crate::{emoji, leaderboard, url, views};
 
 // TODO: Move stuff to their own modules
 // TODO: Implement SSE for URL stats page
@@ -29,13 +29,13 @@ pub async fn root(Query(params): Query<HashMap<String, String>>) -> Markup {
 }
 
 pub async fn insert_url(
- Extension(handle): Extension<Arc<db::Handle>>,
+ State(app_state): State<Arc<AppState>>,
  Query(params): Query<HashMap<String, String>>,
  Form(form_data): Form<CreateUrl>,
 ) -> (StatusCode, Markup) {
  let custom_url = params.get(&String::from("custom_url")).is_some();
 
- match url::insert_url(&*handle, form_data).await {
+ match url::insert_url(&(*app_state).db_handle, form_data).await {
  Ok(i) => {
  let root_data = if custom_url {
  RootData::Custom(CustomUrl::HasIdentifier(i))
@@ -62,10 +62,10 @@ pub async fn insert_url(
 }
 
 pub async fn rpc_insert_url(
- Extension(handle): Extension<Arc<db::Handle>>,
+ State(app_state): State<Arc<AppState>>,
  Json(data): Json<CreateUrl>,
 ) -> (StatusCode, Json<Value>) {
- match url::insert_url(&*handle, data).await {
+ match url::insert_url(&(*app_state).db_handle, data).await {
  Ok(identifier) => (
  StatusCode::CREATED,
  Json(json!({ "identifier": identifier })),
@@ -75,10 +75,10 @@ pub async fn rpc_insert_url(
 }
 
 pub async fn url_stats(
- Extension(handle): Extension<Arc<db::Handle>>,
+ State(app_state): State<Arc<AppState>>,
  Path(identifier): Path<String>,
 ) -> (StatusCode, Markup) {
- match url::url_stats(&*handle, identifier).await {
+ match url::url_stats(&(*app_state).db_handle, identifier).await {
  Ok(url_stat) => (StatusCode::OK, views::url::view_stats(&url_stat)),
  Err(_e) => {
  // TODO: Give back 50x when it's a problem with the DB
@@ -88,13 +88,13 @@ pub async fn url_stats(
 }
 
 pub async fn fetch_url(
- Extension(handle): Extension<Arc<db::Handle>>,
+ State(app_state): State<Arc<AppState>>,
  Path(identifier): Path<String>,
 ) -> (StatusCode, HeaderMap, Markup) {
  let mut headers = HeaderMap::new();
 
  if emoji::is_valid(&identifier) {
- match url::fetch_url(&*handle, identifier).await {
+ match url::fetch_url(&(*app_state).db_handle, identifier).await {
  Ok(u) => {
  headers.insert(LOCATION, u.parse().unwrap());
 
@@ -109,19 +109,17 @@ pub async fn fetch_url(
  }
 }
 
-pub async fn leaderboard(Extension(handle): Extension<Arc<db::Handle>>) -> (StatusCode, Markup) {
- match leaderboard::fetch(&*handle).await {
+pub async fn leaderboard(State(app_state): State<Arc<AppState>>) -> (StatusCode, Markup) {
+ match leaderboard::fetch(&(*app_state).db_handle).await {
  Ok(entries) => (StatusCode::OK, views::leaderboard::render(entries)),
  Err(_e) => (StatusCode::INTERNAL_SERVER_ERROR, maud::html! {}),
  }
 }
 
 // TODO: Static assets controller
-pub async fn js(
- Extension(config): Extension<Arc<AppConfig>>
-) -> (StatusCode, HeaderMap, String) {
+pub async fn js(State(app_state): State<Arc<AppState>>) -> (StatusCode, HeaderMap, String) {
  let mut headers = HeaderMap::new();
- let mut static_assets_path = config.static_assets_path.clone();
+ let mut static_assets_path = (*app_state).config.static_assets_path.clone();
 
  static_assets_path.push("app.js");
 
@@ -139,11 +137,9 @@ pub async fn js(
  }
 }
 
-pub async fn purifyjs(
- Extension(config): Extension<Arc<AppConfig>>
-) -> (StatusCode, HeaderMap, String) {
+pub async fn purifyjs(State(app_state): State<Arc<AppState>>) -> (StatusCode, HeaderMap, String) {
  let mut headers = HeaderMap::new();
- let mut static_assets_path = config.static_assets_path.clone();
+ let mut static_assets_path = (*app_state).config.static_assets_path.clone();
 
  static_assets_path.push("purify.min.js");
 
@@ -161,11 +157,9 @@ pub async fn purifyjs(
  }
 }
 
-pub async fn stylesheet(
- Extension(config): Extension<Arc<AppConfig>>
-) -> (StatusCode, HeaderMap, String) {
+pub async fn stylesheet(State(app_state): State<Arc<AppState>>) -> (StatusCode, HeaderMap, String) {
  let mut headers = HeaderMap::new();
- let mut static_assets_path = config.static_assets_path.clone();
+ let mut static_assets_path = (*app_state).config.static_assets_path.clone();
 
  static_assets_path.push("app.css");
 
@@ -226,33 +220,25 @@ fn parse_url_error(e: url::Error) -> (StatusCode, Json<Value>) {
  ),
  url::Error::MissingScheme => (
  StatusCode::BAD_REQUEST,
- Json(
- json!({
- "message": "URL must have a scheme. Valid schemes are: https, or http.\ne.g https://example.com",
- "type": "E008"
- }),
- ),
+ Json(json!({
+ "message": "URL must have a scheme. Valid schemes are: https, or http.\ne.g https://example.com",
+ "type": "E008"
+ })),
  ),
  url::Error::UnsupportedScheme => (
  StatusCode::BAD_REQUEST,
- Json(
- json!({
- "message": "Unsupported scheme. Acceptable schemes are: https, or http.\ne.g https://example.com",
- "type": "E009"
- }),
- ),
+ Json(json!({
+ "message": "Unsupported scheme. Acceptable schemes are: https, or http.\ne.g https://example.com",
+ "type": "E009"
+ })),
  ),
  url::Error::MissingHost => (
  StatusCode::BAD_REQUEST,
- Json(
- json!({"message": "URL host does not exist, or is invalid.", "type": "E010"}),
- ),
+ Json(json!({"message": "URL host does not exist, or is invalid.", "type": "E010"})),
  ),
  url::Error::MissingPath => (
  StatusCode::BAD_REQUEST,
- Json(
- json!({"message": "URL path does not exist, or is invalid.", "type": "E011"}),
- ),
+ Json(json!({"message": "URL path does not exist, or is invalid.", "type": "E011"})),
  ),
  }
 }

src/db.rs

@@ -5,6 +5,7 @@ use postgres_native_tls::MakeTlsConnector;
 use std::{fmt, io};
 use tokio_postgres::NoTls;
 
+#[derive(Clone)]
 pub struct Handle {
  pub pool: Pool,
 }