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

Add no_hardlinks option to LocalConfig and fix error handling #642

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
name: CI

on:
push:
on: [push, pull_request]

jobs:
CI:
Expand Down
84 changes: 82 additions & 2 deletions object_store_factory/src/local.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,39 @@ use std::sync::Arc;
#[derive(Deserialize, Debug, PartialEq, Eq, Clone)]
pub struct LocalConfig {
pub data_dir: String,
#[serde(default = "default_false")]
pub disable_hardlinks: bool,
}

fn default_false() -> bool {
false
}

impl LocalConfig {
pub fn from_hashmap(
map: &HashMap<String, String>,
) -> Result<Self, object_store::Error> {
Ok(Self {
data_dir: map.get("data_dir").unwrap().clone(),
data_dir: map
.get("data_dir")
.ok_or_else(|| object_store::Error::Generic {
store: "local",
source: "Missing data_dir".into(),
})?
.clone(),
disable_hardlinks: map
.get("disable_hardlinks")
.map(|s| s == "true")
.unwrap_or(false),
})
}

pub fn to_hashmap(&self) -> HashMap<String, String> {
let mut map = HashMap::new();
map.insert("data_dir".to_string(), self.data_dir.clone());
map.insert(
"disable_hardlinks".to_string(),
self.disable_hardlinks.to_string());
map
}

Expand All @@ -44,6 +63,31 @@ mod tests {
let config = LocalConfig::from_hashmap(&map)
.expect("Failed to create config from hashmap");
assert_eq!(config.data_dir, "/tmp/data".to_string());
assert!(!config.disable_hardlinks); // Default value
}

#[test]
fn test_config_from_hashmap_with_disable_hardlinks() {
let mut map = HashMap::new();
map.insert("data_dir".to_string(), "/tmp/data".to_string());
map.insert("disable_hardlinks".to_string(), "true".to_string());

let config = LocalConfig::from_hashmap(&map)
.expect("Failed to create config from hashmap");
assert_eq!(config.data_dir, "/tmp/data".to_string());
assert!(config.disable_hardlinks);
}

#[test]
fn test_config_from_hashmap_with_disable_hardlinks_false() {
let mut map = HashMap::new();
map.insert("data_dir".to_string(), "/tmp/data".to_string());
map.insert("disable_hardlinks".to_string(), "false".to_string());

let config = LocalConfig::from_hashmap(&map)
.expect("Failed to create config from hashmap");
assert_eq!(config.data_dir, "/tmp/data".to_string());
assert!(!config.disable_hardlinks);
}

#[test]
Expand All @@ -64,6 +108,7 @@ mod tests {

let result = LocalConfig {
data_dir: data_dir.to_string(),
disable_hardlinks: false,
}
.build_local_storage();
assert!(result.is_ok(), "Expected Ok, got Err: {:?}", result);
Expand All @@ -73,6 +118,7 @@ mod tests {
fn test_build_local_storage_with_invalid_path() {
let result = LocalConfig {
data_dir: "".to_string(),
disable_hardlinks: false,
}
.build_local_storage();
assert!(result.is_err(), "Expected Err due to invalid path, got Ok");
Expand All @@ -82,10 +128,44 @@ mod tests {
fn test_to_hashmap() {
let local_config = LocalConfig {
data_dir: "path/to/data".to_string(),
disable_hardlinks: true,
};

let hashmap = local_config.to_hashmap();

assert_eq!(hashmap.get("data_dir"), Some(&"path/to/data".to_string()));
assert_eq!(hashmap.get("disable_hardlinks"), Some(&"true".to_string()));
}
}

#[test]
fn test_default_false() {
assert!(!default_false());
}

#[test]
fn test_deserialize_with_default() {
let json = r#"
{
"data_dir": "/tmp/data"
}
"#;

let config: LocalConfig = serde_json::from_str(json).unwrap();
assert_eq!(config.data_dir, "/tmp/data");
assert!(!config.disable_hardlinks);
}

#[test]
fn test_deserialize_with_disable_hardlinks() {
let json = r#"
{
"data_dir": "/tmp/data",
"disable_hardlinks": true
}
"#;

let config: LocalConfig = serde_json::from_str(json).unwrap();
assert_eq!(config.data_dir, "/tmp/data");
assert!(config.disable_hardlinks);
}
}
2 changes: 2 additions & 0 deletions src/config/schema.rs
Original file line number Diff line number Diff line change
Expand Up @@ -637,6 +637,7 @@ cache_control = "private, max-age=86400"
SeafowlConfig {
object_store: Some(ObjectStoreConfig::Local(LocalConfig {
data_dir: "./seafowl-data".to_string(),
disable_hardlinks: false,
})),
catalog: Some(Catalog::Postgres(Postgres {
dsn: "postgresql://user:pass@localhost:5432/somedb".to_string(),
Expand Down Expand Up @@ -732,6 +733,7 @@ cache_control = "private, max-age=86400"
SeafowlConfig {
object_store: Some(ObjectStoreConfig::Local(LocalConfig {
data_dir: "some_other_path".to_string(),
disable_hardlinks: false,
})),
catalog: Some(Catalog::Sqlite(Sqlite {
dsn: "sqlite://file.sqlite".to_string(),
Expand Down
1 change: 1 addition & 0 deletions src/context/delta.rs
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,7 @@ mod tests {
Arc::new(LocalFileSystem::new_with_prefix(tmp_dir.path()).unwrap()),
ObjectStoreConfig::Local(LocalConfig {
data_dir: tmp_dir.path().to_string_lossy().to_string(),
disable_hardlinks: false,
}),
),
Some(tmp_dir),
Expand Down
5 changes: 4 additions & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ use seafowl::{

use tokio::time::{interval, Duration};
use tracing::level_filters::LevelFilter;
use tracing::{error, info, subscriber, warn};
use tracing::{debug, error, info, subscriber, warn};
use tracing_log::LogTracer;
use tracing_subscriber::filter::EnvFilter;

Expand Down Expand Up @@ -157,6 +157,9 @@ async fn main() {
config
};

debug!("Input configuration: {:?}", args);
debug!("Starting configuration: {:?}", config);

if !args.cli
&& let Some(ref metrics) = config.misc.metrics
{
Expand Down
33 changes: 32 additions & 1 deletion src/object_store/wrapped.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ use url::Url;

use object_store_factory::aws::S3Config;
use object_store_factory::google::GCSConfig;
use object_store_factory::local::LocalConfig;
use object_store_factory::ObjectStoreConfig;

// Wrapper around the object_store crate that holds on to the original config
Expand Down Expand Up @@ -151,6 +152,22 @@ impl ObjectStore for InternalObjectStore {
payload: PutPayload,
opts: PutOptions,
) -> Result<PutResult> {
if let ObjectStoreConfig::Local(LocalConfig {
disable_hardlinks: true,
..
}) = self.config
{
return self
.inner
.put_opts(
location,
payload,
PutOptions{
mode: object_store::PutMode::Overwrite,
..opts
},
).await;
};
self.inner.put_opts(location, payload, opts).await
}

Expand Down Expand Up @@ -239,6 +256,13 @@ impl ObjectStore for InternalObjectStore {
///
/// Will return an error if the destination already has an object.
async fn copy_if_not_exists(&self, from: &Path, to: &Path) -> Result<()> {
if let ObjectStoreConfig::Local(LocalConfig {
disable_hardlinks: true,
..
}) = self.config
{
return self.inner.copy(from, to).await;
}
self.inner.copy_if_not_exists(from, to).await
}

Expand All @@ -254,6 +278,13 @@ impl ObjectStore for InternalObjectStore {
// this with a lock too, so look into using that down the line instead.
return self.inner.rename(from, to).await;
}
if let ObjectStoreConfig::Local(LocalConfig {
disable_hardlinks: true,
..
}) = self.config
{
return self.inner.rename(from, to).await;
}
self.inner.rename_if_not_exists(from, to).await
}
}
Expand All @@ -264,7 +295,7 @@ mod tests {
use crate::object_store::wrapped::InternalObjectStore;
use datafusion::common::Result;
use rstest::rstest;

use object_store_factory::aws::S3Config;
use object_store_factory::ObjectStoreConfig;

Expand Down
Loading