v0.48.0

[Xuanwo]

OpenDAL Core Upgrade to v0.48

Public API

Typo in customized_credential_load

Since v0.48, the customed_credential_load function has been renamed to customized_credential_load to fix the typo of customized.

- builder.customed_credential_load(v);
+ builder.customized_credential_load(v);

S3 service rename security_token to session_token

In 2014 Amazon switched from AWS_SECURITY_TOKEN to AWS_SESSION_TOKEN. To be consistent with the naming of AWS STS, we have renamed the security_token field to session_token in the S3 service.

- builder.security_token(v);
+ builder.session_token(v);

Operator from_iter and via_iter replaces from_map and via_map

Since v0.48, Operator's new APIs from_iter and via_iter methods have deprecated the from_map and via_map methods.

- Operator::from_map::<Fs>(map)?.finish();
+ Operator::from_iter::<Fs>(map)?.finish();

New API from_iter and via_iter should cover all use cases of from_map and via_map.

Service builder now takes ownership

Since v0.48, all service builder now takes ownership self instead of &mut self. This change will allow users to configure the service in a more flexible way.

- let mut builder = S3::default();
- builder.bucket("test");
- builder.root("/path/to/root");
+ let builder = S3::default().bucket("test").root("/path/to/root");
  let op = Operator::new(builder)?.finish();

Raw API

oio::Write::write will write the whole buffer

Starting from version 0.48, oio::Write::write now writes the entire buffer. This update aligns the API more closely with oio::Read::read and simplifies the implementation of concurrent writing.

  trait Write {
-     fn write(&mut self, bs: Buffer) -> impl Future<Output = Result<usize>>;
+     fn write(&mut self, bs: Buffer) -> impl Future<Output = Result<()>>;
  }

write will now return Result<()> instead of Result<usize>. The number of bytes written can be obtained from the buffer's length.

Access::metadata() will return Arc<AccessInfo>

Starting from version 0.48, Access::metadata() will return Arc<AccessInfo> instead of AccessInfo. This change is intended to improve performance and reduce memory usage.

  trait Access {
-     fn metadata(&self) -> AccessInfo;
+     fn metadata(&self) -> Arc<AccessInfo>;
  }

MinitraceLayer renamed to FastraceLayer

The MinitraceLayer has been renamed to FastraceLayer to respond to the transition from minitrace to fastrace.

- use opendal::layers::MinitraceLayer;
+ use opendal::layers::FastraceLayer;

Use Configurator to replace Builder::from_config

Since v0.48, the Builder::from_config and Builder::from_map method has been replaced by the Configurator trait. The Configurator trait provides a more flexible and extensible way to configure OpenDAL.

Service implementers should update their code to use the Configurator trait instead:

impl Configurator for MemoryConfig {
    fn into_builder(self) -> impl Builder {
        MemoryBuilder { config: self }
    }
}

impl Builder for MemoryBuilder {
    const SCHEME: Scheme = Scheme::Memory;
    type Config = MemoryConfig;

    fn build(self) -> Result<impl Access> {
        ...
    }
}

---

What's Changed

Added

• feat(services/fs): Support fs config by @meteorgan in feat(services/fs): Support fs config #4853
• feat(services): init monoiofs by @NKID00 in feat(services): init monoiofs #4855
• feat(core/types): avoid a copy in Buffer::to_bytes() by cloning contiguous bytes by @LDeakin in feat(core/types): avoid a copy in Buffer::to_bytes() by cloning contiguous bytes #4858
• feat(core): Add object versioning for OSS by @Lzzzzzt in feat(core): Add object versioning for OSS #4870
• feat: fs add concurrent write by @hoslo in feat: fs add concurrent write #4817
• feat(services/s3): Add object versioning for S3 by @Lzzzzzt in feat(services/s3): Add object versioning for S3 #4873
• feat(integrations/cloudfilter): read only cloud filter by @ho-229 in feat(integrations/cloudfilter): read only cloud filter #4856
• feat(bindings/go): Add full native support from C to Go. by @yuchanns in feat(bindings/go): Add full native support from C to Go. #4886
• feat(bindings/go): add benchmark. by @yuchanns in feat(bindings/go): add benchmark. #4893
• feat(core): support user defined metadata for oss by @meteorgan in feat(core): support user defined metadata for oss #4881
• feat(service/fastrace): rename minitrace to fastrace by @andylokandy in feat(service/fastrace): rename minitrace to fastrace #4906
• feat(prometheus-client): add metric label about root on using PrometheusClientLayer by @flaneur2020 in feat(prometheus-client): add metric label about root on using PrometheusClientLayer #4907
• feat(services/monoiofs): monoio wrapper by @NKID00 in feat(services/monoiofs): monoio wrapper #4885
• feat(layers/mime-guess): add a layer that can automatically set Content-Type based on the extension in the path. by @czy-29 in feat(layers/mime-guess): add a layer that can automatically set Content-Type based on the extension in the path. #4912
• feat(core)!: Make config data object by @tisonkun in feat(core)!: Make config data object #4915
• feat(core)!: from_map is now fallible by @tisonkun in feat(core)!: from_map is now fallible #4917
• ci(bindings/go): always test against the latest core by @yuchanns in ci(bindings/go): always test against the latest core #4913
• feat(!): Allow users to build operator from config by @Xuanwo in feat(!): Allow users to build operator from config #4919
• feat: Add from_iter and via_iter for operator by @Xuanwo in feat: Add from_iter and via_iter for operator #4921

