diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..2d25c3f --- /dev/null +++ b/.dockerignore @@ -0,0 +1,11 @@ +.git +target +notes +node_modules +dist +coverage +.idea +.vscode +.DS_Store +*.log +var diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..f2e3bb3 --- /dev/null +++ b/.env.example @@ -0,0 +1,11 @@ +POSTGRES_DB=rmcp +POSTGRES_USER=rmcp +POSTGRES_PASSWORD=change-me +MCPAAS_DATABASE_URL=postgres://rmcp:change-me@postgres:5432/rmcp +MCPAAS_STORAGE_ROOT=/var/lib/rmcp/storage +MCPAAS_ADMIN_BIND=0.0.0.0:3001 +MCPAAS_MCP_BIND=0.0.0.0:3002 +MCPAAS_LOG_LEVEL=info +MCPAAS_SECRET_PROVIDER=env +MCPAAS_PUBLIC_BASE_URL=https://rmcp.example.com +MCPAAS_MCP_PUBLIC_URL=https://rmcp.example.com/mcp diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..56e9c44 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,42 @@ +name: CI + +on: + pull_request: + push: + branches: + - main + - "feat/**" + +concurrency: + group: ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + rust: + name: Rust Checks + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Install Rust toolchain + uses: dtolnay/rust-toolchain@master + with: + toolchain: 1.85.0 + components: rustfmt, clippy + + - name: Cache cargo artifacts + uses: Swatinem/rust-cache@v2 + + - name: Check formatting + run: cargo fmt --all --check + + - name: Check workspace + run: cargo check --workspace + + - name: Run clippy + run: cargo clippy --workspace --all-targets --all-features -- -D warnings + + - name: Run tests + run: cargo test --workspace --all-targets diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..9df5dfd --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,62 @@ +name: Deploy + +on: + push: + branches: + - main + workflow_dispatch: + +concurrency: + group: deploy-${{ github.ref }} + cancel-in-progress: true + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup SSH agent + uses: webfactory/ssh-agent@v0.9.0 + with: + ssh-private-key: ${{ secrets.DEPLOY_SSH_KEY }} + + - name: Configure known hosts + run: | + mkdir -p ~/.ssh + chmod 700 ~/.ssh + printf '%s\n' "${{ secrets.DEPLOY_KNOWN_HOSTS }}" > ~/.ssh/known_hosts + chmod 644 ~/.ssh/known_hosts + + - name: Sync project to server + run: | + rsync -az --delete \ + --exclude ".git" \ + --exclude "target" \ + --exclude "notes" \ + --exclude "node_modules" \ + ./ "${{ secrets.DEPLOY_USER }}@${{ secrets.DEPLOY_HOST }}:${{ secrets.DEPLOY_PATH }}/" + + - name: Write environment file + run: | + ssh "${{ secrets.DEPLOY_USER }}@${{ secrets.DEPLOY_HOST }}" \ + "mkdir -p '${{ secrets.DEPLOY_PATH }}' && cat > '${{ secrets.DEPLOY_PATH }}/.env'" \ + <<< "${{ secrets.DEPLOY_ENV_FILE }}" + + - name: Deploy with Docker Compose + run: | + ssh "${{ secrets.DEPLOY_USER }}@${{ secrets.DEPLOY_HOST }}" " + set -e + cd '${{ secrets.DEPLOY_PATH }}' + docker compose up -d --build --remove-orphans + " + + - name: Verify health endpoints + run: | + ssh "${{ secrets.DEPLOY_USER }}@${{ secrets.DEPLOY_HOST }}" " + set -e + curl --fail --silent http://127.0.0.1:3001/health >/dev/null + curl --fail --silent http://127.0.0.1:3002/health >/dev/null + " diff --git a/.gitignore b/.gitignore index 39bb821..faaf180 100644 --- a/.gitignore +++ b/.gitignore @@ -7,5 +7,5 @@ /coverage /.env /var +/notes *.log - diff --git a/Cargo.lock b/Cargo.lock index 33d2385..ddb72cf 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -6,22 +6,227 @@ version = 4 name = "admin-api" version = "0.1.0" dependencies = [ + "axum", + "serde_json", "tokio", "tracing", + "tracing-subscriber", ] +[[package]] +name = "aho-corasick" +version = "1.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddd31a130427c27518df266943a5308ed92d4b226cc639f5a8f1002816174301" +dependencies = [ + "memchr", +] + +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + +[[package]] +name = "axum" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b52af3cb4058c895d37317bb27508dccc8e5f2d39454016b297bf4a400597b8" +dependencies = [ + "axum-core", + "bytes", + "form_urlencoded", + "futures-util", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-util", + "itoa", + "matchit", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "serde_core", + "serde_json", + "serde_path_to_error", + "serde_urlencoded", + "sync_wrapper", + "tokio", + "tower", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "axum-core" +version = "0.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08c78f31d7b1291f7ee735c1c6780ccde7785daae9a9206026862dab7d8792d1" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "http-body-util", + "mime", + "pin-project-lite", + "sync_wrapper", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "bytes" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33" + +[[package]] +name = "cfg-if" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801" + [[package]] name = "equivalent" version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" +[[package]] +name = "form_urlencoded" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" +dependencies = [ + "percent-encoding", +] + +[[package]] +name = "futures-channel" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07bbe89c50d7a535e539b8c17bc0b49bdb77747034daa8087407d655f3f7cc1d" +dependencies = [ + "futures-core", +] + +[[package]] +name = "futures-core" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e3450815272ef58cec6d564423f6e755e25379b217b0bc688e295ba24df6b1d" + +[[package]] +name = "futures-task" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "037711b3d59c33004d3856fbdc83b99d4ff37a24768fa1be9ce3538a1cde4393" + +[[package]] +name = "futures-util" +version = "0.3.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "389ca41296e6190b48053de0321d02a77f32f8a5d2461dd38762c0593805c6d6" +dependencies = [ + "futures-core", + "futures-task", + "pin-project-lite", + "slab", +] + [[package]] name = "hashbrown" version = "0.16.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "841d1cc9bed7f9236f321df977030373f4a4163ae1a7dbfe1a51a2c1a51d9100" +[[package]] +name = "http" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3ba2a386d7f85a81f119ad7498ebe444d2e22c2af0b86b069416ace48b3311a" +dependencies = [ + "bytes", + "itoa", +] + +[[package]] +name = "http-body" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1efedce1fb8e6913f23e0c92de8e62cd5b772a67e7b3946df930a62566c93184" +dependencies = [ + "bytes", + "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b021d93e26becf5dc7e1b75b1bed1fd93124b374ceb73f43d4d4eafec896a64a" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "pin-project-lite", +] + +[[package]] +name = "httparse" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" + +[[package]] +name = "httpdate" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df3b46402a9d5adb4c86a0cf463f42e19994e3ee891101b1841f30a545cb49a9" + +[[package]] +name = "hyper" +version = "1.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ab2d4f250c3d7b1c9fcdff1cece94ea4e2dfbec68614f7b87cb205f24ca9d11" +dependencies = [ + "atomic-waker", + "bytes", + "futures-channel", + "futures-core", + "http", + "http-body", + "httparse", + "httpdate", + "itoa", + "pin-project-lite", + "pin-utils", + "smallvec", + "tokio", +] + +[[package]] +name = "hyper-util" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96547c2556ec9d12fb1578c4eaf448b04993e7fb79cbaad930a656880a6bdfa0" +dependencies = [ + "bytes", + "http", + "http-body", + "hyper", + "pin-project-lite", + "tokio", + "tower-service", +] + [[package]] name = "indexmap" version = "2.13.0" @@ -38,12 +243,48 @@ version = "1.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682" +[[package]] +name = "lazy_static" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" + +[[package]] +name = "libc" +version = "0.2.183" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5b646652bf6661599e1da8901b3b9522896f01e736bad5f723fe7a3a27f899d" + +[[package]] +name = "log" +version = "0.4.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897" + +[[package]] +name = "matchers" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1525a2a28c7f4fa0fc98bb91ae755d1e2d1505079e05539e35bc876b5d65ae9" +dependencies = [ + "regex-automata", +] + +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + [[package]] name = "mcp-server" version = "0.1.0" dependencies = [ + "axum", + "serde_json", "tokio", "tracing", + "tracing-subscriber", ] [[package]] @@ -152,18 +393,56 @@ version = "2.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79" +[[package]] +name = "mime" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" + +[[package]] +name = "mio" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a69bcab0ad47271a0234d9422b131806bf3968021e5dc9328caf2d4cd58557fc" +dependencies = [ + "libc", + "wasi", + "windows-sys", +] + +[[package]] +name = "nu-ansi-term" +version = "0.50.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7957b9740744892f114936ab4a57b3f487491bbeafaf8083688b16841a4240e5" +dependencies = [ + "windows-sys", +] + [[package]] name = "once_cell" version = "1.21.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" +[[package]] +name = "percent-encoding" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + [[package]] name = "pin-project-lite" version = "0.2.17" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" +[[package]] +name = "pin-utils" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184" + [[package]] name = "proc-macro2" version = "1.0.106" @@ -182,6 +461,23 @@ dependencies = [ "proc-macro2", ] +[[package]] +name = "regex-automata" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e1dd4122fc1595e8162618945476892eefca7b88c52820e74af6262213cae8f" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.8.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc897dd8d9e8bd1ed8cdad82b5966c3e0ecae09fb1907d58efaa013543185d0a" + [[package]] name = "ryu" version = "1.0.23" @@ -231,6 +527,29 @@ dependencies = [ "zmij", ] +[[package]] +name = "serde_path_to_error" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10a9ff822e371bb5403e391ecd83e182e0e77ba7f6fe0160b795797109d1b457" +dependencies = [ + "itoa", + "serde", + "serde_core", +] + +[[package]] +name = "serde_urlencoded" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3491c14715ca2294c4d6a88f15e84739788c1d030eed8c110436aafdaa2f3fd" +dependencies = [ + "form_urlencoded", + "itoa", + "ryu", + "serde", +] + [[package]] name = "serde_yaml" version = "0.9.34+deprecated" @@ -244,6 +563,37 @@ dependencies = [ "unsafe-libyaml", ] +[[package]] +name = "sharded-slab" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6" +dependencies = [ + "lazy_static", +] + +[[package]] +name = "slab" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5" + +[[package]] +name = "smallvec" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" + +[[package]] +name = "socket2" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a766e1110788c36f4fa1c2b71b387a7815aa65f88ce0229841826633d93723e" +dependencies = [ + "libc", + "windows-sys", +] + [[package]] name = "syn" version = "2.0.117" @@ -255,6 +605,12 @@ dependencies = [ "unicode-ident", ] +[[package]] +name = "sync_wrapper" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" + [[package]] name = "thiserror" version = "2.0.18" @@ -275,14 +631,27 @@ dependencies = [ "syn", ] +[[package]] +name = "thread_local" +version = "1.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f60246a4944f24f6e018aa17cdeffb7818b76356965d03b07d6a9886e8962185" +dependencies = [ + "cfg-if", +] + [[package]] name = "tokio" version = "1.50.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "27ad5e34374e03cfffefc301becb44e9dc3c17584f414349ebe29ed26661822d" dependencies = [ + "libc", + "mio", "pin-project-lite", + "socket2", "tokio-macros", + "windows-sys", ] [[package]] @@ -296,12 +665,41 @@ dependencies = [ "syn", ] +[[package]] +name = "tower" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" +dependencies = [ + "futures-core", + "futures-util", + "pin-project-lite", + "sync_wrapper", + "tokio", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + +[[package]] +name = "tower-service" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" + [[package]] name = "tracing" version = "0.1.44" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" dependencies = [ + "log", "pin-project-lite", "tracing-attributes", "tracing-core", @@ -325,6 +723,36 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" dependencies = [ "once_cell", + "valuable", +] + +[[package]] +name = "tracing-log" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee855f1f400bd0e5c02d150ae5de3840039a3f54b025156404e34c23c03f47c3" +dependencies = [ + "log", + "once_cell", + "tracing-core", +] + +[[package]] +name = "tracing-subscriber" +version = "0.3.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb7f578e5945fb242538965c2d0b04418d38ec25c79d160cd279bf0731c8d319" +dependencies = [ + "matchers", + "nu-ansi-term", + "once_cell", + "regex-automata", + "sharded-slab", + "smallvec", + "thread_local", + "tracing", + "tracing-core", + "tracing-log", ] [[package]] @@ -339,6 +767,33 @@ version = "0.2.11" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "673aac59facbab8a9007c7f6108d11f63b603f7cabff99fabf650fea5c32b861" +[[package]] +name = "valuable" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65" + +[[package]] +name = "wasi" +version = "0.11.1+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link", +] + [[package]] name = "zmij" version = "1.0.21" diff --git a/Cargo.toml b/Cargo.toml index 0dea7d5..dd961d8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -21,9 +21,11 @@ rust-version = "1.85" version = "0.1.0" [workspace.dependencies] +axum = "0.8" serde = { version = "1", features = ["derive"] } serde_json = "1" serde_yaml = "0.9" thiserror = "2" tokio = { version = "1", features = ["macros", "rt-multi-thread"] } tracing = "0.1" +tracing-subscriber = { version = "0.3", features = ["env-filter", "fmt"] } diff --git a/README.md b/README.md index a09d485..8ec25ac 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ MCPaaS - это low-code платформа для публикации внеш - `docs/mcp-interface.md` - транспорт и контракт публикации MCP tools. - `docs/testing-strategy.md` - стратегия тестирования до и во время разработки. - `docs/runtime-config.md` - конфигурация окружения, storage и секретов. +- `docs/deployment.md` - контейнерный деплой, reverse proxy и CI/CD. - `docs/rust-design.md` - распределение методов, `impl`, `trait` и service-слоя без god-struct. - `docs/development-rules.md` - правила разработки, TDD-процесс и git workflow. - `docs/rust-code-rules.md` - Rust-specific правила кода, toolchain и linting. diff --git a/TASKS.md b/TASKS.md index 8476257..2b9f295 100644 --- a/TASKS.md +++ b/TASKS.md @@ -2,21 +2,9 @@ ## Current -### `feat/domain-model` - -Status: completed - -DoD: - -- core domain types from `docs/data-model.md` exist -- basic JSON and YAML serialization works -- domain unit tests pass - -## Next - ### `feat/schema-engine` -Status: pending +Status: in_progress DoD: @@ -24,6 +12,8 @@ DoD: - schema validation works - JSON sample normalization works +## Next + ### `feat/mapping-engine` Status: pending diff --git a/apps/admin-api/Cargo.toml b/apps/admin-api/Cargo.toml index 51b01b7..9c5accd 100644 --- a/apps/admin-api/Cargo.toml +++ b/apps/admin-api/Cargo.toml @@ -6,6 +6,8 @@ rust-version.workspace = true version.workspace = true [dependencies] +axum.workspace = true +serde_json.workspace = true tokio.workspace = true tracing.workspace = true - +tracing-subscriber.workspace = true diff --git a/apps/admin-api/Dockerfile b/apps/admin-api/Dockerfile new file mode 100644 index 0000000..43af89e --- /dev/null +++ b/apps/admin-api/Dockerfile @@ -0,0 +1,25 @@ +FROM rust:1.85-bookworm AS builder + +WORKDIR /app + +COPY Cargo.toml Cargo.lock ./ +COPY apps ./apps +COPY crates ./crates + +RUN cargo build --release -p admin-api + +FROM debian:bookworm-slim + +RUN apt-get update \ + && apt-get install -y --no-install-recommends ca-certificates curl \ + && rm -rf /var/lib/apt/lists/* + +WORKDIR /app + +COPY --from=builder /app/target/release/admin-api /usr/local/bin/admin-api + +ENV MCPAAS_ADMIN_BIND=0.0.0.0:3001 + +EXPOSE 3001 + +CMD ["admin-api"] diff --git a/apps/admin-api/src/main.rs b/apps/admin-api/src/main.rs index f328e4d..9c2c830 100644 --- a/apps/admin-api/src/main.rs +++ b/apps/admin-api/src/main.rs @@ -1 +1,34 @@ -fn main() {} +use std::{env, net::SocketAddr}; + +use axum::{Json, Router, routing::get}; +use serde_json::json; +use tokio::net::TcpListener; +use tracing::info; + +#[tokio::main] +async fn main() -> Result<(), Box> { + tracing_subscriber::fmt() + .with_env_filter( + env::var("MCPAAS_LOG_LEVEL") + .unwrap_or_else(|_| "admin_api=info,tower_http=info".into()), + ) + .init(); + + let bind_addr = env::var("MCPAAS_ADMIN_BIND").unwrap_or_else(|_| "0.0.0.0:3001".into()); + let socket_addr: SocketAddr = bind_addr.parse()?; + let app = Router::new().route("/health", get(health)); + let listener = TcpListener::bind(socket_addr).await?; + + info!("admin-api listening on {}", socket_addr); + + axum::serve(listener, app).await?; + + Ok(()) +} + +async fn health() -> Json { + Json(json!({ + "service": "admin-api", + "status": "ok" + })) +} diff --git a/apps/mcp-server/Cargo.toml b/apps/mcp-server/Cargo.toml index b8a2d0b..e87dbc7 100644 --- a/apps/mcp-server/Cargo.toml +++ b/apps/mcp-server/Cargo.toml @@ -6,6 +6,8 @@ rust-version.workspace = true version.workspace = true [dependencies] +axum.workspace = true +serde_json.workspace = true tokio.workspace = true tracing.workspace = true - +tracing-subscriber.workspace = true diff --git a/apps/mcp-server/Dockerfile b/apps/mcp-server/Dockerfile new file mode 100644 index 0000000..2be6772 --- /dev/null +++ b/apps/mcp-server/Dockerfile @@ -0,0 +1,25 @@ +FROM rust:1.85-bookworm AS builder + +WORKDIR /app + +COPY Cargo.toml Cargo.lock ./ +COPY apps ./apps +COPY crates ./crates + +RUN cargo build --release -p mcp-server + +FROM debian:bookworm-slim + +RUN apt-get update \ + && apt-get install -y --no-install-recommends ca-certificates curl \ + && rm -rf /var/lib/apt/lists/* + +WORKDIR /app + +COPY --from=builder /app/target/release/mcp-server /usr/local/bin/mcp-server + +ENV MCPAAS_MCP_BIND=0.0.0.0:3002 + +EXPOSE 3002 + +CMD ["mcp-server"] diff --git a/apps/mcp-server/src/main.rs b/apps/mcp-server/src/main.rs index f328e4d..92a9719 100644 --- a/apps/mcp-server/src/main.rs +++ b/apps/mcp-server/src/main.rs @@ -1 +1,34 @@ -fn main() {} +use std::{env, net::SocketAddr}; + +use axum::{Json, Router, routing::get}; +use serde_json::json; +use tokio::net::TcpListener; +use tracing::info; + +#[tokio::main] +async fn main() -> Result<(), Box> { + tracing_subscriber::fmt() + .with_env_filter( + env::var("MCPAAS_LOG_LEVEL") + .unwrap_or_else(|_| "mcp_server=info,tower_http=info".into()), + ) + .init(); + + let bind_addr = env::var("MCPAAS_MCP_BIND").unwrap_or_else(|_| "0.0.0.0:3002".into()); + let socket_addr: SocketAddr = bind_addr.parse()?; + let app = Router::new().route("/health", get(health)); + let listener = TcpListener::bind(socket_addr).await?; + + info!("mcp-server listening on {}", socket_addr); + + axum::serve(listener, app).await?; + + Ok(()) +} + +async fn health() -> Json { + Json(json!({ + "service": "mcp-server", + "status": "ok" + })) +} diff --git a/apps/ui/Dockerfile b/apps/ui/Dockerfile new file mode 100644 index 0000000..9a5a6e2 --- /dev/null +++ b/apps/ui/Dockerfile @@ -0,0 +1,6 @@ +FROM nginx:1.27-alpine + +COPY apps/ui/index.html /usr/share/nginx/html/index.html +COPY apps/ui/nginx.conf /etc/nginx/conf.d/default.conf + +EXPOSE 3000 diff --git a/apps/ui/README.md b/apps/ui/README.md deleted file mode 100644 index 1c1a2d4..0000000 --- a/apps/ui/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# UI - -The UI app is planned as a separate TypeScript project and is intentionally kept outside the Cargo workspace. diff --git a/apps/ui/index.html b/apps/ui/index.html new file mode 100644 index 0000000..8b0c806 --- /dev/null +++ b/apps/ui/index.html @@ -0,0 +1,59 @@ + + + + + + RMCP UI + + + +
+

