This is an automated email from the ASF dual-hosted git repository.
xuanwo 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 a9e400f46 refactor: split oss service to new crate (#6978)
a9e400f46 is described below
commit a9e400f46569700d520ef6e9970778db83ddc021
Author: Huang Youliang <[email protected]>
AuthorDate: Sun Dec 14 18:33:52 2025 +0800
refactor: split oss service to new crate (#6978)
* refactor: split oss service to new crate
* Fixup
* * Update GLOBAL_REQWEST_CLIENT visibility
* Place docs.md under the src directory
---
core/Cargo.lock | 21 +++++++++
core/Cargo.toml | 3 +-
core/core/Cargo.toml | 6 +--
core/core/src/raw/http_util/client.rs | 3 +-
core/core/src/raw/http_util/mod.rs | 2 +-
core/core/src/services/mod.rs | 5 --
core/services/oss/Cargo.toml | 54 ++++++++++++++++++++++
.../services/oss => services/oss/src}/backend.rs | 8 +++-
.../services/oss => services/oss/src}/config.rs | 24 +++++-----
.../src/services/oss => services/oss/src}/core.rs | 6 +--
.../services/oss => services/oss/src}/deleter.rs | 6 +--
.../src/services/oss => services/oss/src}/docs.md | 4 +-
.../src/services/oss => services/oss/src}/error.rs | 4 +-
.../oss/mod.rs => services/oss/src/lib.rs} | 12 +++--
.../services/oss => services/oss/src}/lister.rs | 6 +--
.../services/oss => services/oss/src}/writer.rs | 4 +-
core/src/lib.rs | 2 +
17 files changed, 122 insertions(+), 48 deletions(-)
diff --git a/core/Cargo.lock b/core/Cargo.lock
index a2f7917e2..e9d0f278b 100644
--- a/core/Cargo.lock
+++ b/core/Cargo.lock
@@ -5508,6 +5508,7 @@ dependencies = [
"opendal-service-moka",
"opendal-service-mysql",
"opendal-service-obs",
+ "opendal-service-oss",
"opendal-service-postgresql",
"opendal-service-s3",
"opendal-service-sled",
@@ -5987,6 +5988,26 @@ dependencies = [
"serde",
]
+[[package]]
+name = "opendal-service-oss"
+version = "0.55.0"
+dependencies = [
+ "anyhow",
+ "bytes",
+ "ctor",
+ "http 1.4.0",
+ "log",
+ "opendal-core",
+ "pretty_assertions",
+ "quick-xml",
+ "reqsign",
+ "reqwest",
+ "serde",
+ "serde_json",
+ "tokio",
+ "tracing-subscriber",
+]
+
[[package]]
name = "opendal-service-postgresql"
version = "0.55.0"
diff --git a/core/Cargo.toml b/core/Cargo.toml
index 84d9a5775..819100b5d 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -141,7 +141,7 @@ services-mysql = ["dep:opendal-service-mysql"]
services-obs = ["dep:opendal-service-obs"]
services-onedrive = ["opendal-core/services-onedrive"]
services-opfs = ["opendal-core/services-opfs"]
-services-oss = ["opendal-core/services-oss"]
+services-oss = ["dep:opendal-service-oss"]
services-pcloud = ["opendal-core/services-pcloud"]
services-persy = ["opendal-core/services-persy"]
services-postgresql = ["dep:opendal-service-postgresql"]
@@ -213,6 +213,7 @@ opendal-service-ipfs = { path = "services/ipfs", version =
"0.55.0", optional =
opendal-service-moka = { path = "services/moka", version = "0.55.0", optional
= true, default-features = false }
opendal-service-mysql = { path = "services/mysql", version = "0.55.0",
optional = true, default-features = false }
opendal-service-obs = { path = "services/obs", version = "0.55.0", optional =
true, default-features = false }
+opendal-service-oss = { path = "services/oss", version = "0.55.0", optional =
true, default-features = false }
opendal-service-postgresql = { path = "services/postgresql", version =
"0.55.0", optional = true, default-features = false }
opendal-service-sled = { path = "services/sled", version = "0.55.0", optional
= true, default-features = false }
opendal-service-s3 = { path = "services/s3", version = "0.55.0", optional =
true, default-features = false }
diff --git a/core/core/Cargo.toml b/core/core/Cargo.toml
index 26665d932..957ddf3d1 100644
--- a/core/core/Cargo.toml
+++ b/core/core/Cargo.toml
@@ -117,11 +117,7 @@ services-opfs = [
"dep:wasm-bindgen-futures",
"dep:web-sys",
]
-services-oss = [
- "dep:reqsign",
- "reqsign?/services-aliyun",
- "reqsign?/reqwest_request",
-]
+
services-pcloud = []
services-persy = ["dep:persy", "internal-tokio-rt"]
services-redb = ["dep:redb", "internal-tokio-rt"]
diff --git a/core/core/src/raw/http_util/client.rs
b/core/core/src/raw/http_util/client.rs
index 81185068c..4c69cb890 100644
--- a/core/core/src/raw/http_util/client.rs
+++ b/core/core/src/raw/http_util/client.rs
@@ -47,8 +47,7 @@ use crate::*;
/// This is merely a temporary solution because reqsign requires a reqwest
client to be passed.
/// We will remove it after the next major version of reqsign, which will
enable users to provide their own client.
#[allow(dead_code)]
-pub(crate) static GLOBAL_REQWEST_CLIENT: LazyLock<reqwest::Client> =
- LazyLock::new(reqwest::Client::new);
+pub static GLOBAL_REQWEST_CLIENT: LazyLock<reqwest::Client> =
LazyLock::new(reqwest::Client::new);
/// HttpFetcher is a type erased [`HttpFetch`].
pub type HttpFetcher = Arc<dyn HttpFetchDyn>;
diff --git a/core/core/src/raw/http_util/mod.rs
b/core/core/src/raw/http_util/mod.rs
index 1c0aa8cf9..ae6b1e585 100644
--- a/core/core/src/raw/http_util/mod.rs
+++ b/core/core/src/raw/http_util/mod.rs
@@ -25,7 +25,7 @@
mod client;
/// temporary client used by several features
#[allow(unused_imports)]
-pub(crate) use client::GLOBAL_REQWEST_CLIENT;
+pub use client::GLOBAL_REQWEST_CLIENT;
pub use client::HttpClient;
pub use client::HttpFetch;
pub use client::HttpFetcher;
diff --git a/core/core/src/services/mod.rs b/core/core/src/services/mod.rs
index a5bc5cc87..4cc96c928 100644
--- a/core/core/src/services/mod.rs
+++ b/core/core/src/services/mod.rs
@@ -159,11 +159,6 @@ mod onedrive;
#[cfg(feature = "services-onedrive")]
pub use onedrive::*;
-#[cfg(feature = "services-oss")]
-mod oss;
-#[cfg(feature = "services-oss")]
-pub use oss::*;
-
#[cfg(feature = "services-pcloud")]
mod pcloud;
#[cfg(feature = "services-pcloud")]
diff --git a/core/services/oss/Cargo.toml b/core/services/oss/Cargo.toml
new file mode 100644
index 000000000..9448602a1
--- /dev/null
+++ b/core/services/oss/Cargo.toml
@@ -0,0 +1,54 @@
+# 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 Aliyun OSS service implementation"
+name = "opendal-service-oss"
+
+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 }
+quick-xml = { workspace = true, features = ["serialize", "overlapped-lists"] }
+reqsign = { workspace = true, features = ["services-aliyun",
"reqwest_request"] }
+reqwest = { version = "0.12.24", features = ["stream"], default-features =
false }
+serde = { workspace = true, features = ["derive"] }
+
+[dev-dependencies]
+anyhow = "1"
+pretty_assertions = "1"
+serde_json = { workspace = true }
+tokio = { workspace = true, features = [
+ "macros",
+ "rt-multi-thread",
+ "io-util",
+] }
+tracing-subscriber = "0.3"
diff --git a/core/core/src/services/oss/backend.rs
b/core/services/oss/src/backend.rs
similarity index 99%
rename from core/core/src/services/oss/backend.rs
rename to core/services/oss/src/backend.rs
index b7c59d7b5..0b79c196f 100644
--- a/core/core/src/services/oss/backend.rs
+++ b/core/services/oss/src/backend.rs
@@ -36,8 +36,8 @@ use super::lister::OssListers;
use super::lister::OssObjectVersionsLister;
use super::writer::OssWriter;
use super::writer::OssWriters;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
const DEFAULT_BATCH_MAX_OPERATIONS: usize = 1000;
@@ -684,6 +684,10 @@ impl Access for OssBackend {
ErrorKind::Unsupported,
"operation is not supported",
)),
+ _ => Err(Error::new(
+ ErrorKind::Unsupported,
+ "operation is not supported",
+ )),
};
let mut req = req?;
diff --git a/core/core/src/services/oss/config.rs
b/core/services/oss/src/config.rs
similarity index 88%
rename from core/core/src/services/oss/config.rs
rename to core/services/oss/src/config.rs
index 75b5d66a1..73a900d1d 100644
--- a/core/core/src/services/oss/config.rs
+++ b/core/services/oss/src/config.rs
@@ -20,6 +20,8 @@ use std::fmt::Debug;
use serde::Deserialize;
use serde::Serialize;
+use opendal_core::OperatorUri;
+
use super::backend::OssBuilder;
/// Config for Aliyun Object Storage Service (OSS) support.
@@ -56,17 +58,17 @@ pub struct OssConfig {
/// Access key id for oss.
///
/// - this field if it's `is_some`
- /// - env value: [`ALIBABA_CLOUD_ACCESS_KEY_ID`]
+ /// - env value: `ALIBABA_CLOUD_ACCESS_KEY_ID`
pub access_key_id: Option<String>,
/// Access key secret for oss.
///
/// - this field if it's `is_some`
- /// - env value: [`ALIBABA_CLOUD_ACCESS_KEY_SECRET`]
+ /// - env value: `ALIBABA_CLOUD_ACCESS_KEY_SECRET`
pub access_key_secret: Option<String>,
/// `security_token` will be loaded from
///
/// - this field if it's `is_some`
- /// - env value: [`ALIBABA_CLOUD_SECURITY_TOKEN`]
+ /// - env value: `ALIBABA_CLOUD_SECURITY_TOKEN`
pub security_token: Option<String>,
/// The size of max batch operations.
#[deprecated(
@@ -80,24 +82,24 @@ pub struct OssConfig {
/// credential to assume role with `role_arn`.
///
/// - this field if it's `is_some`
- /// - env value: [`ALIBABA_CLOUD_ROLE_ARN`]
+ /// - env value: `ALIBABA_CLOUD_ROLE_ARN`
pub role_arn: Option<String>,
/// role_session_name for this backend.
pub role_session_name: Option<String>,
/// `oidc_provider_arn` will be loaded from
///
/// - this field if it's `is_some`
- /// - env value: [`ALIBABA_CLOUD_OIDC_PROVIDER_ARN`]
+ /// - env value: `ALIBABA_CLOUD_OIDC_PROVIDER_ARN`
pub oidc_provider_arn: Option<String>,
/// `oidc_token_file` will be loaded from
///
/// - this field if it's `is_some`
- /// - env value: [`ALIBABA_CLOUD_OIDC_TOKEN_FILE`]
+ /// - env value: `ALIBABA_CLOUD_OIDC_TOKEN_FILE`
pub oidc_token_file: Option<String>,
/// `sts_endpoint` will be loaded from
///
/// - this field if it's `is_some`
- /// - env value: [`ALIBABA_CLOUD_STS_ENDPOINT`]
+ /// - env value: `ALIBABA_CLOUD_STS_ENDPOINT`
pub sts_endpoint: Option<String>,
}
@@ -112,10 +114,10 @@ impl Debug for OssConfig {
}
}
-impl crate::Configurator for OssConfig {
+impl opendal_core::Configurator for OssConfig {
type Builder = OssBuilder;
- fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
+ fn from_uri(uri: &OperatorUri) -> opendal_core::Result<Self> {
let mut map = uri.options().clone();
if let Some(name) = uri.name() {
@@ -137,8 +139,8 @@ impl crate::Configurator for OssConfig {
#[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_extracts_bucket_and_root() {
diff --git a/core/core/src/services/oss/core.rs b/core/services/oss/src/core.rs
similarity index 99%
rename from core/core/src/services/oss/core.rs
rename to core/services/oss/src/core.rs
index 7bdf5456d..9df696380 100644
--- a/core/core/src/services/oss/core.rs
+++ b/core/services/oss/src/core.rs
@@ -40,9 +40,9 @@ use reqsign::AliyunOssSigner;
use serde::Deserialize;
use serde::Serialize;
-use crate::raw::*;
-use crate::services::oss::core::constants::X_OSS_FORBID_OVERWRITE;
-use crate::*;
+use crate::core::constants::X_OSS_FORBID_OVERWRITE;
+use opendal_core::raw::*;
+use opendal_core::*;
pub mod constants {
pub const X_OSS_SERVER_SIDE_ENCRYPTION: &str =
"x-oss-server-side-encryption";
diff --git a/core/core/src/services/oss/deleter.rs
b/core/services/oss/src/deleter.rs
similarity index 97%
rename from core/core/src/services/oss/deleter.rs
rename to core/services/oss/src/deleter.rs
index f5b930746..da900148d 100644
--- a/core/core/src/services/oss/deleter.rs
+++ b/core/services/oss/src/deleter.rs
@@ -23,9 +23,9 @@ use http::StatusCode;
use super::core::*;
use super::error::parse_error;
-use crate::raw::oio::BatchDeleteResult;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::oio::BatchDeleteResult;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct OssDeleter {
core: Arc<OssCore>,
diff --git a/core/core/src/services/oss/docs.md b/core/services/oss/src/docs.md
similarity index 98%
rename from core/core/src/services/oss/docs.md
rename to core/services/oss/src/docs.md
index 805455bc3..6ca1e15f6 100644
--- a/core/core/src/services/oss/docs.md
+++ b/core/services/oss/src/docs.md
@@ -1,5 +1,3 @@
-
-
# Capabilities
This service can be used to:
@@ -38,7 +36,7 @@ Refer to [`OssBuilder`]'s public API docs for more
information.
use std::sync::Arc;
use anyhow::Result;
-use opendal_core::services::Oss;
+use opendal_service_oss::Oss;
use opendal_core::Operator;
#[tokio::main]
diff --git a/core/core/src/services/oss/error.rs
b/core/services/oss/src/error.rs
similarity index 98%
rename from core/core/src/services/oss/error.rs
rename to core/services/oss/src/error.rs
index 7ca0fdde9..9feae4cc7 100644
--- a/core/core/src/services/oss/error.rs
+++ b/core/services/oss/src/error.rs
@@ -21,8 +21,8 @@ use http::StatusCode;
use quick_xml::de;
use serde::Deserialize;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
/// OssError is the error returned by oss service.
#[derive(Default, Debug, Deserialize)]
diff --git a/core/core/src/services/oss/mod.rs b/core/services/oss/src/lib.rs
similarity index 83%
rename from core/core/src/services/oss/mod.rs
rename to core/services/oss/src/lib.rs
index cf7055624..a995973d2 100644
--- a/core/core/src/services/oss/mod.rs
+++ b/core/services/oss/src/lib.rs
@@ -15,10 +15,9 @@
// specific language governing permissions and limitations
// under the License.
-/// Default scheme for oss service.
-pub const OSS_SCHEME: &str = "oss";
-
-use crate::types::DEFAULT_OPERATOR_REGISTRY;
+#![cfg_attr(docsrs, feature(doc_cfg))]
+//! Aliyun Object Storage Service (OSS) implementation for Apache OpenDAL.
+#![deny(missing_docs)]
mod backend;
mod config;
@@ -31,7 +30,10 @@ mod writer;
pub use backend::OssBuilder as Oss;
pub use config::OssConfig;
+/// Default scheme for oss service.
+pub const OSS_SCHEME: &str = "oss";
+
#[ctor::ctor]
fn register_oss_service() {
- DEFAULT_OPERATOR_REGISTRY.register::<Oss>(OSS_SCHEME);
+ opendal_core::DEFAULT_OPERATOR_REGISTRY.register::<Oss>(OSS_SCHEME);
}
diff --git a/core/core/src/services/oss/lister.rs
b/core/services/oss/src/lister.rs
similarity index 98%
rename from core/core/src/services/oss/lister.rs
rename to core/services/oss/src/lister.rs
index f6c312cbf..4d30b1812 100644
--- a/core/core/src/services/oss/lister.rs
+++ b/core/services/oss/src/lister.rs
@@ -22,9 +22,9 @@ use quick_xml::de;
use super::core::*;
use super::error::parse_error;
-use crate::raw::oio::PageContext;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::oio::PageContext;
+use opendal_core::raw::*;
+use opendal_core::*;
pub type OssListers = TwoWays<oio::PageLister<OssLister>,
oio::PageLister<OssObjectVersionsLister>>;
diff --git a/core/core/src/services/oss/writer.rs
b/core/services/oss/src/writer.rs
similarity index 99%
rename from core/core/src/services/oss/writer.rs
rename to core/services/oss/src/writer.rs
index 13f5e6317..6668f3386 100644
--- a/core/core/src/services/oss/writer.rs
+++ b/core/services/oss/src/writer.rs
@@ -23,8 +23,8 @@ use http::StatusCode;
use super::core::*;
use super::error::parse_error;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub type OssWriters = TwoWays<oio::MultipartWriter<OssWriter>,
oio::AppendWriter<OssWriter>>;
diff --git a/core/src/lib.rs b/core/src/lib.rs
index 066ccd442..426675c9b 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -51,6 +51,8 @@ pub mod services {
pub use opendal_service_mysql::*;
#[cfg(feature = "services-obs")]
pub use opendal_service_obs::*;
+ #[cfg(feature = "services-oss")]
+ pub use opendal_service_oss::*;
#[cfg(feature = "services-postgresql")]
pub use opendal_service_postgresql::*;
#[cfg(feature = "services-s3")]
