Remove unnecessary mut and document possible panic

Bump tempfile from 3.7.1 to 3.8.0

.github/workflows/audit.yml

@@ -16,6 +16,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions-rs/audit-check@v1
+      - uses: rustsec/audit-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/rust.yml

@@ -16,18 +16,11 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
-          components: rustfmt
 
       - name: Check Formatting
-        uses: actions-rs/cargo@v1
+        run: cargo fmt --all -- --check
-        with:
+
-          command: fmt
-          args: --all -- --check
 
   clippy:
     name: Clippy
@@ -37,12 +30,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
-          components: rustfmt
 
       - name: Cache cargo registry, index and build directory
         uses: actions/cache@v3
@@ -54,10 +42,9 @@ jobs:
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Clippy Linting
-        uses: actions-rs/cargo@v1
+        run: cargo clippy --all-features -- -Dclippy::all -Dclippy::pedantic
-        with:
+      - name: Clippy Test Linting
-          command: clippy
+        run: cargo clippy --tests -- -Dclippy::all -Dclippy::pedantic
-          args: -- -D warnings
 
 
   test:
@@ -74,11 +61,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
-        with:
-          toolchain: stable
-          profile: minimal
-          override: true
 
       - name: Cache cargo registry, index and build directory
         uses: actions/cache@v3
@@ -90,6 +73,4 @@ jobs:
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Run Tests
-        uses: actions-rs/cargo@v1
+        run: cargo test
-        with:
-          command: test

CHANGELOG.md

