Query multiple beamline configurations

Cargo.toml

@@ -37,7 +37,7 @@ assert_matches = "1.5.0"
 async-std = { version = "1.13.0", features = ["attributes"], default-features = false }
 httpmock = { version = "0.7.0", default-features = false }
 rstest = "0.24.0"
-serde_json = "1.0.138"
+serde_json = { version = "1.0.138", features = ["preserve_order"] }
 tempfile = "3.16.0"
 
 [build-dependencies]

README.md

@@ -83,9 +83,9 @@ echo '{
 </details>
 
 ### Queries (read-only)
-There are two read only queries, one to get the visit directory for a given
-visit and beamline and one to get the current configuration for a given
-beamline.
+There are three read only queries, one to get the visit directory for a given
+visit and beamline, one to get the current configuration for a given
+beamline and one to get the current configuration(s) for one or more beamline.
 
 #### paths
 Get the visit directory for a beamline and visit
@@ -119,7 +119,9 @@ Get the current configuration values for the given beamline
     visitTemplate
     scanTemplate
     detectorTemplate
-    latestScanNumber
+    dbScanNumber
+    fileScanNumber
+    trackerFileExtension
   }
 }
 ```
@@ -131,11 +133,91 @@ Get the current configuration values for the given beamline
     "visitTemplate": "/data/{instrument}/data/{year}/{visit}",
     "scanTemplate": "{subdirectory}/{instrument}-{scan_number}",
     "detectorTemplate": "{subdirectory}/{instrument}-{scan_number}-{detector}",
-    "latestScanNumber": 20839
+    "dbScanNumber": 0,
+    "fileScanNumber": null,
+    "trackerFileExtension": null
   }
 }
 ```
 
+#### configurations
+Get the current configuration values for one or more beamlines specified as a list.
+Providing no beamlines returns all current configurations.
+
+##### Query
+```graphql
+{
+    configurations(beamlineFilters: ["i22", "i11"]) {
+    beamline
+    visitTemplate
+    scanTemplate
+    detectorTemplate
+    dbScanNumber
+    fileScanNumber
+    trackerFileExtension
+  }
+}
+```
+
+##### Response
+```json
+{
+  "configurations": [
+      {
+        "beamline": "i11",
+        "visitTemplate": "/tmp/{instrument}/data/{year}/{visit}",
+        "scanTemplate": "{subdirectory}/{instrument}-{scan_number}",
+        "detectorTemplate": "{subdirectory}/{instrument}-{scan_number}-{detector}",
+        "dbScanNumber": 0,
+        "fileScanNumber": null,
+        "trackerFileExtension": null
+      },
+      {
+        "beamline": "i22",
+        "visitTemplate": "/tmp/{instrument}/data/{year}/{visit}",
+        "scanTemplate": "{subdirectory}/{instrument}-{scan_number}",
+        "detectorTemplate": "{subdirectory}/{instrument}-{scan_number}-{detector}",
+        "dbScanNumber": 0,
+        "fileScanNumber": null,
+        "trackerFileExtension": null
+      }
+    ]
+}
+```
+
+##### Query
+```graphql
+{
+    configurations {
+    beamline
+    visitTemplate
+    scanTemplate
+    detectorTemplate
+    dbScanNumber
+    fileScanNumber
+    trackerFileExtension
+  }
+}
+```
+
+##### Response
+```json
+{
+  "configurations": [
+      {
+        "beamline": "i11",
+        "visitTemplate": "/tmp/{instrument}/data/{year}/{visit}",
+        "scanTemplate": "{subdirectory}/{instrument}-{scan_number}",
+        "detectorTemplate": "{subdirectory}/{instrument}-{scan_number}-{detector}",
+        "dbScanNumber": 0,
+        "fileScanNumber": null,
+        "trackerFileExtension": null
+      },
+      ...
+    ]
+}
+```
+
 ## Mutations (read-write)
 
 #### scan

src/db_service.rs

@@ -297,6 +297,32 @@ impl SqliteScanPathService {
         .ok_or(ConfigurationError::MissingBeamline(beamline.into()))
     }
 
