Skip to content

Commit e6d3276

Browse files
authored
Enhance error logging in local webserver by including server type, port, project name, and version in error messages. Update IntegrateChangesResponse struct to be public and derive Deserialize for improved usability. (#2516)
1 parent ab121fe commit e6d3276

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

apps/framework-cli/src/cli/local_webserver.rs

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1378,12 +1378,17 @@ impl Webserver {
13781378
let route_service = route_service.clone();
13791379
let conn = conn_builder.serve_connection(
13801380
io,
1381-
route_service,
1381+
route_service.clone(),
13821382
);
13831383
let watched = graceful.watch(conn);
1384+
// Set server_label to "API" for the main API server. This label is used in error logging below.
1385+
let server_label = "API";
1386+
let port = socket.port();
1387+
let project_name = route_service.project.name().to_string();
1388+
let version = route_service.current_version.clone();
13841389
tokio::task::spawn(async move {
13851390
if let Err(e) = watched.await {
1386-
error!("server error: {}", e);
1391+
error!("server error on {} server (port {}): {} [project: {}, version: {}]", server_label, port, e, project_name, version);
13871392
}
13881393
});
13891394
}
@@ -1398,9 +1403,14 @@ impl Webserver {
13981403
management_service,
13991404
);
14001405
let watched = graceful.watch(conn);
1406+
// Set server_label to "Management" for the management server. This label is used in error logging below.
1407+
let server_label = "Management";
1408+
let port = management_socket.port();
1409+
let project_name = project.name().to_string();
1410+
let version = project.cur_version().to_string();
14011411
tokio::task::spawn(async move {
14021412
if let Err(e) = watched.await {
1403-
error!("server error: {}", e);
1413+
error!("server error on {} server (port {}): {} [project: {}, version: {}]", server_label, port, e, project_name, version);
14041414
}
14051415
});
14061416
}
@@ -1561,11 +1571,11 @@ pub struct IntegrateChangesRequest {
15611571
pub tables: Vec<String>,
15621572
}
15631573

1564-
#[derive(Debug, Serialize)]
1565-
struct IntegrateChangesResponse {
1566-
status: String,
1567-
message: String,
1568-
updated_tables: Vec<String>,
1574+
#[derive(Debug, Serialize, Deserialize)]
1575+
pub struct IntegrateChangesResponse {
1576+
pub status: String,
1577+
pub message: String,
1578+
pub updated_tables: Vec<String>,
15691579
}
15701580

15711581
#[derive(Debug, thiserror::Error)]

0 commit comments

Comments
 (0)