Changed

• refactor(services/s3)!: renamed security_token to session_token by @Zyyeric in refactor(services/s3)!: renamed security_token to session_token #4875
• refactor(core)!: Make oio::Write always write all given buffer by @Xuanwo in refactor(core)!: Make oio::Write always write all given buffer #4880
• refactor(core)!: Return Arc<AccessInfo> for metadata by @Lzzzzzt in refactor(core)!: Return Arc<AccessInfo> for metadata #4883
• refactor(core!): Make service builder takes ownership by @Xuanwo in refactor(core!): Make service builder takes ownership #4922
• refactor(integrations/cloudfilter): implement Filter instead of SyncFilter by @ho-229 in refactor(integrations/cloudfilter): implement Filter instead of SyncFilter #4920

Fixed

• fix(services/s3): NoSuchBucket is a ConfigInvalid for OpenDAL by @tisonkun in fix(services/s3): NoSuchBucket is a ConfigInvalid for OpenDAL #4895
• fix: oss will not use the port by @Lzzzzzt in fix: oss will not use the port #4899

Docs

• docs(core): update README to add MimeGuessLayer. by @czy-29 in docs(core): update README to add MimeGuessLayer. #4916
• docs(core): Add upgrade docs for 0.48 by @Xuanwo in docs(core): Add upgrade docs for 0.48 #4924
• docs: fix spelling by @jbampton in docs: fix spelling #4925
• docs(core): Fix comment for into_futures_async_write by @Xuanwo in docs(core): Fix comment for into_futures_async_write #4928

CI

• ci: Add issue template and pr template for opendal by @Xuanwo in ci: Add issue template and pr template for opendal #4884
• ci: Remove CI reviewer since it doesn't work by @Xuanwo in ci: Remove CI reviewer since it doesn't work #4891

Chore

• chore!: fix typo customed should be customized by @tisonkun in chore!: fix typo customed should be customized #4847
• chore: Fix spelling by @jbampton in chore: Fix spelling #4864
• chore: remove unneeded duplicate word by @jbampton in chore: remove unneeded duplicate word #4865
• chore: fix spelling by @jbampton in chore: fix spelling #4866
• chore: fix spelling by @NKID00 in chore: fix spelling #4869
• chore: Make compfs able to test by @Xuanwo in chore: Make compfs able to test #4878
• chore(services/compfs): remove allow(dead_code) by @George-Miao in chore(services/compfs): remove allow(dead_code) #4879
• chore: Make rust 1.80 clippy happy by @Xuanwo in chore: Make rust 1.80 clippy happy #4927
• chore: Bump crates versions by @Xuanwo in chore: Bump crates versions  #4929

New Contributors

• @meteorgan made their first contribution in feat(services/fs): Support fs config #4853
• @LDeakin made their first contribution in feat(core/types): avoid a copy in Buffer::to_bytes() by cloning contiguous bytes #4858
• @Lzzzzzt made their first contribution in feat(core): Add object versioning for OSS #4870
• @Zyyeric made their first contribution in refactor(services/s3)!: renamed security_token to session_token #4875
• @czy-29 made their first contribution in feat(layers/mime-guess): add a layer that can automatically set Content-Type based on the extension in the path. #4912

Full Changelog: v0.47.3...v0.48.0

---

This discussion was created from the release v0.48.0.