refactor: add support for extending file storage to other schemes and provide a runtime flag for the same

config/config.example.toml

@@ -509,14 +509,6 @@ client_secret = "paypal_secret_key" # Secret key for PayPal onboarding
 partner_id = "paypal_partner_id" # Partner ID for PayPal onboarding
 enabled = true # Switch to enable or disable PayPal onboarding
 
-[frm]
-enabled = true
-
-[paypal_onboarding]
-client_id = "paypal_client_id" # Client ID for PayPal onboarding
-client_secret = "paypal_secret_key" # Secret key for PayPal onboarding
-partner_id = "paypal_partner_id" # Partner ID for PayPal onboarding
-enabled = true # Switch to enable or disable PayPal onboarding
 
 [events]
 source = "logs"                    # The event sink to push events supports kafka or logs (stdout)
@@ -529,3 +521,11 @@ refund_analytics_topic = "topic"          # Kafka topic to be used for Refund ev
 api_logs_topic = "topic"                  # Kafka topic to be used for incoming api events
 connector_logs_topic = "topic"            # Kafka topic to be used for connector api events
 outgoing_webhook_logs_topic = "topic"     # Kafka topic to be used for outgoing webhook events
+
+# File storage configuration
+[file_storage]
+file_storage_backend = "aws_s3"            # File storage backend to be used
+
+[file_storage.aws_s3]
+region = "us-east-1"                      # The AWS region used by the AWS S3 for file storage
+bucket_name = "bucket1"                   # The AWS S3 bucket name for file storage

config/development.toml

@@ -542,3 +542,6 @@ client_id = ""
 client_secret = ""
 partner_id = ""
 enabled = true
+
+[file_storage]
+file_storage_backend = "file_system"

config/docker_compose.toml

@@ -398,3 +398,6 @@ enabled = true
 
 [events]
 source = "logs"
+
+[file_storage]
+file_storage_backend = "file_system"

crates/common_utils/src/errors.rs

@@ -142,3 +142,19 @@ where
         T::switch_from(self)
     }
 }
+
+/// Represents errors that can occur during file storage operations.
+#[derive(Debug, thiserror::Error, PartialEq)]
+pub enum FileStorageError {
+    /// Indicates that the file upload operation failed.
+    #[error("Failed to upload file")]
+    UploadFailed,
+
+    /// Indicates that the file retrieval operation failed.
+    #[error("Failed to retrieve file")]
+    RetrieveFailed,
+
+    /// Indicates that the file deletion operation failed.
+    #[error("Failed to delete file")]
+    DeleteFailed,
+}

crates/common_utils/src/fs_utils.rs

@@ -0,0 +1,115 @@
+//!
+//! Module for local file system storage operations
+//!
+
+use std::{
+    fs::{remove_file, File},
+    io::{Read, Write},
+    path::PathBuf,
+};
+
+use error_stack::{IntoReport, ResultExt};
+
+use crate::errors::CustomResult;
+
+/// Constructs the file path for a given file key within the file system.
+/// The file path is generated based on the workspace path and the provided file key.
+fn get_file_path(file_key: impl AsRef<str>) -> PathBuf {
+    let mut file_path = PathBuf::new();
+    #[cfg(feature = "logs")]
+    file_path.push(router_env::env::workspace_path());
+    #[cfg(not(feature = "logs"))]
+    file_path.push(std::env::current_dir().unwrap_or(".".into()));
+
+    file_path.push("files");
+    file_path.push(file_key.as_ref());
+    file_path
+}
+
+/// Represents a file system for storing and managing files locally.
+#[derive(Debug, Clone)]
+pub struct FileSystem;
+
+impl FileSystem {
+    /// Saves the provided file data to the file system under the specified file key.
+    pub fn save_file_to_fs(
+        &self,
+        file_key: impl AsRef<str>,
+        file_data: Vec<u8>,
+    ) -> CustomResult<(), FileSystemStorageError> {
+        let file_path = get_file_path(&file_key);
+
+        // Ignore the file name and create directories in the `file_path` if not exists
+        std::fs::create_dir_all(
+            file_path
+                .parent()
+                .ok_or(FileSystemStorageError::CreateDirFailed)?,
+        )
+        .into_report()
+        .change_context(FileSystemStorageError::CreateDirFailed)?;
+
+        let mut file = File::create(file_path)
+            .into_report()
+            .change_context(FileSystemStorageError::CreateFailure)?;
+        file.write_all(&file_data)
+            .into_report()
+            .change_context(FileSystemStorageError::WriteFailure)?;
+        Ok(())
+    }
+
+    /// Deletes the file associated with the specified file key from the file system.
+    pub fn delete_file_from_fs(
+        &self,
+        file_key: impl AsRef<str>,
+    ) -> CustomResult<(), FileSystemStorageError> {
+        let file_path = get_file_path(file_key);
+        remove_file(file_path)
+            .into_report()
+            .change_context(FileSystemStorageError::DeleteFailure)?;
+        Ok(())
+    }
+
+    /// Retrieves the file content associated with the specified file key from the file system.
+    pub fn retrieve_file_from_fs(
+        &self,
+        file_key: impl AsRef<str>,
+    ) -> CustomResult<Vec<u8>, FileSystemStorageError> {
+        let mut received_data: Vec<u8> = Vec::new();
+        let file_path = get_file_path(file_key);
+        let mut file = File::open(file_path)
+            .into_report()
+            .change_context(FileSystemStorageError::FileOpenFailure)?;
+        file.read_to_end(&mut received_data)
+            .into_report()
+            .change_context(FileSystemStorageError::ReadFailure)?;
+        Ok(received_data)
+    }
+}
+
+/// Represents an error that can occur during local file system storage operations.
+#[derive(Debug, thiserror::Error)]
+pub enum FileSystemStorageError {
+    /// Error indicating opening a file failed
+    #[error("Failed while opening the file")]
+    FileOpenFailure,
+
+    /// Error indicating file creation failed.
+    #[error("Failed to create file")]
+    CreateFailure,
+
+    /// Error indicating reading a file failed.
+    #[error("Failed while reading the file")]
+    ReadFailure,
+
+    /// Error indicating writing to a file failed.
+    #[error("Failed while writing into file")]
+    WriteFailure,
+
+    /// Error indicating file deletion failed.
+    #[error("Failed while deleting the file")]
+    DeleteFailure,
+
+    /// Error indicating directory creation failed
+    #[error("Failed while creating a directory")]
+    CreateDirFailed,
+}

crates/common_utils/src/lib.rs

@@ -10,6 +10,7 @@ pub mod errors;
 pub mod events;
 pub mod ext_traits;
 pub mod fp_utils;
+pub mod fs_utils;
 pub mod macros;
 pub mod pii;
 #[allow(missing_docs)] // Todo: add docs

crates/external_services/Cargo.toml

@@ -10,13 +10,15 @@ license.workspace = true
 [features]
 kms = ["dep:aws-config", "dep:aws-sdk-kms"]
 email = ["dep:aws-config"]
+aws_s3 = ["dep:aws-config", "dep:aws-sdk-s3"]
 
 [dependencies]
 async-trait = "0.1.68"
 aws-config = { version = "0.55.3", optional = true }
 aws-sdk-kms = { version = "0.28.0", optional = true }
 aws-sdk-sesv2 = "0.28.0"
 aws-sdk-sts = "0.28.0"
+aws-sdk-s3 = { version = "0.28.0", optional = true }
 aws-smithy-client = "0.55.3"
 base64 = "0.21.2"
 dyn-clone = "1.0.11"