Merge pull request 'Print the version on lift off and add version endpoint' (#30) from 29-print-version-add-endpoint into main

Reviewed-on: #30

Cargo.lock

@@ -17,6 +17,12 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "anyhow"
+version = "1.0.71"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c7d0618f0e0b7e8ff11427422b64564d5fb0be1940354bfe2e0529b18a9d9b8"
+
 [[package]]
 name = "approx"
 version = "0.5.1"
@@ -1847,6 +1853,7 @@ dependencies = [
  "reqwest",
  "rocket",
  "thiserror",
+ "vergen",
 ]
 
 [[package]]
@@ -2274,6 +2281,17 @@ version = "0.2.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426"
 
+[[package]]
+name = "vergen"
+version = "8.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8b3c89c2c7e50f33e4d35527e5bf9c11d6d132226dbbd1753f0fbe9f19ef88c6"
+dependencies = [
+ "anyhow",
+ "rustversion",
+ "time 0.3.20",
+]
+
 [[package]]
 name = "version_check"
 version = "0.9.4"

Cargo.toml

@@ -22,6 +22,9 @@ reqwest = { version = "0.11.9", features = ["json"] }
 rocket = { version = "0.5.0-rc.3", features = ["json"] }
 thiserror = "1.0.31"
 
+[build-dependencies]
+vergen = { version = "8.2.1", default-features = false, features = ["build", "git", "gitcl"] }
+
 [dev-dependencies]
 assert_float_eq = "1.1.3"
 assert_matches = "1.5.0"

README.md

@@ -216,6 +216,31 @@ an address fails or if the position is out of bounds of the map, nothing is
 returned (HTTP 404). If the maps cannot/have not been downloaded or cached yet,
 a service unavailable error is returned (HTTP 503).
 
+## Version endpoint
+
+The `/version` endpoint provides information of the current version and build
+of the service.  This can be used to check if it needs to be updated.
+Again, there is no path and no query parameters, just:
+
+```http
+GET /version
+```
+
+### Version responses
+
+The response uses the JSON format and typically looks like this:
+
+```json
+{
+  "version": "0.2.7",
+  "timestamp": "2023-05-29T13:34:34.701323159Z",
+  "git_sha": "bb5962d",
+  "git_timestamp": "2023-05-29T15:32:17.000000000+02:00"
+}
+```
+
+(Build and git information in example output may be out of date.)
+
 ## License
 
 Sinoptik is licensed under the MIT license (see the `LICENSE` file or

build.rs

@@ -0,0 +1,9 @@
+use std::error::Error;
+use vergen::EmitBuilder;
+
+fn main() -> Result<(), Box<dyn Error>> {
+    // Generate the `cargo:` instructions to fill the appropriate environment variables.
+    EmitBuilder::builder().all_build().all_git().emit()?;
+
+    Ok(())
+}

src/lib.rs

@@ -21,6 +21,7 @@ use rocket::fairing::AdHoc;
 use rocket::http::Status;
 use rocket::response::Responder;
 use rocket::serde::json::Json;
+use rocket::serde::Serialize;
 use rocket::{get, routes, Build, Request, Rocket, State};
 
 use self::forecast::{forecast, Forecast, Metric};
@@ -84,13 +85,41 @@ impl<'r, 'o: 'r> Responder<'r, 'o> for Error {
     }
 }
 
-/// Result type that defaults to [`Error`] as the default error type.
-pub(crate) type Result<T, E = Error> = std::result::Result<T, E>;
-
 #[derive(Responder)]
 #[response(content_type = "image/png")]
 struct PngImageData(Vec<u8>);
 
+/// Result type that defaults to [`Error`] as the default error type.
+pub(crate) type Result<T, E = Error> = std::result::Result<T, E>;
+
+/// The version information as JSON response.
+#[derive(Debug, Serialize)]
+#[serde(crate = "rocket::serde")]
+struct VersionInfo {
+    /// The version of the build.
+    version: String,
+
+    /// The timestamp of the build.
+    timestamp: String,
+
+    /// The (most recent) git SHA used for the build.
+    git_sha: String,
+
+    /// The timestamp of the last git commit used for the build.
+    git_timestamp: String,
+}
+impl VersionInfo {
+    /// Retrieves the version information from the environment variables.
+    fn new() -> Self {
+        Self {
+            version: String::from(env!("CARGO_PKG_VERSION")),
+            timestamp: String::from(env!("VERGEN_BUILD_TIMESTAMP")),
+            git_sha: String::from(&env!("VERGEN_GIT_SHA")[0..7]),
+            git_timestamp: String::from(env!("VERGEN_GIT_COMMIT_TIMESTAMP")),
+        }
+    }
+}
+
 /// Handler for retrieving the forecast for an address.
 #[get("/forecast?<address>&<metrics>")]
 async fn forecast_address(
@@ -150,6 +179,12 @@ async fn map_geo(
     image_data.map(PngImageData)
 }
 
+/// Returns the version information.
+#[get("/version", format = "application/json")]
+async fn version() -> Result<Json<VersionInfo>> {
+    Ok(Json(VersionInfo::new()))
+}
+
 /// Sets up Rocket.
 fn rocket(maps_handle: MapsHandle) -> Rocket<Build> {
     let maps_refresher = maps::run(Arc::clone(&maps_handle));
@@ -157,7 +192,13 @@ fn rocket(maps_handle: MapsHandle) -> Rocket<Build> {
     rocket::build()
         .mount(
             "/",
-            routes![forecast_address, forecast_geo, map_address, map_geo],
+            routes![
+                forecast_address,
+                forecast_geo,
+                map_address,
+                map_geo,
+                version
+            ],
         )
         .manage(maps_handle)
         .attach(AdHoc::on_liftoff("Maps refresher", |_| {
@@ -166,6 +207,15 @@ fn rocket(maps_handle: MapsHandle) -> Rocket<Build> {
                 let _refresher = rocket::tokio::spawn(maps_refresher);
             })
         }))
+        .attach(AdHoc::on_liftoff("Version", |_| {
+            Box::pin(async move {
+                let name = env!("CARGO_PKG_NAME");
+                let version = env!("CARGO_PKG_VERSION");
+                let git_sha = &env!("VERGEN_GIT_SHA")[0..7];
+
+                println!("🌁 Started {name} v{version} (git @{git_sha})");
+            })
+        }))
 }
 
 /// Sets up Rocket and the maps cache refresher task.