feat: move admin ui into sub crate (#91)

Author: bzp2010

.github/workflows/build.yaml

@@ -2,9 +2,9 @@ name: Build
 
 on:
   push:
-    branches: ["main"]
+    branches: [ "main" ]
   pull_request:
-    branches: ["main"]
+    branches: [ "main" ]
 
 env:
   CARGO_TERM_COLOR: always
@@ -27,7 +27,7 @@ jobs:
         with:
           node-version: lts/*
           cache: "pnpm"
-          cache-dependency-path: ui/pnpm-lock.yaml
+          cache-dependency-path: crates/admin-ui/ui/pnpm-lock.yaml
 
       - name: Setup Rust toolchain
         run: rustup toolchain install stable --profile minimal
@@ -42,23 +42,27 @@ jobs:
         id: ui-cache
         uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # 5.0.4
         with:
-          path: ui/dist
-          key: ui-dist-${{ hashFiles('ui/src/**', 'ui/index.html', 'ui/vite.config.ts', 'ui/tsconfig*.json', 'ui/package.json', 'ui/pnpm-lock.yaml') }}
+          path: crates/admin-ui/ui-dist
+          key: ui-dist-${{ hashFiles('crates/admin-ui/ui/src/**',
+            'crates/admin-ui/ui/index.html',
+            'crates/admin-ui/ui/vite.config.ts',
+            'crates/admin-ui/ui/tsconfig*.json',
+            'crates/admin-ui/ui/package.json',
+            'crates/admin-ui/ui/pnpm-lock.yaml', 'crates/admin-ui/build.rs',
+            'crates/admin-ui/Cargo.toml') }}
 
       - name: Build UI
         if: steps.ui-cache.outputs.cache-hit != 'true'
-        run: |
-          pnpm -C ui install --frozen-lockfile
-          pnpm -C ui build
+        run: cargo build -p aisix-admin-ui --features build-ui -vv
 
       - name: Run Lint
-        run: cargo clippy --all-targets --locked -- -D warnings
+        run: cargo clippy --workspace --all-targets --locked -- -D warnings
 
       - name: Build
         run: cargo build --locked
 
       - name: Run Test
-        run: cargo test --locked
+        run: cargo test --workspace --locked
 
       - name: Run E2E Test
         run: |

.gitignore

@@ -7,8 +7,7 @@
 
 # Node.js/TypeScript/Vite
 node_modules/
-ui/node_modules/
-ui/dist/
+ui-dist/
 ui/.vite/
 ui/.cache/
 *.tsbuildinfo

Cargo.lock

@@ -1,5 +1,5 @@
 [workspace]
-members = ["crates/aisix-llm"]
+members = ["crates/aisix-llm", "crates/admin-ui"]
 resolver = "3"
 
 [workspace.package]
@@ -8,6 +8,7 @@ edition = "2024"
 rust-version = "1.85"
 
 [workspace.dependencies]
+anyhow = "1"
 async-trait = "0.1"
 assert_matches = "1.5"
 aws-credential-types = "1.2.14"
@@ -51,35 +52,42 @@ edition = "2024"
 rust-version = "1.85"
 
 [features]
-build-ui = []
+build-ui = ["aisix-admin-ui/build-ui"]
 
 [dependencies]
 aisix-llm = { path = "crates/aisix-llm" }
+aisix-admin-ui = { path = "crates/admin-ui" }
+anyhow.workspace = true
+tokio.workspace = true
+reqwest.workspace = true
+http.workspace = true
+axum.workspace = true
+serde.workspace = true
+serde_json.workspace = true
+async-trait.workspace = true
+aws-credential-types.workspace = true
+aws-sigv4.workspace = true
+aws-smithy-eventstream.workspace = true
+aws-smithy-runtime-api.workspace = true
+aws-smithy-types.workspace = true
+futures.workspace = true
+bytes.workspace = true
+fastrace.workspace = true
+pin-project.workspace = true
+thiserror.workspace = true
+uuid.workspace = true
+utoipa.workspace = true
+percent-encoding.workspace = true
+
 log = { version = "0.4.29", features = ["kv", "kv_serde"] }
-tokio = { workspace = true }
-reqwest = { workspace = true }
 openssl = { version = "0.10.77" }
 tokio-openssl = "0.6"
 clap = { version = "4.6.0", features = ["derive"] }
 config = "0.15"
-http = { workspace = true }
 http-body = "1.0.1"
 http-body-util = "0.1.3"
-axum = { workspace = true }
-serde = { workspace = true }
-serde_json = { workspace = true }
 etcd-client = { version = "0.18.0", features = ["tls-openssl"] }
-async-trait = { workspace = true }
-aws-credential-types = { workspace = true }
-aws-sigv4 = { workspace = true }
-aws-smithy-eventstream = { workspace = true }
-aws-smithy-runtime-api = { workspace = true }
-aws-smithy-types = { workspace = true }
-futures = { workspace = true }
-bytes = { workspace = true }
 arc-swap = "1"
-anyhow = "1"
-fastrace = { workspace = true }
 fastrace-axum = "0.2.0"
 fastrace-opentelemetry = "0.17.0"
 opentelemetry = "0.31.0"
@@ -109,23 +117,18 @@ opentelemetry-semantic-conventions = { version = "0.31.0", features = [
 ] }
 metrics = "0.24.2"
 metrics-exporter-otel = "0.3.0"
-pin-project = { workspace = true }
 dashmap = "6.1.0"
-thiserror = { workspace = true }
 skp-ratelimit = { git = "https://github.com/bzp2010/skp-ratelimit.git", branch = "bzp/feat-custom-cost", default-features = false, features = [
   "memory",
 ] }
 rand = "0.10.1"
 jsonschema = { version = "0.46.0", default-features = false }
-uuid = { workspace = true }
-utoipa = { workspace = true }
 utoipa-scalar = { version = "0.3", features = ["axum"] }
 rust-embed = { version = "8.11.0", default-features = false, features = [
   "axum-ex",
   "debug-embed",
   "deterministic-timestamps",
 ] }
-mime_guess = "2.0.5"
 tower = { version = "0.5.3", default-features = false, features = ["util"] }
 validator = { version = "0.20", features = ["derive"] }
 axum-server = { version = "0.8.0", default-features = false, features = [
@@ -134,16 +137,15 @@ axum-server = { version = "0.8.0", default-features = false, features = [
 backon = { version = "1.6.0", default-features = false, features = [
   "tokio-sleep",
 ] }
-percent-encoding = { workspace = true }
 
 [build-dependencies]
 vergen-git2 = { version = "9.1.0" }
 anyhow = "1"
 
 [dev-dependencies]
+assert_matches.workspace = true
+pretty_assertions.workspace = true
 tokio-test = "0.4"
-assert_matches = { workspace = true }
-pretty_assertions = { workspace = true }
 rstest = "0.26"
 tempfile = "3"
 

Cargo.toml

@@ -1,11 +1,7 @@
-use std::{env, fs, process};
-
-use anyhow::{Result, anyhow};
+use anyhow::Result;
 use vergen_git2::{Emitter, Git2Builder};
 
 fn main() -> Result<()> {
-    build_ui()?;
-
     Emitter::default()
         .add_instructions(&Git2Builder::default().sha(true).build()?)?
         .emit()?;
@@ -14,39 +10,3 @@ fn main() -> Result<()> {
 
     Ok(())
 }
-
-fn build_ui() -> Result<()> {
-    let manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap_or_else(|_| ".".to_string());
-
-    if env::var("CARGO_FEATURE_BUILD_UI").is_ok() {
-        println!("cargo:rerun-if-changed=ui");
-
-        let status = process::Command::new("pnpm")
-            .args(["install", "--frozen-lockfile"])
-            .current_dir(format!("{manifest_dir}/ui"))
-            .stdout(std::process::Stdio::inherit())
-            .stderr(std::process::Stdio::inherit())
-            .status()?;
-
-        if !status.success() {
-            return Err(anyhow!(
-                "failed to install ui dependencies with status: {}",
-                status
-            ));
-        }
-
-        let status = process::Command::new("pnpm")
-            .args(["run", "build"])
-            .current_dir(format!("{manifest_dir}/ui"))
-            .stdout(std::process::Stdio::inherit())
-            .stderr(std::process::Stdio::inherit())
-            .status()?;
-
-        if !status.success() {
-            return Err(anyhow!("failed to build ui with status: {}", status));
-        }
-    } else {
-        fs::create_dir_all(format!("{manifest_dir}/ui/dist"))?;
-    }
-    Ok(())
-}

build.rs

@@ -0,0 +1,26 @@
+[package]
+name = "aisix-admin-ui"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+
+[features]
+build-ui = []
+
+[dependencies]
+axum.workspace = true
+http.workspace = true
+mime_guess = "2.0.5"
+rust-embed = { version = "8.11.0", default-features = false, features = [
+  "axum-ex",
+  "debug-embed",
+  "deterministic-timestamps",
+] }
+
+[dev-dependencies]
+axum.workspace = true
+assert_matches.workspace = true
+pretty_assertions.workspace = true
+
+[build-dependencies]
+anyhow.workspace = true

crates/admin-ui/Cargo.toml

@@ -0,0 +1,44 @@
+use std::{env, fs, process};
+
+use anyhow::{Result, bail};
+
+fn main() -> Result<()> {
+    build_ui()?;
+
+    println!("cargo:rerun-if-changed=build.rs");
+
+    Ok(())
+}
+
+fn build_ui() -> Result<()> {
+    let manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap_or_else(|_| ".".to_string());
+
+    fs::create_dir_all(format!("{manifest_dir}/ui-dist"))?;
+
+    if env::var("CARGO_FEATURE_BUILD_UI").is_ok() {
+        println!("cargo:rerun-if-changed=ui/");
+
+        let status = process::Command::new("pnpm")
+            .args(["install", "--frozen-lockfile"])
+            .current_dir(format!("{manifest_dir}/ui"))
+            .stdout(std::process::Stdio::inherit())
+            .stderr(std::process::Stdio::inherit())
+            .status()?;
+
+        if !status.success() {
+            bail!("failed to install ui dependencies with status: {}", status);
+        }
+
+        let status = process::Command::new("pnpm")
+            .args(["run", "build"])
+            .current_dir(format!("{manifest_dir}/ui"))
+            .stdout(std::process::Stdio::inherit())
+            .stderr(std::process::Stdio::inherit())
+            .status()?;
+
+        if !status.success() {
+            bail!("failed to build ui with status: {}", status);
+        }
+    }
+    Ok(())
+}

crates/admin-ui/build.rs

@@ -5,7 +5,7 @@ use rust_embed::Embed;
 const UI_INDEX_HTML: &str = "index.html";
 
 #[derive(Embed)]
-#[folder = "ui/dist/"]
+#[folder = "ui-dist/"]
 struct Assets;
 
 pub async fn handler(uri: Uri) -> Response {