This is an automated email from the ASF dual-hosted git repository.
koushiro pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 6eb8ec10a refactor(services/ipmfs): split ipmfs into separate crate
(#7042)
6eb8ec10a is described below
commit 6eb8ec10a06ca0c3beef89d80212cffe176d804a
Author: Jintao Zhang <[email protected]>
AuthorDate: Fri Dec 19 19:27:50 2025 +0800
refactor(services/ipmfs): split ipmfs into separate crate (#7042)
* refactor(services/ipmfs): split ipmfs into separate crate
This PR splits the ipmfs service into its own crate `opendal-service-ipmfs`.
- Create new crate at `core/services/ipmfs`
- Update feature flag to use the new crate
- Remove ipmfs from `opendal-core`
- Re-export from facade crate
Closes #6903
* fix: simplify import as suggested by reviewer
* fix: remove moved services from core module declarations
- Remove http, huggingface, koofr, lakefs from core/core/src/services/mod.rs
- Remove their feature definitions from core/core/Cargo.toml
- These services are now separate crates in core/services/
* chore: update Cargo.lock to fix async-graphql dependency issue
* fix: update doc example to use opendal_service_ipmfs
---
core/Cargo.lock | 15 ++++++++
core/Cargo.toml | 3 +-
core/core/Cargo.toml | 1 -
core/core/src/services/mod.rs | 5 ---
core/services/ipmfs/Cargo.toml | 44 ++++++++++++++++++++++
.../ipmfs => services/ipmfs/src}/backend.rs | 4 +-
.../ipmfs => services/ipmfs/src}/builder.rs | 13 +++----
.../ipmfs => services/ipmfs/src}/config.rs | 8 ++--
.../services/ipmfs => services/ipmfs/src}/core.rs | 4 +-
.../ipmfs => services/ipmfs/src}/deleter.rs | 4 +-
.../services/ipmfs => services/ipmfs/src}/docs.md | 0
.../services/ipmfs => services/ipmfs/src}/error.rs | 4 +-
.../ipmfs/mod.rs => services/ipmfs/src/lib.rs} | 2 +-
.../ipmfs => services/ipmfs/src}/lister.rs | 10 ++---
.../ipmfs => services/ipmfs/src}/writer.rs | 4 +-
core/src/lib.rs | 2 +
16 files changed, 88 insertions(+), 35 deletions(-)
diff --git a/core/Cargo.lock b/core/Cargo.lock
index 7ecfd8997..d937a7a13 100644
--- a/core/Cargo.lock
+++ b/core/Cargo.lock
@@ -5580,6 +5580,7 @@ dependencies = [
"opendal-service-http",
"opendal-service-huggingface",
"opendal-service-ipfs",
+ "opendal-service-ipmfs",
"opendal-service-koofr",
"opendal-service-lakefs",
"opendal-service-memcached",
@@ -6317,6 +6318,20 @@ dependencies = [
"tokio",
]
+[[package]]
+name = "opendal-service-ipmfs"
+version = "0.55.0"
+dependencies = [
+ "bytes",
+ "ctor",
+ "http 1.4.0",
+ "log",
+ "opendal-core",
+ "serde",
+ "serde_json",
+ "tokio",
+]
+
[[package]]
name = "opendal-service-koofr"
version = "0.55.0"
diff --git a/core/Cargo.toml b/core/Cargo.toml
index 9c039dcda..132d11e3b 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -139,7 +139,7 @@ services-hdfs-native = ["dep:opendal-service-hdfs-native"]
services-http = ["dep:opendal-service-http"]
services-huggingface = ["dep:opendal-service-huggingface"]
services-ipfs = ["dep:opendal-service-ipfs"]
-services-ipmfs = ["opendal-core/services-ipmfs"]
+services-ipmfs = ["dep:opendal-service-ipmfs"]
services-koofr = ["dep:opendal-service-koofr"]
services-lakefs = ["dep:opendal-service-lakefs"]
services-memcached = ["dep:opendal-service-memcached"]
@@ -242,6 +242,7 @@ opendal-service-hdfs-native = { path =
"services/hdfs-native", version = "0.55.0
opendal-service-http = { path = "services/http", version = "0.55.0", optional
= true, default-features = false }
opendal-service-huggingface = { path = "services/huggingface", version =
"0.55.0", optional = true, default-features = false }
opendal-service-ipfs = { path = "services/ipfs", version = "0.55.0", optional
= true, default-features = false }
+opendal-service-ipmfs = { path = "services/ipmfs", version = "0.55.0",
optional = true, default-features = false }
opendal-service-koofr = { path = "services/koofr", version = "0.55.0",
optional = true, default-features = false }
opendal-service-lakefs = { path = "services/lakefs", version = "0.55.0",
optional = true, default-features = false }
opendal-service-memcached = { path = "services/memcached", version = "0.55.0",
optional = true, default-features = false }
diff --git a/core/core/Cargo.toml b/core/core/Cargo.toml
index 55ba6d924..a2ff4f0d4 100644
--- a/core/core/Cargo.toml
+++ b/core/core/Cargo.toml
@@ -59,7 +59,6 @@ layers-dtrace = ["dep:probe"]
services-gridfs = ["dep:mongodb", "dep:mongodb-internal-macros"]
services-hdfs = ["dep:hdrs"]
-services-ipmfs = []
services-memory = []
services-mongodb = ["dep:mongodb", "dep:mongodb-internal-macros"]
services-monoiofs = ["dep:monoio", "dep:flume"]
diff --git a/core/core/src/services/mod.rs b/core/core/src/services/mod.rs
index 7b96c8677..0f3bc406b 100644
--- a/core/core/src/services/mod.rs
+++ b/core/core/src/services/mod.rs
@@ -29,11 +29,6 @@ mod hdfs;
#[cfg(feature = "services-hdfs")]
pub use self::hdfs::*;
-#[cfg(feature = "services-ipmfs")]
-mod ipmfs;
-#[cfg(feature = "services-ipmfs")]
-pub use ipmfs::*;
-
#[cfg(feature = "services-memory")]
mod memory;
#[cfg(feature = "services-memory")]
diff --git a/core/services/ipmfs/Cargo.toml b/core/services/ipmfs/Cargo.toml
new file mode 100644
index 000000000..d07c81c8c
--- /dev/null
+++ b/core/services/ipmfs/Cargo.toml
@@ -0,0 +1,44 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[package]
+description = "Apache OpenDAL ipmfs service implementation"
+name = "opendal-service-ipmfs"
+
+authors = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+[package.metadata.docs.rs]
+all-features = true
+
+[dependencies]
+opendal-core = { path = "../../core", version = "0.55.0", default-features =
false }
+
+bytes = { workspace = true }
+ctor = { workspace = true }
+http = { workspace = true }
+log = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
+serde_json = { workspace = true }
+
+[dev-dependencies]
+tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
diff --git a/core/core/src/services/ipmfs/backend.rs
b/core/services/ipmfs/src/backend.rs
similarity index 98%
rename from core/core/src/services/ipmfs/backend.rs
rename to core/services/ipmfs/src/backend.rs
index c10550355..0d39d665a 100644
--- a/core/core/src/services/ipmfs/backend.rs
+++ b/core/services/ipmfs/src/backend.rs
@@ -27,8 +27,8 @@ use super::deleter::IpmfsDeleter;
use super::error::parse_error;
use super::lister::IpmfsLister;
use super::writer::IpmfsWriter;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
/// IPFS Mutable File System (IPMFS) backend.
#[doc = include_str!("docs.md")]
diff --git a/core/core/src/services/ipmfs/builder.rs
b/core/services/ipmfs/src/builder.rs
similarity index 94%
rename from core/core/src/services/ipmfs/builder.rs
rename to core/services/ipmfs/src/builder.rs
index eef4312ff..d73c2e6d1 100644
--- a/core/core/src/services/ipmfs/builder.rs
+++ b/core/services/ipmfs/src/builder.rs
@@ -24,8 +24,8 @@ use super::IPMFS_SCHEME;
use super::backend::IpmfsBackend;
use super::config::IpmfsConfig;
use super::core::IpmfsCore;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
/// IPFS file system support based on [IPFS
MFS](https://docs.ipfs.tech/concepts/file-systems/) API.
///
@@ -50,20 +50,17 @@ use crate::*;
///
/// ## Via Builder
///
-/// ```no_run
-/// use anyhow::Result;
-/// use opendal_core::services::Ipmfs;
+/// ```rust,no_run
/// use opendal_core::Operator;
+/// use opendal_core::Result;
+/// use opendal_service_ipmfs::Ipmfs;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
-/// // create backend builder
/// let mut builder = Ipmfs::default()
-/// // set the storage bucket for OpenDAL
/// .endpoint("http://127.0.0.1:5001";);
///
/// let op: Operator = Operator::new(builder)?.finish();
-///
/// Ok(())
/// }
/// ```
diff --git a/core/core/src/services/ipmfs/config.rs
b/core/services/ipmfs/src/config.rs
similarity index 91%
rename from core/core/src/services/ipmfs/config.rs
rename to core/services/ipmfs/src/config.rs
index c598ffff3..3fcf7a55a 100644
--- a/core/core/src/services/ipmfs/config.rs
+++ b/core/services/ipmfs/src/config.rs
@@ -31,10 +31,10 @@ pub struct IpmfsConfig {
pub endpoint: Option<String>,
}
-impl crate::Configurator for IpmfsConfig {
+impl opendal_core::Configurator for IpmfsConfig {
type Builder = IpmfsBuilder;
- fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
+ fn from_uri(uri: &opendal_core::OperatorUri) -> opendal_core::Result<Self>
{
let mut map = uri.options().clone();
if let Some(authority) = uri.authority() {
map.insert("endpoint".to_string(), format!("http://{authority}";));
@@ -57,8 +57,8 @@ impl crate::Configurator for IpmfsConfig {
#[cfg(test)]
mod tests {
use super::*;
- use crate::Configurator;
- use crate::types::OperatorUri;
+ use opendal_core::Configurator;
+ use opendal_core::OperatorUri;
#[test]
fn from_uri_sets_endpoint_and_root() {
diff --git a/core/core/src/services/ipmfs/core.rs
b/core/services/ipmfs/src/core.rs
similarity index 98%
rename from core/core/src/services/ipmfs/core.rs
rename to core/services/ipmfs/src/core.rs
index e93ade99a..c39118c56 100644
--- a/core/core/src/services/ipmfs/core.rs
+++ b/core/services/ipmfs/src/core.rs
@@ -22,8 +22,8 @@ use std::sync::Arc;
use http::Request;
use http::Response;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct IpmfsCore {
pub info: Arc<AccessorInfo>,
diff --git a/core/core/src/services/ipmfs/deleter.rs
b/core/services/ipmfs/src/deleter.rs
similarity index 96%
rename from core/core/src/services/ipmfs/deleter.rs
rename to core/services/ipmfs/src/deleter.rs
index dc1f45c27..a8c0bda88 100644
--- a/core/core/src/services/ipmfs/deleter.rs
+++ b/core/services/ipmfs/src/deleter.rs
@@ -21,8 +21,8 @@ use http::StatusCode;
use super::core::IpmfsCore;
use super::error::parse_error;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct IpmfsDeleter {
core: Arc<IpmfsCore>,
diff --git a/core/core/src/services/ipmfs/docs.md
b/core/services/ipmfs/src/docs.md
similarity index 100%
rename from core/core/src/services/ipmfs/docs.md
rename to core/services/ipmfs/src/docs.md
diff --git a/core/core/src/services/ipmfs/error.rs
b/core/services/ipmfs/src/error.rs
similarity index 98%
rename from core/core/src/services/ipmfs/error.rs
rename to core/services/ipmfs/src/error.rs
index 395b4e710..426fb964f 100644
--- a/core/core/src/services/ipmfs/error.rs
+++ b/core/services/ipmfs/src/error.rs
@@ -20,8 +20,8 @@ use http::StatusCode;
use serde::Deserialize;
use serde_json::de;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
#[derive(Deserialize, Default, Debug)]
#[serde(default)]
diff --git a/core/core/src/services/ipmfs/mod.rs
b/core/services/ipmfs/src/lib.rs
similarity index 96%
rename from core/core/src/services/ipmfs/mod.rs
rename to core/services/ipmfs/src/lib.rs
index 58f92b507..62739595c 100644
--- a/core/core/src/services/ipmfs/mod.rs
+++ b/core/services/ipmfs/src/lib.rs
@@ -18,7 +18,7 @@
/// Default scheme for ipmfs service.
pub const IPMFS_SCHEME: &str = "ipmfs";
-use crate::types::DEFAULT_OPERATOR_REGISTRY;
+use opendal_core::DEFAULT_OPERATOR_REGISTRY;
mod backend;
mod builder;
diff --git a/core/core/src/services/ipmfs/lister.rs
b/core/services/ipmfs/src/lister.rs
similarity index 96%
rename from core/core/src/services/ipmfs/lister.rs
rename to core/services/ipmfs/src/lister.rs
index cc09f1c85..87d615c9f 100644
--- a/core/core/src/services/ipmfs/lister.rs
+++ b/core/services/ipmfs/src/lister.rs
@@ -23,11 +23,11 @@ use serde::Deserialize;
use super::core::IpmfsCore;
use super::error::parse_error;
-use crate::EntryMode;
-use crate::ErrorKind;
-use crate::Metadata;
-use crate::Result;
-use crate::raw::*;
+use opendal_core::EntryMode;
+use opendal_core::ErrorKind;
+use opendal_core::Metadata;
+use opendal_core::Result;
+use opendal_core::raw::*;
pub struct IpmfsLister {
core: Arc<IpmfsCore>,
diff --git a/core/core/src/services/ipmfs/writer.rs
b/core/services/ipmfs/src/writer.rs
similarity index 96%
rename from core/core/src/services/ipmfs/writer.rs
rename to core/services/ipmfs/src/writer.rs
index 9ca8b10a3..dd679b375 100644
--- a/core/core/src/services/ipmfs/writer.rs
+++ b/core/services/ipmfs/src/writer.rs
@@ -21,8 +21,8 @@ use http::StatusCode;
use super::core::IpmfsCore;
use super::error::parse_error;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct IpmfsWriter {
core: Arc<IpmfsCore>,
diff --git a/core/src/lib.rs b/core/src/lib.rs
index 43c121799..73e74a2af 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -82,6 +82,8 @@ pub mod services {
pub use opendal_service_huggingface::*;
#[cfg(feature = "services-ipfs")]
pub use opendal_service_ipfs::*;
+ #[cfg(feature = "services-ipmfs")]
+ pub use opendal_service_ipmfs::*;
#[cfg(feature = "services-koofr")]
pub use opendal_service_koofr::*;
#[cfg(feature = "services-lakefs")]
