release 2.2.4

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

@@ -20,7 +20,7 @@ jobs:
           - os: macos-latest
             name: mac-spa-client
             bash: make release-client-mac
-          - os:  windows-latest
+          - os: windows-latest
             name: windows-spa-client
             bash: make release-client-win
     runs-on: ${{ matrix.settings.os }}
@@ -29,21 +29,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           submodules: true
-
-      - name: Install Rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-      - name: Cache cargo registry
-        uses: actions/cache@v2
-        with:
-          path: ~/.cargo/registry
-          key: ${{ matrix.settings.os }}-cargo-registry-trimmed-${{ hashFiles('**/Cargo.lock') }}
-      - name: Cache cargo index
-        uses: actions/cache@v2
-        with:
-          path: ~/.cargo/git
-          key: ${{ matrix.settings.os }}-cargo-index-trimmed-${{ hashFiles('**/Cargo.lock') }}
+      - uses: Swatinem/rust-cache@v2
       - name: Setup MUSL
         if: matrix.settings.os == 'ubuntu-latest'
         run: |
@@ -53,7 +39,6 @@ jobs:
       - name: Build Release
         run: ${{ matrix.settings.bash }}
 
-
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:

.github/workflows/spa-server-cd.yml

@@ -47,28 +47,11 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: true
-      - name: Install Rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-
-      - name: Cache cargo registry
-        uses: actions/cache@v2
-        with:
-          path: ~/.cargo/registry
-          key: cargo-registry-trimmed-${{ hashFiles('**/Cargo.lock') }}
-
-      - name: Cache cargo index
-        uses: actions/cache@v2
-        with:
-          path: ~/.cargo/git
-          key: cargo-index-trimmed-${{ hashFiles('**/Cargo.lock') }}
-
+      - uses: Swatinem/rust-cache@v2
       - name: Setup MUSL
         run: |
           rustup target add x86_64-unknown-linux-musl
           sudo apt-get -qq install musl-tools
-
       - name: Build Release Linux
         run: make release-linux-server-musl
 

.github/workflows/spa-server-ci.yml

@@ -14,31 +14,16 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: true
-      - name: Install Rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-      - name: Cache cargo registry
-        uses: actions/cache@v2
-        with:
-          path: ~/.cargo/registry
-          key: cargo-registry-trimmed-${{ hashFiles('**/Cargo.lock') }}
-      - name: Cache cargo index
-        uses: actions/cache@v2
-        with:
-          path: ~/.cargo/git
-          key: cargo-index-trimmed-${{ hashFiles('**/Cargo.lock') }}
-      - name: build all
-        run: cargo build
-      - name: run spa-client test
-        run: cargo test -p spa-client
-      - name: run spa-client test
-        run: cargo test -p spa-server
+      - uses: Swatinem/rust-cache@v2
       - name: run integration test
         # --show-output
         run: cargo test -p tests --test starter -j 1 -- --test-threads 1
       - name: run pebble
         run: ./run_pebble.sh
         working-directory: ./tests/bash/
       - name: run acme integration test
-        run: cargo test -p tests --test acme_test -j 1 -- --test-threads 1
+        run: cargo test -p tests --test acme_test -j 1 -- --test-threads 1
+      - name: run spa-client test
+        run: cargo test -p spa-client
+      - name: run spa-client test
+        run: cargo test -p spa-server

client/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "spa-client"
-version = "2.2.3"
+version = "2.2.4"
 edition = "2021"
 authors = ["timzaak"]
 license = "MIT"

client/src/api.rs

@@ -1,11 +1,8 @@
 use crate::Config;
 use anyhow::anyhow;
 use reqwest::{header, multipart, StatusCode};
-use spa_server::admin_server::request::{
-    DeleteDomainVersionOption, DomainWithOptVersionOption, GetDomainOption,
-    UpdateUploadingStatusOption,
-};
-use spa_server::domain_storage::{DomainInfo, ShortMetaData, UploadDomainPosition};
+use spa_server::admin_server::request::{DeleteDomainVersionOption, DomainWithOptVersionOption, DomainWithVersionOption, GetDomainOption, UpdateUploadingStatusOption};
+use spa_server::domain_storage::{CertInfo, DomainInfo, ShortMetaData, UploadDomainPosition};
 use std::borrow::Cow;
 use std::path::PathBuf;
 
