feat: added put methods (#121)

* feat: added put methods

* fix: removed an unused variable

* fix: removed an unused module

crates/aws_clients/Cargo.toml

@@ -10,3 +10,4 @@ aws-config = { version = "1", features = ["behavior-version-latest"] }
 time_file_name = { path = "../time_file_name" }
 shared = { path = "../shared" }
 aws-sdk-dynamodb = "1.54.0"
+log = "0.4.22"

crates/aws_clients/src/dynamodb/entities/mod.rs

@@ -0,0 +1,31 @@
+//! Entities
+
+/// Collection
+/// <https://hitohata.github.io/ExogenesisEnsemble-Part3-Redemption/project/docs/technical-information/DynamoDB-Definition/#collection>
+pub mod collection {
+    use time_file_name::file_datetime::PathDateTime;
+
+    pub struct CollectionItem {
+        pub year: String,
+        pub unix_time: i64,
+        pub is_unzipped: bool,
+        pub vault: String,
+        /// This is a S3 bucket name
+        pub key_name: String,
+    }
+
+    impl CollectionItem {
+        /// create a new item
+        pub fn new_object(key_name: &str, vault: &str) -> Result<Self, String> {
+            let path_date_time = PathDateTime::parse(key_name)?;
+
+            Ok(CollectionItem {
+                year: path_date_time.year.to_string(),
+                unix_time: path_date_time.unix_time,
+                is_unzipped: false,
+                vault: vault.to_string(),
+                key_name: key_name.to_string(),
+            })
+        }
+    }
+}

crates/aws_clients/src/dynamodb/mod.rs

@@ -1,9 +1,33 @@
+pub mod entities;
 pub mod client {
+    use crate::dynamodb::entities::collection::CollectionItem;
+    use crate::environment_values::clients::dynamodb_client;
+    use crate::environment_values::lambda_environment_values::table_name;
+    use aws_sdk_dynamodb::types::AttributeValue;
     use shared::traits::GetFileListTrait;
+    use std::future::Future;
+    use std::time::{SystemTime, UNIX_EPOCH};
 
     pub struct DynamoDbClient {}
 
-    pub trait DynamoClientTrait: GetFileListTrait {}
+    pub trait DynamoClientTrait: GetFileListTrait {
+        /// put a new collection item
+        fn put_collection_item(
+            collection: &CollectionItem,
+        ) -> impl Future<Output = Result<bool, String>> + Send;
+        // put zipping time
+        /// time is mill sec
+        fn put_unzipping_item(
+            key_name: &str,
+            time: Option<u128>,
+        ) -> impl Future<Output = Result<bool, String>> + Send;
+        /// put unzipped item
+        /// time is mill sec
+        fn put_unzipped_item(
+            key_name: &str,
+            time: Option<u128>,
+        ) -> impl Future<Output = Result<bool, String>> + Send;
+    }
 
     impl GetFileListTrait for DynamoDbClient {
         async fn get_years() -> Result<Vec<String>, String> {
@@ -27,9 +51,78 @@ pub mod client {
         }
     }
 
-    impl DynamoClientTrait for DynamoDbClient {}
+    impl DynamoClientTrait for DynamoDbClient {
+        async fn put_collection_item(collection: &CollectionItem) -> Result<bool, String> {
+            let request = dynamodb_client()
+                .await
+                .put_item()
+                .table_name(table_name())
+                .item("PK", AttributeValue::S(collection.year.to_string()))
+                .item("SK", AttributeValue::N(collection.unix_time.to_string()))
+                .item("IsUnzipped", AttributeValue::Bool(collection.is_unzipped))
+                .item("Vault", AttributeValue::S(collection.vault.to_string()))
+                .item(
+                    "KeyName",
+                    AttributeValue::S(collection.key_name.to_string()),
+                );
+
+            if let Err(e) = request.send().await {
+                return Err(e.to_string());
+            }
+
+            Ok(true)
+        }
+
+        async fn put_unzipping_item(key_name: &str, time: Option<u128>) -> Result<bool, String> {
+            let now = get_now(time)?;
+
+            let request = dynamodb_client()
+                .await
+                .put_item()
+                .table_name(table_name())
+                .item("PK", AttributeValue::S("Unzipping".to_string()))
+                .item("SK", AttributeValue::N(now.to_string()))
+                .item("KeyName", AttributeValue::S(key_name.to_string()));
+
+            if let Err(e) = request.send().await {
+                return Err(e.to_string());
+            }
+
+            Ok(true)
+        }
+
+        async fn put_unzipped_item(key_name: &str, time: Option<u128>) -> Result<bool, String> {
+            let now = get_now(time)?;
+
+            let request = dynamodb_client()
+                .await
+                .put_item()
+                .table_name(table_name())
+                .item("PK", AttributeValue::S("Unzipped".to_string()))
+                .item("SK", AttributeValue::N(now.to_string()))
+                .item("KeyName", AttributeValue::S(key_name.to_string()));
+
+            if let Err(e) = request.send().await {
+                return Err(e.to_string());
+            }
+
+            Ok(true)
+        }
+    }
+
+    /// this is a helper function.
+    /// if there is argument, this function returns it.
+    /// If not, this function gets system time.
+    fn get_now(time: Option<u128>) -> Result<u128, String> {
+        match time {
+            Some(now) => Ok(now),
+            None => match SystemTime::now().duration_since(UNIX_EPOCH) {
+                Ok(now) => Ok(now.as_millis()),
+                Err(_) => Err("Failed to get current time".to_string()),
+            },
+        }
+    }
 }
 
 #[cfg(test)]
 mod test_util;
-

crates/aws_clients/src/dynamodb/test_util/mod.rs

@@ -1,4 +1,3 @@
-
 use crate::environment_values::clients::test_dynamo_client;
 use aws_sdk_dynamodb::types::{
     AttributeDefinition, KeySchemaElement, KeyType, ProvisionedThroughput, ScalarAttributeType,
@@ -96,12 +95,12 @@ mod test {
     use super::*;
     use crate::dynamodb::test_util::create_table;
     use tokio;
-    
+
     #[tokio::test]
     async fn test_table_existence() {
         // Act
         let result = table_existence("non-existing-table").await;
-        
+
         // Assert
         assert_eq!(result, false);
     }
@@ -111,10 +110,10 @@ mod test {
         // Arrange
         let table_name = "new-table";
         create_table(table_name).await;
-        
+
         // Act
         let result = table_existence(table_name).await;
-        
+
         // Assert
         assert!(result);
     }

crates/aws_clients/src/environment_values/mod.rs

@@ -11,7 +11,6 @@ pub mod lambda_environment_values {
     }
 
     /// DynamoDB table name
-    #[allow(dead_code)] // TODO: Delete
     pub fn table_name() -> &'static str {
         static TABLE_NAME: OnceLock<String> = OnceLock::new();
         TABLE_NAME.get_or_init(|| var("TABLE_NAME").unwrap())

docs/project/docs/technical-information/DynamoDB-Definition.md

@@ -13,13 +13,13 @@ sidebar_position: 2
 
 ### Manage Files
 
-| Key        | Detail     | Note                                                     |
-|:-----------|:-----------|:---------------------------------------------------------|
-| PK         | datetime   | The key is `{year}-{month}-{day}-{hour}-{min}-{sec}`[^1] |
-| SK         | Epoch time |                                                          |
-| IsUnzipped | boolean    | If the file is unzipped or not                           |
-| Vault      | String     | Glacier vault                                            |
-| KeyName    | String     | S3 prefix                                                |
+| Key        | Detail     | Note                           |
+|:-----------|:-----------|:-------------------------------|
+| PK         | datetime   | The key is `{year}`            |
+| SK         | Epoch time |                                |
+| IsUnzipped | boolean    | If the file is unzipped or not |
+| Vault      | String     | Glacier vault                  |
+| KeyName    | String     | S3 prefix                      |
 
 ### Date Lookup
 
@@ -45,22 +45,22 @@ If the `{year}-{month}` has days in the month of the year.
 
 This is for the unzipped files
 
-| Key         | Detail             | Note                                               |
-|:------------|:-------------------|:---------------------------------------------------|
-| PK          | Unzipped           | Fixed string "Unzipped"                            |
-| CreatedDate | Epoch time         | The datetime that the file is retrieved or created |
-| KeyName     | name of object key | The object key name                                |
+| Key     | Detail             | Note                                               |
+|:--------|:-------------------|:---------------------------------------------------|
+| PK      | Unzipped           | Fixed string "Unzipped"                            |
+| SK      | Epoch time         | The datetime that the file is retrieved or created |
+| KeyName | name of object key | The object key name                                |
 
 
 ### Manage Unzipping Files
 
 This is for the unzipping files
 
-| Key         | Detail             | Note                                            |
-|:------------|:-------------------|:------------------------------------------------|
-| PK          | Unzipped           | Fixed string "Unzipping"                        |
-| CreatedDate | Epoch time         | The datetime that the retrieval request is made |
-| KeyName     | name of object key | The object key name                             |
+| Key     | Detail             | Note                                            |
+|:--------|:-------------------|:------------------------------------------------|
+| PK      | Unzipped           | Fixed string "Unzipping"                        |
+| SK      | Epoch time         | The datetime that the retrieval request is made |
+| KeyName | name of object key | The object key name                             |
 
 
 ## Access Pattern