RMCP UI

+

Deployment placeholder for the administrative console. The production UI container is reachable through /.

+
+ + diff --git a/apps/ui/nginx.conf b/apps/ui/nginx.conf new file mode 100644 index 0000000..14b118a --- /dev/null +++ b/apps/ui/nginx.conf @@ -0,0 +1,11 @@ +server { + listen 3000; + server_name _; + + root /usr/share/nginx/html; + index index.html; + + location / { + try_files $uri $uri/ /index.html; + } +} diff --git a/crates/mcpaas-schema/src/error.rs b/crates/mcpaas-schema/src/error.rs new file mode 100644 index 0000000..2bc176c --- /dev/null +++ b/crates/mcpaas-schema/src/error.rs @@ -0,0 +1,55 @@ +use thiserror::Error; + +#[derive(Clone, Debug, PartialEq, Eq, Error)] +pub enum SchemaError { + #[error("missing required field at {path}")] + MissingField { path: String }, + #[error("invalid value at {path}: expected {expected}, got {actual}")] + InvalidType { + path: String, + expected: &'static str, + actual: &'static str, + }, + #[error("invalid enum value at {path}: expected one of {expected:?}, got {actual}")] + InvalidEnumValue { + path: String, + expected: Vec, + actual: String, + }, + #[error("no matching oneof variant at {path}")] + OneofMismatch { path: String }, +} + +impl SchemaError { + pub fn missing_field(path: impl Into) -> Self { + Self::MissingField { path: path.into() } + } + + pub fn invalid_type( + path: impl Into, + expected: &'static str, + actual: &'static str, + ) -> Self { + Self::InvalidType { + path: path.into(), + expected, + actual, + } + } + + pub fn invalid_enum_value( + path: impl Into, + expected: Vec, + actual: impl Into, + ) -> Self { + Self::InvalidEnumValue { + path: path.into(), + expected, + actual: actual.into(), + } + } + + pub fn oneof_mismatch(path: impl Into) -> Self { + Self::OneofMismatch { path: path.into() } + } +} diff --git a/crates/mcpaas-schema/src/lib.rs b/crates/mcpaas-schema/src/lib.rs index 8d9a4de..6b4962c 100644 --- a/crates/mcpaas-schema/src/lib.rs +++ b/crates/mcpaas-schema/src/lib.rs @@ -1,164 +1,7 @@ -use std::collections::BTreeMap; +mod error; +mod model; +mod normalize; +mod validate; -use serde::{Deserialize, Serialize}; -use serde_json::Value; - -#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] -#[serde(rename_all = "snake_case")] -pub enum SchemaKind { - Object, - Array, - String, - Integer, - Number, - Boolean, - Enum, - #[serde(rename = "null")] - Null, - Oneof, -} - -#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] -pub struct Schema { - #[serde(rename = "type")] - pub kind: SchemaKind, - #[serde(default, skip_serializing_if = "Option::is_none")] - pub description: Option, - #[serde(default)] - pub required: bool, - #[serde(default)] - pub nullable: bool, - #[serde(default, skip_serializing_if = "Option::is_none")] - pub default_value: Option, - #[serde(default, skip_serializing_if = "BTreeMap::is_empty")] - pub fields: BTreeMap, - #[serde(default, skip_serializing_if = "Option::is_none")] - pub items: Option>, - #[serde(default, skip_serializing_if = "Vec::is_empty")] - pub enum_values: Vec, - #[serde(default, skip_serializing_if = "Vec::is_empty")] - pub variants: Vec, -} - -impl Schema { - pub fn is_object(&self) -> bool { - self.kind == SchemaKind::Object - } - - pub fn field(&self, name: &str) -> Option<&Schema> { - self.fields.get(name) - } - - pub fn has_required_fields(&self) -> bool { - self.fields.values().any(|field| field.required) - } -} - -#[cfg(test)] -mod tests { - use std::collections::BTreeMap; - - use super::{Schema, SchemaKind}; - - #[test] - fn object_schema_exposes_fields() { - let mut fields = BTreeMap::new(); - fields.insert( - "email".to_owned(), - Schema { - kind: SchemaKind::String, - description: None, - required: true, - nullable: false, - default_value: None, - fields: BTreeMap::new(), - items: None, - enum_values: Vec::new(), - variants: Vec::new(), - }, - ); - - let schema = Schema { - kind: SchemaKind::Object, - description: Some("User input".to_owned()), - required: true, - nullable: false, - default_value: None, - fields, - items: None, - enum_values: Vec::new(), - variants: Vec::new(), - }; - - assert!(schema.is_object()); - assert!(schema.has_required_fields()); - assert_eq!( - schema.field("email").map(|field| field.required), - Some(true) - ); - } - - #[test] - fn schema_serializes_type_field() { - let schema = Schema { - kind: SchemaKind::Array, - description: None, - required: false, - nullable: false, - default_value: None, - fields: BTreeMap::new(), - items: Some(Box::new(Schema { - kind: SchemaKind::String, - description: None, - required: false, - nullable: false, - default_value: None, - fields: BTreeMap::new(), - items: None, - enum_values: Vec::new(), - variants: Vec::new(), - })), - enum_values: Vec::new(), - variants: Vec::new(), - }; - - let value = serde_json::to_value(schema).unwrap(); - - assert_eq!(value["type"], "array"); - assert_eq!(value["items"]["type"], "string"); - } - - #[test] - fn schema_roundtrips_through_yaml() { - let schema = Schema { - kind: SchemaKind::Object, - description: Some("Lead output".to_owned()), - required: true, - nullable: false, - default_value: None, - fields: BTreeMap::from([( - "id".to_owned(), - Schema { - kind: SchemaKind::String, - description: None, - required: true, - nullable: false, - default_value: None, - fields: BTreeMap::new(), - items: None, - enum_values: Vec::new(), - variants: Vec::new(), - }, - )]), - items: None, - enum_values: Vec::new(), - variants: Vec::new(), - }; - - let yaml = serde_yaml::to_string(&schema).unwrap(); - let restored: Schema = serde_yaml::from_str(&yaml).unwrap(); - - assert!(yaml.contains("type: object")); - assert_eq!(restored, schema); - } -} +pub use error::SchemaError; +pub use model::{Schema, SchemaKind}; diff --git a/crates/mcpaas-schema/src/model.rs b/crates/mcpaas-schema/src/model.rs new file mode 100644 index 0000000..7486bc1 --- /dev/null +++ b/crates/mcpaas-schema/src/model.rs @@ -0,0 +1,178 @@ +use std::collections::BTreeMap; + +use serde::{Deserialize, Serialize}; +use serde_json::Value; + +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum SchemaKind { + Object, + Array, + String, + Integer, + Number, + Boolean, + Enum, + #[serde(rename = "null")] + Null, + Oneof, +} + +#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] +pub struct Schema { + #[serde(rename = "type")] + pub kind: SchemaKind, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub description: Option, + #[serde(default)] + pub required: bool, + #[serde(default)] + pub nullable: bool, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub default_value: Option, + #[serde(default, skip_serializing_if = "BTreeMap::is_empty")] + pub fields: BTreeMap, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub items: Option>, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub enum_values: Vec, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub variants: Vec, +} + +impl Schema { + pub fn is_object(&self) -> bool { + self.kind == SchemaKind::Object + } + + pub fn field(&self, name: &str) -> Option<&Schema> { + self.fields.get(name) + } + + pub fn has_required_fields(&self) -> bool { + self.fields.values().any(|field| field.required) + } + + pub fn expected_type_name(&self) -> &'static str { + match self.kind { + SchemaKind::Object => "object", + SchemaKind::Array => "array", + SchemaKind::String => "string", + SchemaKind::Integer => "integer", + SchemaKind::Number => "number", + SchemaKind::Boolean => "boolean", + SchemaKind::Enum => "enum", + SchemaKind::Null => "null", + SchemaKind::Oneof => "oneof", + } + } +} + +#[cfg(test)] +mod tests { + use std::collections::BTreeMap; + + use super::{Schema, SchemaKind}; + + #[test] + fn object_schema_exposes_fields() { + let mut fields = BTreeMap::new(); + fields.insert( + "email".to_owned(), + Schema { + kind: SchemaKind::String, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }, + ); + + let schema = Schema { + kind: SchemaKind::Object, + description: Some("User input".to_owned()), + required: true, + nullable: false, + default_value: None, + fields, + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }; + + assert!(schema.is_object()); + assert!(schema.has_required_fields()); + assert_eq!( + schema.field("email").map(|field| field.required), + Some(true) + ); + } + + #[test] + fn schema_serializes_type_field() { + let schema = Schema { + kind: SchemaKind::Array, + description: None, + required: false, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: Some(Box::new(Schema { + kind: SchemaKind::String, + description: None, + required: false, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + })), + enum_values: Vec::new(), + variants: Vec::new(), + }; + + let value = serde_json::to_value(schema).unwrap(); + + assert_eq!(value["type"], "array"); + assert_eq!(value["items"]["type"], "string"); + } + + #[test] + fn schema_roundtrips_through_yaml() { + let schema = Schema { + kind: SchemaKind::Object, + description: Some("Lead output".to_owned()), + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::from([( + "id".to_owned(), + Schema { + kind: SchemaKind::String, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }, + )]), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }; + + let yaml = serde_yaml::to_string(&schema).unwrap(); + let restored: Schema = serde_yaml::from_str(&yaml).unwrap(); + + assert!(yaml.contains("type: object")); + assert_eq!(restored, schema); + } +} diff --git a/crates/mcpaas-schema/src/normalize.rs b/crates/mcpaas-schema/src/normalize.rs new file mode 100644 index 0000000..8247296 --- /dev/null +++ b/crates/mcpaas-schema/src/normalize.rs @@ -0,0 +1,163 @@ +use std::collections::BTreeMap; + +use serde_json::{Map, Value}; + +use crate::{Schema, SchemaKind}; + +impl Schema { + pub fn from_json_sample(value: &Value) -> Self { + match value { + Value::Null => Self { + kind: SchemaKind::Null, + description: None, + required: true, + nullable: true, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }, + Value::Bool(_) => scalar_schema(SchemaKind::Boolean), + Value::String(_) => scalar_schema(SchemaKind::String), + Value::Number(number) if number.is_i64() || number.is_u64() => { + scalar_schema(SchemaKind::Integer) + } + Value::Number(_) => scalar_schema(SchemaKind::Number), + Value::Array(items) => array_schema(items), + Value::Object(fields) => object_schema(fields), + } + } +} + +fn scalar_schema(kind: SchemaKind) -> Schema { + Schema { + kind, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + } +} + +fn array_schema(items: &[Value]) -> Schema { + Schema { + kind: SchemaKind::Array, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: items + .first() + .map(|item| Box::new(Schema::from_json_sample(item))), + enum_values: Vec::new(), + variants: Vec::new(), + } +} + +fn object_schema(fields: &Map) -> Schema { + Schema { + kind: SchemaKind::Object, + description: None, + required: true, + nullable: false, + default_value: None, + fields: fields + .iter() + .map(|(name, value)| (name.clone(), Schema::from_json_sample(value))) + .collect(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + } +} + +#[cfg(test)] +mod tests { + use std::collections::BTreeMap; + + use serde_json::json; + + use crate::{Schema, SchemaKind}; + + #[test] + fn infers_object_schema_from_json_sample() { + let schema = Schema::from_json_sample(&json!({ + "lead": { + "email": "user@example.com", + "active": true + }, + "score": 42 + })); + + assert_eq!(schema.kind, SchemaKind::Object); + assert_eq!( + schema.field("lead").map(|field| field.kind.clone()), + Some(SchemaKind::Object) + ); + assert_eq!( + schema + .field("lead") + .and_then(|field| field.field("email")) + .map(|field| field.kind.clone()), + Some(SchemaKind::String) + ); + assert_eq!( + schema.field("score").map(|field| field.kind.clone()), + Some(SchemaKind::Integer) + ); + } + + #[test] + fn infers_array_item_schema_from_first_sample_item() { + let schema = Schema::from_json_sample(&json!([ + { + "id": "lead_01", + "tags": ["warm", "priority"] + } + ])); + + assert_eq!(schema.kind, SchemaKind::Array); + assert_eq!( + schema + .items + .as_deref() + .and_then(|item| item.field("id")) + .map(|field| field.kind.clone()), + Some(SchemaKind::String) + ); + assert_eq!( + schema + .items + .as_deref() + .and_then(|item| item.field("tags")) + .map(|field| field.kind.clone()), + Some(SchemaKind::Array) + ); + } + + #[test] + fn infers_null_schema_for_null_sample() { + let schema = Schema::from_json_sample(&serde_json::Value::Null); + + assert_eq!( + schema, + Schema { + kind: SchemaKind::Null, + description: None, + required: true, + nullable: true, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + } + ); + } +} diff --git a/crates/mcpaas-schema/src/validate.rs b/crates/mcpaas-schema/src/validate.rs new file mode 100644 index 0000000..0075f92 --- /dev/null +++ b/crates/mcpaas-schema/src/validate.rs @@ -0,0 +1,260 @@ +use serde_json::Value; + +use crate::{Schema, SchemaError, SchemaKind}; + +impl Schema { + pub fn validate_shape(&self, value: &Value) -> Result<(), SchemaError> { + validate_value(self, value, "$") + } +} + +fn validate_value(schema: &Schema, value: &Value, path: &str) -> Result<(), SchemaError> { + if value.is_null() { + if schema.nullable || schema.kind == SchemaKind::Null { + return Ok(()); + } + + return Err(SchemaError::invalid_type( + path, + schema.expected_type_name(), + "null", + )); + } + + match schema.kind { + SchemaKind::Object => validate_object(schema, value, path), + SchemaKind::Array => validate_array(schema, value, path), + SchemaKind::String => validate_scalar(schema, value, path, Value::is_string), + SchemaKind::Integer => validate_scalar(schema, value, path, Value::is_i64_or_u64), + SchemaKind::Number => validate_scalar(schema, value, path, Value::is_number), + SchemaKind::Boolean => validate_scalar(schema, value, path, Value::is_boolean), + SchemaKind::Enum => validate_enum(schema, value, path), + SchemaKind::Null => Err(SchemaError::invalid_type( + path, + "null", + actual_type_name(value), + )), + SchemaKind::Oneof => validate_oneof(schema, value, path), + } +} + +fn validate_object(schema: &Schema, value: &Value, path: &str) -> Result<(), SchemaError> { + let Some(object) = value.as_object() else { + return Err(SchemaError::invalid_type( + path, + "object", + actual_type_name(value), + )); + }; + + for (field_name, field_schema) in &schema.fields { + let field_path = format!("{path}.{field_name}"); + + match object.get(field_name) { + Some(field_value) => validate_value(field_schema, field_value, &field_path)?, + None if field_schema.required => return Err(SchemaError::missing_field(field_path)), + None => {} + } + } + + Ok(()) +} + +fn validate_array(schema: &Schema, value: &Value, path: &str) -> Result<(), SchemaError> { + let Some(items) = value.as_array() else { + return Err(SchemaError::invalid_type( + path, + "array", + actual_type_name(value), + )); + }; + + if let Some(item_schema) = schema.items.as_deref() { + for (index, item) in items.iter().enumerate() { + let item_path = format!("{path}[{index}]"); + validate_value(item_schema, item, &item_path)?; + } + } + + Ok(()) +} + +fn validate_scalar( + schema: &Schema, + value: &Value, + path: &str, + is_valid: impl Fn(&Value) -> bool, +) -> Result<(), SchemaError> { + if is_valid(value) { + return Ok(()); + } + + Err(SchemaError::invalid_type( + path, + schema.expected_type_name(), + actual_type_name(value), + )) +} + +fn validate_enum(schema: &Schema, value: &Value, path: &str) -> Result<(), SchemaError> { + let Some(actual) = value.as_str() else { + return Err(SchemaError::invalid_type( + path, + "enum", + actual_type_name(value), + )); + }; + + if schema.enum_values.iter().any(|expected| expected == actual) { + return Ok(()); + } + + Err(SchemaError::invalid_enum_value( + path, + schema.enum_values.clone(), + actual, + )) +} + +fn validate_oneof(schema: &Schema, value: &Value, path: &str) -> Result<(), SchemaError> { + if schema + .variants + .iter() + .any(|variant| validate_value(variant, value, path).is_ok()) + { + return Ok(()); + } + + Err(SchemaError::oneof_mismatch(path)) +} + +fn actual_type_name(value: &Value) -> &'static str { + match value { + Value::Null => "null", + Value::Bool(_) => "boolean", + Value::Number(number) if number.is_i64() || number.is_u64() => "integer", + Value::Number(_) => "number", + Value::String(_) => "string", + Value::Array(_) => "array", + Value::Object(_) => "object", + } +} + +trait JsonValueExt { + fn is_i64_or_u64(&self) -> bool; +} + +impl JsonValueExt for Value { + fn is_i64_or_u64(&self) -> bool { + self.as_i64().is_some() || self.as_u64().is_some() + } +} + +#[cfg(test)] +mod tests { + use std::collections::BTreeMap; + + use serde_json::json; + + use crate::{Schema, SchemaError, SchemaKind}; + + #[test] + fn validates_nested_object_shape() { + let schema = Schema { + kind: SchemaKind::Object, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::from([( + "lead".to_owned(), + Schema { + kind: SchemaKind::Object, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::from([( + "email".to_owned(), + Schema { + kind: SchemaKind::String, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }, + )]), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }, + )]), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }; + + let result = schema.validate_shape(&json!({ + "lead": { + "email": "user@example.com" + } + })); + + assert!(result.is_ok()); + } + + #[test] + fn rejects_missing_required_field() { + let schema = Schema { + kind: SchemaKind::Object, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::from([( + "email".to_owned(), + Schema { + kind: SchemaKind::String, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }, + )]), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }; + + let error = schema.validate_shape(&json!({})).unwrap_err(); + + assert_eq!(error, SchemaError::missing_field("$.email")); + } + + #[test] + fn rejects_invalid_scalar_type() { + let schema = Schema { + kind: SchemaKind::Boolean, + description: None, + required: true, + nullable: false, + default_value: None, + fields: BTreeMap::new(), + items: None, + enum_values: Vec::new(), + variants: Vec::new(), + }; + + let error = schema.validate_shape(&json!("true")).unwrap_err(); + + assert_eq!(error, SchemaError::invalid_type("$", "boolean", "string")); + } +} diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..b377b3e --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,80 @@ +services: + postgres: + image: postgres:16-alpine + restart: unless-stopped + environment: + POSTGRES_DB: ${POSTGRES_DB:-rmcp} + POSTGRES_USER: ${POSTGRES_USER:-rmcp} + POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-rmcp} + volumes: + - postgres_data:/var/lib/postgresql/data + healthcheck: + test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-rmcp} -d ${POSTGRES_DB:-rmcp}"] + interval: 10s + timeout: 5s + retries: 5 + + admin-api: + build: + context: . + dockerfile: apps/admin-api/Dockerfile + restart: unless-stopped + environment: + MCPAAS_DATABASE_URL: ${MCPAAS_DATABASE_URL:-postgres://rmcp:rmcp@postgres:5432/rmcp} + MCPAAS_STORAGE_ROOT: ${MCPAAS_STORAGE_ROOT:-/var/lib/rmcp/storage} + MCPAAS_ADMIN_BIND: ${MCPAAS_ADMIN_BIND:-0.0.0.0:3001} + MCPAAS_LOG_LEVEL: ${MCPAAS_LOG_LEVEL:-info} + MCPAAS_SECRET_PROVIDER: ${MCPAAS_SECRET_PROVIDER:-env} + depends_on: + postgres: + condition: service_healthy + volumes: + - artifact_storage:${MCPAAS_STORAGE_ROOT:-/var/lib/rmcp/storage} + ports: + - "3001:3001" + healthcheck: + test: ["CMD", "curl", "--fail", "http://127.0.0.1:3001/health"] + interval: 15s + timeout: 5s + retries: 5 + + mcp-server: + build: + context: . + dockerfile: apps/mcp-server/Dockerfile + restart: unless-stopped + environment: + MCPAAS_DATABASE_URL: ${MCPAAS_DATABASE_URL:-postgres://rmcp:rmcp@postgres:5432/rmcp} + MCPAAS_STORAGE_ROOT: ${MCPAAS_STORAGE_ROOT:-/var/lib/rmcp/storage} + MCPAAS_MCP_BIND: ${MCPAAS_MCP_BIND:-0.0.0.0:3002} + MCPAAS_LOG_LEVEL: ${MCPAAS_LOG_LEVEL:-info} + MCPAAS_SECRET_PROVIDER: ${MCPAAS_SECRET_PROVIDER:-env} + depends_on: + postgres: + condition: service_healthy + volumes: + - artifact_storage:${MCPAAS_STORAGE_ROOT:-/var/lib/rmcp/storage} + ports: + - "3002:3002" + healthcheck: + test: ["CMD", "curl", "--fail", "http://127.0.0.1:3002/health"] + interval: 15s + timeout: 5s + retries: 5 + + ui: + build: + context: . + dockerfile: apps/ui/Dockerfile + restart: unless-stopped + ports: + - "3000:3000" + healthcheck: + test: ["CMD", "wget", "-qO-", "http://127.0.0.1:3000/"] + interval: 15s + timeout: 5s + retries: 5 + +volumes: + postgres_data: + artifact_storage: diff --git a/docs/architecture.md b/docs/architecture.md index ece87db..1cb14f1 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -384,6 +384,17 @@ gRPC target: - import/export конфигураций, - workflow публикации и отображение статуса. +### Deployment layer + +Ответственность: + +- контейнерная упаковка приложений; +- orchestration через `docker-compose`; +- reverse proxy routing; +- healthchecks и delivery pipeline. + +Этот слой не должен влиять на доменную модель и application contracts. + ## 10. Предлагаемая структура репозитория Для реализации рекомендуется workspace-структура: diff --git a/docs/deployment.md b/docs/deployment.md new file mode 100644 index 0000000..4f20aec --- /dev/null +++ b/docs/deployment.md @@ -0,0 +1,217 @@ +# Deployment + +## 1. Назначение документа + +Этот документ фиксирует platform-agnostic модель деплоя проекта. + +Он отвечает на вопросы: + +- какие deployment artifacts должны быть в репозитории; +- как проект должен запускаться в production-like окружении; +- как routing должен работать через reverse proxy; +- что должен делать CD pipeline. + +Документ не привязан к конкретному hypervisor, cloud provider, типу VM или домашней инфраструктуре. + +## 2. Базовая модель деплоя + +Для MVP принимается контейнерная модель: + +- `admin-api`, `mcp-server` и `ui` упаковываются в контейнеры; +- `PostgreSQL` запускается как отдельный контейнер; +- сервисы запускаются через `docker-compose`; +- перед приложением находится reverse proxy; +- CI проверяет качество, CD доставляет и перезапускает сервисы. + +## 3. Что должно быть в репозитории + +В проекте должны существовать: + +- `Dockerfile` для `apps/admin-api`; +- `Dockerfile` для `apps/mcp-server`; +- `Dockerfile` для `apps/ui` или отдельный production build flow для UI; +- `docker-compose.yml`; +- `.env.example`; +- `.github/workflows/ci.yml`; +- `.github/workflows/deploy.yml`; +- примеры reverse proxy конфигураций. + +Рекомендуемое стартовое распределение портов: + +- `ui` -> `3000` +- `admin-api` -> `3001` +- `mcp-server` -> `3002` + +## 4. Production-like runtime состав + +Минимальный набор сервисов: + +- `ui` +- `admin-api` +- `mcp-server` +- `postgres` + +Persistent data: + +- volume для `postgres`; +- volume или bind mount для `artifact storage`. + +## 5. Рекомендуемая routing model + +Под одним доменом: + +- `/` -> `ui` +- `/api/admin/` -> `admin-api` +- `/mcp/` -> `mcp-server` + +Это позволяет: + +- централизовать TLS; +- не плодить поддомены без необходимости; +- держать demo URL простым; +- использовать один reverse proxy для UI, API и MCP. + +## 6. Требования к reverse proxy + +Reverse proxy должен обеспечивать: + +- TLS termination; +- редирект `HTTP -> HTTPS`; +- `X-Forwarded-*` headers; +- отключение buffering для MCP endpoint; +- увеличенные таймауты для долгих runtime-запросов; +- корректную маршрутизацию UI, admin API и MCP. + +Особенно для `mcp-server` важно: + +- `proxy_buffering off`; +- `proxy_request_buffering off`; +- длинный `proxy_read_timeout`. + +## 7. Пример `nginx` + +```nginx +server { + listen 80; + server_name example.com; + + return 301 https://$host$request_uri; +} + +server { + listen 443 ssl http2; + server_name example.com; + + ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem; + ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem; + + client_max_body_size 25m; + + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_http_version 1.1; + + location / { + proxy_pass http://ui:3000; + } + + location /api/admin/ { + proxy_pass http://admin-api:3001/; + } + + location /mcp/ { + proxy_pass http://mcp-server:3002/; + proxy_buffering off; + proxy_request_buffering off; + proxy_read_timeout 300s; + proxy_send_timeout 300s; + } +} +``` + +## 8. Пример `Traefik` + +```yaml +services: + ui: + labels: + - traefik.enable=true + - traefik.http.routers.ui.rule=Host(`example.com`) && PathPrefix(`/`) + - traefik.http.services.ui.loadbalancer.server.port=3000 + + admin-api: + labels: + - traefik.enable=true + - traefik.http.routers.admin.rule=Host(`example.com`) && PathPrefix(`/api/admin`) + - traefik.http.services.admin.loadbalancer.server.port=3001 + + mcp-server: + labels: + - traefik.enable=true + - traefik.http.routers.mcp.rule=Host(`example.com`) && PathPrefix(`/mcp`) + - traefik.http.services.mcp.loadbalancer.server.port=3002 +``` + +Для production нужно отдельно проверить timeout behavior на MCP маршруте. + +## 9. Требования к `docker-compose` + +`docker-compose.yml` должен: + +- поднимать `postgres`, `admin-api`, `mcp-server`, `ui`; +- использовать env vars вместо hardcoded config; +- иметь persistent storage для БД и artifacts; +- не публиковать внутренние сервисы наружу без необходимости; +- содержать healthchecks. + +## 10. Healthchecks + +Нужны как минимум: + +- `GET /health` для `admin-api` +- `GET /health` для `mcp-server` + +CD не должен считать deployment успешным, пока эти endpoints не начали возвращать `200 OK`. + +## 11. CI и CD + +### 11.1. CI + +CI должен выполнять: + +- `cargo fmt --all --check` +- `cargo check --workspace` +- `cargo clippy --workspace --all-targets --all-features -- -D warnings` +- `cargo test --workspace --all-targets` + +### 11.2. CD + +CD для MVP должен: + +- запускаться только для `main`; +- собирать production artifacts; +- доставлять deployment files на целевой Linux host; +- выполнять controlled restart; +- проверять health endpoints после запуска. + +Минимальный flow: + +1. push в `main` +2. успешный `CI` +3. build images +4. upload env и deployment files +5. `docker compose pull` +6. `docker compose up -d` +7. healthcheck verification + +Для MVP допустим deployment с удаленной сборкой на целевом Linux host через `ssh + rsync + docker compose up -d --build`, если не используется отдельный container registry. + +## 12. Что нельзя забыть + +- TLS и renewal сертификатов; +- backup для `postgres` и artifact storage; +- секреты вне репозитория; +- ограничение доступа к `admin-api`; +- rollback на предыдущий image tag или предыдущую compose revision. diff --git a/docs/implementation-plan.md b/docs/implementation-plan.md index 849f718..c79b863 100644 --- a/docs/implementation-plan.md +++ b/docs/implementation-plan.md @@ -353,7 +353,34 @@ DoD: - publish/reload flow стабилен; - документация по запуску достаточна для повторения демо. -## 14. Приоритеты по реализации +## 14. Этап 12. Deployment и CD + +Цель: + +- сделать повторяемый production-like запуск проекта. + +Фичи: + +- `Dockerfile` для приложений; +- `docker-compose.yml`; +- `.env.example`; +- reverse proxy examples; +- health endpoints; +- CD workflow для `main`. + +Результат: + +- проект можно развернуть на Linux-хосте без ручной сборки бинарей и без ad-hoc shell-скриптов. + +DoD: + +- backend приложения собираются в контейнеры; +- есть production-like compose конфигурация; +- reverse proxy examples задокументированы; +- CI и CD разделены; +- deployment проверяется healthchecks. + +## 15. Приоритеты по реализации Если времени не хватает, сохраняется такой приоритет: @@ -369,7 +396,7 @@ DoD: - диплом должен показать работающую платформу; - лучше один полный вертикальный сценарий, чем три недоделанных адаптера. -## 15. Разбиение по фичам +## 16. Разбиение по фичам Каждый этап желательно бить на маленькие фичи: @@ -386,7 +413,7 @@ DoD: Для каждой такой фичи локальный `DoD` должен быть записан до начала реализации хотя бы в рабочем описании задачи или ветки. -## 16. Практический итог +## 17. Практический итог Правильная последовательность для проекта: diff --git a/docs/runtime-config.md b/docs/runtime-config.md index f03f18f..cd2a83e 100644 --- a/docs/runtime-config.md +++ b/docs/runtime-config.md @@ -63,6 +63,8 @@ var/mcpaas/ - `MCPAAS_MCP_BIND` - `MCPAAS_LOG_LEVEL` - `MCPAAS_SECRET_PROVIDER` +- `MCPAAS_PUBLIC_BASE_URL` +- `MCPAAS_MCP_PUBLIC_URL` Опционально: @@ -108,6 +110,19 @@ Demo/deployment: - локальный или сетевой storage; - включенная auth-защита admin-api; - стабильный `Streamable HTTP` endpoint для MCP. +- containerized runtime через `Docker` и `docker-compose`. + +## 8.1. Delivery artifacts + +Для production-like запуска проект должен поставляться с: + +- `Dockerfile` для backend приложений; +- `docker-compose.yml`; +- `.env.example`; +- healthcheck endpoints; +- reverse proxy configuration examples. + +Подробности вынесены в `docs/deployment.md`. ## 9. Что важно не допустить