acton-cli 0.25.0

CLI tool for scaffolding and managing acton-service backend services
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
use anyhow::Result;
use colored::Colorize;

#[allow(clippy::too_many_arguments)]
pub async fn execute(
    service_name: String,
    package: Option<String>,
    method: Option<String>,
    request: Option<String>,
    response: Option<String>,
    health: bool,
    reflection: bool,
    streaming: bool,
    handler: bool,
    client: bool,
    interceptor: Option<String>,
    dry_run: bool,
) -> Result<()> {
    if dry_run {
        show_dry_run(&service_name, &package, &method);
        return Ok(());
    }

    println!(
        "{}",
        format!("Adding gRPC service: {}", service_name).bold()
    );
    println!();

    // Determine package name
    let package_name = package
        .clone()
        .unwrap_or_else(|| format!("{}.v1", service_name.to_lowercase()));

    println!("{}: {}", "Package".cyan().bold(), package_name.cyan());
    println!();

    // Step 1: Show proto file setup
    println!("{}", "1. Create proto file:".green().bold());
    println!();
    show_proto_file(
        &service_name,
        &package_name,
        &method,
        &request,
        &response,
        streaming,
    );
    println!();

    // Step 2: Show build.rs setup
    println!("{}", "2. Set up build.rs:".green().bold());
    println!();
    show_build_setup();
    println!();

    // Step 3: Show Cargo.toml feature setup
    println!("{}", "3. Enable gRPC feature in Cargo.toml:".green().bold());
    println!();
    show_cargo_setup();
    println!();

    // Step 4: Show service implementation
    if handler {
        println!("{}", "4. Implement gRPC service:".green().bold());
        println!();
        show_service_implementation(&service_name, &package_name, &method, streaming);
        println!();
    }

    // Step 5: Show server setup
    let server_step = if handler { "5" } else { "4" };
    println!(
        "{}",
        format!("{}. Set up gRPC server:", server_step)
            .green()
            .bold()
    );
    println!();
    show_server_setup(&service_name, &package_name, health, reflection);
    println!();

    // Step 6: Show client setup if requested
    if client {
        let client_step = if handler { "6" } else { "5" };
        println!(
            "{}",
            format!("{}. Create gRPC client:", client_step)
                .green()
                .bold()
        );
        println!();
        show_client_setup(&service_name, &package_name);
        println!();
    }

    // Step 7: Show interceptor setup if requested
    if let Some(ref interceptor_type) = interceptor {
        let step = if client && handler {
            "7"
        } else if client || handler {
            "6"
        } else {
            "5"
        };
        println!("{}", format!("{}. Add interceptor:", step).green().bold());
        println!();
        show_interceptor_setup(interceptor_type);
        println!();
    }

    // Final notes
    println!("{}", "Build and test:".cyan().bold());
    println!("  cargo build --features grpc");
    println!("  cargo run --features grpc");
    println!();
    println!("{}", "Test with grpcurl:".cyan().bold());
    println!("  grpcurl -plaintext localhost:9090 list");
    println!(
        "  grpcurl -plaintext -d '{{}}' localhost:9090 {}.{}/MethodName",
        package_name, service_name
    );
    println!();

    println!("{}", "Learn more:".yellow().bold());
    println!("  See acton-service/examples/ping-pong.rs for a complete example");
    println!("  See acton-service/examples/event-driven.rs for HTTP + gRPC");

    Ok(())
}

fn show_dry_run(service_name: &str, package: &Option<String>, method: &Option<String>) {
    println!("\n{}", "Dry run - would show:".bold());
    println!();
    println!("Service: {}", service_name.cyan());
    if let Some(pkg) = package {
        println!("Package: {}", pkg.cyan());
    }
    if let Some(mtd) = method {
        println!("Method: {}", mtd.cyan());
    }
    println!();
    println!("Instructions for adding gRPC service {}", service_name);
}

