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

refactor: Polish Writer API by merging append and write together #2036

Merged
merged 8 commits into from
Apr 19, 2023
Merged
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
8 changes: 0 additions & 8 deletions core/src/layers/concurrent_limit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -316,10 +316,6 @@ impl<R: oio::Write> oio::Write for ConcurrentLimitWrapper<R> {
self.inner.write(bs).await
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs).await
}

async fn abort(&mut self) -> Result<()> {
self.inner.abort().await
}
Expand All @@ -334,10 +330,6 @@ impl<R: oio::BlockingWrite> oio::BlockingWrite for ConcurrentLimitWrapper<R> {
self.inner.write(bs)
}

fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs)
}

fn close(&mut self) -> Result<()> {
self.inner.close()
}
Expand Down
16 changes: 0 additions & 16 deletions core/src/layers/error_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -411,14 +411,6 @@ impl<T: oio::Write> oio::Write for ErrorContextWrapper<T> {
})
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs).await.map_err(|err| {
err.with_operation(WriteOperation::Append)
.with_context("service", self.scheme)
.with_context("path", &self.path)
})
}

async fn abort(&mut self) -> Result<()> {
self.inner.abort().await.map_err(|err| {
err.with_operation(WriteOperation::Append)
Expand All @@ -445,14 +437,6 @@ impl<T: oio::BlockingWrite> oio::BlockingWrite for ErrorContextWrapper<T> {
})
}

fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs).map_err(|err| {
err.with_operation(WriteOperation::BlockingAppend)
.with_context("service", self.scheme)
.with_context("path", &self.path)
})
}

