build: release docker image by GitHubActions, add docker image for

spa-client
doc: add docker image for spa-client
improve: add debug log for spa-server request

Author: timzaak

.dockerignore

@@ -1,4 +1,5 @@
 target
 tmp
 .git
-.github
+.github
+doc

.github/workflows/spa-client-docker-cd.yml

@@ -0,0 +1,37 @@
+name: sap-client docker release
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        required: true
+        description: "git tag to release"
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: SPA-Client.Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: timzaak/spa-client:${{github.event.inputs.tag}}

Dockerfile

@@ -1,5 +1,7 @@
 # -*- mode: dockerfile -*-
 
+# Dockerfile for spa-server
+
 # You can override this `--build-arg BASE_IMAGE=...` to use different
 # version of Rust
 ARG BASE_IMAGE=rust:1.59

Makefile

@@ -1,7 +1,7 @@
 # All is from https://github.com/extrawurst/gitui
 SPC_CLIENT_JS_DIR = jsclient
 
-.PHONY: build-spa-client-js, build-release, release-mac, release-win, release-linux-musl, docker-release
+.PHONY: build-spa-client-js, build-release, release-mac, release-win, release-linux-musl, docker-release, spa-client-docker-release
 
 build-release:
 	cargo build --package spa-client --release
@@ -43,3 +43,11 @@ else
 	DOCKER_BUILDKIT=1 docker build . -t="timzaak/spa-server:$(VERSION)"
     docker push timzaak/spa-server:$(VERSION)
 endif
+
+spa-client-docker-release:
+ifeq ($(VERSION), )
+	$(error VEDRSION is not set)
+else
+	DOCKER_BUILDKIT=1 docker build . -f SPA-Client.Dockerfile -t="timzaak/client:$(VERSION)"
+    docker push timzaak/spa-client:$(VERSION)
+endif

SPA-Client.Dockerfile

@@ -0,0 +1,25 @@
+# -*- mode: dockerfile -*-
+
+# Dockerfile for spa-server
+
+# You can override this `--build-arg BASE_IMAGE=...` to use different
+# version of Rust
+ARG BASE_IMAGE=rust:1.59
+
+ARG RUNTIME_IMAGE=debian:buster-slim
+
+# Our first FROM statement declares the build environment.
+FROM ${BASE_IMAGE} AS builder
+
+# Add our source code.
+ADD . .
+
+# Build our application.
+RUN --mount=type=cache,target=/usr/local/cargo/registry \
+     cargo build --package spa-client --release
+
+FROM ${RUNTIME_IMAGE}
+
+COPY --from=builder ./target/release/spa-client /usr/bin
+
+CMD ["spa-client"]

client/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "spa-client"
-version = "1.2.3"
+version = "0.1.0"
 edition = "2021"
 authors = ["timzaak"]
 license = "MIT"
