Bump the version to 0.2.11

Also somebody seems to have slightly moved Eindhoven.

.gitea/workflows/check-lint-test.yml

@@ -21,9 +21,6 @@ jobs:
           override: true
           components: rustfmt, clippy
 
-      - name: Use sparse Cargo index for crates.io
-        run: echo -e '[registries.crates-io]\nprotocol = "sparse"' >> /root/.cargo/config.toml
-
       - name: Run cargo check
         uses: https://github.com/actions-rs/cargo@v1
         with:

.gitea/workflows/release.yml

@@ -2,7 +2,8 @@ name: "Release"
 
 on:
   push:
-    tags: "v*"
+    tags:
+      - "v*"
 
 jobs:
   release:
@@ -20,25 +21,16 @@ jobs:
           echo "Releasing version: $VERSION"
           echo "VERSION=$VERSION" >> $GITHUB_ENV
 
-      - name: Install Rust stable toolchain
-        uses: https://github.com/actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-
-      - name: Use sparse Cargo index for crates.io
-        run: echo -e '[registries.crates-io]\nprotocol = "sparse"' >> /root/.cargo/config.toml
-
-      - name: Install cargo-deb
-        uses: https://github.com/brndnmtthws/rust-action-cargo-binstall@v1
-        with:
-          packages: cargo-deb
-
-      - name: Run cargo-deb
-        uses: https://github.com/actions-rs/cargo@v1
-        with:
-          command: deb
+      - name: Get the release notes from the changelog
+        run: |
+          EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
+          RELEASE_NOTES=$(sed -n -e "/^## \[$VERSION\]/,/^## \[/{//"'!'"p;}" CHANGELOG.md | sed -e '1d;$d')
+          echo "Release notes:"
+          echo
+          echo "$RELEASE_NOTES"
+          echo "RELEASE_NOTES<<$EOF" >> "$GITHUB_ENV"
+          echo "$RELEASE_NOTES" >> "$GITHUB_ENV"
+          echo "$EOF" >> "$GITHUB_ENV"
 
       - name: Install Go
         uses: actions/setup-go@v4
@@ -50,11 +42,12 @@ jobs:
         with:
           # This is available by default.
           api_key: '${{ secrets.RELEASE_TOKEN }}'
-          files: target/debian/sinoptik*.deb
+          files: FIXME
           title: 'Release ${{ env.VERSION }}'
+          body: '${{ env.RELEASE_NOTES }}'
 
   release-crate:
-    name: "Release crate"
+    name: "Release Rust crate"
     runs-on: debian-latest
     steps:
       - name: Checkout sources
@@ -83,3 +76,37 @@ jobs:
         with:
           command: publish
           args: --registry luon
+
+  release-deb:
+    name: "Release Debian package"
+    runs-on: debian-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install Rust stable toolchain
+        uses: https://github.com/actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+
+      - name: Install cargo-deb
+        uses: https://github.com/brndnmtthws/rust-action-cargo-binstall@v1
+        with:
+          packages: cargo-deb
+
+      - name: Run cargo-deb
+        uses: https://github.com/actions-rs/cargo@v1
+        with:
+          command: deb
+
+      - name: Publish Debian package
+        env:
+          DEB_REPO_TOKEN: '${{ secrets.DEB_REPO_TOKEN }}'
+        run: |
+          curl --config <(printf "user=%s:%s" paul "${DEB_REPO_TOKEN}") \
+            --upload-file target/debian/sinoptik*.deb \
+            https://git.luon.net/api/packages/paul/debian/pool/bookworm/main/upload

CHANGELOG.md

