api for accessing dataset tiles

michaelmattig · michaelmattig · commit 92025bbc655e · 2025-12-01T17:54:28.000+01:00
diff --git a/services/src/api/apidoc.rs b/services/src/api/apidoc.rs
@@ -1,7 +1,7 @@
 #![allow(clippy::needless_for_each)] // TODO: remove when clippy is fixed for utoipa <https://github.com/juhaku/utoipa/issues/1420>
 
 use crate::api::handlers;
-use crate::api::handlers::datasets::{AddDatasetTile, VolumeFileLayersResponse};
+use crate::api::handlers::datasets::{AddDatasetTile, DatasetTile, VolumeFileLayersResponse};
 use crate::api::handlers::permissions::{
     PermissionListOptions, PermissionListing, PermissionRequest, Resource,
 };
@@ -118,6 +118,7 @@ use utoipa::{Modify, OpenApi};
         handlers::datasets::update_dataset_symbology_handler,
         handlers::datasets::update_loading_info_handler,
         handlers::datasets::add_dataset_tiles_handler,
+        handlers::datasets::get_dataset_tiles_handler,
         handlers::layers::add_collection,
         handlers::layers::add_existing_collection_to_collection,
         handlers::layers::add_existing_layer_to_collection,
@@ -406,6 +407,7 @@ use utoipa::{Modify, OpenApi};
             VolumeName,
             DataPath,
             AddDatasetTile,
+            DatasetTile,
 
             PlotOutputFormat,
             WrappedPlotOutput,
diff --git a/services/src/api/handlers/datasets.rs b/services/src/api/handlers/datasets.rs
@@ -15,6 +15,7 @@ use crate::{
     datasets::{
         DatasetName,
         listing::{DatasetListOptions, DatasetListing, DatasetProvider},
+        postgres::DatasetTileId,
         storage::{AutoCreateDataset, DatasetStore, SuggestMetaData},
         upload::{AdjustFilePath, Upload, UploadDb, UploadId, UploadRootPath, VolumeName, Volumes},
     },
@@ -28,7 +29,7 @@ use crate::{
 };
 use actix_web::{
     FromRequest, HttpResponse, HttpResponseBuilder, Responder,
-    web::{self, Json},
+    web::{self, Json, Query},
 };
 use gdal::{
     DatasetOptions,
@@ -63,7 +64,8 @@ use std::{
     convert::{TryFrom, TryInto},
     path::Path,
 };
-use utoipa::{ToResponse, ToSchema};
+use utoipa::{IntoParams, ToResponse, ToSchema};
+use validator::Validate;
 
 pub(crate) fn init_dataset_routes<C>(cfg: &mut web::ServiceConfig)
 where
@@ -96,7 +98,8 @@ where
             )
             .service(
                 web::resource("/{dataset}/tiles")
-                    .route(web::post().to(add_dataset_tiles_handler::<C>)),
+                    .route(web::post().to(add_dataset_tiles_handler::<C>))
+                    .route(web::get().to(get_dataset_tiles_handler::<C>)),
             )
             .service(
                 web::resource("/{dataset}")
@@ -246,7 +249,6 @@ pub async fn add_dataset_tiles_handler<C: ApplicationContext>(
         &dataset
             .data_path
             .ok_or(AddDatasetTilesError::DatasetIsMissingDataPath)?,
-        &session_context,
     )
     .context(CannotAddTilesToDataset)?;
 
@@ -345,24 +347,17 @@ fn validate_tile(
     Ok(())
 }
 
-fn file_path_from_data_path<T: SessionContext>(
-    data_path: &DataPath,
-    session_context: &T,
-) -> Result<std::path::PathBuf> {
+fn file_path_from_data_path(data_path: &DataPath) -> Result<std::path::PathBuf> {
     Ok(match data_path {
-        DataPath::Volume(volume_name) => session_context
-            .volumes()?
+        DataPath::Volume(volume_name) => Volumes::default()
+            .volumes
             .iter()
-            .find(|v| v.name == volume_name.0)
+            .find(|v| v.name == *volume_name)
             .ok_or(Error::UnknownVolumeName {
                 volume_name: volume_name.0.clone(),
             })?
             .path
-            .clone()
-            .ok_or(Error::CannotAccessVolumePath {
-                volume_name: volume_name.0.clone(),
-            })?
-            .into(),
+            .clone(),
         DataPath::Upload(upload_id) => upload_id.root_path()?,
     })
 }
@@ -445,6 +440,71 @@ pub async fn get_dataset_handler<C: ApplicationContext>(
     Ok(web::Json(dataset))
 }
 
+#[derive(Clone, Serialize, Deserialize, PartialEq, Debug, ToSchema)]
+pub struct DatasetTile {
+    pub id: DatasetTileId,
+    pub time: crate::api::model::datatypes::TimeInterval,
+    pub spatial_partition: SpatialPartition2D,
+    pub band: u32,
+    pub z_index: u32,
+    pub params: GdalDatasetParameters,
+}
+
+#[derive(Debug, Deserialize, IntoParams, Validate)]
+pub struct GetDatasetTilesParams {
+    pub offset: u32,
+    #[validate(range(min = 1, max = 100))]
+    pub limit: u32,
+    // TODO: filter by time, space, filename, ...
+}
+
+/// Retrieves details about a dataset using the internal name.
+#[utoipa::path(
+    tag = "Datasets",
+    get,
+    path = "/dataset/{dataset}/tiles",
+    responses(
+        (status = 200, description = "OK", body = Vec<DatasetTile>),
+        (status = 401, response = crate::api::model::responses::UnauthorizedUserResponse)
+    ),
+    params(
+        ("dataset" = DatasetName, description = "Dataset Name"),
+        GetDatasetTilesParams
+    ),
+    security(
+        ("session_token" = [])
+    )
+)]
+pub async fn get_dataset_tiles_handler<C: ApplicationContext>(
+    dataset: web::Path<DatasetName>,
+    session: C::Session,
+    params: Query<GetDatasetTilesParams>,
+    app_ctx: web::Data<C>,
+) -> Result<impl Responder, GetDatasetTilesError> {
+    let session_ctx = app_ctx.session_context(session).db();
+
+    let real_dataset = dataset.into_inner();
+
+    let dataset_id = session_ctx
+        .resolve_dataset_name_to_id(&real_dataset)
+        .await
+        .context(CannotLoadDatasetForGettingTiles)?;
+
+    // handle the case where the dataset name is not known
+    let dataset_id = dataset_id
+        .ok_or(error::Error::UnknownDatasetName {
+            dataset_name: real_dataset.to_string(),
+        })
+        .context(CannotLoadDatasetForGettingTiles)?;
+
+    let tiles = session_ctx
+        .get_dataset_tiles(dataset_id, &params.into_inner())
+        .await
+        .context(CannotLoadDatasetTiles)?;
+
+    Ok(web::Json(tiles))
+}
+
 /// Update details about a dataset using the internal name.
 #[utoipa::path(
     tag = "Datasets",
diff --git a/services/src/api/model/responses/datasets/errors.rs b/services/src/api/model/responses/datasets/errors.rs
@@ -176,3 +176,27 @@ impl fmt::Debug for AddDatasetTilesError {
         write!(f, "{}", ge_report(self))
     }
 }
