refactor: Namespace VFS structs with Node

Author: MaxFangX

common/src/api/def.rs

@@ -11,8 +11,8 @@
 //! Each endpoint should be documented with:
 //! - 1) HTTP method e.g. `GET`
 //! - 2) Endpoint e.g. `/v1/file`
-//! - 3) Data used to make the request e.g. `FileId`
-//! - 4) The return type e.g. `Option<File>`
+//! - 3) Data used to make the request e.g. `NodeFileId`
+//! - 4) The return type e.g. `Option<NodeFile>`
 //!
 //! The methods below should resemble the data actually sent across the wire.
 
@@ -27,7 +27,7 @@ use crate::api::provision::{
     SealedSeedId,
 };
 use crate::api::runner::UserPorts;
-use crate::api::vfs::{Directory, File, FileId};
+use crate::api::vfs::{NodeDirectory, NodeFile, NodeFileId};
 use crate::api::UserPk;
 use crate::enclave::Measurement;
 
@@ -63,31 +63,37 @@ pub trait NodeBackendApi {
         data: NodeInstanceSeed,
     ) -> Result<NodeInstanceSeed, BackendApiError>;
 
-    /// GET /v1/file [`File`] -> [`Option<File>`]
+    /// GET /v1/file [`NodeFileId`] -> [`Option<NodeFile>`]
     async fn get_file(
         &self,
-        file_id: &FileId,
-    ) -> Result<Option<File>, BackendApiError>;
+        file_id: &NodeFileId,
+    ) -> Result<Option<NodeFile>, BackendApiError>;
 
-    /// POST /v1/file [`File`] -> [`File`]
-    async fn create_file(&self, file: &File) -> Result<File, BackendApiError>;
+    /// POST /v1/file [`NodeFile`] -> [`NodeFile`]
+    async fn create_file(
+        &self,
+        file: &NodeFile,
+    ) -> Result<NodeFile, BackendApiError>;
 
-    /// PUT /v1/file [`File`] -> [`File`]
-    async fn upsert_file(&self, file: &File) -> Result<File, BackendApiError>;
+    /// PUT /v1/file [`NodeFile`] -> [`NodeFile`]
+    async fn upsert_file(
+        &self,
+        file: &NodeFile,
+    ) -> Result<NodeFile, BackendApiError>;
 
-    /// DELETE /v1/file [`FileId`] -> "OK"
+    /// DELETE /v1/file [`NodeFileId`] -> "OK"
     ///
     /// Returns "OK" only if exactly one row was deleted.
     async fn delete_file(
         &self,
-        file_id: &FileId,
+        file_id: &NodeFileId,
     ) -> Result<String, BackendApiError>;
 
-    /// GET /v1/directory [`Directory`] -> [`Vec<File>`]
+    /// GET /v1/directory [`NodeDirectory`] -> [`Vec<NodeFile>`]
     async fn get_directory(
         &self,
-        dir: &Directory,
-    ) -> Result<Vec<File>, BackendApiError>;
+        dir: &NodeDirectory,
+    ) -> Result<Vec<NodeFile>, BackendApiError>;
 }
 
 /// Defines the api that the runner exposes to the node.

common/src/api/vfs.rs

@@ -5,38 +5,38 @@ use crate::enclave::Measurement;
 
 /// Uniquely identifies a directory in the node's virtual file system.
 #[derive(Clone, Hash, Eq, PartialEq, Deserialize, Serialize)]
