Bump version (v0.17.1)

fix: remove redundant param in md url

.env.example

@@ -0,0 +1,7 @@
+HOC_REPODIR='./repos'
+HOC_CACHEDIR='./cache'
+HOC_PORT=8080
+HOC_HOST='0.0.0.0'
+HOC_WORKERS=4
+
+HOC_BASE_URL='http://0.0.0.0:8080'

.github/workflows/audit.yml

@@ -4,27 +4,24 @@ on:
     - cron: '0 1 * * *'
   push:
     paths:
-      - 'Cargo.toml'
-      - 'Cargo.lock'
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
   pull_request:
 
 jobs:
   security_audit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
-      - name: Cache cargo registry
-        uses: actions/cache@v1
+      - name: Cache cargo registry, index and build directory
+        uses: actions/cache@v2
         with:
-          path: /usr/share/rust/.cargo/registry
-          key: ${{ runner.os }}-cargo-registry
-
-      - name: Cache cargo index
-        uses: actions/cache@v1
-        with:
-          path: /usr/share/rust/.cargo/git
-          key: ${{ runner.os }}-cargo-index
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            ./target
+          key: audit-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - uses: actions-rs/audit-check@v1
         with:

.github/workflows/nix-build.yml

@@ -1,20 +0,0 @@
-name: "Nix Build"
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: cachix/install-nix-action@v8
-      - name: Cache nix store
-        uses: actions/cache@v1
-        with:
-          path: /nix
-          key: ${{ runner.os }}-nix-store
-      - uses: cachix/cachix-action@v5
-        with:
-          name: hitsofcode
-          signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
-          attributes: package

.github/workflows/release.yml

@@ -0,0 +1,76 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  publish:
+    name: Publishing for ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        rust: [stable]
+        include:
+          - os: macos-latest
+            artifact_prefix: macos
+            target: x86_64-apple-darwin
+            binary_postfix: ""
+          - os: ubuntu-latest
+            artifact_prefix: linux
+            target: x86_64-unknown-linux-gnu
+            binary_postfix: ""
+          - os: windows-latest
+            artifact_prefix: windows
+            target: x86_64-pc-windows-msvc
+            binary_postfix: ".exe"
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.rust }}
+          override: true
+
+      - name: Cache cargo registry, index and build directory
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            ./target
+          key: release-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cargo build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          toolchain: ${{ matrix.rust }}
+          args: --release --target ${{ matrix.target }}
+
+      - name: Packaging final binary
+        shell: bash
+        run: |
+          cd target/${{ matrix.target }}/release
+          strip hoc${{ matrix.binary_postfix }}
+          tar czvf hoc-${{ matrix.artifact_prefix }}.tar.gz hoc${{ matrix.binary_postfix }}
+
+          if [[ ${{ runner.os }} == 'Windows' ]]; then
+            certutil -hashfile hoc-${{ matrix.artifact_prefix }}.tar.gz sha256 | grep -E [A-Fa-f0-9]{64} > hoc-${{ matrix.artifact_prefix }}.sha256
+          else
+            shasum -a 256 hoc-${{ matrix.artifact_prefix }}.tar.gz > hoc-${{ matrix.artifact_prefix }}.sha256
+          fi
+
+      - name: Releasing assets
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            target/${{ matrix.target }}/release/hoc-${{ matrix.artifact_prefix }}.tar.gz
+            target/${{ matrix.target }}/release/hoc-${{ matrix.artifact_prefix }}.sha256
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/rust.yml

@@ -1,41 +1,30 @@
-name: Rust
-
 on: [push, pull_request]
 
 jobs:
-  lint:
-    name: Linting and Formatting Checks
+
+  rustfmt:
+    name: Rustfmt
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
 
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
+          profile: minimal
           override: true
+          components: rustfmt
 
-      - name: Install rustfmt
-        run: rustup component add rustfmt
-
-      - name: Cache cargo registry
-        uses: actions/cache@v1
+      - name: Cache cargo registry, index and build directory
+        uses: actions/cache@v2
         with:
-          path: ~/.cargo/registry
-          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
-
-      - name: Cache cargo index
-        uses: actions/cache@v1
-        with:
-          path: ~/.cargo/git
-          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
-
-      - name: Cache cargo build
-        uses: actions/cache@v1
-        with:
-          path: target
-          key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            ./target
+          key: rustfmt-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Check Formatting
         uses: actions-rs/cargo@v1
@@ -43,8 +32,29 @@ jobs:
           command: fmt
           args: --all -- --check
 
-      - name: Install clippy
-        run: rustup component add clippy
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+          components: rustfmt
+
+      - name: Cache cargo registry, index and build directory
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            ./target
+          key: clippy-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Clippy Linting
         uses: actions-rs/cargo@v1
@@ -52,8 +62,9 @@ jobs:
           command: clippy
           args: -- -D warnings
 
+
   test:
-    name: Run Tests
+    name: Test Suite
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -62,31 +73,23 @@ jobs:
 
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
 
       - name: Install stable toolchain
         uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
+          profile: minimal
           override: true
 
-      - name: Cache cargo registry
-        uses: actions/cache@v1
+      - name: Cache cargo registry, index and build directory
+        uses: actions/cache@v2
         with:
-          path: ~/.cargo/registry
-          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
-
-      - name: Cache cargo index
-        uses: actions/cache@v1
-        with:
-          path: ~/.cargo/git
-          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
-
-      - name: Cache cargo build
-        uses: actions/cache@v1
-        with:
-          path: target
-          key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            ./target
+          key: test-${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Run Tests
         uses: actions-rs/cargo@v1

.gitignore

@@ -4,3 +4,5 @@ repos
 cache
 hoc.log
 result
+hoc.toml
+.env

.travis.yml

@@ -1,17 +0,0 @@
-language: rust
-
-rust:
-  - stable
-  - beta
-  - nightly
-
-cache:
-  - cargo
-
-matrix:
-  allow_failures:
-    - rust: nightly
-
-notifications:
-  email:
-    on_failure: always

Cargo.toml

@@ -1,31 +1,34 @@
 [package]
 name = "hoc"
-version = "0.14.0"
+version = "0.17.1"
 authors = ["Valentin Brandl <vbrandl@riseup.net>"]
 edition = "2018"
 build = "build.rs"
 
 [dependencies]
-actix-web = "3.0.0"
+actix-rt = "1.1.1"
+actix-web = "3.3.2"
 badge = "0.3.0"
-bytes = "0.5.6"
-futures = "0.3.5"
-git2 = "0.13.11"
+bytes = "1.0.1"
+config = { version = "0.10.1", features = ["toml"] }
+dotenv = "0.15.0"
+futures = "0.3.13"
+git2 = "0.13.17"
 lazy_static = "1.4.0"
-log = "0.4.11"
-log4rs = "0.13.0"
 number_prefix = "0.4.0"
 openssl-probe = "0.1.2"
-reqwest = "0.10.8"
-serde = "1.0.115"
-serde_derive = "1.0.103"
-serde_json = "1.0.57"
-structopt = "0.3.17"
-actix-rt = "1.1.1"
+reqwest = "0.10.10"
+serde = "1.0.123"
+serde_derive = "1.0.123"
+serde_json = "1.0.63"
+tracing = "0.1.25"
+tracing-actix-web = "0.2.1"
+tracing-futures = "0.2.5"
+tracing-subscriber = "0.2.16"
 
 [build-dependencies]
-ructe = "0.12.0"
-vergen = "3.1.0"
+ructe = "0.13.0"
+vergen = { version = "4.1.0", default-features = false, features = ["git"] }
 
 [dev-dependencies]
-tempfile = "3.1.0"
+tempfile = "3.2.0"

README.md

@@ -1,9 +1,8 @@
 # Hits-of-Code
 
-[![Hits-of-Code](https://hitsofcode.com/github/vbrandl/hoc)](https://hitsofcode.com/view/github/vbrandl/hoc)
+[![Hits-of-Code](https://hitsofcode.com/github/vbrandl/hoc)](https://hitsofcode.com/github/vbrandl/hoc/view)
 [![Drone build](https://drone.vbrandl.net/api/badges/vbrandl/hoc/status.svg)](https://drone.vbrandl.net/vbrandl/hoc)
 [![Gitlab build](https://gitlab.com/vbrandl/hoc/badges/master/pipeline.svg)](https://gitlab.com/vbrandl/hoc/pipelines)
-[![Travis build](https://travis-ci.org/vbrandl/hoc.svg?branch=master)](https://travis-ci.org/vbrandl/hoc)
 [![dependency status](https://deps.rs/repo/github/vbrandl/hoc/status.svg)](https://deps.rs/repo/github/vbrandl/hoc)
 
 Small webservice, that returns a badge of the Hits-of-Code of a git repository, as described by [Yegor
@@ -27,7 +26,7 @@ where `<service>` is one of `gitub`, `gitlab` or `bitbucket`. The HoC data can a
 https://<host>/<service>/<user>/<repo>/json
 ```
 
-There is also an overview page available via `https://<host>/view/<service>/<user>/<repo>`
+There is also an overview page available via `https://<host>/<service>/<user>/<repo>/view`
 
 To delete a repository and the cache from the server, send a `POST` request to
 `https://<host>/<service>/<user>/<repo>/delete`. On the overview page, there is a button to perform this operation. It
@@ -49,21 +48,29 @@ $ docker build .
 
 inside the repository.
 
-I'm currently working on migrating to [nix](https://nixos.org/nix). To get a
-development shell, run `nix-shell`, to build the package run `nix-build --attr
-package` and to build the Docker image, run `nix-build --attr dockerImage`.
+I'm currently working on migrating to [nix](https://nixos.org/nix). To get a development shell, run `nix-shell`, to
+build the package run `nix-build --attr package` and to build the Docker image, run `nix-build --attr dockerImage`.
 
 
 ## Running
 
-Run either the binary produced by cargo, the Docker container you just built (using docker-compose) or pull the image
-from [Docker Hub](https://hub.docker.com/r/vbrandl/hits-of-code)
+Rename [`hoc.toml.example`](./hoc.toml.example) to `hoc.toml` or [`.env.example`](./.env.example) to `.env` and set the
+correct value for `base_url`/`HOC_BASE_URL`. If you don't want to use a configuration or dotenv file, you can pass all
+parameters directly via environment variables. For variable names see [`.env.example`](./.env.example).
+
+To start a local instance of the service just run:
 
 ```
-$ docker run -it --rm vbrandl/hits-of-code --help
+$ HOC_BASE_URL='http://0.0.0.0:8080' ./hoc
 ```
 
-When running the binary directly, you need a git binary in your `PATH`.
+You can also use the Docker image:
+
+```
+$ docker run -p 8080:8080 --env HOC_BASE_URL='http://0.0.0.0:8080' -it --rm vbrandl/hits-of-code
+```
+
+When running the binary directly, you need a `git` binary in your `PATH`.
 
 
 ## License

build.rs

@@ -2,11 +2,11 @@ extern crate ructe;
 extern crate vergen;
 
 use ructe::Ructe;
-use vergen::{generate_cargo_keys, ConstantsFlags};
+use vergen::{gen, ConstantsFlags};
 
 fn main() {
     let flags = ConstantsFlags::SHA_SHORT;
-    generate_cargo_keys(flags).expect("Unable to generate the cargo keys!");
+    gen(flags).expect("Unable to generate the cargo keys!");
     Ructe::from_env()
         .expect("ructe")
         .compile_templates("templates")

docker-compose.yml

@@ -1,4 +1,4 @@
-version: "2"
+version: "3"
 
 services:
   hoc:
@@ -9,3 +9,5 @@ services:
     # ports:
     #   - "127.0.0.1:8080:8080"
     restart: always
+    env_file:
+      - ./.env

hoc.toml.example

@@ -0,0 +1,15 @@
+# every parameter can also be set (or overwritten) by passing an environment
+# variable namend `HOC_<PARAMETERNAME>`, e.g.
+# `HOC_BASE_URL='https://hitsofcode.com' ./hoc`
+
+# these config parameters have default values and must not explicitly be set
+repodir = "./repos"
+cachedir = "./cache"
+port = 8080
+host = "0.0.0.0"
+workers = 4
+
+# these parameters don't have default values and must be set
+
+# this should be the public base URL of the service, e.g. `https://hitsofcode.com`
+base_url = "http://0.0.0.0:8080"

src/cache.rs

@@ -8,6 +8,7 @@ use std::{
 };
 
 /// Enum to indicate the state of the cache
+#[derive(Debug)]
 pub(crate) enum CacheState<'a> {
     /// Current head and cached head are the same
     Current {
@@ -26,11 +27,13 @@ pub(crate) enum CacheState<'a> {
 }
 
 impl<'a> CacheState<'a> {
+    #[instrument]
     pub(crate) fn read_from_file(
-        path: impl AsRef<Path>,
+        path: impl AsRef<Path> + std::fmt::Debug,
         branch: &str,
         head: &str,
     ) -> Result<CacheState<'a>> {
+        trace!("Reading cache");
         if path.as_ref().exists() {
             let cache: Cache = serde_json::from_reader(BufReader::new(File::open(path)?))?;
             Ok(cache
@@ -38,6 +41,7 @@ impl<'a> CacheState<'a> {
                 .get(branch)
                 .map(|c| {
                     if c.head == head {
+                        trace!("Cache is up to date");
                         CacheState::Current {
                             count: c.count,
                             commits: c.commits,
@@ -45,6 +49,7 @@ impl<'a> CacheState<'a> {
                             cache: cache.clone(),
                         }
                     } else {
+                        trace!("Cache is out of date");
                         CacheState::Old {
                             head: c.head.to_string(),
                             // TODO: get rid of clone
@@ -59,6 +64,7 @@ impl<'a> CacheState<'a> {
         }
     }
 
+    #[instrument]
     pub(crate) fn calculate_new_cache(
         self,
         count: u64,
@@ -66,6 +72,7 @@ impl<'a> CacheState<'a> {
         head: Cow<'a, str>,
         branch: &'a str,
     ) -> Cache<'a> {
+        trace!("Calculating new cache");
         match self {
             CacheState::Old { mut cache, .. } => {
                 if let Some(mut cache) = cache.entries.get_mut(branch) {
@@ -77,6 +84,7 @@ impl<'a> CacheState<'a> {
             }
             CacheState::Current { cache, .. } => cache,
             CacheState::NoneForBranch(mut cache) => {
+                trace!("Creating new cache for branch");
                 cache.entries.insert(
                     branch.into(),
                     CacheEntry {
@@ -88,6 +96,7 @@ impl<'a> CacheState<'a> {
                 cache
             }
             CacheState::No => {
+                trace!("Creating new cache file");
                 let mut entries = HashMap::with_capacity(1);
                 entries.insert(
                     branch.into(),
@@ -103,12 +112,12 @@ impl<'a> CacheState<'a> {
     }
 }
 
-#[derive(Serialize, Deserialize, Clone)]
+#[derive(Serialize, Deserialize, Clone, Debug)]
 pub(crate) struct Cache<'a> {
     pub entries: HashMap<Cow<'a, str>, CacheEntry<'a>>,
 }
 
-#[derive(Serialize, Deserialize, Clone)]
+#[derive(Serialize, Deserialize, Clone, Debug)]
 pub(crate) struct CacheEntry<'a> {
     /// HEAD commit ref
     pub head: Cow<'a, str>,
@@ -119,7 +128,9 @@ pub(crate) struct CacheEntry<'a> {
 }
 
 impl<'a> Cache<'a> {
-    pub(crate) fn write_to_file(&self, path: impl AsRef<Path>) -> Result<()> {
+    #[instrument]
+    pub(crate) fn write_to_file(&self, path: impl AsRef<Path> + std::fmt::Debug) -> Result<()> {
+        trace!("Persisting cache to disk");
         create_dir_all(path.as_ref().parent().ok_or(Error::Internal)?)?;
         serde_json::to_writer(
             OpenOptions::new()

src/config.rs

@@ -1,70 +1,41 @@
-use crate::{error::Result, statics::OPT};
-use log::LevelFilter;
-use log4rs::{
-    append::{console::ConsoleAppender, file::FileAppender},
-    config::{Appender, Config, Root},
-    encode::pattern::PatternEncoder,
-};
+use config::{Config, ConfigError, Environment, File};
 use std::path::PathBuf;
-use structopt::StructOpt;
 
-#[derive(StructOpt, Debug)]
-pub(crate) struct Opt {
-    #[structopt(
-        short = "o",
-        long = "outdir",
-        parse(from_os_str),
-        default_value = "./repos"
-    )]
+#[derive(Debug, Deserialize)]
+pub struct Settings {
     /// Path to store cloned repositories
-    pub(crate) outdir: PathBuf,
-    #[structopt(
-        short = "c",
-        long = "cachedir",
-        parse(from_os_str),
-        default_value = "./cache"
-    )]
+    pub repodir: PathBuf,
     /// Path to store cache
-    pub(crate) cachedir: PathBuf,
-    #[structopt(short = "p", long = "port", default_value = "8080")]
+    pub cachedir: PathBuf,
     /// Port to listen on
-    pub(crate) port: u16,
-    #[structopt(short = "h", long = "host", default_value = "0.0.0.0")]
+    pub port: u16,
     /// Interface to listen on
-    pub(crate) host: String,
-    #[structopt(short = "d", long = "domain", default_value = "hitsofcode.com")]
-    /// Interface to listen on
-    pub(crate) domain: String,
-    #[structopt(short = "w", long = "workers", default_value = "4")]
+    pub host: String,
+    /// Base URL
+    pub base_url: String,
     /// Number of worker threads
-    pub(crate) workers: usize,
-    #[structopt(
-        short = "l",
-        long = "logfile",
-        parse(from_os_str),
-        default_value = "./hoc.log"
-    )]
-    /// The logfile
-    pub(crate) logfile: PathBuf,
+    pub workers: usize,
 }
 
-pub(crate) async fn init() -> Result<()> {
+pub(crate) fn init() {
+    dotenv::dotenv().ok();
     std::env::set_var("RUST_LOG", "actix_web=info,hoc=info");
     openssl_probe::init_ssl_cert_env_vars();
-    let stdout = ConsoleAppender::builder().build();
-    let file = FileAppender::builder()
-        .encoder(Box::new(PatternEncoder::new("{d} - {m}{n}")))
-        .build(&OPT.logfile)
-        .unwrap();
-    let config = Config::builder()
-        .appender(Appender::builder().build("stdout", Box::new(stdout)))
-        .appender(Appender::builder().build("file", Box::new(file)))
-        .build(
-            Root::builder()
-                .appender("stdout")
-                .appender("file")
-                .build(LevelFilter::Info),
-        )?;
-    log4rs::init_config(config)?;
-    Ok(())
+
+    tracing_subscriber::fmt().init();
+}
+
+impl Settings {
+    pub fn new() -> Result<Self, ConfigError> {
+        let mut config = Config::new();
+        config
+            .merge(File::with_name("hoc.toml").required(false))?
+            .merge(Environment::with_prefix("hoc"))?
+            .set_default("repodir", "./repos")?
+            .set_default("cachedir", "./cache")?
+            .set_default("workers", 4)?
+            .set_default("port", 8080)?
+            .set_default("host", "0.0.0.0")?;
+        config.try_into()
+    }
 }

src/count.rs

@@ -1,10 +1,12 @@
 use crate::error::Result;
 use std::{fs::read_dir, path::Path, result::Result as StdResult};
 
+#[instrument]
 pub(crate) fn count_repositories<P>(repo_path: P) -> Result<usize>
 where
-    P: AsRef<Path>,
+    P: AsRef<Path> + std::fmt::Debug,
 {
+    trace!("Counting repositories");
     std::fs::create_dir_all(&repo_path)?;
     Ok(read_dir(repo_path)?
         .filter_map(StdResult::ok)

src/error.rs

@@ -14,8 +14,6 @@ pub(crate) enum Error {
     Git(git2::Error),
     Internal,
     Io(std::io::Error),
-    Log(log::SetLoggerError),
-    LogBuilder(log4rs::config::Errors),
     Parse(std::num::ParseIntError),
     Serial(serde_json::Error),
     BranchNotFound,
@@ -29,8 +27,6 @@ impl fmt::Display for Error {
             Error::Git(e) => write!(fmt, "Git({})", e),
             Error::Internal => write!(fmt, "Internal Error"),
             Error::Io(e) => write!(fmt, "Io({})", e),
-            Error::Log(e) => write!(fmt, "Log({})", e),
-            Error::LogBuilder(e) => write!(fmt, "LogBuilder({})", e),
             Error::Parse(e) => write!(fmt, "Parse({})", e),
             Error::Serial(e) => write!(fmt, "Serial({})", e),
             Error::BranchNotFound => write!(fmt, "Repo doesn't have master branch"),
@@ -76,12 +72,6 @@ impl From<git2::Error> for Error {
     }
 }
 
-impl From<log::SetLoggerError> for Error {
-    fn from(err: log::SetLoggerError) -> Self {
-        Error::Log(err)
-    }
-}
-
 impl From<std::io::Error> for Error {
     fn from(err: std::io::Error) -> Self {
         Error::Io(err)
@@ -100,12 +90,6 @@ impl From<reqwest::Error> for Error {
     }
 }
 
-impl From<log4rs::config::Errors> for Error {
-    fn from(err: log4rs::config::Errors) -> Self {
-        Error::LogBuilder(err)
-    }
-}
-
 impl From<std::num::ParseIntError> for Error {
     fn from(err: std::num::ParseIntError) -> Self {
         Error::Parse(err)

src/main.rs

@@ -5,9 +5,9 @@ extern crate actix_web;
 #[macro_use]
 extern crate lazy_static;
 #[macro_use]
-extern crate log;
-#[macro_use]
 extern crate serde_derive;
+#[macro_use]
+extern crate tracing;
 
 mod cache;
 mod config;
@@ -29,7 +29,8 @@ use crate::{
 };
 use actix_web::{
     http::header::{CacheControl, CacheDirective, Expires, LOCATION},
-    middleware, web, App, HttpResponse, HttpServer, Responder,
+    middleware::{self, normalize::TrailingSlash},
+    web, App, HttpResponse, HttpServer, Responder,
 };
 use badge::{Badge, BadgeOptions};
 use git2::{BranchType, Repository};
@@ -44,6 +45,7 @@ use std::{
     sync::Arc,
     time::{Duration, SystemTime},
 };
+use tracing::Instrument;
 
 include!(concat!(env!("OUT_DIR"), "/templates.rs"));
 
@@ -107,16 +109,16 @@ fn hoc(repo: &str, repo_dir: &str, cache_dir: &str, branch: &str) -> Result<(u64
     let cache = CacheState::read_from_file(&cache_dir, branch, &head)?;
     match &cache {
         CacheState::Current { count, commits, .. } => {
-            info!("Using cache for {}", repo_dir);
+            info!("Using cache");
             return Ok((*count, head, *commits));
         }
         CacheState::Old { head, .. } => {
-            info!("Updating cache for {}", repo_dir);
+            info!("Updating cache");
             arg.push(format!("{}..{}", head, branch));
             arg_commit_count.push(format!("{}..{}", head, branch));
         }
         CacheState::No | CacheState::NoneForBranch(..) => {
-            info!("Creating cache for {}", repo_dir);
+            info!("Creating cache");
             arg.push(branch.to_string());
             arg_commit_count.push(branch.to_string());
         }
@@ -124,7 +126,7 @@ fn hoc(repo: &str, repo_dir: &str, cache_dir: &str, branch: &str) -> Result<(u64
     arg.push("--".to_string());
     arg.push(".".to_string());
     let output = Command::new("git")
-        .args(&dbg!(arg))
+        .args(&arg)
         .current_dir(&repo_dir)
         .output()?
         .stdout;
@@ -179,36 +181,45 @@ where
     T: Service,
 {
     let data = data.into_inner();
-    let repo = format!(
-        "{}/{}/{}",
-        T::domain(),
-        data.0.to_lowercase(),
-        data.1.to_lowercase()
+    let span = info_span!(
+        "deleting repository and cache",
+        service = T::domain(),
+        user = data.0.as_str(),
+        repo = data.1.as_str()
     );
-    info!("Deleting cache and repository for {}", repo);
-    let cache_dir = dbg!(format!("{}/{}.json", &state.cache, repo));
-    let repo_dir = dbg!(format!("{}/{}", &state.repos, repo));
-    std::fs::remove_file(&cache_dir).or_else(|e| {
-        if e.kind() == io::ErrorKind::NotFound {
-            Ok(())
-        } else {
-            Err(e)
-        }
-    })?;
-    std::fs::remove_dir_all(&repo_dir).or_else(|e| {
-        if e.kind() == io::ErrorKind::NotFound {
-            Ok(())
-        } else {
-            Err(e)
-        }
-    })?;
-    REPO_COUNT.fetch_sub(1, Ordering::Relaxed);
-    Ok(HttpResponse::TemporaryRedirect()
-        .header(
-            LOCATION,
-            format!("/view/{}/{}/{}", T::url_path(), data.0, data.1),
-        )
-        .finish())
+    let future = async {
+        let repo = format!(
+            "{}/{}/{}",
+            T::domain(),
+            data.0.to_lowercase(),
+            data.1.to_lowercase()
+        );
+        info!("Deleting cache and repository");
+        let cache_dir = format!("{}/{}.json", &state.cache, repo);
+        let repo_dir = format!("{}/{}", &state.repos, repo);
+        std::fs::remove_file(&cache_dir).or_else(|e| {
+            if e.kind() == io::ErrorKind::NotFound {
+                Ok(())
+            } else {
+                Err(e)
+            }
+        })?;
+        std::fs::remove_dir_all(&repo_dir).or_else(|e| {
+            if e.kind() == io::ErrorKind::NotFound {
+                Ok(())
+            } else {
+                Err(e)
+            }
+        })?;
+        REPO_COUNT.fetch_sub(1, Ordering::Relaxed);
+        Ok(HttpResponse::TemporaryRedirect()
+            .header(
+                LOCATION,
+                format!("/{}/{}/{}/view", T::url_path(), data.0, data.1),
+            )
+            .finish())
+    };
+    future.instrument(span).await
 }
 
 async fn handle_hoc_request<T, F>(
@@ -222,41 +233,51 @@ where
     F: Fn(HocResult) -> Result<HttpResponse>,
 {
     let data = data.into_inner();
-    let repo = format!("{}/{}", data.0.to_lowercase(), data.1.to_lowercase());
-    let service_path = format!("{}/{}", T::url_path(), repo);
-    let service_url = format!("{}/{}", T::domain(), repo);
-    let path = format!("{}/{}", state.repos, service_url);
-    let url = format!("https://{}", service_url);
-    let remote_exists = remote_exists(&url).await?;
-    let file = Path::new(&path);
-    if !file.exists() {
-        if !remote_exists {
-            warn!("Repository does not exist: {}", url);
-            return mapper(HocResult::NotFound);
+    let span = info_span!(
+        "handling hoc calculation",
+        service = T::domain(),
+        user = data.0.as_str(),
+        repo = data.1.as_str(),
+        branch
+    );
+    let future = async {
+        let repo = format!("{}/{}", data.0.to_lowercase(), data.1.to_lowercase());
+        let service_path = format!("{}/{}", T::url_path(), repo);
+        let service_url = format!("{}/{}", T::domain(), repo);
+        let path = format!("{}/{}", state.repos, service_url);
+        let url = format!("https://{}", service_url);
+        let remote_exists = remote_exists(&url).await?;
+        let file = Path::new(&path);
+        if !file.exists() {
+            if !remote_exists {
+                warn!("Repository does not exist");
+                return mapper(HocResult::NotFound);
+            }
+            info!("Cloning for the first time");
+            create_dir_all(file)?;
+            let repo = Repository::init_bare(file)?;
+            repo.remote_add_fetch("origin", "refs/heads/*:refs/heads/*")?;
+            repo.remote_set_url("origin", &url)?;
+            REPO_COUNT.fetch_add(1, Ordering::Relaxed);
         }
-        info!("Cloning {} for the first time", url);
-        create_dir_all(file)?;
-        let repo = Repository::init_bare(file)?;
-        repo.remote_add_fetch("origin", "refs/heads/*:refs/heads/*")?;
-        repo.remote_set_url("origin", &url)?;
-        REPO_COUNT.fetch_add(1, Ordering::Relaxed);
-    }
-    pull(&path)?;
-    let (hoc, head, commits) = hoc(&service_url, &state.repos, &state.cache, branch)?;
-    let hoc_pretty = match NumberPrefix::decimal(hoc as f64) {
-        NumberPrefix::Standalone(hoc) => hoc.to_string(),
-        NumberPrefix::Prefixed(prefix, hoc) => format!("{:.1}{}", hoc, prefix),
+        pull(&path)?;
+        let (hoc, head, commits) = hoc(&service_url, &state.repos, &state.cache, branch)?;
+        let hoc_pretty = match NumberPrefix::decimal(hoc as f64) {
+            NumberPrefix::Standalone(hoc) => hoc.to_string(),
+            NumberPrefix::Prefixed(prefix, hoc) => format!("{:.1}{}", hoc, prefix),
+        };
+        let res = HocResult::Hoc {
+            hoc,
+            commits,
+            hoc_pretty,
+            head,
+            url,
+            repo,
+            service_path,
+        };
+        mapper(res)
     };
-    let res = HocResult::Hoc {
-        hoc,
-        commits,
-        hoc_pretty,
-        head,
-        url,
-        repo,
-        service_path,
-    };
-    mapper(res)
+    future.instrument(span).await
 }
 
 pub(crate) async fn json_hoc<T: Service>(
@@ -279,11 +300,25 @@ pub(crate) async fn json_hoc<T: Service>(
     handle_hoc_request::<T, _>(state, data, branch, mapper).await
 }
 
+fn no_cache_response(body: Vec<u8>) -> HttpResponse {
+    let expiration = SystemTime::now() + Duration::from_secs(30);
+    HttpResponse::Ok()
+        .content_type("image/svg+xml")
+        .set(Expires(expiration.into()))
+        .set(CacheControl(vec![
+            CacheDirective::MaxAge(0u32),
+            CacheDirective::MustRevalidate,
+            CacheDirective::NoCache,
+            CacheDirective::NoStore,
+        ]))
+        .body(body)
+}
+
 pub(crate) async fn calculate_hoc<T: Service>(
     state: web::Data<Arc<State>>,
     data: web::Path<(String, String)>,
     branch: web::Query<BranchQuery>,
-) -> Result<HttpResponse> {
+) -> HttpResponse {
     let mapper = move |r| match r {
         HocResult::NotFound => p404(),
         HocResult::Hoc { hoc_pretty, .. } => {
@@ -296,21 +331,23 @@ pub(crate) async fn calculate_hoc<T: Service>(
             // TODO: remove clone
             let body = badge.to_svg().as_bytes().to_vec();
 
-            let expiration = SystemTime::now() + Duration::from_secs(30);
-            Ok(HttpResponse::Ok()
-                .content_type("image/svg+xml")
-                .set(Expires(expiration.into()))
-                .set(CacheControl(vec![
-                    CacheDirective::MaxAge(0u32),
-                    CacheDirective::MustRevalidate,
-                    CacheDirective::NoCache,
-                    CacheDirective::NoStore,
-                ]))
-                .body(body))
+            Ok(no_cache_response(body))
         }
     };
     let branch = branch.branch.as_deref().unwrap_or("master");
-    handle_hoc_request::<T, _>(state, data, branch, mapper).await
+    let error_badge = |_| {
+        let error_badge = Badge::new(BadgeOptions {
+            subject: "Hits-of-Code".to_string(),
+            color: "#ff0000".to_string(),
+            status: "error".to_string(),
+        })
+        .unwrap();
+        let body = error_badge.to_svg().as_bytes().to_vec();
+        no_cache_response(body)
+    };
+    handle_hoc_request::<T, _>(state, data, branch, mapper)
+        .await
+        .unwrap_or_else(error_badge)
 }
 
 async fn overview<T: Service>(
@@ -334,7 +371,7 @@ async fn overview<T: Service>(
             let repo_info = RepoInfo {
                 commit_url: &T::commit_url(&repo, &head),
                 commits,
-                domain: &OPT.domain,
+                base_url: &OPT.base_url,
                 head: &head,
                 hoc,
                 hoc_pretty: &hoc_pretty,
@@ -362,7 +399,7 @@ async fn index() -> Result<HttpResponse> {
         &mut buf,
         VERSION_INFO,
         REPO_COUNT.load(Ordering::Relaxed),
-        &OPT.domain,
+        &OPT.base_url,
     )?;
     Ok(HttpResponse::Ok().content_type("text/html").body(buf))
 }
@@ -375,7 +412,7 @@ async fn generate(params: web::Form<GeneratorForm<'_>>) -> Result<HttpResponse>
         &mut buf,
         VERSION_INFO,
         REPO_COUNT.load(Ordering::Relaxed),
-        &OPT.domain,
+        &OPT.base_url,
         params.service.url(),
         params.service.service(),
         &repo,
@@ -405,17 +442,16 @@ fn favicon32() -> HttpResponse {
 async fn start_server() -> std::io::Result<()> {
     let interface = format!("{}:{}", OPT.host, OPT.port);
     let state = Arc::new(State {
-        repos: OPT.outdir.display().to_string(),
+        repos: OPT.repodir.display().to_string(),
         cache: OPT.cachedir.display().to_string(),
     });
     HttpServer::new(move || {
         App::new()
             .data(state.clone())
-            .wrap(middleware::Logger::default())
-            // .wrap(middleware::NormalizePath::default())
+            .wrap(tracing_actix_web::TracingLogger)
+            .wrap(middleware::NormalizePath::new(TrailingSlash::Trim))
             .service(index)
             .service(web::resource("/tacit-css.min.css").route(web::get().to(css)))
-            // TODO
             .service(web::resource("/favicon.ico").route(web::get().to(favicon32)))
             .service(generate)
             .service(web::resource("/github/{user}/{repo}").to(calculate_hoc::<GitHub>))
@@ -439,6 +475,9 @@ async fn start_server() -> std::io::Result<()> {
             .service(web::resource("/view/github/{user}/{repo}").to(overview::<GitHub>))
             .service(web::resource("/view/gitlab/{user}/{repo}").to(overview::<Gitlab>))
             .service(web::resource("/view/bitbucket/{user}/{repo}").to(overview::<Bitbucket>))
+            .service(web::resource("/github/{user}/{repo}/view").to(overview::<GitHub>))
+            .service(web::resource("/gitlab/{user}/{repo}/view").to(overview::<Gitlab>))
+            .service(web::resource("/bitbucket/{user}/{repo}/view").to(overview::<Bitbucket>))
             .default_service(web::resource("").route(web::get().to(async_p404)))
     })
     .workers(OPT.workers)
@@ -449,6 +488,8 @@ async fn start_server() -> std::io::Result<()> {
 
 #[actix_rt::main]
 async fn main() -> std::io::Result<()> {
-    config::init().await.unwrap();
-    start_server().await
+    config::init();
+    let span = info_span!("hoc", version = env!("CARGO_PKG_VERSION"));
+    let _ = span.enter();
+    start_server().instrument(span).await
 }

src/statics.rs

@@ -1,6 +1,5 @@
-use crate::{config::Opt, count::count_repositories};
+use crate::{config::Settings, count::count_repositories};
 use std::sync::atomic::AtomicUsize;
-use structopt::StructOpt;
 
 pub struct VersionInfo<'a> {
     pub commit: &'a str,
@@ -8,7 +7,7 @@ pub struct VersionInfo<'a> {
 }
 
 pub(crate) const VERSION_INFO: VersionInfo = VersionInfo {
-    commit: env!("VERGEN_SHA_SHORT"),
+    commit: env!("VERGEN_GIT_SHA_SHORT"),
     version: env!("CARGO_PKG_VERSION"),
 };
 pub(crate) const CSS: &str = include_str!("../static/tacit-css.min.css");
@@ -16,7 +15,7 @@ pub(crate) const FAVICON: &[u8] = include_bytes!("../static/favicon32.png");
 
 lazy_static! {
     pub(crate) static ref CLIENT: reqwest::Client = reqwest::Client::new();
-    pub(crate) static ref OPT: Opt = Opt::from_args();
+    pub(crate) static ref OPT: Settings = Settings::new().unwrap();
     pub(crate) static ref REPO_COUNT: AtomicUsize =
-        AtomicUsize::new(count_repositories(&OPT.outdir).unwrap());
+        AtomicUsize::new(count_repositories(&OPT.repodir).unwrap());
 }

src/template.rs

@@ -1,7 +1,7 @@
 pub struct RepoInfo<'a> {
     pub commit_url: &'a str,
     pub commits: u64,
-    pub domain: &'a str,
+    pub base_url: &'a str,
     pub head: &'a str,
     pub hoc: u64,
     pub hoc_pretty: &'a str,

src/tests.rs

@@ -37,7 +37,9 @@ macro_rules! test_service {
 
 #[actix_rt::test]
 async fn test_index() {
-    let mut app = test::init_service(App::new().service(index)).await;
+    std::env::set_var("HOC_BASE_URL", "http://0.0.0.0:8080");
+
+    let mut app = test_app!(index);
 
     let req = dbg!(test::TestRequest::with_uri("/").to_request());
     let resp = dbg!(test::call_service(&mut app, req).await);

templates/generate.rs.html

@@ -1,7 +1,7 @@
 @use super::base;
 @use crate::statics::VersionInfo;
 
-@(version_info: VersionInfo, repo_count: usize, domain: &str, url: &str, service: &str, path: &str)
+@(version_info: VersionInfo, repo_count: usize, base_url: &str, url: &str, service: &str, path: &str)
 
 @:base("Hits-of-Code Badges", "Badge Generator", {
 
@@ -10,7 +10,7 @@ Here is the markdown for the badge for <a href="https://@url/@path">@url/@path</
 </p>
 
 <pre>
-[![Hits-of-Code](https://@domain/@service/@path)](https://@domain/view/@service/@path)
+[![Hits-of-Code](@base_url/@service/@path)](@base_url/@service/@path/view)
 </pre>
 
 <p>
@@ -18,6 +18,6 @@ It will be rendered like this
 </p>
 
 <pre>
-<a href="https://@domain/view/@service/@path"><img src="https://@domain/@service/@path" alt="example badge" /></a>
+<a href="@base_url/@service/@path/view"><img src="@base_url/@service/@path" alt="example badge" /></a>
 </pre>
 }, version_info, repo_count)

templates/index.rs.html

@@ -1,7 +1,7 @@
 @use super::base;
 @use crate::statics::VersionInfo;
 
-@(version_info: VersionInfo, repo_count: usize, domain: &str)
+@(version_info: VersionInfo, repo_count: usize, base_url: &str)
 
 @:base("Hits-of-Code Badges", "Hits-of-Code Badges", {
 
@@ -24,7 +24,7 @@ used for GitHub, GitLab and Bitbucket repositories. Just put the following code
 </p>
 
 <pre>
-[![Hits-of-Code](https://@domain/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)](https://@domain/view/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)
+[![Hits-of-Code](@base_url/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)](@base_url/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;/view)
 </pre>
 
 <p>
@@ -33,7 +33,7 @@ following Markdown
 </p>
 
 <pre>
-[![Hits-of-Code](https://@domain/github/vbrandl/hoc)](https://@domain/view/github/vbrandl/hoc)
+[![Hits-of-Code](@base_url/github/vbrandl/hoc)](@base_url/github/vbrandl/hoc/view)
 </pre>
 
 <p>
@@ -41,7 +41,7 @@ would render this badge:
 </p>
 
 <pre>
-<a href="https://@domain/view/github/vbrandl/hoc"><img src="https://@domain/github/vbrandl/hoc"
+<a href="@base_url/github/vbrandl/hoc/view"><img src="@base_url/github/vbrandl/hoc"
 alt="example badge" /></a>
 </pre>
 
@@ -55,7 +55,7 @@ in your repository or you want a badge for another branch of your repository, ju
 You can also request the HoC as JSON by appending <code>/json</code> to the request path. This will return a JSON object
 with three fields: <code>count</code> (the HoC value), <code>commits</code> (the number of commits) and
 <code>head</code> (the commit ref of HEAD). Requesting <a
-href="https://@domain/github/vbrandl/hoc/json">https://@domain/github/vbrandl/hoc/json</a> might return something along
+href="@base_url/github/vbrandl/hoc/json">@base_url/github/vbrandl/hoc/json</a> might return something along
 the lines of
 </p>
 

templates/overview.rs.html

@@ -19,7 +19,7 @@ To include the badge in your readme, use the following markdown:
 </p>
 
 <pre>
-[![Hits-of-Code](https://@repo_info.domain/@repo_info.path?branch=@repo_info.branch)](https://@repo_info.domain/view/@repo_info.path?branch=@repo_info.branch)
+[![Hits-of-Code](@repo_info.base_url/@repo_info.path?branch=@repo_info.branch)](@repo_info.base_url/@repo_info.path/view?branch=@repo_info.branch)
 </pre>