Merge pull request #10 from SinTan1729/multi-arch

Multi-arch builds
2024-12-25 23:28:37 -06:00 · 2024-03-29 15:38:48 -05:00 · 2024-03-29 15:38:48 -05:00 · 753b73c4a3
commit 753b73c4a3
parent d6dcd2f18d fbcb088260
10 changed files with 141 additions and 110 deletions
--- a/.gitignore
+++ b/.gitignore
@ -1,4 +1,4 @@
-# Ignore cargo build outputs
+# Ignore build outputs
 actix/target

 # Ignore SQLite file
@ -7,3 +7,5 @@ urls.sqlite
 # Ignore irrelevant dotfiles
 .vscode/
 **/.directory
+.env
+
--- a/10
+++ b/10
@ -7,20 +7,20 @@ COPY ./actix/src ./src
 RUN cargo chef prepare --recipe-path recipe.json

 FROM chef as builder
+ARG target=x86_64-unknown-linux-musl
 RUN apt-get update && apt-get install -y musl-tools
-RUN rustup target add x86_64-unknown-linux-musl
+RUN rustup target add $target

 COPY --from=planner /chhoto-url/recipe.json recipe.json
 # Build dependencies - this is the caching Docker layer
-RUN cargo chef cook --release --target=x86_64-unknown-linux-musl --recipe-path recipe.json
+RUN cargo chef cook --release --target=$target --recipe-path recipe.json

 COPY ./actix/Cargo.toml ./actix/Cargo.lock .
 COPY ./actix/src ./src
 # Build application
-RUN cargo build --release --target=x86_64-unknown-linux-musl --locked --bin chhoto-url
+RUN cargo build --release --target=$target --locked --bin chhoto-url

 FROM scratch
-COPY --from=builder /chhoto-url/target/x86_64-unknown-linux-musl/release/chhoto-url /chhoto-url
+COPY --from=builder /chhoto-url/target/$target/release/chhoto-url /chhoto-url
 COPY ./resources /resources
 ENTRYPOINT ["/chhoto-url"]
-
--- a/Dockerfile.multiarch
+++ b/Dockerfile.multiarch
@ -0,0 +1,15 @@
+FROM scratch as builder-amd64
+COPY ./actix/target/x86_64-unknown-linux-musl/release/chhoto-url /chhoto-url
+
+FROM scratch as builder-arm64
+COPY ./actix/target/aarch64-unknown-linux-musl/release/chhoto-url /chhoto-url
+
+FROM scratch as builder-arm
+COPY ./actix/target/armv7-unknown-linux-musleabihf/release/chhoto-url /chhoto-url
+
+ARG TARGETARCH
+FROM builder-$TARGETARCH
+COPY ./resources /resources
+
+ENTRYPOINT ["/chhoto-url"]
+
--- a/43
+++ b/43
@ -0,0 +1,43 @@
+# .env file has the variables $DOCKER_USERNAME and $PASSWORD defined
+include .env
+
+setup:
+	cargo install cross
+	rustup target add x86_64-unknown-linux-musl
+	docker buildx create --use --platform=linux/arm64,linux/amd64 --name multi-platform-builder
+	docker buildx inspect --bootstrap
+
+build-dev:
+	cargo build --release --locked --manifest-path=actix/Cargo.toml --target x86_64-unknown-linux-musl
+
+docker-local: build-dev
+	docker build --tag chhoto-url --build-arg TARGETARCH=amd64 -f Dockerfile.multiarch .
+
+docker-test: docker-local
+	docker ps -q --filter "name=chhoto-url" | xargs -r docker stop
+	docker ps -aq --filter "name=chhoto-url" | xargs -r docker rm
+	docker run -p 4567:4567 --name chhoto-url -e password="${PASSWORD}" -d chhoto-url
+	docker logs chhoto-url -f
+
+docker-dev: build-dev
+	docker build --push --tag ${DOCKER_USERNAME}/chhoto-url:dev --build-arg TARGETARCH=amd64 -f Dockerfile.multiarch .
+
+build-release:
+	cross build --release --locked --manifest-path=actix/Cargo.toml --target aarch64-unknown-linux-musl
+	cross build --release --locked --manifest-path=actix/Cargo.toml --target armv7-unknown-linux-musleabihf
+	cross build --release --locked --manifest-path=actix/Cargo.toml --target x86_64-unknown-linux-musl
+
+V_PATCH := $(shell cat actix/Cargo.toml | sed -rn 's/^version = "(.+)"$$/\1/p')
+V_MINOR := $(shell cat actix/Cargo.toml | sed -rn 's/^version = "(.+)\..+"$$/\1/p')
+V_MAJOR := $(shell cat actix/Cargo.toml | sed -rn 's/^version = "(.+)\..+\..+"$$/\1/p')
+docker-release: build-release
+	docker buildx build --push --tag ${DOCKER_USERNAME}/chhoto-url:${V_MAJOR} --tag ${DOCKER_USERNAME}/chhoto-url:${V_MINOR} \
+		--tag ${DOCKER_USERNAME}/chhoto-url:${V_PATCH} --tag ${DOCKER_USERNAME}/chhoto-url:latest \
+		--platform linux/amd64,linux/arm64,linux/arm/v7 -f Dockerfile.multiarch .
+
+clean:
+	docker ps -q --filter "name=chhoto-url" | xargs -r docker stop
+	docker ps -aq --filter "name=chhoto-url" | xargs -r docker rm
+	cargo clean --manifest-path=actix/Cargo.toml
+
+.PHONY: build-dev docker-local build-release
--- a/README.md
+++ b/README.md
@ -18,8 +18,12 @@ If you feel like a feature is missing, please let me know by creating an issue
 using the "feature request" template.

 ## But why another URL shortener?