-pub struct Directory {
+pub struct NodeDirectory {
     pub node_pk: PublicKey,
     pub measurement: Measurement,
     pub dirname: String,
 }
 
 /// Uniquely identifies a file in the node's virtual file system.
 #[derive(Clone, Deserialize, Serialize)]
-pub struct FileId {
+pub struct NodeFileId {
     // Flattened because serde_qs doesn't play well with nested structs
     #[serde(flatten)]
-    pub dir: Directory,
+    pub dir: NodeDirectory,
     pub filename: String,
 }
 
 #[derive(Clone, Serialize, Deserialize)]
-pub struct File {
+pub struct NodeFile {
     // Flattened because serde_qs doesn't play well with nested structs
     #[serde(flatten)]
-    pub id: FileId,
+    pub id: NodeFileId,
     pub data: Vec<u8>,
 }
 
-impl FileId {
+impl NodeFileId {
     pub fn new(
         node_pk: PublicKey,
         measurement: Measurement,
         dirname: String,
         filename: String,
     ) -> Self {
         Self {
-            dir: Directory {
+            dir: NodeDirectory {
                 node_pk,
                 measurement,
                 dirname,
@@ -46,7 +46,7 @@ impl FileId {
     }
 }
 
-impl File {
+impl NodeFile {
     pub fn new(
         node_pk: PublicKey,
         measurement: Measurement,
@@ -55,8 +55,8 @@ impl File {
         data: Vec<u8>,
     ) -> Self {
         Self {
-            id: FileId {
-                dir: Directory {
+            id: NodeFileId {
+                dir: NodeDirectory {
                     node_pk,
                     measurement,
                     dirname,

node/src/api/client.rs

@@ -11,7 +11,7 @@ use common::api::provision::{
 use common::api::qs::{GetByUserPk, GetByUserPkAndMeasurement};
 use common::api::rest::{RestClient, DELETE, GET, POST, PUT};
 use common::api::runner::UserPorts;
-use common::api::vfs::{Directory, File, FileId};
+use common::api::vfs::{NodeDirectory, NodeFile, NodeFileId};
 use common::api::UserPk;
 use common::enclave::Measurement;
 
@@ -60,9 +60,9 @@ impl LexeApiClient {
 impl ApiClient for LexeApiClient {
     async fn create_file_with_retries(
         &self,
-        data: &File,
+        data: &NodeFile,
         retries: usize,
-    ) -> Result<File, BackendApiError> {
+    ) -> Result<NodeFile, BackendApiError> {
         let url = self.build_url(Backend, V1, "/file");
         self.rest
             .request_with_retries(POST, url, &data, retries, None)
@@ -71,9 +71,9 @@ impl ApiClient for LexeApiClient {
 
     async fn upsert_file_with_retries(
         &self,
-        data: &File,
+        data: &NodeFile,
         retries: usize,
-    ) -> Result<File, BackendApiError> {
+    ) -> Result<NodeFile, BackendApiError> {
         let url = self.build_url(Backend, V1, "/file");
         self.rest
             .request_with_retries(PUT, url, &data, retries, None)
@@ -124,18 +124,24 @@ impl NodeBackendApi for LexeApiClient {
 
     async fn get_file(
         &self,
-        data: &FileId,
-    ) -> Result<Option<File>, BackendApiError> {
+        data: &NodeFileId,
+    ) -> Result<Option<NodeFile>, BackendApiError> {
         let url = self.build_url(Backend, V1, "/file");
         self.rest.request(GET, url, &data).await
     }
 
-    async fn create_file(&self, data: &File) -> Result<File, BackendApiError> {
+    async fn create_file(
+        &self,
+        data: &NodeFile,
+    ) -> Result<NodeFile, BackendApiError> {
         let url = self.build_url(Backend, V1, "/file");
         self.rest.request(POST, url, &data).await
     }
 
-    async fn upsert_file(&self, data: &File) -> Result<File, BackendApiError> {
+    async fn upsert_file(
+        &self,
+        data: &NodeFile,
+    ) -> Result<NodeFile, BackendApiError> {
         let url = self.build_url(Backend, V1, "/file");
         self.rest.request(PUT, url, &data).await
     }
@@ -145,16 +151,16 @@ impl NodeBackendApi for LexeApiClient {
     #[allow(dead_code)]
     async fn delete_file(
         &self,
-        data: &FileId,
+        data: &NodeFileId,
     ) -> Result<String, BackendApiError> {
         let url = self.build_url(Backend, V1, "/file");
         self.rest.request(DELETE, url, &data).await
     }
 
     async fn get_directory(
         &self,
-        data: &Directory,
-    ) -> Result<Vec<File>, BackendApiError> {
+        data: &NodeDirectory,
+    ) -> Result<Vec<NodeFile>, BackendApiError> {
         let url = self.build_url(Backend, V1, "/directory");
         self.rest.request(GET, url, &data).await
     }