fn show_proto_file(
    service_name: &str,
    package_name: &str,
    method: &Option<String>,
    request: &Option<String>,
    response: &Option<String>,
    streaming: bool,
) {
    let method_name = method.as_deref().unwrap_or("Execute");

    let default_request = format!("{}Request", method_name);
    let default_response = format!("{}Response", method_name);

    let request_type = request.as_deref().unwrap_or(&default_request);
    let response_type = response.as_deref().unwrap_or(&default_response);

    println!("   Create proto/{}.proto:", service_name.to_lowercase());
    println!();
    println!("   syntax = \"proto3\";");
    println!();
    println!("   package {};", package_name);
    println!();
    println!("   service {} {{", service_name);

    if streaming {
        println!("     // Server streaming");
        println!(
            "     rpc {}({}) returns (stream {});",
            method_name, request_type, response_type
        );
        println!("     // Or bidirectional streaming:");
        println!(
            "     // rpc {}(stream {}) returns (stream {});",
            method_name, request_type, response_type
        );
    } else {
        println!(
            "     rpc {}({}) returns ({});",
            method_name, request_type, response_type
        );
    }

    println!("   }}");
    println!();
    println!("   message {} {{", request_type);
    println!("     string id = 1;");
    println!("     // Add your fields");
    println!("   }}");
    println!();
    println!("   message {} {{", response_type);
    println!("     string result = 1;");
    println!("     // Add your fields");
    println!("   }}");
}

fn show_build_setup() {
    println!("   Create or update build.rs:");
    println!();
    println!("   fn main() -> Result<(), Box<dyn std::error::Error>> {{");
    println!("       #[cfg(feature = \"grpc\")]");
    println!("       {{");
    println!("           acton_service::build_utils::compile_service_protos()?;");
    println!("       }}");
    println!("       Ok(())");
    println!("   }}");
    println!();
    println!(
        "   {}: See acton-service/examples/build.rs.example",
        "Example".yellow()
    );
}

