feat: Add vendored support (#411)

* feat: Add vendored support

Signed-off-by: Xuanwo <github@xuanwo.io>

* Use diff=false instead

Signed-off-by: Xuanwo <github@xuanwo.io>

* try fix

Signed-off-by: Xuanwo <github@xuanwo.io>

* Fix typo

Signed-off-by: Xuanwo <github@xuanwo.io>

* Use vendor by default

Signed-off-by: Xuanwo <github@xuanwo.io>

* Add check

Signed-off-by: Xuanwo <github@xuanwo.io>

---------

Signed-off-by: Xuanwo <github@xuanwo.io>

Author: Xuanwo

.gitattributes

@@ -0,0 +1 @@
+src/generated/ diff=false

.github/workflows/ci.yml

@@ -21,6 +21,9 @@ jobs:
         uses: Swatinem/rust-cache@v1.4.0
       - name: make check
         run: make check
+      - name: Catch unexpected changes in the generated code
+        run: |
+          git diff --exit-code
 
   unit-test:
     name: unit test

Cargo.toml

@@ -17,6 +17,12 @@ integration-tests = []
 [lib]
 name = "tikv_client"
 
+[workspace]
+members = [
+    ".",
+    "proto-build",
+]
+
 [dependencies]
 async-recursion = "0.3"
 async-trait = "0.1"
@@ -39,7 +45,6 @@ tokio = { version = "1", features = ["sync", "rt-multi-thread", "macros"] }
 tonic = { version = "0.9", features = ["tls"] }
 
 [dev-dependencies]
-tempfile = "3.6"
 clap = "2"
 env_logger = "0.10"
 fail = { version = "0.4", features = ["failpoints"] }
@@ -51,14 +56,9 @@ reqwest = { version = "0.11", default-features = false, features = [
 serde_json = "1"
 serial_test = "0.5.0"
 simple_logger = "1"
+tempfile = "3.6"
 tokio = { version = "1", features = ["sync", "rt-multi-thread", "macros"] }
 
-[build-dependencies]
-glob = "0.3"
-tonic-build = "0.9"
-# Suppress doctest bug (https://stackoverflow.com/questions/66074003/how-to-turn-off-cargo-doc-test-and-compile-for-a-specific-module-in-rust)
-tonic-disable-doctest = "0.1.0"
-
 [[test]]
 name = "failpoint_tests"
 path = "tests/failpoint_tests.rs"

Makefile

@@ -11,15 +11,18 @@ INTEGRATION_TEST_ARGS := --features "integration-tests"
 
 default: check
 
-check:
+generate:
+	cargo run -p tikv-client-proto-build
+
+check: generate
 	cargo check --all --all-targets --features "${ALL_FEATURES}"
 	cargo fmt -- --check
 	cargo clippy --all-targets --features "${ALL_FEATURES}" -- -D clippy::all
 
-unit-test:
+unit-test: generate
 	cargo test --all --no-default-features
 
-integration-test:
+integration-test: generate
 	cargo test txn_ --all ${INTEGRATION_TEST_ARGS} -- --nocapture
 	cargo test raw_ --all ${INTEGRATION_TEST_ARGS} -- --nocapture
 	cargo test misc_ --all ${INTEGRATION_TEST_ARGS} -- --nocapture
@@ -32,7 +35,7 @@ doc:
 tiup:
 	tiup playground nightly --mode tikv-slim --kv 3 --without-monitor --kv.config $(shell pwd)/config/tikv.toml --pd.config $(shell pwd)/config/pd.toml &
 
-all: check doc test
+all: generate check doc test
 
 clean:
 	cargo clean

proto-build/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "tikv-client-proto-build"
+version = "0.0.0"
+publish = false
+
+keywords = ["TiKV", "KV", "distributed-systems"]
+license = "Apache-2.0"
+authors = ["The TiKV Project Authors"]
+repository = "https://github.com/tikv/client-rust"
+description = "The Rust language implementation of TiKV client."
+edition = "2021"
+
+[dependencies]
+glob = "0.3"
+tonic-build = "0.9"
+# Suppress doctest bug (https://stackoverflow.com/questions/66074003/how-to-turn-off-cargo-doc-test-and-compile-for-a-specific-module-in-rust)
+tonic-disable-doctest = "0.1.0"

build.rs renamed to proto-build/src/main.rs

@@ -1,12 +1,14 @@
-// Copyright 2020 TiKV Project Authors. Licensed under Apache-2.0.
-
-use tonic_disable_doctest::BuilderEx;
+// Copyright 2023 TiKV Project Authors. Licensed under Apache-2.0.
 
 fn main() {
+    use tonic_disable_doctest::BuilderEx;
+
     tonic_build::configure()
         .disable_doctests_for_types([".google.api.HttpRule"])
+        .emit_rerun_if_changed(false)
         .build_server(false)
         .include_file("mod.rs")
+        .out_dir("src/generated")
         .compile(
             &glob::glob("proto/*.proto")
                 .unwrap()