+
+#[derive(Snafu, IntoStaticStr)]
+#[snafu(visibility(pub(crate)))]
+#[snafu(context(suffix(false)))] // disables default `Snafu` suffix
+pub enum GetDatasetTilesError {
+    CannotLoadDatasetForGettingTiles { source: error::Error },
+    CannotLoadDatasetTiles { source: error::Error },
+}
+
+impl ResponseError for GetDatasetTilesError {
+    fn error_response(&self) -> HttpResponse {
+        HttpResponse::build(self.status_code()).json(ErrorResponse::from(self))
+    }
+
+    fn status_code(&self) -> StatusCode {
+        StatusCode::BAD_REQUEST
+    }
+}
+
+impl fmt::Debug for GetDatasetTilesError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{}", ge_report(self))
+    }
+}
diff --git a/services/src/api/model/services.rs b/services/src/api/model/services.rs
@@ -177,6 +177,7 @@ pub struct UpdateDataset {
     pub description: String,
     #[validate(custom(function = "validate_tags"))]
     pub tags: Vec<String>,
+    // TODO: result descriptor update? or change the model so that the result descriptor is only part of the metadata
 }
 
 #[derive(Deserialize, Serialize, PartialEq, Eq, Debug, Clone, ToSchema, Validate)]
diff --git a/services/src/datasets/postgres.rs b/services/src/datasets/postgres.rs
@@ -1,8 +1,9 @@
 use std::path::PathBuf;
 
-use crate::api::handlers::datasets::AddDatasetTile;
+use crate::api::handlers::datasets::{AddDatasetTile, DatasetTile, GetDatasetTilesParams};
 use crate::api::model::datatypes::SpatialPartition2D;
 use crate::api::model::services::{DataPath, UpdateDataset};
+use crate::config::Gdal;
 use crate::contexts::PostgresDb;
 use crate::datasets::listing::Provenance;
 use crate::datasets::listing::{DatasetListOptions, DatasetListing, DatasetProvider};
@@ -1321,6 +1322,54 @@ where
 
         Ok(())
     }