-I've looked at a couple popular URL shorteners, however they either have
-unnecessary features, or they didn't have all the features I wanted.
+Most URL shorteners are either bloated with unnecessary features, or are a pain to set up.
+Even fewer are written with simplicity and lightness in mind. When I saw the simply-shorten
+project (linked below), I really liked the idea but thought that it missed some details. Also,
+I didn't like the fact that a simple app like this had a ~200 MB docker image (mostly due to the
+included java runtime). So, I decided to rewrite it in Rust and add some features to it that I
+thought were essential (e.g. hit counting).

 ## What does the name mean?
 Chhoto (ছোট, [IPA](https://en.wikipedia.org/wiki/Help:IPA/Bengali): /tʃʰoʈo/) is the Bangla word
@ -75,10 +79,17 @@ place, resulting in possibly unwanted behavior.

 ## Building and running with docker
 ### `docker run` method
-0. (Only if you really want to) Build the image
+0. (Only if you really want to) Build the image for the default `x86_64-unknown-linux-musl` target:
 ```
-docker build . -t chhoto-url:latest
+docker build . -t chhoto-url
 ```
+For building on `arm64` or `arm/v7`, use the following:
+```
+docker build . -t chhoto-url --build-arg target=<desired-target>
+```
+Make sure that the desired target is a `musl` one, since the docker image is built from `scratch`.
+For cross-compilation, take a look at the `Makefile`. It builds and pushes for `linux/amd64`, `linux/aarch64`
+and `linux/arm/v7` architectures. For any other architectures, open a discussion, and I'll try to help you out.
 1. Run the image
 ```
 docker run -p 4567:4567
--- a/actix/Cargo.lock
+++ b/actix/Cargo.lock
@ -8,7 +8,7 @@ version = "0.5.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "5f7b0a21988c1bf877cf4759ef5ddaac04c1c9fe808c9142ecb78ba97d97a28a"
 dependencies = [
- "bitflags 2.4.2",
+ "bitflags 2.5.0",
 "bytes",
 "futures-core",
 "futures-sink",
@ -29,7 +29,7 @@ dependencies = [
 "actix-service",
 "actix-utils",
 "actix-web",
- "bitflags 2.4.2",
+ "bitflags 2.5.0",
 "bytes",
 "derive_more",
 "futures-core",
@ -54,7 +54,7 @@ dependencies = [
 "actix-utils",
 "ahash",
 "base64 0.21.7",
- "bitflags 2.4.2",
+ "bitflags 2.5.0",
 "brotli",
 "bytes",
 "bytestring",
@ -88,7 +88,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e01ed3140b2f8d422c68afa1ed2e85d996ea619c988ac834d255db32138655cb"
 dependencies = [
 "quote",
- "syn 2.0.53",
+ "syn 2.0.55",
 ]

 [[package]]
@ -217,7 +217,7 @@ dependencies = [
 "actix-router",
 "proc-macro2",
 "quote",
- "syn 2.0.53",
+ "syn 2.0.55",
 ]

 [[package]]
@ -285,9 +285,9 @@ dependencies = [

 [[package]]
 name = "aho-corasick"
-version = "1.1.2"
+version = "1.1.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b2969dcb958b36655471fc61f7e416fa76033bdd4bfed0678d8fee1e2d07a1f0"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
 dependencies = [
 "memchr",
 ]
@ -369,15 +369,15 @@ checksum = "0952808a6c2afd1aa8947271f3a60f1a6763c7b912d210184c5149b5cf147247"

 [[package]]
 name = "autocfg"
-version = "1.1.0"
+version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
+checksum = "f1fdabc7756949593fe60f30ec81974b613357de856987752631dea1e3394c80"

 [[package]]
 name = "backtrace"
-version = "0.3.69"
+version = "0.3.71"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2089b7e3f35b9dd2d0ed921ead4f6d318c27680d4a5bd167b3ee120edb105837"
+checksum = "26b05800d2e817c8b3b4b54abd461726265fa9789ae34330622f2db9ee696f9d"
 dependencies = [
 "addr2line",
 "cc",
@ -408,9 +408,9 @@ checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"

 [[package]]
 name = "bitflags"
-version = "2.4.2"
+version = "2.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ed570934406eb16438a4e976b1b4500774099c13b8cb96eec99f620f05090ddf"
+checksum = "cf4b9d6a944f767f8e5e0db018570623c85f3d925ac718db4e06d0187adb21c1"

 [[package]]
 name = "block-buffer"
@ -444,9 +444,9 @@ dependencies = [

 [[package]]
 name = "bytes"
-version = "1.5.0"
+version = "1.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a2bd12c1caf447e69cd4528f47f94d203fd2582878ecb9e9465484c4148a8223"
+checksum = "514de17de45fdb8dc022b1a7975556c53c86f9f0aa5f534b98977b171857c2c9"

 [[package]]
 name = "bytestring"
@ -842,9 +842,9 @@ dependencies = [

 [[package]]
 name = "indexmap"
-version = "2.2.5"
+version = "2.2.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7b0b929d511467233429c45a44ac1dcaa21ba0f5ba11e4879e6ed28ddb4f9df4"
+checksum = "168fb715dda47215e360912c096649d23d58bf392ac62f73919e831745e40f26"
 dependencies = [
 "equivalent",
 "hashbrown",
@ -861,9 +861,9 @@ dependencies = [

 [[package]]
 name = "itoa"
-version = "1.0.10"
+version = "1.0.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1a46d1a171d865aa5f83f92695765caa047a9b4cbae2cbf37dbd613a793fd4c"
+checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b"

 [[package]]
 name = "jobserver"
@ -932,9 +932,9 @@ checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c"

 [[package]]
 name = "memchr"
-version = "2.7.1"
+version = "2.7.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "523dc4f511e55ab87b694dc30d0f820d60906ef06413f93d4d7a1385599cc149"
+checksum = "6c8640c5d730cb13ebd907d8d04b52f55ac9a2eec55b440c8892f40d56c76c1d"

 [[package]]
 name = "mime"
@ -1136,9 +1136,9 @@ dependencies = [

 [[package]]
 name = "regex"
-version = "1.10.3"
+version = "1.10.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b62dbe01f0b06f9d8dc7d49e05a0785f153b00b2c227856282f671e0318c9b15"
+checksum = "c117dbdfde9c8308975b6a18d71f3f385c89461f7b3fb054288ecf2a2058ba4c"
 dependencies = [
 "aho-corasick",
 "memchr",
@ -1159,9 +1159,9 @@ dependencies = [

 [[package]]
 name = "regex-syntax"
-version = "0.8.2"
+version = "0.8.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f"
+checksum = "adad44e29e4c806119491a7f06f03de4d1af22c3a680dd47f1e6e179439d1f56"

 [[package]]
 name = "rusqlite"
@ -1169,7 +1169,7 @@ version = "0.31.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b838eba278d213a8beaf485bd313fd580ca4505a00d5871caeb1457c55322cae"
 dependencies = [
- "bitflags 2.4.2",
+ "bitflags 2.5.0",
 "fallible-iterator",
 "fallible-streaming-iterator",
 "hashlink",
@ -1227,14 +1227,14 @@ checksum = "7eb0b34b42edc17f6b7cac84a52a1c5f0e1bb2227e997ca9011ea3dd34e8610b"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.53",
+ "syn 2.0.55",
 ]

 [[package]]
 name = "serde_json"
-version = "1.0.114"
+version = "1.0.115"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c5f09b1bd632ef549eaa9f60a1f8de742bdbc698e6cee2095fc84dde5f549ae0"
+checksum = "12dc5c46daa8e9fdf4f5e71b6cf9a53f2487da0e86e55808e2d35539666497dd"
 dependencies = [
 "itoa",
 "ryu",
@ -1295,9 +1295,9 @@ dependencies = [

 [[package]]
 name = "smallvec"
-version = "1.13.1"
+version = "1.13.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e6ecd384b10a64542d77071bd64bd7b231f4ed5940fba55e98c3de13824cf3d7"
+checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67"

 [[package]]
 name = "socket2"
@ -1328,9 +1328,9 @@ dependencies = [

 [[package]]
 name = "syn"
-version = "2.0.53"
+version = "2.0.55"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7383cd0e49fff4b6b90ca5670bfd3e9d6a733b3f90c686605aa7eec8c4996032"
+checksum = "002a1b3dbf967edfafc32655d0f377ab0bb7b994aa1d32c8cc7e9b8bf3ebb8f0"
 dependencies = [
 "proc-macro2",
 "quote",
@ -1385,9 +1385,9 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20"

 [[package]]
 name = "tokio"
-version = "1.36.0"
+version = "1.37.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "61285f6515fa018fb2d1e46eb21223fff441ee8db5d0f1435e8ab4f5cdb80931"
+checksum = "1adbebffeca75fcfd058afa480fb6c0b81e165a0323f9c9d39c9697e37c46787"
 dependencies = [
 "backtrace",
 "bytes",
@ -1670,32 +1670,32 @@ checksum = "9ce1b18ccd8e73a9321186f97e46f9f04b778851177567b1975109d26a08d2a6"
 dependencies = [
 "proc-macro2",
 "quote",
- "syn 2.0.53",
+ "syn 2.0.55",
 ]

 [[package]]
 name = "zstd"
-version = "0.13.0"
+version = "0.13.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bffb3309596d527cfcba7dfc6ed6052f1d39dfbd7c867aa2e865e4a449c10110"
+checksum = "2d789b1514203a1120ad2429eae43a7bd32b90976a7bb8a05f7ec02fa88cc23a"
 dependencies = [
 "zstd-safe",
 ]

 [[package]]
 name = "zstd-safe"
-version = "7.0.0"
+version = "7.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "43747c7422e2924c11144d5229878b98180ef8b06cca4ab5af37afc8a8d8ea3e"
+checksum = "1cd99b45c6bc03a018c8b8a86025678c87e55526064e38f9df301989dce7ec0a"
 dependencies = [
 "zstd-sys",
 ]

 [[package]]
 name = "zstd-sys"
-version = "2.0.9+zstd.1.5.5"
+version = "2.0.10+zstd.1.5.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9e16efa8a874a0481a574084d34cc26fdb3b99627480f785888deb6386506656"
+checksum = "c253a4914af5bafc8fa8c86ee400827e83cf6ec01195ec1f1ed8441bf00d65aa"
 dependencies = [
 "cc",
 "pkg-config",
--- a/actix/src/database.rs
+++ b/actix/src/database.rs
@ -1,20 +1,13 @@
 use rusqlite::Connection;

-pub fn find_url(shortlink: &str, db: &Connection) -> String {
+pub fn find_url(shortlink: &str, db: &Connection) -> Option<String> {
    let mut statement = db
        .prepare_cached("SELECT long_url FROM urls WHERE short_url = ?1")
        .unwrap();

-    let links = statement
-        .query_map([shortlink], |row| row.get("long_url"))
-        .unwrap();
-
-    let mut longlink = String::new();
-    for link in links {
-        longlink = link.unwrap();
-    }
-
-    longlink
+    statement
+        .query_row([shortlink], |row| row.get("long_url"))
+        .ok()
 }

 pub fn getall(db: &Connection) -> Vec<String> {
--- a/actix/src/main.rs
+++ b/actix/src/main.rs
@ -6,7 +6,7 @@ use actix_web::{
    http::StatusCode,
    middleware, post,
    web::{self, Redirect},
-    App, HttpResponse, HttpServer, Responder,
+    App, Either, HttpResponse, HttpServer, Responder,
 };
 use rusqlite::Connection;
 use std::env;
@ -78,18 +78,22 @@ async fn error404() -> impl Responder {
 #[get("/{shortlink}")]
 async fn link_handler(shortlink: web::Path<String>, data: web::Data<AppState>) -> impl Responder {
    let shortlink_str = shortlink.to_string();
-    let longlink = utils::get_longurl(shortlink_str, &data.db);
-    if longlink.is_empty() {
-        Redirect::to("/err/404")
-    } else {
+    if let Some(longlink) = utils::get_longurl(shortlink_str, &data.db) {
        let redirect_method = env::var("redirect_method").unwrap_or(String::from("PERMANENT"));
        database::add_hit(shortlink.as_str(), &data.db);
        if redirect_method == "TEMPORARY" {
-            Redirect::to(longlink)
+            Either::Left(Redirect::to(longlink))
        } else {
            // Defaults to permanent redirection
-            Redirect::to(longlink).permanent()
+            Either::Left(Redirect::to(longlink).permanent())
        }
+    } else {
+        Either::Right(
+            NamedFile::open_async("./resources/static/404.html")
+                .await
+                .customize()
+                .with_status(StatusCode::NOT_FOUND),
+        )
    }
 }

--- a/actix/src/utils.rs
+++ b/actix/src/utils.rs
@ -3,11 +3,11 @@ use rand::seq::SliceRandom;
 use regex::Regex;
 use rusqlite::Connection;

-pub fn get_longurl(shortlink: String, db: &Connection) -> String {
+pub fn get_longurl(shortlink: String, db: &Connection) -> Option<String> {
    if validate_link(&shortlink) {
        database::find_url(shortlink.as_str(), db)
    } else {
-        String::new()
+        None
    }
 }

@ -35,7 +35,7 @@ pub fn add_link(req: String, db: &Connection) -> (bool, String) {
        shortlink = random_name();
    }

-    if validate_link(shortlink.as_str()) && get_longurl(shortlink.clone(), db).is_empty() {
+    if validate_link(shortlink.as_str()) && get_longurl(shortlink.clone(), db).is_none() {
        (
            database::add_link(shortlink.clone(), longlink, db),
            shortlink,
--- a/docker_push_script.sh
+++ b/docker_push_script.sh
@ -1,37 +0,0 @@
-#!/bin/env bash
-
-if [ "$1" == "dev" ]; then
-    name="chhoto-url"
-    docker build -t $name .
-    docker tag $name sintan1729/$name:dev
-    docker push sintan1729/$name:dev
-
-elif [ "$1" == "release" ]; then
-    v_patch=$(cat actix/Cargo.toml | sed -rn 's/^version = "(.+)"$/\1/p')
-    v_minor=$(echo $v_patch | sed -rn 's/^(.+\..+)\..+$/\1/p')
-    v_major=$(echo $v_minor | sed -rn 's/^(.+)\..+$/\1/p')
-
-    name="chhoto-url"
-
-    docker build -t $name .
-
-    for tag in $v_major $v_minor $v_patch latest
-    do
-        docker tag $name sintan1729/$name:$tag
-    done
-
-    echo "Do you want to push these to Docker Hub?"
-    select yn in "Yes" "No";
-    do
-        if [ "$yn"="Yes" ]; then
-            for tag in $v_major $v_minor $v_patch latest
-            do
-                docker push sintan1729/$name:$tag
-            done
-        else
-            echo "Okay! Not pushing."
-        fi
-        break
-    done
-fi
-