Add array to model and make metadata queryable (#55)

Author: abbiemery

resources/metadata_array.json

@@ -0,0 +1,56 @@
+{
+  "data": {
+    "id": "det",
+    "attributes": {
+      "ancestors": [
+        "4866611f-e6d9-4517-bedf-fc5526df57ad",
+        "primary"
+      ],
+      "structure_family": "array",
+      "specs": [],
+      "metadata": {},
+      "structure": {
+        "data_type": {
+          "endianness": "not_applicable",
+          "kind": "i",
+          "itemsize": 1,
+          "dt_units": null
+        },
+        "chunks": [
+          [
+            1,
+            1,
+            1,
+            1,
+            1
+          ],
+          [
+            1024
+          ],
+          [
+            1024
+          ]
+        ],
+        "shape": [
+          5,
+          1024,
+          1024
+        ],
+        "dims": null,
+        "resizable": false
+      },
+      "access_blob": {},
+      "sorting": null,
+      "data_sources": null
+    },
+    "links": {
+      "self": "http://0.0.0.0:8000/api/v1/metadata/4866611f-e6d9-4517-bedf-fc5526df57ad/primary/det",
+      "full": "http://0.0.0.0:8000/api/v1/array/full/4866611f-e6d9-4517-bedf-fc5526df57ad/primary/det",
+      "block": "http://0.0.0.0:8000/api/v1/array/block/4866611f-e6d9-4517-bedf-fc5526df57ad/primary/det?block={0},{1},{2}"
+    },
+    "meta": null
+  },
+  "error": null,
+  "links": null,
+  "meta": {}
+}

src/clients.rs

@@ -6,7 +6,7 @@ use serde::de::DeserializeOwned;
 use tracing::{info, instrument};
 use uuid::Uuid;
 
-use crate::model::{app, container, event_stream, run, table};
+use crate::model::{app, array, container, event_stream, run, table};
 
 pub type ClientResult<T> = Result<T, ClientError>;
 
@@ -46,6 +46,15 @@ impl TiledClient {
         self.request(&format!("/api/v1/metadata/{id}/{stream}"), None)
             .await
     }
+    pub async fn array_metadata(
+        &self,
+        id: Uuid,
+        stream: String,
+        array: String,
+    ) -> ClientResult<array::ArrayMetadataRoot> {
+        self.request(&format!("/api/v1/metadata/{id}/{stream}/{array}"), None)
+            .await
+    }
     pub async fn table_metadata(
         &self,
         id: Uuid,

src/model.rs

@@ -1,4 +1,5 @@
 pub(crate) mod app;
+pub(crate) mod array;
 pub(crate) mod container;
 pub(crate) mod event_stream;
 pub(crate) mod node;
@@ -32,6 +33,15 @@ impl TiledQuery {
         self.0.event_stream_metadata(id, stream).await
     }
     #[instrument(skip(self))]
+    async fn array_metadata(
+        &self,
+        id: Uuid,
+        stream: String,
+        array: String,
+    ) -> Result<array::ArrayMetadataRoot, ClientError> {
+        self.0.array_metadata(id, stream, array).await
+    }
+    #[instrument(skip(self))]
     async fn table_metadata(
         &self,
         id: Uuid,
@@ -131,6 +141,31 @@ mod tests {
         mock.assert();
     }
     #[tokio::test]
+    async fn array_metadata() {
+        let id = Uuid::parse_str("4866611f-e6d9-4517-bedf-fc5526df57ad").unwrap();
+        let stream = "primary";
+        let array = "det";
+        let server = MockServer::start();
+        let mock = server
+            .mock_async(|when, then| {
+                when.method("GET")
+                    .path(format!("/api/v1/metadata/{id}/{stream}/{array}"));
+                then.status(200)
+                    .body_from_file("resources/metadata_array.json");
+            })
+            .await;
+        let schema = build_schema(&server.base_url());
+        let query = r#"{ arrayMetadata(id:"4866611f-e6d9-4517-bedf-fc5526df57ad", stream:"primary", array:"det") {data {id}}}"#;
+        let response = schema.execute(query).await;
+        let exp = value! ({
+            "arrayMetadata": { "data": {"id": "det"}}
+        });
+
+        assert_eq!(response.data, exp);
+        assert_eq!(response.errors, &[]);
+        mock.assert();
+    }
+    #[tokio::test]
     async fn table_metadata() {
         let id = Uuid::parse_str("4866611f-e6d9-4517-bedf-fc5526df57ad").unwrap();
         let stream = "primary";

src/model/array.rs

@@ -0,0 +1,71 @@
+use std::collections::HashMap;
+
+use async_graphql::SimpleObject;
+use serde::{Deserialize, Serialize};
+use serde_json::Value;
+
+use crate::model::node;
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, SimpleObject)]
+pub struct ArrayMetadataRoot {
+    pub data: ArrayData,
+    pub error: Value,
+    pub links: Option<node::Links>,
+    pub meta: Value,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, SimpleObject)]
+pub struct ArrayData {
+    pub id: String,
+    pub attributes: ArrayAttributes,
+    pub links: ArrayLinks,
+    pub meta: Value,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, SimpleObject)]
+pub struct ArrayAttributes {
+    pub ancestors: Vec<Value>,
+    pub structure_family: String,
+    pub specs: Option<Vec<Value>>,
+    pub metadata: HashMap<String, Value>,
+    pub structure: ArrayStructure,
+    pub access_blob: Value,
+    pub sorting: Value,
+    pub data_sources: Value,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, SimpleObject)]
+pub struct ArrayStructure {
+    data_type: DataType,
+    chunks: Value,
+    shape: Value,
+    dims: Value,
+    resizable: bool,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, SimpleObject)]
+pub struct DataType {
+    endianness: String,
+    kind: String,
+    itemsize: i64,
+    dt_units: Value,
+}
+
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, SimpleObject)]
+pub struct ArrayLinks {
+    #[serde(rename = "self")]
+    #[graphql(name = "self")]
+    pub full: Option<String>,
+    pub block: Option<String>,
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::model::array;
+    use crate::test_utils::assert_readable_as;
+
+    #[test]
+    fn array_metadata() {
+        assert_readable_as::<array::ArrayMetadataRoot>("resources/metadata_array.json");
+    }
+}