@@ -11,7 +11,7 @@ categories = ["command-line-utilities", "accessibility", "web-programming::http-
 
 include = ["src/**/*", "Cargo.toml"]
 
-rust-version = "1.59"
+#rust-version = "1.59"
 
 [[bin]]
 name = "spa-client"

client/client_config_default.conf

@@ -0,0 +1,10 @@
+# admin server, if set --config-dir
+server {
+  address: "http://127.0.0.1:9000"
+  auth_token: "token"
+}
+
+upload {
+  # default value is:3
+  parallel: 3
+}

client/src/lib.rs

@@ -6,6 +6,7 @@ pub mod commands;
 mod config;
 mod upload_files;
 
+use anyhow::Context;
 use crate::api::API;
 use crate::commands::{CliCommand, Commands};
 use crate::config::Config;
@@ -40,7 +41,8 @@ fn success(message: &str) {
 }
 
 fn run_with_commands(commands: CliCommand) -> anyhow::Result<()> {
-    let config = Config::load(commands.config_dir)?;
+    let config = Config::load(commands.config_dir)
+        .with_context(||"Please set config, you can get help at https://github.com/timzaak/spa-server/blob/master/doc/SPA-Client.md#how-to-use-commandline-of-spa-client")?;
     println!(
         "spa-client connect to admin server({})",
         &config.server.address

doc/Roadmap.md

@@ -1,13 +1,21 @@
 # Roadmap
 ### Version 1.3.x
-Now there is no real roadmap for V1.3.x, need users.
+Now there is no real roadmap for v1.3.x, need users.
 
-### Version 1.2.4
+### Version 1.2.5
+- [ ] make release trigger by tag
+
+
+### Version 1.2.4(client:v0.2.0)
 - [ ] release commandline of spa-client for mac/ios/linux (by GitHub Actions), put them with GitHub release page
-- [ ] fix possible bugs about uploading and spa-client(-js)
-- [ ] improve doc, ready to get the world known it.
+- [x] fix possible bugs about uploading and spa-client(-js)
+- [ ] doc: improve doc, ready to get the world known it.
+- [x] build: release docker image by GitHubActions
+- [x] build: add docker image for spa-client
+- [x] doc: how to use spa-client image
+- [x] improve: add debug log for spa-server request
 
-### version 1.2.3
+### version 1.2.3(client:v0.1.0)
 - [x] admin server export http api to accept files to local file system
 - [x] add client to sync local files to admin server（retry support）
 - [ ] ~~release server/client to crate~~ [crate needs dep version, need replace warp firstly](https://github.com/rust-lang/cargo/issues/1565)

doc/SPA-Client.md

@@ -32,3 +32,10 @@ curl "http://$ADMIN_SERVER/update_version?domain=$DOMAIN" -H "Authorization: Bea
 ```
 
 All the admin server http api is in the [Admin_Server_API.md](./doc/Admin_Server_API.md).
+
+
+## spa-client docker image
+there is an example of using spa-client docker image
+```shell
+docker run --rm -it -v $CONFIG_FILE_PATH:/client.conf timzaak/client spa-client -c /client.conf info
+```

doc/design/Uploading_File_Process.md

@@ -5,16 +5,17 @@ Firstly, there are lots of files needed upload, so `retry` and `correct` must be
 there also may exist large files which more than 20M(we would consider it later, we have lots work to do to support 
 resume breakpoint).
 
-So the admin-server should provider an api to show file metadata and status in server of the selected domain version.
-according to file metadata on the server side, `spa-client` could decide which file should be uploaded and which not,
+So the admin-server should provider api to show file metadata for checking file md5 and uploading status in server to avoid uploading conflict.
+
+According to file metadata on the server side, `spa-client` could decide which file should be uploaded and which not,
 this could save time when network errors happen.
 
-Admin-server also need to know which version is in the process of receiving files after restart. So when the 
+Admin-server also need to know which version is in the process of receiving files after restart. So when 
 `spa-client` begin to upload file, it should tell admin-server, and admin-server add a file `.SPA-Processing` to
 the directory `$Domain/$Version` if it not exists. admin-server will also reject the client uploading file if the
 version is not set `.SPA-Prpccessing`. When `spa-client` tell admin-server uploading is finished, admin-server should
 remove the file `.SPA-Processing`. The version which has `.SPA-Processing` should not be allowed to be online.
 
 
-The above article do not consider how to deal with `S3` storage, I may later bring `S3` http client to admin-server
-or `spa-client`, and do some work to improve the performance of `S3` files which are not cached in server.
+The above article do not consider how to deal with `S3` storage, we may later bring `S3` http client to admin-server
+or `spa-client`, and do some work to improve the performance of `S3` files which are not cached in `spa-server`.

example/js-app-example/README.md

@@ -16,13 +16,13 @@ npm install spa-client --save-dev
 ```
 2. add configs for spa-client in the [.env](.env) file
 
-3. Add script to package.json (need `dotenv` to inject config, you can also use config file as [SPA-Client](../../doc/SPA-Client.md)) said.
+3. Add script to package.json (need `dotenv` to inject config, you can also use config file as [SPA-Client](../../doc/SPA-Client.md) said).
 
 ```json
 {
   "script":{
       "upload": "dotenv .env.prod spa-client upload ./build www.example.com",
-      "release":"dotenv .env.prod spa-client release www.baidu.com"
+      "release":"dotenv .env.prod spa-client release www.example.com"
   }
 }
 ```
@@ -33,7 +33,7 @@ if you don't want to use `dotenv`, just like this, the config file is like [clie
 {
   "script":{
       "upload": "spa-client upload ./build www.example.com --config-dir $CONFIG_PATH",
-      "release": "spa-client release www.baidu.com --config-dir $CONFIG_PATH"
+      "release": "spa-client release www.example.com --config-dir $CONFIG_PATH"
   }
 }
 ```

jsclient/README.md

@@ -1,4 +1,4 @@
 # SPA-Client
 This is a wrapper of Rust commandline for [spa-server](https://github.com/timzaak/spa-server), 
-please read the doc [SPA_Client.md](https://github.com/timzaak/spa-server/blob/master/doc/SPA-Client.md) to more information
-about it, and there is also an example to quick start: [js-app-example](https://github.com/timzaak/spa-server/tree/master/example/js-app-example)
+please read the doc [SPA_Client.md](https://github.com/timzaak/spa-server/blob/master/doc/SPA-Client.md) to get more information , 
+and there is also an example to quick start: [js-app-example](https://github.com/timzaak/spa-server/tree/master/example/js-app-example)

server/src/file_cache.rs

@@ -151,6 +151,16 @@ pub enum DataBlock {
     // for use warp
     FileBlock(ArcPath),
 }
+/*
+impl DataBlock {
+    pub fn get_path(&self) -> &ArcPath {
+        match self {
+            DataBlock::CacheBlock {path,..} => path,
+            DataBlock::FileBlock(path) => path,
+        }
+    }
+}
+*/
 
 pub struct CacheItem {
     pub meta: Metadata,

server/src/static_file_filter.rs

@@ -176,13 +176,17 @@ fn cache_reply(
 }
 
 async fn cache_or_file_reply(
-    item: Arc<CacheItem>,
+    item: (String, Arc<CacheItem>),
     conditionals: Conditionals,
     accept_encoding: Option<String>,
 ) -> Result<Response<Body>, Rejection> {
+    let (key, item) = item;
     let modified = item.meta.modified().map(LastModified::from).ok();
     match conditionals.check(modified) {
-        Cond::NoBody(resp) => Ok(resp),
+        Cond::NoBody(resp) => {
+            tracing::debug!("{} hit client cache", key);
+            Ok(resp)
+        },
         Cond::WithBody(range) => match &item.data {
             DataBlock::CacheBlock {
                 bytes,
@@ -200,16 +204,23 @@ async fn cache_or_file_reply(
                 //false,false => cache without content-encoding
                 //false, true => file
                 if !client_accept_gzip && compressed {
+                    tracing::debug!("{} hit disk", key);
                     file_reply(&item, path.as_ref(), range, modified).await
                 } else {
                     let mut resp = cache_reply(item.as_ref(), bytes, range, modified);
                     if client_accept_gzip && compressed {
+                        tracing::debug!("{} hit cache, compressed", key);
                         resp.headers_mut().typed_insert(ContentEncoding::gzip());
+                    }else {
+                        tracing::debug!("{} hit cache", key);
                     }
                     Ok(resp)
                 }
             }
-            DataBlock::FileBlock(path) => file_reply(&item, path.as_ref(), range, modified).await,
+            DataBlock::FileBlock(path) => {
+                tracing::debug!("{} hit disk", key);
+                file_reply(&item, path.as_ref(), range, modified).await
+            },
         },
     }
 }
@@ -239,33 +250,37 @@ fn cache_item_to_response_header(
     }
 }
 
-pub fn static_file_filter(
+async fn get_cache_file(
+    tail: warp::path::Tail,
+    authority_opt: Option<Authority>,
     domain_storage: Arc<DomainStorage>,
-) -> impl Filter<Extract = (Response<Body>,), Error = Rejection> + Clone {
-    async fn get_cache_file(
-        tail: warp::path::Tail,
-        authority_opt: Option<Authority>,
-        domain_storage: Arc<DomainStorage>,
-    ) -> Result<Arc<CacheItem>, Rejection> {
-        match authority_opt {
-            Some(authority) => {
-                let key = sanitize_path(tail.as_str()).map(|s| {
-                    if s.is_empty() {
-                        "index.html".to_owned()
-                    } else {
-                        s
-                    }
-                })?;
-                let host = authority.host();
-                if let Some(cache_item) = domain_storage.get_file(host, &key) {
-                    Ok(cache_item)
+) -> Result<(String,Arc<CacheItem>), Rejection> {
+    match authority_opt {
+        Some(authority) => {
+            let key = sanitize_path(tail.as_str()).map(|s| {
+                if s.is_empty() {
+                    "index.html".to_owned()
                 } else {
-                    Err(reject::not_found())
+                    s
                 }
+            })?;
+            let host = authority.host();
+            if let Some(cache_item) = domain_storage.get_file(host, &key) {
+                Ok((key, cache_item))
+            } else {
+                tracing::debug!("no file for: {}/{}", &host, &key);
+                Err(reject::not_found())
             }
-            None => Err(reject::not_found()),
         }
+        None => {
+            tracing::warn!("No Authority Request");
+            Err(reject::not_found())
+        },
     }
+}
+pub fn static_file_filter(
+    domain_storage: Arc<DomainStorage>,
+) -> impl Filter<Extract = (Response<Body>,), Error = Rejection> + Clone {
     warp::get()
         .or(warp::head())
         .unify()