Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add possibility to configure a subfolder inside an S3 bucket #2647

Merged
merged 10 commits into from
Aug 28, 2023
20 changes: 12 additions & 8 deletions rust/hyperlane-base/src/types/checkpoint_syncer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ pub enum CheckpointSyncerConf {
/// Bucket name
bucket: String,
/// Folder name inside bucket
folder: String
folder: String,
/// S3 Region
region: Region,
},
Expand All @@ -43,8 +43,8 @@ pub enum RawCheckpointSyncerConf {
S3 {
/// Bucket name
bucket: Option<String>,
// Folder name inside bucket - defaults to the root of the bucket (i.e. empty string)
folder: Option<String>
/// Folder name inside bucket - defaults to the root of the bucket (i.e. empty string)
folder: Option<String>,
/// S3 Region
region: Option<String>,
},
Expand Down Expand Up @@ -88,7 +88,7 @@ impl FromRawConf<'_, RawCheckpointSyncerConf> for CheckpointSyncerConf {
.ok_or_else(|| eyre!("Missing `bucket` for S3 checkpoint syncer"))
.into_config_result(|| cwp + "bucket")?,
folder: folder
.ok_or_else("")
.map_or(Ok::<String, Report>(String::from("")), Result::Ok)
.into_config_result(|| cwp + "folder")?,
region: region
.ok_or_else(|| eyre!("Missing `region` for S3 checkpoint syncer"))
Expand All @@ -113,13 +113,17 @@ impl FromStr for CheckpointSyncerConf {

match prefix {
"s3" => {
let [bucket, region]: [&str; 2] = suffix
let url_components = suffix
.split('/')
.collect::<Vec<_>>()
.try_into()
.map_err(|_| eyre!("Error parsing storage location; could not split bucket and region ({suffix})"))?;
.collect::<Vec<&str>>();
let [bucket, region, folder]: [&str; 3] = match url_components[..] {
[bucket, region] => Ok([bucket, region, ""]), // no folder means empty folder path
[bucket, region, folder] => Ok([bucket, region, folder]),
_ => Err(eyre!("Error parsing storage location; could not split bucket, region and folder ({suffix})"))
}?;
Ok(CheckpointSyncerConf::S3 {
bucket: bucket.into(),
folder: folder.into(),
region: region
.parse()
.context("Invalid region when parsing storage location")?,
Expand Down
2 changes: 1 addition & 1 deletion rust/hyperlane-base/src/types/s3_storage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,6 @@ impl CheckpointSyncer for S3Storage {
}

fn announcement_location(&self) -> String {
format!("s3://{}/{}", self.bucket, self.region.name())
format!("s3://{}/{}/{}", self.bucket, self.region.name(), self.folder)
gbouv marked this conversation as resolved.
Show resolved Hide resolved
}
}