goosefs-sdk 0.2.2

Goosefs Rust gRPC Client - Direct gRPC client for Goosefs Master/Worker
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

// Copyright (C) 2026 Tencent. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::io::Result;

/// Build script for `goosefs-sdk`.
///
/// Pre-generated protobuf code under `src/generated/` is checked into the
/// repository and shipped with the crate so that downstream users do NOT
/// need `protoc` installed to build this crate.
///
/// To regenerate the protobuf code (after modifying any `.proto` file),
/// build with the `regen-proto` cargo feature **and** the opt-in env var
/// (the env var prevents accidental regeneration when the feature is on
/// transitively):
///
/// ```bash
/// GOOSEFS_SDK_REGEN_PROTO=1 cargo build --features regen-proto
/// ```
fn main() -> Result<()> {
    // Only re-run the build script when the opt-in env var changes, so that
    // normal builds (without `protoc` available) stay fast and reproducible.
    println!("cargo:rerun-if-env-changed=GOOSEFS_SDK_REGEN_PROTO");

    if std::env::var("GOOSEFS_SDK_REGEN_PROTO").as_deref() != Ok("1") {
        // Default path: use the pre-generated code shipped under src/generated/.
        return Ok(());
    }

    #[cfg(feature = "regen-proto")]
    {
        let proto_root = "proto";

        // Opt-in path: regenerate protobuf code in-tree. Requires `protoc`.
        tonic_prost_build::configure()
            .build_server(false)
            .build_client(true)
            // Output all generated code into src/generated/ so it can be
            // checked into the repository and shipped with the crate.
            .out_dir("src/generated")
            .compile_protos(
                &[
                    "proto/grpc/common.proto",
                    "proto/grpc/fscommon.proto",
                    "proto/grpc/version.proto",
                    "proto/grpc/file_system_master.proto",
                    "proto/grpc/block_worker.proto",
                    "proto/grpc/worker_manager_master.proto",
                    "proto/grpc/metric_master.proto",
                    "proto/proto/dataserver/protocol.proto",
                    "proto/proto/dataserver/status.proto",
                    "proto/proto/security/capability_token.proto",
                    "proto/proto/security/token.proto",
                    "proto/proto/shared/acl.proto",
                    "proto/proto/shared/location.proto",
                    "proto/grpc/sasl/sasl_server.proto",
                ],
                &[proto_root],
            )?;

        println!("cargo:rerun-if-changed={}", proto_root);
    }

    #[cfg(not(feature = "regen-proto"))]
    {
        eprintln!(
            "warning: GOOSEFS_SDK_REGEN_PROTO=1 is set but the `regen-proto` \
             cargo feature is not enabled; skipping protobuf regeneration. \
             Re-run with `--features regen-proto` to regenerate."
        );
    }

    Ok(())
}