refactor(error): improve error messages and file handling #334

simonsan · 2024-10-14T16:02:46Z

Create parent directory if it does not exist before opening the file for writing.

simonsan · 2024-10-14T21:25:02Z

I kept:

        for i in 0u8..=255 {
            let filename = self.path.join("data").join(hex::encode([i]));
            fs::create_dir_all(&filename).map_err(|err| {
                LocalBackendErrorKind::DirectoryCreationFailed {
                    path: filename.clone(),
                    source: err,
                }
            })?;
        }

as that impacts compatibility with restic, and a repository without that, wouldn't be able to be read by it. Hence, I thought, we keep that, but we make sure, that also without these directories (in case someone deletes them), we are able to create and write to these directories. Not sure, how else we could handle that.

aawsome

Good catch!
I have just found a small thing I would change in this PR...

aawsome · 2024-10-16T12:30:24Z

crates/backend/src/local.rs

    fn write_bytes(&self, tpe: FileType, id: &Id, _cacheable: bool, buf: Bytes) -> Result<()> {
        trace!("writing tpe: {:?}, id: {}", &tpe, &id);
        let filename = self.path(tpe, id);
+
+        // create parent directory if it does not exist
+        if let Some(parent) = filename.parent() {


I would make a method parent_path and then just use self.parent_path(tpe,id) here.

Added! Not sure how we would handle a non-existing parent? e.g. in a root path, that should never happen right? Or do you have another idea?

Actually I thought about having something along the fn path, but just without the last join. We know there is a parent because we just create paths which do have a parent. My idea was just about removing the error handling which will never be called.

codecov · 2024-10-16T13:15:18Z

Codecov Report

Attention: Patch coverage is 40.00000% with 3 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@171e2aa). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
crates/core/src/commands/check.rs	40.0%	3 Missing ⚠️

Additional details and impacted files

Files with missing lines	Coverage Δ
crates/backend/src/local.rs	`0.0% <ø> (ø)`
crates/core/src/commands/check.rs	`65.4% <40.0%> (ø)`

- Update error messages for file operations in the `LocalBackendErrorKind` enum. - Refactor the `ReadBackend` and `WriteBackend` implementations in the `LocalBackend` module to handle file opening errors more accurately. - Add error variants `OpeningFileForPartialReadingFailed` and `OpeningFileForWritingFailed` to provide specific information about file opening failures. - Create parent directory if it does not exist before opening the file for writing. Fixes #rustic-rs/rustic#1315 Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

nardoor

Hello,

Looks good to me!
Just one question about an error log.

crates/core/src/commands/check.rs

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

## 🤖 New release * `rustic_backend`: 0.4.2 -> 0.5.0 (⚠️ API breaking changes) * `rustic_core`: 0.5.5 -> 0.6.0 (⚠️ API breaking changes) * `rustic_testing`: 0.2.3 -> 0.3.0 (✓ API compatible changes) ### ⚠️ `rustic_backend` breaking changes ``` --- failure enum_missing: pub enum removed or renamed --- Description: A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/enum_missing.ron Failed in: enum rustic_backend::error::LocalBackendErrorKind, previously in file /tmp/.tmp0sSY8G/rustic_backend/src/error.rs:90 enum rustic_backend::error::RestErrorKind, previously in file /tmp/.tmp0sSY8G/rustic_backend/src/error.rs:67 enum rustic_backend::error::BackendAccessErrorKind, previously in file /tmp/.tmp0sSY8G/rustic_backend/src/error.rs:10 enum rustic_backend::error::RcloneErrorKind, previously in file /tmp/.tmp0sSY8G/rustic_backend/src/error.rs:43 --- failure module_missing: pub module removed or renamed --- Description: A publicly-visible module cannot be imported by its prior path. A `pub use` may have been removed, or the module may have been renamed, removed, or made non-public. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/module_missing.ron Failed in: mod rustic_backend::error, previously in file /tmp/.tmp0sSY8G/rustic_backend/src/error.rs:1 ``` ### ⚠️ `rustic_core` breaking changes ``` --- failure inherent_method_missing: pub method removed or renamed --- Description: A publicly-visible method or associated fn is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/inherent_method_missing.ron Failed in: LocalDestination::remove_dir, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:129 LocalDestination::remove_file, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:152 LocalDestination::create_dir, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:171 LocalDestination::set_times, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:189 LocalDestination::set_user_group, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:237 LocalDestination::set_uid_gid, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:283 LocalDestination::set_permission, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:324 LocalDestination::set_extended_attributes, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:385 LocalDestination::set_length, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:466 LocalDestination::create_special, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:521 LocalDestination::read_at, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:599 LocalDestination::write_at, previously in file /tmp/.tmp0sSY8G/rustic_core/src/backend/local_destination.rs:663 RusticError::into_inner, previously in file /tmp/.tmp0sSY8G/rustic_core/src/error.rs:46 RusticError::backend_error, previously in file /tmp/.tmp0sSY8G/rustic_core/src/error.rs:61 ``` <details><summary>Changelog</summary> ## `rustic_backend` <blockquote> ## [0.5.0](rustic_backend-v0.4.2...rustic_backend-v0.5.0) - 2024-11-18 ### Added - *(async)* add `async_compatible` methods to identify backend compatibility ([#355](#355)) - add 'yandex-disk' to enabled opendal services and update opendal to 0.50.2 ([#360](#360)) ### Other - *(error)* enhance error logging and output formatting ([#361](#361)) - *(backend)* simplify code in local backend ([#362](#362)) - *(backend)* migrate from `backoff` to `backon` ([#356](#356)) - *(error)* improve error messages and file handling ([#334](#334)) - *(deps)* lock file maintenance rust dependencies ([#345](#345)) - *(deps)* [**breaking**] upgrade to new conflate version ([#300](#300)) - *(errors)* [**breaking**] Improve error handling, display and clean up codebase ([#321](#321)) </blockquote> ## `rustic_core` <blockquote> ## [0.6.0](rustic_core-v0.5.5...rustic_core-v0.6.0) - 2024-11-18 ### Added - *(async)* add `async_compatible` methods to identify backend compatibility ([#355](#355)) ### Fixed - prevent overwriting hot repository on init ([#353](#353)) ### Other - *(error)* enhance error logging and output formatting ([#361](#361)) - *(deps)* remove Derivative and replace with Default impl due to RUSTSEC-2024-0388 ([#359](#359)) - *(error)* improve error messages and file handling ([#334](#334)) - *(deps)* lock file maintenance rust dependencies ([#345](#345)) - *(deps)* remove cdc and switch to rustic_cdc ([#348](#348)) - *(deps)* [**breaking**] upgrade to new conflate version ([#300](#300)) - *(errors)* [**breaking**] Improve error handling, display and clean up codebase ([#321](#321)) </blockquote> ## `rustic_testing` <blockquote> ## [0.3.0](rustic_testing-v0.2.3...rustic_testing-v0.3.0) - 2024-11-18 ### Added - *(async)* add `async_compatible` methods to identify backend compatibility ([#355](#355)) ### Other - *(errors)* [**breaking**] Improve error handling, display and clean up codebase ([#321](#321)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). Co-authored-by: rustic-release-plz[bot] <182542030+rustic-release-plz[bot]@users.noreply.github.com>

simonsan added A-errors Area: error handling needs improvement C-refactor Category: Refactoring of already existing code labels Oct 14, 2024

simonsan requested a review from aawsome October 14, 2024 16:03

simonsan added the S-waiting-for-review Status: PRs waiting for review label Oct 14, 2024

aawsome requested changes Oct 16, 2024

View reviewed changes

simonsan requested a review from aawsome October 16, 2024 13:30

simonsan added S-blocked Status: Blocked from merging/working on due to some issue and removed S-waiting-for-review Status: PRs waiting for review labels Oct 24, 2024

simonsan marked this pull request as draft October 24, 2024 01:19

simonsan mentioned this pull request Oct 25, 2024

refactor(errors)!: improve RusticError display and usage #321

Merged

9 tasks

simonsan added this to the NEXT milestone Oct 30, 2024

simonsan added 4 commits November 17, 2024 02:39

log error when pack file cannot be found instead of panicking

fb0f1e1

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

add method from review

95c675f

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

refactoring to option instead of result

0583d0a

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

simonsan force-pushed the fix/create-directories branch from c186960 to 0583d0a Compare November 17, 2024 02:09

simonsan marked this pull request as ready for review November 17, 2024 02:09

simonsan removed the S-blocked Status: Blocked from merging/working on due to some issue label Nov 17, 2024

simonsan requested review from aawsome and removed request for aawsome November 17, 2024 02:12

simonsan added the S-waiting-for-review Status: PRs waiting for review label Nov 17, 2024

Merge branch 'main' into fix/create-directories

1443a6b

nardoor previously approved these changes Nov 17, 2024

View reviewed changes

crates/core/src/commands/check.rs Show resolved Hide resolved

simonsan added 2 commits November 17, 2024 20:50

Merge branch 'main' into fix/create-directories

1701893

change error message and add note for error handling

8f78c33

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

simonsan dismissed nardoor’s stale review via 8f78c33 November 17, 2024 20:00

simonsan added 2 commits November 18, 2024 03:29

Merge branch 'main' into fix/create-directories

f9b771a

Merge branch 'main' into fix/create-directories

b53ed8c

simonsan merged commit 749879f into main Nov 18, 2024
20 checks passed

simonsan deleted the fix/create-directories branch November 18, 2024 03:15

rustic-release-plz bot mentioned this pull request Nov 18, 2024

chore: release #354

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(error): improve error messages and file handling #334

refactor(error): improve error messages and file handling #334

simonsan commented Oct 14, 2024 •

edited

Loading

simonsan commented Oct 14, 2024

aawsome left a comment

aawsome Oct 16, 2024

simonsan Oct 16, 2024 •

edited

Loading

aawsome Nov 18, 2024

codecov bot commented Oct 16, 2024 •

edited

Loading

nardoor left a comment

refactor(error): improve error messages and file handling #334

refactor(error): improve error messages and file handling #334

Conversation

simonsan commented Oct 14, 2024 • edited Loading

simonsan commented Oct 14, 2024

aawsome left a comment

Choose a reason for hiding this comment

aawsome Oct 16, 2024

Choose a reason for hiding this comment

simonsan Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

aawsome Nov 18, 2024

Choose a reason for hiding this comment

codecov bot commented Oct 16, 2024 • edited Loading

Codecov Report

nardoor left a comment

Choose a reason for hiding this comment

simonsan commented Oct 14, 2024 •

edited

Loading

simonsan Oct 16, 2024 •

edited

Loading

codecov bot commented Oct 16, 2024 •

edited

Loading