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 5abf36a53 refactor: split gridfs service out as new crate (#7037)
5abf36a53 is described below
commit 5abf36a535b36d6a118fcf72c8516183cdce3676
Author: Mozammil Ali <[email protected]>
AuthorDate: Sat Dec 20 20:50:50 2025 +0530
refactor: split gridfs service out as new crate (#7037)
* Service: gridfs #6898
* Fix formatting
* chore: format toml with taplo
* revert some changes
---------
Co-authored-by: koushiro <[email protected]>
---
core/Cargo.lock | 15 ++++++++
core/Cargo.toml | 6 ++--
core/core/Cargo.toml | 5 ---
core/core/src/services/mod.rs | 5 ---
core/services/gridfs/Cargo.toml | 42 ++++++++++++++++++++++
.../gridfs => services/gridfs/src}/backend.rs | 4 +--
.../gridfs => services/gridfs/src}/config.rs | 15 ++++----
.../gridfs => services/gridfs/src}/core.rs | 5 ++-
.../gridfs => services/gridfs/src}/deleter.rs | 6 ++--
.../gridfs => services/gridfs/src}/docs.md | 4 +--
.../gridfs/mod.rs => services/gridfs/src/lib.rs} | 11 +++---
.../gridfs => services/gridfs/src}/writer.rs | 5 +--
core/src/lib.rs | 2 ++
13 files changed, 89 insertions(+), 36 deletions(-)
diff --git a/core/Cargo.lock b/core/Cargo.lock
index 4448ffdb4..664fec5e3 100644
--- a/core/Cargo.lock
+++ b/core/Cargo.lock
@@ -5577,6 +5577,7 @@ dependencies = [
"opendal-service-gdrive",
"opendal-service-ghac",
"opendal-service-github",
+ "opendal-service-gridfs",
"opendal-service-hdfs",
"opendal-service-hdfs-native",
"opendal-service-http",
@@ -5607,6 +5608,7 @@ dependencies = [
"opendal-service-swift",
"opendal-service-tikv",
"opendal-service-upyun",
+ "opendal-service-vercel-artifacts",
"opendal-service-vercel-blob",
"opendal-service-webdav",
"opendal-service-webhdfs",
@@ -6274,6 +6276,19 @@ dependencies = [
"tokio",
]
+[[package]]
+name = "opendal-service-gridfs"
+version = "0.55.0"
+dependencies = [
+ "ctor",
+ "futures",
+ "mea",
+ "mongodb",
+ "opendal-core",
+ "serde",
+ "tokio",
+]
+
[[package]]
name = "opendal-service-hdfs"
version = "0.55.0"
diff --git a/core/Cargo.toml b/core/Cargo.toml
index d153180a1..8ca76024b 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -135,7 +135,7 @@ services-gcs = ["dep:opendal-service-gcs"]
services-gdrive = ["dep:opendal-service-gdrive"]
services-ghac = ["dep:opendal-service-ghac"]
services-github = ["dep:opendal-service-github"]
-services-gridfs = ["opendal-core/services-gridfs"]
+services-gridfs = ["dep:opendal-service-gridfs"]
services-hdfs = ["dep:opendal-service-hdfs"]
services-hdfs-native = ["dep:opendal-service-hdfs-native"]
services-http = ["dep:opendal-service-http"]
@@ -171,7 +171,7 @@ services-surrealdb = ["dep:opendal-service-surrealdb"]
services-swift = ["dep:opendal-service-swift"]
services-tikv = ["dep:opendal-service-tikv"]
services-upyun = ["dep:opendal-service-upyun"]
-services-vercel-artifacts = ["opendal-core/services-vercel-artifacts"]
+services-vercel-artifacts = ["dep:opendal-service-vercel-artifacts"]
services-vercel-blob = ["dep:opendal-service-vercel-blob"]
services-webdav = ["dep:opendal-service-webdav"]
services-webhdfs = ["dep:opendal-service-webhdfs"]
@@ -241,6 +241,7 @@ opendal-service-gcs = { path = "services/gcs", version =
"0.55.0", optional = tr
opendal-service-gdrive = { path = "services/gdrive", version = "0.55.0",
optional = true, default-features = false }
opendal-service-ghac = { path = "services/ghac", version = "0.55.0", optional
= true, default-features = false }
opendal-service-github = { path = "services/github", version = "0.55.0",
optional = true, default-features = false }
+opendal-service-gridfs = { path = "services/gridfs", version = "0.55.0",
optional = true, default-features = false }
opendal-service-hdfs = { path = "services/hdfs", version = "0.55.0", optional
= true, default-features = false }
opendal-service-hdfs-native = { path = "services/hdfs-native", version =
"0.55.0", optional = true, default-features = false }
opendal-service-http = { path = "services/http", version = "0.55.0", optional
= true, default-features = false }
@@ -270,6 +271,7 @@ opendal-service-surrealdb = { path = "services/surrealdb",
version = "0.55.0", o
opendal-service-swift = { path = "services/swift", version = "0.55.0",
optional = true, default-features = false }
opendal-service-tikv = { path = "services/tikv", version = "0.55.0", optional
= true, default-features = false }
opendal-service-upyun = { path = "services/upyun", version = "0.55.0",
optional = true, default-features = false }
+opendal-service-vercel-artifacts = { path = "services/vercel-artifacts",
version = "0.55.0", optional = true, default-features = false }
opendal-service-vercel-blob = { path = "services/vercel-blob", version =
"0.55.0", optional = true, default-features = false }
opendal-service-webdav = { path = "services/webdav", version = "0.55.0",
optional = true, default-features = false }
opendal-service-webhdfs = { path = "services/webhdfs", version = "0.55.0",
optional = true, default-features = false }
diff --git a/core/core/Cargo.toml b/core/core/Cargo.toml
index 8de41c8fc..3d58a953c 100644
--- a/core/core/Cargo.toml
+++ b/core/core/Cargo.toml
@@ -57,16 +57,11 @@ executors-tokio = ["tokio/rt"]
# Enable dtrace support.
layers-dtrace = ["dep:probe"]
-services-gridfs = ["dep:mongodb", "dep:mongodb-internal-macros"]
-services-ipmfs = []
-services-lakefs = []
services-memory = []
services-mongodb = ["dep:mongodb", "dep:mongodb-internal-macros"]
services-redis = ["dep:redis", "dep:fastpool", "redis?/tokio-rustls-comp"]
services-redis-native-tls = ["services-redis", "redis?/tokio-native-tls-comp"]
services-rocksdb = ["dep:rocksdb", "internal-tokio-rt"]
-services-vercel-artifacts = []
-services-webhdfs = []
[lib]
bench = false
diff --git a/core/core/src/services/mod.rs b/core/core/src/services/mod.rs
index 62ee7588e..864a88bfb 100644
--- a/core/core/src/services/mod.rs
+++ b/core/core/src/services/mod.rs
@@ -19,11 +19,6 @@
//!
//! More ongoing services support is tracked at
[opendal#5](https://github.com/apache/opendal/issues/5). Please feel free to
submit issues if there are services not covered.
-#[cfg(feature = "services-gridfs")]
-mod gridfs;
-#[cfg(feature = "services-gridfs")]
-pub use gridfs::*;
-
#[cfg(feature = "services-memory")]
mod memory;
#[cfg(feature = "services-memory")]
diff --git a/core/services/gridfs/Cargo.toml b/core/services/gridfs/Cargo.toml
new file mode 100644
index 000000000..12a704bbe
--- /dev/null
+++ b/core/services/gridfs/Cargo.toml
@@ -0,0 +1,42 @@
+# 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 GridFS service implementation"
+name = "opendal-service-gridfs"
+
+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]
+ctor = { workspace = true }
+futures = { workspace = true }
+mea = "0.5.1"
+mongodb = "3.3.0"
+opendal-core = { path = "../../core", version = "0.55.0", default-features =
false }
+serde = { workspace = true, features = ["derive"] }
+
+[dev-dependencies]
+tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
diff --git a/core/core/src/services/gridfs/backend.rs
b/core/services/gridfs/src/backend.rs
similarity index 99%
rename from core/core/src/services/gridfs/backend.rs
rename to core/services/gridfs/src/backend.rs
index 7519cacb8..9e76b64d9 100644
--- a/core/core/src/services/gridfs/backend.rs
+++ b/core/services/gridfs/src/backend.rs
@@ -18,14 +18,14 @@
use std::sync::Arc;
use mea::once::OnceCell;
+use opendal_core::raw::*;
+use opendal_core::*;
use super::GRIDFS_SCHEME;
use super::config::GridfsConfig;
use super::core::*;
use super::deleter::GridfsDeleter;
use super::writer::GridfsWriter;
-use crate::raw::*;
-use crate::*;
#[doc = include_str!("docs.md")]
#[derive(Debug, Default)]
diff --git a/core/core/src/services/gridfs/config.rs
b/core/services/gridfs/src/config.rs
similarity index 92%
rename from core/core/src/services/gridfs/config.rs
rename to core/services/gridfs/src/config.rs
index 512602034..b9d965a2c 100644
--- a/core/core/src/services/gridfs/config.rs
+++ b/core/services/gridfs/src/config.rs
@@ -17,6 +17,7 @@
use std::fmt::Debug;
+use opendal_core::*;
use serde::Deserialize;
use serde::Serialize;
@@ -50,10 +51,10 @@ impl Debug for GridfsConfig {
}
}
-impl crate::Configurator for GridfsConfig {
+impl Configurator for GridfsConfig {
type Builder = GridfsBuilder;
- fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
+ fn from_uri(uri: &OperatorUri) -> Result<Self> {
let mut map = uri.options().clone();
if let Some(authority) = uri.authority() {
@@ -95,18 +96,15 @@ impl crate::Configurator for GridfsConfig {
#[cfg(test)]
mod tests {
use super::*;
- use crate::Configurator;
- use crate::types::OperatorUri;
#[test]
- fn from_uri_sets_connection_database_bucket_and_root() {
+ fn from_uri_sets_connection_database_bucket_and_root() -> Result<()> {
let uri = OperatorUri::new(
"gridfs://mongo.example.com:27017/app_files/assets/images",
Vec::<(String, String)>::new(),
- )
- .unwrap();
+ )?;
- let cfg = GridfsConfig::from_uri(&uri).unwrap();
+ let cfg = GridfsConfig::from_uri(&uri)?;
assert_eq!(
cfg.connection_string.as_deref(),
Some("mongodb://mongo.example.com:27017")
@@ -114,5 +112,6 @@ mod tests {
assert_eq!(cfg.database.as_deref(), Some("app_files"));
assert_eq!(cfg.bucket.as_deref(), Some("assets"));
assert_eq!(cfg.root.as_deref(), Some("images"));
+ Ok(())
}
}
diff --git a/core/core/src/services/gridfs/core.rs
b/core/services/gridfs/src/core.rs
similarity index 98%
rename from core/core/src/services/gridfs/core.rs
rename to core/services/gridfs/src/core.rs
index cdc2a8ac0..3f5f9a9bb 100644
--- a/core/core/src/services/gridfs/core.rs
+++ b/core/services/gridfs/src/core.rs
@@ -24,9 +24,8 @@ use mongodb::bson::doc;
use mongodb::gridfs::GridFsBucket;
use mongodb::options::ClientOptions;
use mongodb::options::GridFsBucketOptions;
-
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
#[derive(Clone)]
pub struct GridfsCore {
diff --git a/core/core/src/services/gridfs/deleter.rs
b/core/services/gridfs/src/deleter.rs
similarity index 95%
rename from core/core/src/services/gridfs/deleter.rs
rename to core/services/gridfs/src/deleter.rs
index 798041872..986a05fd3 100644
--- a/core/core/src/services/gridfs/deleter.rs
+++ b/core/services/gridfs/src/deleter.rs
@@ -17,10 +17,10 @@
use std::sync::Arc;
+use opendal_core::raw::*;
+use opendal_core::*;
+
use super::core::*;
-use crate::raw::oio;
-use crate::raw::*;
-use crate::*;
pub struct GridfsDeleter {
core: Arc<GridfsCore>,
diff --git a/core/core/src/services/gridfs/docs.md
b/core/services/gridfs/src/docs.md
similarity index 93%
rename from core/core/src/services/gridfs/docs.md
rename to core/services/gridfs/src/docs.md
index e72dca132..158730469 100644
--- a/core/core/src/services/gridfs/docs.md
+++ b/core/services/gridfs/src/docs.md
@@ -25,9 +25,9 @@ This service can be used to:
### Via Builder
```rust,no_run
-use anyhow::Result;
-use opendal_core::services::Gridfs;
use opendal_core::Operator;
+use opendal_core::Result;
+use opendal_service_gridfs::Gridfs;
#[tokio::main]
async fn main() -> Result<()> {
diff --git a/core/core/src/services/gridfs/mod.rs
b/core/services/gridfs/src/lib.rs
similarity index 84%
rename from core/core/src/services/gridfs/mod.rs
rename to core/services/gridfs/src/lib.rs
index 93d4fe611..fda56982b 100644
--- a/core/core/src/services/gridfs/mod.rs
+++ b/core/services/gridfs/src/lib.rs
@@ -15,10 +15,10 @@
// specific language governing permissions and limitations
// under the License.
-/// Default scheme for gridfs service.
-pub const GRIDFS_SCHEME: &str = "gridfs";
+//! GridFS service implementation for Apache OpenDAL.
-use crate::types::DEFAULT_OPERATOR_REGISTRY;
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![deny(missing_docs)]
mod backend;
mod config;
@@ -29,7 +29,10 @@ mod writer;
pub use backend::GridfsBuilder as Gridfs;
pub use config::GridfsConfig;
+/// Default scheme for gridfs service.
+pub const GRIDFS_SCHEME: &str = "gridfs";
+
#[ctor::ctor]
fn register_gridfs_service() {
- DEFAULT_OPERATOR_REGISTRY.register::<Gridfs>(GRIDFS_SCHEME);
+ opendal_core::DEFAULT_OPERATOR_REGISTRY.register::<Gridfs>(GRIDFS_SCHEME);
}
diff --git a/core/core/src/services/gridfs/writer.rs
b/core/services/gridfs/src/writer.rs
similarity index 97%
rename from core/core/src/services/gridfs/writer.rs
rename to core/services/gridfs/src/writer.rs
index f1249a816..6e19e74a1 100644
--- a/core/core/src/services/gridfs/writer.rs
+++ b/core/services/gridfs/src/writer.rs
@@ -17,9 +17,10 @@
use std::sync::Arc;
+use opendal_core::raw::*;
+use opendal_core::*;
+
use super::core::*;
-use crate::raw::oio;
-use crate::*;
pub struct GridfsWriter {
core: Arc<GridfsCore>,
diff --git a/core/src/lib.rs b/core/src/lib.rs
index 384a1a981..a3319f8c8 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -74,6 +74,8 @@ pub mod services {
pub use opendal_service_ghac::*;
#[cfg(feature = "services-github")]
pub use opendal_service_github::*;
+ #[cfg(feature = "services-gridfs")]
+ pub use opendal_service_gridfs::*;
#[cfg(feature = "services-hdfs")]
pub use opendal_service_hdfs::*;
#[cfg(feature = "services-hdfs-native")]