fn close(&mut self) -> Result<()> {
self.inner.close().map_err(|err| {
err.with_operation(WriteOperation::BlockingClose)
Expand Down
66 changes: 0 additions & 66 deletions core/src/layers/logging.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1386,39 +1386,6 @@ impl<W: oio::Write> oio::Write for LoggingWriter<W> {
}
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
let size = bs.len();
match self.inner.append(bs).await {
Ok(_) => {
self.written += size as u64;
trace!(
target: LOGGING_TARGET,
"service={} operation={} path={} written={} -> data write {}B",
self.scheme,
WriteOperation::Append,
self.path,
self.written,
size
);
Ok(())
}
Err(err) => {
if let Some(lvl) = self.failure_level {
log!(
target: LOGGING_TARGET,
lvl,
"service={} operation={} path={} written={} -> data write failed: {err:?}",
self.scheme,
WriteOperation::Append,
self.path,
self.written,
)
}
Err(err)
}
}
}

async fn abort(&mut self) -> Result<()> {
match self.inner.abort().await {
Ok(_) => {
Expand Down Expand Up @@ -1504,39 +1471,6 @@ impl<W: oio::BlockingWrite> oio::BlockingWrite for LoggingWriter<W> {
}
}

fn append(&mut self, bs: Bytes) -> Result<()> {
let size = bs.len();
match self.inner.append(bs) {
Ok(_) => {
self.written += size as u64;
trace!(
target: LOGGING_TARGET,
"service={} operation={} path={} written={} -> data write {}B",
self.scheme,
WriteOperation::BlockingAppend,
self.path,
self.written,
size
);
Ok(())
}
Err(err) => {
if let Some(lvl) = self.failure_level {
log!(
target: LOGGING_TARGET,
lvl,
"service={} operation={} path={} written={} -> data write failed: {err:?}",
self.scheme,
WriteOperation::BlockingAppend,
self.path,
self.written,
)
}
Err(err)
}
}
}

fn close(&mut self) -> Result<()> {
match self.inner.close() {
Ok(_) => Ok(()),
Expand Down
23 changes: 0 additions & 23 deletions core/src/layers/metrics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -925,18 +925,6 @@ impl<R: oio::Write> oio::Write for MetricWrapper<R> {
})
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
let size = bs.len();
self.inner
.append(bs)
.await
.map(|_| self.bytes += size as u64)
.map_err(|err| {
self.handle.increment_errors_total(self.op, err.kind());
err
})
}

async fn abort(&mut self) -> Result<()> {
self.inner.abort().await.map_err(|err| {
self.handle.increment_errors_total(self.op, err.kind());
Expand Down Expand Up @@ -964,17 +952,6 @@ impl<R: oio::BlockingWrite> oio::BlockingWrite for MetricWrapper<R> {
})
}

fn append(&mut self, bs: Bytes) -> Result<()> {
let size = bs.len();
self.inner
.append(bs)
.map(|_| self.bytes += size as u64)
.map_err(|err| {
self.handle.increment_errors_total(self.op, err.kind());
err
})
}

fn close(&mut self) -> Result<()> {
self.inner.close().map_err(|err| {
self.handle.increment_errors_total(self.op, err.kind());
Expand Down
16 changes: 0 additions & 16 deletions core/src/layers/minitrace.rs
Original file line number Diff line number Diff line change
Expand Up @@ -337,16 +337,6 @@ impl<R: oio::Write> oio::Write for MinitraceWrapper<R> {
.await
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner
.append(bs)
.in_span(Span::enter_with_parent(
WriteOperation::Append.into_static(),
&self.span,
))
.await
}

async fn abort(&mut self) -> Result<()> {
self.inner
.abort()
Expand Down Expand Up @@ -375,12 +365,6 @@ impl<R: oio::BlockingWrite> oio::BlockingWrite for MinitraceWrapper<R> {
self.inner.write(bs)
}

fn append(&mut self, bs: Bytes) -> Result<()> {
let _span =
Span::enter_with_parent(WriteOperation::BlockingAppend.into_static(), &self.span);
self.inner.append(bs)
}

fn close(&mut self) -> Result<()> {
let _span =
Span::enter_with_parent(WriteOperation::BlockingClose.into_static(), &self.span);
Expand Down
8 changes: 0 additions & 8 deletions core/src/layers/oteltrace.rs
Original file line number Diff line number Diff line change
Expand Up @@ -339,10 +339,6 @@ impl<R: oio::Write> oio::Write for OtelTraceWrapper<R> {
self.inner.write(bs).await
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs).await
}

async fn abort(&mut self) -> Result<()> {
self.inner.abort().await
}
Expand All @@ -357,10 +353,6 @@ impl<R: oio::BlockingWrite> oio::BlockingWrite for OtelTraceWrapper<R> {
self.inner.write(bs)
}

fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs)
}

fn close(&mut self) -> Result<()> {
self.inner.close()
}
Expand Down
33 changes: 0 additions & 33 deletions core/src/layers/prometheus.rs
Original file line number Diff line number Diff line change
Expand Up @@ -720,23 +720,6 @@ impl<R: oio::Write> oio::Write for PrometheusMetricWrapper<R> {
})
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
let size = bs.len();
self.inner
.append(bs)
.await
.map(|_| {
self.stats
.bytes_total
.with_label_values(&[&self.scheme, Operation::Write.into_static()])
.observe(size as f64)
})
.map_err(|err| {
self.stats.increment_errors_total(self.op, err.kind());
err
})
}

async fn abort(&mut self) -> Result<()> {
self.inner.abort().await.map_err(|err| {
self.stats.increment_errors_total(self.op, err.kind());
Expand Down Expand Up @@ -769,22 +752,6 @@ impl<R: oio::BlockingWrite> oio::BlockingWrite for PrometheusMetricWrapper<R> {
})
}

fn append(&mut self, bs: Bytes) -> Result<()> {
let size = bs.len();
self.inner
.append(bs)
.map(|_| {
self.stats
.bytes_total
.with_label_values(&[&self.scheme, Operation::BlockingWrite.into_static()])
.observe(size as f64)
})
.map_err(|err| {
self.stats.increment_errors_total(self.op, err.kind());
err
})
}

fn close(&mut self) -> Result<()> {
self.inner.close().map_err(|err| {
self.stats.increment_errors_total(self.op, err.kind());
Expand Down
35 changes: 0 additions & 35 deletions core/src/layers/retry.rs
Original file line number Diff line number Diff line change
Expand Up @@ -651,27 +651,6 @@ impl<R: oio::Write> oio::Write for RetryWrapper<R> {
}
}

async fn append(&mut self, bs: Bytes) -> Result<()> {
let mut backoff = self.builder.build();

loop {
match self.inner.append(bs.clone()).await {
Ok(v) => return Ok(v),
Err(e) if !e.is_temporary() => return Err(e),
Err(e) => match backoff.next() {
None => return Err(e),
Some(dur) => {
warn!(target: "opendal::service",
"operation={} path={} -> pager retry after {}s: error={:?}",
WriteOperation::Append, self.path, dur.as_secs_f64(), e);
tokio::time::sleep(dur).await;
continue;
}
},
}
}
}

async fn abort(&mut self) -> Result<()> {
let mut backoff = self.builder.build();

Expand Down Expand Up @@ -730,20 +709,6 @@ impl<R: oio::BlockingWrite> oio::BlockingWrite for RetryWrapper<R> {
.map_err(|e| e.set_persistent())
}

fn append(&mut self, bs: Bytes) -> Result<()> {
{ || self.inner.append(bs.clone()) }
.retry(&self.builder)
.when(|e| e.is_temporary())
.notify(move |err, dur| {
warn!(
target: "opendal::service",
"operation={} -> pager retry after {}s: error={:?}",
WriteOperation::BlockingAppend, dur.as_secs_f64(), err)
})
.call()
.map_err(|e| e.set_persistent())
}

fn close(&mut self) -> Result<()> {
{ || self.inner.close() }
.retry(&self.builder)
Expand Down
16 changes: 0 additions & 16 deletions core/src/layers/tracing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -344,14 +344,6 @@ impl<R: oio::Write> oio::Write for TracingWrapper<R> {
self.inner.write(bs).await
}

#[tracing::instrument(
parent = &self.span,
level = "trace",
skip_all)]
async fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs).await
}

#[tracing::instrument(
parent = &self.span,
level = "trace",
Expand All @@ -378,14 +370,6 @@ impl<R: oio::BlockingWrite> oio::BlockingWrite for TracingWrapper<R> {
self.inner.write(bs)
}

#[tracing::instrument(
parent = &self.span,
level = "trace",
skip_all)]
fn append(&mut self, bs: Bytes) -> Result<()> {
self.inner.append(bs)
}

#[tracing::instrument(
parent = &self.span,
level = "trace",
Expand Down
Loading