@@ -7,6 +7,66 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.11] - 2024-02-27
+
+### Security
+
+* Updated dependencies, fixes security advisories:
+  * [RUSTSEC-2024-0003](https://rustsec.org/advisories/RUSTSEC-2024-0003)
+  * [RUSTSEC-2023-0072](https://rustsec.org/advisories/RUSTSEC-2024-0072)
+
+### Fixed
+
+* Fix clippy issue
+* Tweak/fix tests; reduce required accuracy for geocoded coordinates
+
+## [0.2.10] - 2023-11-03
+
+### Security
+
+* Update dependencies
+  ([RUSTSEC-2020-0071](https://rustsec.org/advisories/RUSTSEC-2020-0071.html),
+  [RUSTSEC-2023-0044](https://rustsec.org/advisories/RUSTSEC-2023-0044.html))
+
+### Changed
+
+* Switch to Rocket 0.5 RC4
+* Update dependency on `cached`
+
+### Fixed
+
+* Fix clippy issues
+
+## [0.2.9] - 2023-08-25
+
+### Changed
+
+* Update release Gitea Actions workflow; add seperate job to release Debian
+  package to the new repository
+
+### Security
+
+* Update dependencies ([RUSTSEC-2023-0044](https://rustsec.org/advisories/RUSTSEC-2023-0044))
+
+## [0.2.8] - 2023-06-05
+
+### Added
+
+* Print the version on lift off (#30)
+* Add a `/version` endpoint to the API (#30)
+
+### Changed
+
+* Update dependency on `cached`
+
+### Fixed
+
+* Properly attribute the PAQI metric in its description(s)
+
+### Removed
+
+* No longer provide a map for the PAQI metric; the map used is only for pollen
+
 ## [0.2.7] - 2023-05-26
 
 ### Fixed
@@ -112,7 +172,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Initial release.
 
-[Unreleased]: https://git.luon.net/paul/sinoptik/compare/v0.2.7...HEAD
+[Unreleased]: https://git.luon.net/paul/sinoptik/compare/v0.2.11...HEAD
+[0.2.11]: https://git.luon.net/paul/sinoptik/compare/v0.2.10...v0.2.11
+[0.2.10]: https://git.luon.net/paul/sinoptik/compare/v0.2.9...v0.2.10
+[0.2.9]: https://git.luon.net/paul/sinoptik/compare/v0.2.8...v0.2.9
+[0.2.8]: https://git.luon.net/paul/sinoptik/compare/v0.2.7...v0.2.8
 [0.2.7]: https://git.luon.net/paul/sinoptik/compare/v0.2.6...v0.2.7
 [0.2.6]: https://git.luon.net/paul/sinoptik/compare/v0.2.5...v0.2.6
 [0.2.5]: https://git.luon.net/paul/sinoptik/compare/v0.2.4...v0.2.5

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "sinoptik"
-version = "0.2.7"
+version = "0.2.11"
 authors = [
   "Admar Schoonen <admar@luon.net",
   "Paul van Tilburg <paul@luon.net>"
@@ -12,7 +12,7 @@ repository = "https://git.luon.net/paul/sinoptik"
 license = "MIT"
 
 [dependencies]
-cached = { version = "0.42.0", features = ["async"] }
+cached = { version = "0.46.0", features = ["async"] }
 chrono = "0.4.19"
 chrono-tz = "0.8.1"
 csv = "1.1.6"
@@ -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"
@@ -42,7 +45,8 @@ Currently supported metrics are:
 * O₃ concentration (per hour, from Luchtmeetnet)
 * Particulate matter (PM10) concentration (per hour, from Luchtmeetnet)
 * Pollen (per hour, from Buienradar)
-* Pollen/air quality index (per hour, from Buienradar)
+* Pollen/air quality index (per hour, combined from Buienradar and
+  Luchtmeetnet)
 * Precipitation (per 5 minutes, from Buienradar)
 * UV index (per day, from Buienradar)
 

README.md

@@ -11,7 +11,8 @@ Currently supported metrics are:
 * O₃ concentration (per hour, from [Luchtmeetnet])
 * Particulate matter (PM10) concentration (per hour, from [Luchtmeetnet])
 * Pollen (per hour, from [Buienradar])
-* Pollen/air quality index (per hour, from [Buienradar])
+* Pollen/air quality index (per hour, combined from [Buienradar] and
+  [Luchtmeetnet])
 * Precipitation (per 5 minutes, from [Buienradar])
 * UV index (per day, from [Buienradar])
 
@@ -216,6 +217,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 API endpoint
+
+The `/version` API 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.
@@ -213,8 +263,8 @@ mod tests {
         let response = client.get("/forecast?address=eindhoven").dispatch();
         assert_eq!(response.status(), Status::Ok);
         let json = response.into_json::<JsonValue>().expect("Not valid JSON");
-        assert_float_absolute_eq!(json["lat"].as_f64().unwrap(), 51.4392648, 1e-8);
-        assert_float_absolute_eq!(json["lon"].as_f64().unwrap(), 5.478633, 1e-8);
+        assert_float_absolute_eq!(json["lat"].as_f64().unwrap(), 51.448557, 1e-5);
+        assert_float_absolute_eq!(json["lon"].as_f64().unwrap(), 5.450123, 1e-5);
         assert_matches!(json["time"], JsonValue::Number(_));
         assert_matches!(json.get("AQI"), None);
         assert_matches!(json.get("NO2"), None);
@@ -231,8 +281,8 @@ mod tests {
             .dispatch();
         assert_eq!(response.status(), Status::Ok);
         let json = response.into_json::<JsonValue>().expect("Not valid JSON");
-        assert_float_absolute_eq!(json["lat"].as_f64().unwrap(), 51.4392648, 1e-8);
-        assert_float_absolute_eq!(json["lon"].as_f64().unwrap(), 5.478633, 1e-8);
+        assert_float_absolute_eq!(json["lat"].as_f64().unwrap(), 51.448557, 1e-5);
+        assert_float_absolute_eq!(json["lon"].as_f64().unwrap(), 5.450123, 1e-5);
         assert_matches!(json["time"], JsonValue::Number(_));
         assert_matches!(json.get("AQI"), Some(JsonValue::Array(_)));
         assert_matches!(json.get("NO2"), Some(JsonValue::Array(_)));
@@ -316,7 +366,7 @@ mod tests {
 
         // No metric selected, don't know which map to show?
         let response = client.get("/map?address=eindhoven").dispatch();
-        assert_eq!(response.status(), Status::NotFound);
+        assert_eq!(response.status(), Status::UnprocessableEntity);
     }
 
     #[test]
@@ -325,10 +375,6 @@ mod tests {
         let maps_handle_clone = Arc::clone(&maps_handle);
         let client = Client::tracked(rocket(maps_handle)).expect("Not a valid Rocket instance");
 
-        // No metric passed, don't know which map to show?
-        let response = client.get("/map?lat=51.4&lon=5.5").dispatch();
-        assert_eq!(response.status(), Status::NotFound);
-
         // No maps available yet.
         let response = client.get("/map?lat=51.4&lon=5.5&metric=pollen").dispatch();
         assert_eq!(response.status(), Status::ServiceUnavailable);
@@ -345,8 +391,12 @@ mod tests {
         assert_eq!(response.status(), Status::Ok);
         assert_eq!(response.content_type(), Some(ContentType::PNG));
 
+        // ... but not if it is out of bounds.
+        let response = client.get("/map?lat=0.0&lon=0.0&metric=pollen").dispatch();
+        assert_eq!(response.status(), Status::NotFound);
+
         // No metric passed, don't know which map to show?
         let response = client.get("/map?lat=51.4&lon=5.5").dispatch();
-        assert_eq!(response.status(), Status::NotFound);
+        assert_eq!(response.status(), Status::UnprocessableEntity);
     }
 }

src/maps.rs

@@ -8,7 +8,7 @@ use std::f64::consts::PI;
 use std::sync::{Arc, Mutex};
 
 use chrono::serde::ts_seconds;
-use chrono::{DateTime, Duration, NaiveDateTime, Utc};
+use chrono::{DateTime, Duration, NaiveDateTime, TimeZone, Utc};
 use image::{
     DynamicImage, GenericImage, GenericImageView, ImageError, ImageFormat, Pixel, Rgb, Rgba,
 };
@@ -78,16 +78,16 @@ type MapKeyHistogram = HashMap<Rgb<u8>, u32>;
 /// Note that the actual score starts from 1, not 0 as per this array.
 #[rustfmt::skip]
 const MAP_KEY: [[u8; 3]; 10] = [
-    [0x49, 0xDA, 0x21],
-    [0x30, 0xD2, 0x00],
-    [0xFF, 0xF8, 0x8B],
-    [0xFF, 0xF6, 0x42],
-    [0xFD, 0xBB, 0x31],
-    [0xFD, 0x8E, 0x24],
-    [0xFC, 0x10, 0x3E],
-    [0x97, 0x0A, 0x33],
-    [0xA6, 0x6D, 0xBC],
-    [0xB3, 0x30, 0xA1],
+    [0x49, 0xDA, 0x21], // #49DA21
+    [0x30, 0xD2, 0x00], // #30D200
+    [0xFF, 0xF8, 0x8B], // #FFF88B
+    [0xFF, 0xF6, 0x42], // #FFF642
+    [0xFD, 0xBB, 0x31], // #FDBB31
+    [0xFD, 0x8E, 0x24], // #FD8E24
+    [0xFC, 0x10, 0x3E], // #FC103E
+    [0x97, 0x0A, 0x33], // #970A33
+    [0xA6, 0x6D, 0xBC], // #A66DBC
+    [0xB3, 0x30, 0xA1], // #B330A1
 ];
 
 /// The Buienradar map sample size.
@@ -449,7 +449,7 @@ async fn retrieve_image(url: Url) -> Result<RetrievedMaps> {
             .ok_or_else(|| Error::InvalidImagePath(path.to_owned()))?;
         let timestamp = NaiveDateTime::parse_from_str(timestamp_str, "%Y%m%d%H%M")?;
 
-        DateTime::<Utc>::from_utc(timestamp, Utc)
+        Utc.from_utc_datetime(&timestamp)
     };
     let bytes = response.bytes().await?;
 
@@ -567,7 +567,6 @@ pub(crate) async fn mark_map(
     tokio::task::spawn_blocking(move || {
         let maps = maps_handle.lock().expect("Maps handle lock was poisoned");
         let image = match metric {
-            Metric::PAQI => maps.pollen_mark(position),
             Metric::Pollen => maps.pollen_mark(position),
             Metric::UVI => maps.uvi_mark(position),
             _ => return Err(crate::Error::UnsupportedMetric(metric)),

src/position.rs

@@ -109,7 +109,7 @@ pub(crate) async fn resolve_address(address: String) -> Result<Position> {
         let points: Vec<Point<f64>> = osm.forward(&address)?;
 
         points
-            .get(0)
+            .first()
             .ok_or(Error::NoPositionFound)
             .map(Position::from)
     })

src/providers/combined.rs

@@ -108,7 +108,7 @@ fn merge(
     // value.
     let items = pollen_samples
         .into_iter()
-        .zip(aqi_items.into_iter())
+        .zip(aqi_items)
         .map(|(pollen_sample, aqi_item)| {
             let time = pollen_sample.time;
             let value = (pollen_sample.score as f32).max(aqi_item.value);