@@ -5,9 +5,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Dependencies
-- Bump `serde` from 1.0.160 to 1.0.163 (#613, #617)
+- Bump `serde` from 1.0.160 to 1.0.183 (#613, #617, #627, #636, #639, #640, #645, [#648](https://github.com/vbrandl/hoc/pull/648), [#650](https://github.com/vbrandl/hoc/pull/650), [#652](https://github.com/vbrandl/hoc/pull/652), [#653](https://github.com/vbrandl/hoc/pull/653), [#654](https://github.com/vbrandl/hoc/pull/654), [#655](https://github.com/vbrandl/hoc/pull/655), [#657](https://github.com/vbrandl/hoc/pull/657))
 - Bump `actions/cache` from 2 to 3 (#616)
-- Bump `tokio` from 1.28.0 to 1.28.1 (#618)
+- Bump `tokio` from 1.28.0 to 1.32.0 (#618, #625, #633, #634, [#659](https://github.com/vbrandl/hoc/pull/659), [#660](https://github.com/vbrandl/hoc/pull/660), [#665](https://github.com/vbrandl/hoc/pull/665))
+- Bump `reqwest` from 0.11.17 to 0.11.18 (#619)
+- Bump `vergen` from 8.1.3 to 8.2.4 (#621, #622, #635, #638)
+- Bump `tracing-actix-web` from 0.7.4 to 0.7.6 (#623, [#656](https://github.com/vbrandl/hoc/pull/656))
+- Bump `git2` from 0.17.1 to 0.17.2 (#624)
+- Bump `tempfile` from 3.5.0 to 3.8.0 (#626, [#646](https://github.com/vbrandl/hoc/pull/646), [#658](https://github.com/vbrandl/hoc/pull/658), [#667](https://github.com/vbrandl/hoc/pull/667))
+- Bump `serde_json` from 1.0.96 to 1.0.105 (#630, #632, #637, #641, #644, [#649](https://github.com/vbrandl/hoc/pull/649), [#663](https://github.com/vbrandl/hoc/pull/663))
+- Bump `openssl` from 0.10.50 to 0.10.55 (#631)
+- Bump `tracing-bunyan-formatter` from 0.3.7 to 0.3.9 (#642, [#661](https://github.com/vbrandl/hoc/pull/661))
+- Bump `anyhow` from 1.0.71 to 1.0.75 (#643, [#662](https://github.com/vbrandl/hoc/pull/662), [#664](https://github.com/vbrandl/hoc/pull/664))
+- Bump `ructe` from 0.16.1 to 0.17.0 ([#647](https://github.com/vbrandl/hoc/pull/647))
 
 
 ## [0.35.0] 2023-05-04

Cargo.toml

@@ -19,30 +19,30 @@ badgers = "1.2.0"
 bytes = "1.4.0"
 config = { version = "0.13.3", features = ["toml"] }
 dotenvy = "0.15.7"
-futures = "0.3.27"
+futures = "0.3.28"
-git2 = "0.17.1"
+git2 = "0.17.2"
 lazy_static = "1.4.0"
 mime = "0.3"
 number_prefix = "0.4.0"
 openssl-probe = "0.1.5"
-reqwest = "0.11.17"
+reqwest = "0.11.18"
-serde = "1.0.163"
+serde = "1.0.183"
-serde_derive = "1.0.137"
+serde_derive = "1.0.166"
-serde_json = "1.0.94"
+serde_json = "1.0.105"
 tracing = "0.1.37"
-tracing-actix-web = "0.7.3"
+tracing-actix-web = "0.7.6"
-tracing-bunyan-formatter = "0.3.6"
+tracing-bunyan-formatter = "0.3.9"
 tracing-futures = "0.2.5"
 tracing-log = "0.1.3"
 tracing-subscriber = { version = "0.3.17", features = ["registry", "env-filter"] }
 
 [build-dependencies]
-anyhow = "1.0.71"
+anyhow = "1.0.75"
-ructe = { version = "0.16.1", features = ["mime03"] }
+ructe = { version = "0.17.0", features = ["mime03"] }
-vergen = { version = "8.1.3", default-features = false, features = ["git", "gitoxide"] }
+vergen = { version = "8.2.4", default-features = false, features = ["git", "gitoxide"] }
 
 [dev-dependencies]
 awc = "3.1.1"
-ructe = "0.16.1"
+ructe = "0.17.0"
-tempfile = "3.5.0"
+tempfile = "3.8.0"
-tokio = "1.28.1"
+tokio = "1.32.0"

src/cache.rs

@@ -36,10 +36,10 @@ impl<'a> CacheState<'a> {
         trace!("Reading cache");
         if path.as_ref().exists() {
             let cache: Cache = serde_json::from_reader(BufReader::new(File::open(path)?))?;
-            Ok(cache
+            Ok(cache.entries.get(branch).map_or_else(
-                .entries
+                // TODO: get rid of clone
-                .get(branch)
+                || CacheState::NoneForBranch(cache.clone()),
-                .map(|c| {
+                |c| {
                     if c.head == head {
                         trace!("Cache is up to date");
                         CacheState::Current {
@@ -56,9 +56,8 @@ impl<'a> CacheState<'a> {
                             cache: cache.clone(),
                         }
                     }
-                })
+                },
-                // TODO: get rid of clone
+            ))
-                .unwrap_or_else(|| CacheState::NoneForBranch(cache.clone())))
         } else {
             Ok(CacheState::No)
         }
@@ -75,7 +74,7 @@ impl<'a> CacheState<'a> {
         trace!("Calculating new cache");
         match self {
             CacheState::Old { mut cache, .. } => {
-                if let Some(mut cache) = cache.entries.get_mut(branch) {
+                if let Some(cache) = cache.entries.get_mut(branch) {
                     cache.head = head;
                     cache.count += count;
                     cache.commits += commits;

src/config.rs

@@ -18,6 +18,12 @@ pub struct Settings {
 }
 
 impl Settings {
+    /// Load the configuration from file and environment.
+    ///
+    /// # Errors
+    ///
+    /// * File cannot be read or parsed
+    /// * Environment variables cannot be parsed
     pub fn load() -> Result<Self, ConfigError> {
         Config::builder()
             .add_source(File::with_name("hoc.toml").required(false))

src/error.rs

@@ -41,17 +41,14 @@ impl ResponseError for Error {
 
     fn error_response(&self) -> HttpResponse {
         let mut buf = Vec::new();
-        match self {
+        if let Error::BranchNotFound = self {
-            Error::BranchNotFound => {
+            templates::p404_no_master_html(&mut buf, VERSION_INFO, 0).unwrap();
-                templates::p404_no_master_html(&mut buf, VERSION_INFO, 0).unwrap();
+            HttpResponse::NotFound().content_type("text/html").body(buf)
-                HttpResponse::NotFound().content_type("text/html").body(buf)
+        } else {
-            }
+            templates::p500_html(&mut buf, VERSION_INFO, 0).unwrap();
-            _ => {
+            HttpResponse::InternalServerError()
-                templates::p500_html(&mut buf, VERSION_INFO, 0).unwrap();
+                .content_type("text/html")
-                HttpResponse::InternalServerError()
+                .body(buf)
-                    .content_type("text/html")
-                    .body(buf)
-            }
         }
     }
 }

src/lib.rs

@@ -22,7 +22,7 @@ use crate::{
     cache::CacheState,
     config::Settings,
     error::{Error, Result},
-    service::{Bitbucket, FormService, GitHub, Gitlab, Service, Sourcehut},
+    service::{Bitbucket, FormValue, GitHub, Gitlab, Service, Sourcehut},
     statics::{CLIENT, VERSION_INFO},
     template::{RepoGeneratorInfo, RepoInfo},
 };
@@ -53,7 +53,7 @@ include!(concat!(env!("OUT_DIR"), "/templates.rs"));
 
 #[derive(Deserialize, Serialize)]
 struct GeneratorForm<'a> {
-    service: FormService,
+    service: FormValue,
     user: Cow<'a, str>,
     repo: Cow<'a, str>,
     branch: Option<Cow<'a, str>>,
@@ -282,6 +282,7 @@ where
         }
         pull(&path)?;
         let (hoc, head, commits) = hoc(&service_url, &state.repos(), &state.cache(), branch)?;
+        #[allow(clippy::cast_precision_loss)]
         let hoc_pretty = match NumberPrefix::decimal(hoc as f64) {
             NumberPrefix::Standalone(hoc) => hoc.to_string(),
             NumberPrefix::Prefixed(prefix, hoc) => format!("{hoc:.1}{prefix}"),
@@ -309,7 +310,7 @@ pub(crate) async fn json_hoc<T: Service>(
     let branch = branch.branch.as_deref().unwrap_or("master");
     let rc_clone = repo_count.clone();
     let mapper = move |r| match r {
-        HocResult::NotFound => p404(rc_clone),
+        HocResult::NotFound => p404(&rc_clone),
         HocResult::Hoc {
             hoc, head, commits, ..
         } => Ok(HttpResponse::Ok().json(JsonResponse {
@@ -345,7 +346,7 @@ pub(crate) async fn calculate_hoc<T: Service>(
     let rc_clone = repo_count.clone();
     let label = query.label.clone();
     let mapper = move |r| match r {
-        HocResult::NotFound => p404(rc_clone),
+        HocResult::NotFound => p404(&rc_clone),
         HocResult::Hoc { hoc_pretty, .. } => {
             let badge_opt = BadgeOptions {
                 subject: label,
@@ -386,7 +387,7 @@ async fn overview<T: Service>(
     let base_url = state.settings.base_url.clone();
     let rc_clone = repo_count.clone();
     let mapper = move |r| match r {
-        HocResult::NotFound => p404(rc_clone),
+        HocResult::NotFound => p404(&rc_clone),
         HocResult::Hoc {
             hoc,
             commits,
@@ -413,7 +414,7 @@ async fn overview<T: Service>(
                 VERSION_INFO,
                 rc_clone.load(Ordering::Relaxed),
                 repo_info,
-                label,
+                &label,
             )?;
 
             Ok(HttpResponse::Ok().content_type("text/html").body(buf))
@@ -423,11 +424,13 @@ async fn overview<T: Service>(
 }
 
 #[get("/health_check")]
+#[allow(clippy::unused_async)]
 async fn health_check() -> HttpResponse {
     HttpResponse::Ok().finish()
 }
 
 #[get("/")]
+#[allow(clippy::unused_async)]
 async fn index(
     state: web::Data<State>,
     repo_count: web::Data<AtomicUsize>,
@@ -443,6 +446,7 @@ async fn index(
 }
 
 #[post("/generate")]
+#[allow(clippy::unused_async)]
 async fn generate(
     params: web::Form<GeneratorForm<'_>>,
     state: web::Data<State>,
@@ -470,20 +474,22 @@ async fn generate(
     Ok(HttpResponse::Ok().content_type("text/html").body(buf))
 }
 
-fn p404(repo_count: web::Data<AtomicUsize>) -> Result<HttpResponse> {
+fn p404(repo_count: &web::Data<AtomicUsize>) -> Result<HttpResponse> {
     let mut buf = Vec::new();
     templates::p404_html(&mut buf, VERSION_INFO, repo_count.load(Ordering::Relaxed))?;
     Ok(HttpResponse::NotFound().content_type("text/html").body(buf))
 }
 
+#[allow(clippy::unused_async)]
 async fn async_p404(repo_count: web::Data<AtomicUsize>) -> Result<HttpResponse> {
-    p404(repo_count)
+    p404(&repo_count)
 }
 
 /// A duration to add to current time for a far expires header.
 static FAR: Duration = Duration::from_secs(180 * 24 * 60 * 60);
 
 #[get("/static/{filename}")]
+#[allow(clippy::unused_async)]
 async fn static_file(
     path: web::Path<String>,
     repo_count: web::Data<AtomicUsize>,
@@ -496,11 +502,11 @@ async fn static_file(
                 .content_type(data.mime.clone())
                 .body(data.content)
         })
-        .map(Result::Ok)
+        .map_or_else(|| p404(&repo_count), Result::Ok)
-        .unwrap_or_else(|| p404(repo_count))
 }
 
 #[get("/favicon.ico")]
+#[allow(clippy::unused_async)]
 async fn favicon32() -> HttpResponse {
     let data = &template_statics::favicon32_png;
     HttpResponse::Ok()
@@ -508,6 +514,7 @@ async fn favicon32() -> HttpResponse {
         .body(data.content)
 }
 
+#[allow(clippy::unused_async)]
 async fn start_server(listener: TcpListener, settings: Settings) -> std::io::Result<Server> {
     let workers = settings.workers;
     let repo_count =
@@ -536,6 +543,11 @@ async fn start_server(listener: TcpListener, settings: Settings) -> std::io::Res
     .run())
 }
 
+/// Start the server.
+///
+/// # Errors
+///
+/// * server cannot bind to `listener`
 pub async fn run(listener: TcpListener, settings: Settings) -> std::io::Result<Server> {
     let span = info_span!("hoc", version = env!("CARGO_PKG_VERSION"));
     let _ = span.enter();

src/main.rs

@@ -6,7 +6,7 @@ fn init() {
     dotenvy::dotenv().ok();
     openssl_probe::init_ssl_cert_env_vars();
 
-    telemetry::init_subscriber(telemetry::get_subscriber("hoc", "info"))
+    telemetry::init_subscriber(telemetry::get_subscriber("hoc", "info"));
 }
 
 #[actix_rt::main]

src/service.rs

@@ -29,7 +29,7 @@ pub(crate) trait Service: Sized + 'static {
 }
 
 #[derive(Deserialize, Serialize, Clone, Copy)]
-pub enum FormService {
+pub enum FormValue {
     #[serde(rename = "github")]
     GitHub,
     #[serde(rename = "gitlab")]
@@ -40,22 +40,22 @@ pub enum FormService {
     Sourcehut,
 }
 
-impl FormService {
+impl FormValue {
     pub(crate) fn url(&self) -> &str {
         match self {
-            FormService::GitHub => "github.com",
+            FormValue::GitHub => "github.com",
-            FormService::Gitlab => "gitlab.com",
+            FormValue::Gitlab => "gitlab.com",
-            FormService::Bitbucket => "bitbucket.org",
+            FormValue::Bitbucket => "bitbucket.org",
-            FormService::Sourcehut => "git.sr.ht",
+            FormValue::Sourcehut => "git.sr.ht",
         }
     }
 
     pub(crate) fn service(&self) -> &str {
         match self {
-            FormService::GitHub => "github",
+            FormValue::GitHub => "github",
-            FormService::Gitlab => "gitlab",
+            FormValue::Gitlab => "gitlab",
-            FormService::Bitbucket => "bitbucket",
+            FormValue::Bitbucket => "bitbucket",
-            FormService::Sourcehut => "sourcehut",
+            FormValue::Sourcehut => "sourcehut",
         }
     }
 }

src/statics.rs

@@ -1,3 +1,4 @@
+#[derive(Clone, Copy)]
 pub struct VersionInfo<'a> {
     pub commit: &'a str,
     pub version: &'a str,

src/telemetry.rs

@@ -15,6 +15,10 @@ pub fn get_subscriber(name: &str, env_filter: &str) -> impl Subscriber + Send +
         .with(formatting_layer)
 }
 
+/// # Panics
+///
+/// This panics if the `LogTracer` cannot be initialized or `subscriber` cannot be set as global
+/// default.
 pub fn init_subscriber(subscriber: impl Subscriber + Send + Sync) {
     LogTracer::init().expect("Failed to set logger");
     set_global_default(subscriber).expect("Failed to set tracing subscriber");

src/template.rs

@@ -1,5 +1,6 @@
-use crate::service::FormService;
+use crate::service::FormValue;
 
+#[derive(Clone, Copy)]
 pub struct RepoInfo<'a> {
     pub commit_url: &'a str,
     pub commits: u64,
@@ -13,7 +14,7 @@ pub struct RepoInfo<'a> {
 }
 
 pub struct RepoGeneratorInfo<'a> {
-    pub service: FormService,
+    pub service: FormValue,
     pub user: &'a str,
     pub repo: &'a str,
     pub branch: &'a str,

templates/base.rs.html

@@ -1,4 +1,4 @@
-@use super::statics::*;
+@use super::statics::tacit_css_min_css;
 @use crate::statics::VersionInfo;
 
 @(title: &str, header: &str, content: Content, version_info: VersionInfo, repo_count: usize)

templates/overview.rs.html

@@ -2,7 +2,7 @@
 @use crate::statics::VersionInfo;
 @use crate::template::RepoInfo;
 
-@(version_info: VersionInfo, repo_count: usize, repo_info: RepoInfo, label: String)
+@(version_info: VersionInfo, repo_count: usize, repo_info: RepoInfo, label: &str)
 
 @:base_html("Hits-of-Code Badges", "Overview", {
 

tests/count.rs

@@ -5,14 +5,14 @@ use tempfile::TempDir;
 #[test]
 fn no_repos() {
     let repos = TempDir::new().unwrap();
-    assert_eq!(0, count_repositories(&repos).unwrap())
+    assert_eq!(0, count_repositories(&repos).unwrap());
 }
 
 #[test]
 fn no_repos_for_provider() {
     let repos = TempDir::new().unwrap();
     let _provider = TempDir::new_in(&repos).unwrap();
-    assert_eq!(0, count_repositories(&repos).unwrap())
+    assert_eq!(0, count_repositories(&repos).unwrap());
 }
 
 #[test]
@@ -20,7 +20,7 @@ fn no_repos_for_owner() {
     let repos = TempDir::new().unwrap();
     let provider = TempDir::new_in(&repos).unwrap();
     let _owner = TempDir::new_in(&provider).unwrap();
-    assert_eq!(0, count_repositories(&repos).unwrap())
+    assert_eq!(0, count_repositories(&repos).unwrap());
 }
 
 #[test]
@@ -29,7 +29,7 @@ fn one_repo_for_owner() {
     let provider = TempDir::new_in(&repos).unwrap();
     let owner = TempDir::new_in(&provider).unwrap();
     let _repo = TempDir::new_in(&owner).unwrap();
-    assert_eq!(1, count_repositories(&repos).unwrap())
+    assert_eq!(1, count_repositories(&repos).unwrap());
 }
 
 #[test]
@@ -39,7 +39,7 @@ fn two_repos_for_owner() {
     let owner = TempDir::new_in(&provider).unwrap();
     let _repo1 = TempDir::new_in(&owner).unwrap();
     let _repo2 = TempDir::new_in(&owner).unwrap();
-    assert_eq!(2, count_repositories(&repos).unwrap())
+    assert_eq!(2, count_repositories(&repos).unwrap());
 }
 
 #[test]
@@ -51,7 +51,7 @@ fn two_repos_for_two_providers() {
     let provider2 = TempDir::new_in(&repos).unwrap();
     let owner2 = TempDir::new_in(&provider2).unwrap();
     let _repo2 = TempDir::new_in(&owner2).unwrap();
-    assert_eq!(2, count_repositories(&repos).unwrap())
+    assert_eq!(2, count_repositories(&repos).unwrap());
 }
 
 #[test]
@@ -62,5 +62,5 @@ fn two_subdirs_in_one_repo() {
     let repo = TempDir::new_in(&owner).unwrap();
     let _subdir1 = TempDir::new_in(&repo).unwrap();
     let _subdir2 = TempDir::new_in(&repo).unwrap();
-    assert_eq!(1, count_repositories(&repos).unwrap())
+    assert_eq!(1, count_repositories(&repos).unwrap());
 }

tests/util/mod.rs

@@ -25,24 +25,26 @@ pub async fn spawn_app() -> TestApp {
     let listener = TcpListener::bind("127.0.0.1:0").expect("Failed to bind random port");
 
     let port = listener.local_addr().unwrap().port();
-    let address = format!("http://127.0.0.1:{}", port);
+    let address = format!("http://127.0.0.1:{port}");
 
-    let _repo_dir = tempdir().expect("Cannot create repo_dir");
+    let repo_dir = tempdir().expect("Cannot create repo_dir");
-    let _cache_dir = tempdir().expect("Cannot create cache_dir");
+    let cache_dir = tempdir().expect("Cannot create cache_dir");
 
     let mut settings = Settings::load().expect("Failed to read configuration.");
-    settings.repodir = _repo_dir.path().to_path_buf();
+    settings.repodir = repo_dir.path().to_path_buf();
-    settings.cachedir = _cache_dir.path().to_path_buf();
+    settings.cachedir = cache_dir.path().to_path_buf();
 
     let server = hoc::run(listener, settings)
         .await
         .expect("Failed to bind address");
 
+    #[allow(clippy::let_underscore_future)]
+    // don't await so the test server runs in the background
     let _ = tokio::spawn(server);
 
     TestApp {
         address,
-        _repo_dir,
+        _repo_dir: repo_dir,
-        _cache_dir,
+        _cache_dir: cache_dir,
     }
 }