fn show_cargo_setup() {
    println!("   [dependencies]");
    println!(r#"   acton-service = {{ version = "0.2", features = ["grpc"] }}"#);
    println!();
    println!("   [build-dependencies]");
    println!(r#"   acton-service = {{ version = "0.2", features = ["build-utils"] }}"#);
}

fn show_service_implementation(
    service_name: &str,
    package_name: &str,
    method: &Option<String>,
    streaming: bool,
) {
    let method_name = method.as_deref().unwrap_or("Execute");
    let method_snake = method_name.to_lowercase();
    let pkg_mod = package_name.replace('.', "_");

    println!("   // Include generated code");
    println!("   pub mod {} {{", pkg_mod);
    println!(r#"       tonic::include_proto!("{}");"#, package_name);
    println!();
    println!("       pub const FILE_DESCRIPTOR_SET: &[u8] =");
    println!(
        r#"           tonic::include_file_descriptor_set!("{}_descriptor");"#,
        pkg_mod
    );
    println!("   }}");
    println!();
    println!("   use {}::{{", pkg_mod);
    println!(
        "       {}_service_server::{{{}Service, {}ServiceServer}},",
        service_name.to_lowercase(),
        service_name,
        service_name
    );
    println!("       {}Request, {}Response,", method_name, method_name);
    println!("   }};");
    println!();
    println!("   #[derive(Default)]");
    println!("   struct {}ServiceImpl {{}}", service_name);
    println!();
    println!("   #[tonic::async_trait]");
    println!(
        "   impl {}Service for {}ServiceImpl {{",
        service_name, service_name
    );

    if streaming {
        println!(
            "       type {}Stream = tokio_stream::wrappers::ReceiverStream<",
            method_name
        );
        println!("           Result<{}Response, tonic::Status>", method_name);
        println!("       >;");
        println!();
        println!("       async fn {}(", method_snake);
        println!("           &self,");
        println!(
            "           request: tonic::Request<{}Request>,",
            method_name
        );
        println!(
            "       ) -> Result<tonic::Response<Self::{}Stream>, tonic::Status> {{",
            method_name
        );
        println!("           let req = request.into_inner();");
        println!("           let (tx, rx) = tokio::sync::mpsc::channel(128);");
        println!();
        println!("           // Stream responses");
        println!("           tokio::spawn(async move {{");
        println!("               for i in 0..10 {{");
        println!(
            "                   let response = {}Response {{",
            method_name
        );
        println!(r#"                       result: format!("Item {{}}", i),"#);
        println!("                   }};");
        println!("                   if tx.send(Ok(response)).await.is_err() {{");
        println!("                       break;");
        println!("                   }}");
        println!("               }}");
        println!("           }});");
        println!();
        println!("           Ok(tonic::Response::new(");
        println!("               tokio_stream::wrappers::ReceiverStream::new(rx)");
        println!("           ))");
        println!("       }}");
    } else {
        println!("       async fn {}(", method_snake);
        println!("           &self,");
        println!(
            "           request: tonic::Request<{}Request>,",
            method_name
        );
        println!(
            "       ) -> Result<tonic::Response<{}Response>, tonic::Status> {{",
            method_name
        );
        println!("           let req = request.into_inner();");
        println!();
        println!("           tracing::info!(id = %req.id, \"Processing request\");");
        println!();
        println!("           let response = {}Response {{", method_name);
        println!(r#"               result: "Success".to_string(),"#);
        println!("           }};");
        println!();
        println!("           Ok(tonic::Response::new(response))");
        println!("       }}");
    }

    println!("   }}");
}

fn show_server_setup(service_name: &str, package_name: &str, health: bool, reflection: bool) {
    let pkg_mod = package_name.replace('.', "_");

    println!("   use acton_service::grpc::server::GrpcServicesBuilder;");
    println!();
    println!("   let grpc_addr = \"0.0.0.0:9090\".parse().unwrap();");
    println!();
    println!("   let service = {}ServiceImpl::default();", service_name);
    println!();
    println!("   let mut builder = GrpcServicesBuilder::new()");

    if health {
        println!("       .with_health()");
    }
    if reflection {
        println!("       .with_reflection()");
        println!(
            "       .add_file_descriptor_set({}::FILE_DESCRIPTOR_SET)",
            pkg_mod
        );
    }

    println!(
        "       .add_service({}ServiceServer::new(service));",
        service_name
    );
    println!();
    println!("   let router = builder.build(None).unwrap();");
    println!();
    println!("   // Serve");
    println!("   router.serve(grpc_addr).await?;");
}

fn show_client_setup(service_name: &str, package_name: &str) {
    let pkg_mod = package_name.replace('.', "_");

    println!(
        "   use {}::{}_service_client::{}ServiceClient;",
        pkg_mod,
        service_name.to_lowercase(),
        service_name
    );
    println!();
    println!("   // Connect to gRPC server");
    println!(
        r#"   let mut client = {}ServiceClient::connect("http://localhost:9090")"#,
        service_name
    );
    println!("       .await?;");
    println!();
    println!("   // Make request");
    println!(
        "   let request = tonic::Request::new({}Request {{",
        service_name
    );
    println!(r#"       id: "123".to_string(),"#);
    println!("   }});");
    println!();
    println!("   let response = client.execute(request).await?;");
    println!("   println!(\"Response: {{:?}}\", response.into_inner());");
}

fn show_interceptor_setup(interceptor_type: &str) {
    match interceptor_type.to_lowercase().as_str() {
        "auth" | "jwt" => {
            println!("   use acton_service::grpc::interceptors::JwtAuthInterceptor;");
            println!();
            println!("   let interceptor = JwtAuthInterceptor::new(");
            println!(r#"       "path/to/public.pem".into(),"#);
            println!(r#"       "RS256".to_string()"#);
            println!("   );");
            println!();
            println!("   // Add to server");
            println!("   .add_service(");
            println!("       YourServiceServer::with_interceptor(service, interceptor)");
            println!("   )");
        }
        "logging" | "tracing" => {
            println!("   use acton_service::grpc::interceptors::TracingInterceptor;");
            println!();
            println!("   let interceptor = TracingInterceptor;");
            println!();
            println!("   // Add to server");
            println!("   .add_service(");
            println!("       YourServiceServer::with_interceptor(service, interceptor)");
            println!("   )");
        }
        "metrics" => {
            println!("   use acton_service::grpc::interceptors::MetricsInterceptor;");
            println!();
            println!("   let interceptor = MetricsInterceptor::new();");
            println!();
            println!("   // Add to server");
            println!("   .add_service(");
            println!("       YourServiceServer::with_interceptor(service, interceptor)");
            println!("   )");
        }
        _ => {
            println!("   // Custom interceptor");
            println!("   use tonic::{{Request, Status}};");
            println!();
            println!("   fn my_interceptor(req: Request<()>) -> Result<Request<()>, Status> {{");
            println!("       // Add your logic");
            println!("       Ok(req)");
            println!("   }}");
            println!();
            println!("   // Add to server");
            println!("   .add_service(");
            println!("       YourServiceServer::with_interceptor(service, my_interceptor)");
            println!("   )");
        }
    }
}