+
+    async fn get_dataset_tiles(
+        &self,
+        dataset: DatasetId,
+        params: &GetDatasetTilesParams,
+    ) -> Result<Vec<DatasetTile>> {
+        let mut conn = self.conn_pool.get().await?;
+        let tx = conn.build_transaction().start().await?;
+
+        self.ensure_permission_in_tx(dataset.into(), Permission::Read, &tx)
+            .await
+            .boxed_context(crate::error::PermissionDb)?;
+
+        let rows = tx
+            .query(
+                "
+            SELECT
+                id, time, bbox, band, z_index, gdal_params
+            FROM
+                dataset_tiles
+            WHERE
+                dataset_id = $1
+            ORDER BY
+                (time).start, 
+                band, 
+                (bbox).upper_left_coordinate.x, 
+                (bbox).upper_left_coordinate.y, 
+                z_index
+            OFFSET $2
+            LIMIT $3",
+                &[&dataset, &(params.offset as i64), &(params.limit as i64)],
+            )
+            .await?;
+
+        let tiles: Vec<DatasetTile> = rows
+            .into_iter()
+            .map(|row| DatasetTile {
+                id: row.get(0),
+                time: row.get(1),
+                spatial_partition: row.get(2),
+                band: row.get(3),
+                z_index: row.get(4),
+                params: row.get::<_, GdalDatasetParameters>(5).into(),
+            })
+            .collect();
+
+        Ok(tiles)
+    }
 }
 
 async fn validate_time(
diff --git a/services/src/datasets/storage.rs b/services/src/datasets/storage.rs
@@ -1,7 +1,7 @@
 use super::listing::Provenance;
 use super::postgres::DatasetMetaData;
 use super::{DatasetIdAndName, DatasetName};
-use crate::api::handlers::datasets::AddDatasetTile;
+use crate::api::handlers::datasets::{AddDatasetTile, DatasetTile, GetDatasetTilesParams};
 use crate::api::model::services::{DataPath, UpdateDataset};
 use crate::datasets::listing::{DatasetListing, DatasetProvider};
 use crate::datasets::upload::UploadDb;
@@ -323,4 +323,10 @@ pub trait DatasetStore {
 
     async fn add_dataset_tiles(&self, dataset: DatasetId, tiles: Vec<AddDatasetTile>)
     -> Result<()>;
+
+    async fn get_dataset_tiles(
+        &self,
+        dataset: DatasetId,
+        params: &GetDatasetTilesParams,
+    ) -> Result<Vec<DatasetTile>>;
 }
diff --git a/test_data/api_calls/multi_tile.http b/test_data/api_calls/multi_tile.http
@@ -1,14 +1,19 @@
 # @name anonymousSession
-POST http://localhost:3030/api/anonymous
+POST http://localhost:3030/api/login
 Content-Type: application/json
 
+{
+  "email": "admin@localhost",
+  "password": "adminadmin"
+}
+
 ###
 # @name dataset
 POST http://localhost:3030/api/dataset
 Content-Type: application/json
 Authorization: Bearer {{anonymousSession.response.body.$.id}}
 
-< ../raster/multi_tile/metadata/dataset.json
+< ../raster/multi_tile/metadata/dataset_irregular.json
 
 ###
 
@@ -44,4 +49,32 @@ Authorization: Bearer {{anonymousSession.response.body.$.id}}
 GET http://localhost:3030/api/wms/{{workflow.response.body.$.id}}?REQUEST=GetMap&SERVICE=WMS&VERSION=1.3.0&FORMAT=image%2Fpng&STYLES=custom%3A{{colorizer}}&TRANSPARENT=true&layers={{workflow.response.body.$.id}}&time=2025-01-01T00%3A00%3A00.000Z&EXCEPTIONS=application%2Fjson&WIDTH=1800&HEIGHT=900&CRS=EPSG%3A4326&BBOX=-90%2C-180%2C90%2C180
 Authorization: Bearer {{anonymousSession.response.body.$.id}}
 
+### Share with users
+
+PUT http://localhost:3030/api/permissions
+Authorization: Bearer {{anonymousSession.response.body.$.id}}
+Content-Type: application/json
+
+ {
+    "resource": {
+        "type": "dataset",
+        "id": "{{dataset.response.body.$.datasetName}}"
+    },
+    "roleId": "4e8081b6-8aa6-4275-af0c-2fa2da557d28",
+    "permission": "Read"
+}
+
+### Share wit hanonymous
+
+PUT http://localhost:3030/api/permissions
+Authorization: Bearer {{anonymousSession.response.body.$.id}}
+Content-Type: application/json
 
+ {
+    "resource": {
+        "type": "dataset",
+        "id": "{{dataset.response.body.$.datasetName}}"
+    },
+    "roleId": "fd8e87bf-515c-4f36-8da6-1a53702ff102",
+    "permission": "Read"
+}

Original file line number	Diff line number	Diff line change
`@@ -177,6 +177,7 @@ pub struct UpdateDataset {`
`177`	`177`	`pub description: String,`
`178`	`178`	`#[validate(custom(function = "validate_tags"))]`
`179`	`179`	`pub tags: Vec<String>,`
	`180`	`+ // TODO: result descriptor update? or change the model so that the result descriptor is only part of the metadata`
`180`	`181`	`}`
`181`	`182`
`182`	`183`	`#[derive(Deserialize, Serialize, PartialEq, Eq, Debug, Clone, ToSchema, Validate)]`