+    pub async fn configurations(
+        &self,
+        filters: Vec<String>,
+    ) -> Result<Vec<BeamlineConfiguration>, ConfigurationError> {
+        let mut q = QueryBuilder::new("SELECT * FROM beamline WHERE name in (");
+        let mut beamlines = q.separated(", ");
+        for filter in filters {
+            beamlines.push_bind(filter);
+        }
+        q.push(")");
+
+        let query = q.build_query_as();
+        Ok(query.fetch_all(&self.pool).await?)
+    }
+
+    pub async fn all_configurations(
+        &self,
+    ) -> Result<Vec<BeamlineConfiguration>, ConfigurationError> {
+        Ok(query_as!(DbBeamlineConfig, "SELECT * FROM beamline")
+            .fetch_all(&self.pool)
+            .await?
+            .into_iter()
+            .map(BeamlineConfiguration::from)
+            .collect())
+    }
+
     pub async fn next_scan_configuration(
         &self,
         beamline: &str,
@@ -575,6 +601,137 @@ mod db_tests {
         assert_eq!(ext, "ext");
     }
 
+    #[rstest]
+    #[test]
+    async fn configurations() {
+        let db = SqliteScanPathService::memory().await;
+        ok!(update("i22")
+            .with_scan_number(122)
+            .with_extension("ext")
+            .insert_new(&db));
+        ok!(update("i11")
+            .with_scan_number(111)
+            .with_extension("ext")
+            .insert_new(&db));
+
+        let confs = ok!(db.configurations(vec![
+            "i22".to_string(),
+            "i11".to_string(),
+            "i03".to_string()
+        ]));
+        // i03 has not been configured so it will not fetch it.
+        assert_eq!(confs.len(), 2);
+
+        for conf in confs.iter() {
+            match conf.name() {
+                "i22" => {
+                    assert_eq!(conf.name(), "i22");
+                    assert_eq!(conf.scan_number(), 122);
+                    assert_eq!(
+                        conf.visit().unwrap().to_string(),
+                        "/tmp/{instrument}/data/{year}/{visit}"
+                    );
+                    assert_eq!(
+                        conf.scan().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}"
+                    );
+                    assert_eq!(
+                        conf.detector().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}-{detector}"
+                    );
+                    let Some(ext) = &conf.tracker_file_extension else {
+                        panic!("Missing extension");
+                    };
+                    assert_eq!(ext, "ext");
+                }
+                "i11" => {
+                    assert_eq!(conf.name(), "i11");
+                    assert_eq!(conf.scan_number(), 111);
+                    assert_eq!(
+                        conf.visit().unwrap().to_string(),
+                        "/tmp/{instrument}/data/{year}/{visit}"
+                    );
+                    assert_eq!(
+                        conf.scan().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}"
+                    );
+                    assert_eq!(
+                        conf.detector().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}-{detector}"
+                    );
+                    let Some(ext) = &conf.tracker_file_extension else {
+                        panic!("Missing extension");
+                    };
+                    assert_eq!(ext, "ext");
+                }
+                other => panic!("Unexpected beamline name: {other}"),
+            }
+        }
+    }
+
+    #[rstest]
+    #[test]
+    async fn all_configurations() {
+        let db = SqliteScanPathService::memory().await;
+        ok!(update("i22")
+            .with_scan_number(122)
+            .with_extension("ext")
+            .insert_new(&db));
+        ok!(update("i11")
+            .with_scan_number(111)
+            .with_extension("ext")
+            .insert_new(&db));
+
+        let confs = ok!(db.all_configurations());
+        assert_eq!(confs.len(), 2);
+
+        for conf in confs.iter() {
+            match conf.name() {
+                "i22" => {
+                    assert_eq!(conf.name(), "i22");
+                    assert_eq!(conf.scan_number(), 122);
+                    assert_eq!(
+                        conf.visit().unwrap().to_string(),
+                        "/tmp/{instrument}/data/{year}/{visit}"
+                    );
+                    assert_eq!(
+                        conf.scan().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}"
+                    );
+                    assert_eq!(
+                        conf.detector().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}-{detector}"
+                    );
+                    let Some(ext) = &conf.tracker_file_extension else {
+                        panic!("Missing extension");
+                    };
+                    assert_eq!(ext, "ext");
+                }
+                "i11" => {
+                    assert_eq!(conf.name(), "i11");
+                    assert_eq!(conf.scan_number(), 111);
+                    assert_eq!(
+                        conf.visit().unwrap().to_string(),
+                        "/tmp/{instrument}/data/{year}/{visit}"
+                    );
+                    assert_eq!(
+                        conf.scan().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}"
+                    );
+                    assert_eq!(
+                        conf.detector().unwrap().to_string(),
+                        "{subdirectory}/{instrument}-{scan_number}-{detector}"
+                    );
+                    let Some(ext) = &conf.tracker_file_extension else {
+                        panic!("Missing extension");
+                    };
+                    assert_eq!(ext, "ext");
+                }
+                other => panic!("Unexpected beamline name: {other}"),
+            }
+        }
+    }
+
     type Update = BeamlineConfigurationUpdate;
 
     #[rstest]