@@ -129,6 +126,19 @@ impl API {
         handle!(resp)
     }
 
+    pub async fn revoke_version(&self, domain:String, version:u32) -> anyhow::Result<()> {
+        let resp = self
+            .async_client
+            .post(self.url("files/revoke_version"))
+            .json(&DomainWithVersionOption {
+                domain,
+                version,
+            })
+            .send()
+            .await?;
+        handle!(resp)
+    }
+
     //TODO: use thiserror instead of anyhow
     pub async fn upload_file<T: Into<Cow<'static, str>>>(
         &self,
@@ -185,6 +195,12 @@ impl API {
             .await?;
         json_resp!(resp, UploadDomainPosition)
     }
+
+    pub async fn get_acme_cert_info(&self, domain: Option<String>) -> anyhow::Result<Vec<CertInfo>> {
+        let resp = self.async_client.get(self.url("cert/acme"))
+            .query(&GetDomainOption{domain}).send().await?;
+        json_resp!(resp, Vec<CertInfo>)         
+    }
 }
 #[cfg(test)]
 mod test {

client/src/commands.rs

@@ -25,6 +25,10 @@ pub enum Commands {
         domain: Option<String>,
         max_reserve: Option<u32>,
     },
+    Revoke {
+        domain: String,
+        version: u32,
+    }
 }
 
 #[derive(Args, Debug)]
@@ -116,4 +120,15 @@ mod test {
             unreachable!()
         }
     }
+
+    #[test]
+    fn revoke_version() {
+        let c = CliCommand::parse_from(&["test", "revoke", "www.example.com", "1"]);
+        if let Commands::Revoke {domain, version} = c.commands {
+            assert_eq!(domain, "www.example.com".to_string());
+            assert_eq!(version, 1);
+        } else {
+            unreachable!()
+        }
+    }
 }

client/src/lib.rs

@@ -62,6 +62,10 @@ async fn run_with_commands(commands: CliCommand) -> anyhow::Result<()> {
             api.remove_files(domain, max_reserve).await?;
             success("delete success!");
         }
+        Commands::Revoke {domain, version} => {
+            api.revoke_version(domain, version).await?;
+            success("revoke success!");
+        }
     };
     Ok(())
 }

config.release.conf

@@ -28,7 +28,7 @@ file_dir = "/data"
 //    # directory to store account and certificate
 //    # optional, default is ${file_dir}/acme
 //    // dir = "/data/acme"
-//    # ci / stage / prod, default is prod
+//    # ci / stage / prod, default is prod, ci is just for CI test with Pebble, don't use it.
 //    //type = prod
 //  }
 

docs/develop/change-log.md

@@ -1,4 +1,12 @@
 # Change Log
+
+### Version 2.2.4
+
+- feat: add cert query API (no doc, no client SDK support)
+- improve: add check when upload of multiple/single domain
+- ci: improve GitHub Action speed
+- feat: add revoke version API (release JS SDK 2.2.4)
+
 ### Version 2.2.3
 - fix: sub_path '' => '/', like GitHub pages
 - fix: redirect with no querystring

docs/guide/spa-server-api.md

@@ -94,7 +94,7 @@ number of files.
 
 ```shell
 
-curl "http://$ADMIN_SERVER/files/metadata?domain=$DOMAIN&version=$VERSION" -H "Authorization: Bearer $TOKEN"
+curl "$ADMIN_SERVER/files/metadata?domain=$DOMAIN&version=$VERSION" -H "Authorization: Bearer $TOKEN"
 # return [{path:$path_string,md5:$md5_string, length: $file_length_integer}]
 ```
 
@@ -105,7 +105,7 @@ curl "http://$ADMIN_SERVER/files/metadata?domain=$DOMAIN&version=$VERSION" -H "A
 ```shell 
 UPLOADING_STATUS=0 # Uploading:0, Finish:1
 
-curl --location --request POST "http://$ADMIN_SERVER/files/upload_status" \
+curl --location --request POST "$ADMIN_SERVER/files/upload_status" \
 --header "Authorization: Bearer $TOKEN" \
 --header 'Content-Type: application/json' \
 --data-raw `{
@@ -122,7 +122,7 @@ The http body is `multipart/form-data` format.
 
 ```shell
 PATH="/upload/file/path"
-curl -X POST "http://$ADMIN_SERVER/file/upload?domain=$domain&version=$version&path=$PATH" \
+curl -X POST "$ADMIN_SERVER/file/upload?domain=$domain&version=$version&path=$PATH" \
 -F "file=@$PATH" -H "Authorization: Bearer $TOKEN"
 # return status code:200 if success 
 ```
@@ -131,11 +131,30 @@ curl -X POST "http://$ADMIN_SERVER/file/upload?domain=$domain&version=$version&p
 
 ```shell
 # keep 2 versions. 
-MAX_RESERVE = 1
+MAX_RESERVE_OPT = 1
 curl -X POST "http://$ADMIN_SERVER/files/delete" \
+ -H "Authorization: Bearer $TOKEN" \
 --data-raw `{
   "domain":$DOMAIN,
-  "max_reserve": $MAX_RESERVE
+  "max_reserve": $MAX_RESERVE_OPT
 }`
 # return status code:200 if success 
+```
+
+### Revoke version
+**Attention: revoke version now is temp, when you reload or restart server, then It would use the max version.**
+```shell
+TARGET_VERSION=1
+curl -X POST "$ADMIN_SERVER/files/revoke_version" \
+ -H "Authorization: Bearer $TOKEN" \
+--data-raw `{
+  "domain":$DOMAIN,
+  "version": $TARGET_VERSION
+}`
+```
+
+### Get Cert version
+```shell
+curl -X POST "$ADMIN_SERVER/cert?domain=$DOMAIN_OPT" \
+ - H "Authorization: Bearer $TOKEN"
 ```

docs/guide/spa-server-configuration.md

@@ -40,7 +40,7 @@ file_dir = "/data"
 //    # directory to store account and certificate
 //    # optional, default is ${file_dir}/acme
 //    // dir = "/data/acme"
-//    # ci / stage / prod, default is prod
+//    # ci / stage / prod, default is prod, ci is just for CI test with Pebble, don't use it.
 //    //type = prod
 //  }
 

jsclient/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spa-client",
-  "version": "2.2.2",
+  "version": "2.2.4",
   "description": "js sdk for spa-server",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

jsclient/src/command.ts

@@ -135,14 +135,29 @@ const deleteCmd = command({
         })
     }
 })
+const revokeVersionCmd = command({
+    name: 'revoke',
+    args: {
+        domain,
+        version,
+        config: configDirOption
+    },
+    handler({domain, version, config}) {
+        writeResult(async() => {
+            const client = await getClient(config)
+            await client.revokeVersion(domain, version)
+            return "revoke successful"
+        })
+    }
+})
 
 
 export const cmd = subcommands({
     name: 'spa-client',
     description: 'js command line for spa-server',
     version: Version,
-    cmds: {info, upload, release, reload, delete: deleteCmd}
+    cmds: {info, upload, release, reload, delete: deleteCmd, revoke: revokeVersionCmd}
 })
 export default function runCommand() {
     run(binary(cmd), process.argv)
-}
+}

jsclient/src/index.ts

@@ -31,6 +31,12 @@ export interface UploadDomainPositionResp {
     status: GetDomainPositionStatus
 }
 
+export interface CertInfoResp {
+    begin: string,
+    end: string,
+    host: string,
+}
+
 export interface ShortMetaData {
     path: string
     md5: string
@@ -202,6 +208,12 @@ export default class SPAClient {
             params: {domain, format: 'Json'}
         }).then(resp<UploadDomainPositionResp>)
     }
+    public revokeVersion(domain:String, version: number) {
+        return this.http.post(`/files/revoke_version`, {domain, version}).then(emptyResp)
+    }
+    public getCertInfo(domain?:string) {
+        return this.http.get('/cert/acme', {params: {domain}}).then(resp<CertInfoResp[]>)
+    }
 }
 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "spa-server-doc",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "description": "This is for docs powered by VitePress",
   "private": true,
   "type": "module",