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

Code Quality: Convert into await using statement or declaration #15092

Open
gumbarros opened this issue Apr 1, 2024 · 10 comments
Open

Code Quality: Convert into await using statement or declaration #15092

gumbarros opened this issue Apr 1, 2024 · 10 comments
Labels
codebase quality Issues that are not bugs, but still might be worth improving (eg, code hygiene or maintainability)

Comments

@gumbarros
Copy link
Contributor

Description

using (var stream = File.OpenRead(_item.ItemPath))

to

await using (var stream = File.OpenRead(_item.ItemPath))					

In .NET, classes that own unmanaged resources usually implement the IDisposable interface to provide a mechanism for releasing unmanaged resources synchronously. However, in some cases they need to provide an asynchronous mechanism for releasing unmanaged resources in addition to (or instead of) the synchronous one. Providing such a mechanism enables the consumer to perform resource-intensive dispose operations without blocking the main thread of a GUI application for a long time.

The IAsyncDisposable.DisposeAsync method of this interface returns a ValueTask that represents the asynchronous dispose operation. Classes that own unmanaged resources implement this method, and the consumer of these classes calls this method on an object when it is no longer needed.

Source: https://stackoverflow.com/questions/58610350/what-is-the-difference-between-using-and-await-using-and-how-can-i-decide-which

Concerned code

Generated using Jetbrains Rider:

<platforms><Files.App>\Utils\Storage\StorageItems\VirtualStorageItem.cs (1 issue)
<platforms><Files.App>\Utils\Storage\StorageBaseItems\BaseStorageFile.cs (1 issue)
<platforms><Files.App>\Utils\Shell\LaunchHelper.cs (2 issues)
<platforms><Files.App>\Utils\Storage\StorageItems\ZipStorageFile.cs (7 issues)
<platforms><Files.App>\Utils\Storage\StorageItems\VirtualStorageFile.cs (4 issues)
<platforms><Files.App>\Utils\Storage\Operations\ShellFilesystemOperations.cs (4 issues)
<platforms><Files.App>\Utils\Storage\StorageItems\ZipStorageFolder.cs (9 issues)
<platforms><Files.App>\Utils\Storage\StorageItems\NativeStorageFile.cs (4 issues)
<platforms><Files.App>\Utils\Storage\StorageItems\SystemStorageFile.cs (9 issues)
<platforms><Files.App>\ViewModels\Properties\HashesViewModel.cs (1 issue)
<platforms><Files.App>\Utils\Storage\StorageItems\FtpStorageFile.cs (3 issues)
<platforms><Files.App>\Utils\Cloud\Detector\SynologyDriveCloudDetector.cs (3 issues)
<platforms><Files.App>\Utils\Cloud\Detector\GoogleDriveCloudDetector.cs (3 issues)
<platforms><Files.App>\Services\SideloadUpdateService.cs (2 issues)
<platforms><Files.App>\Services\UpdateService.cs (2 issues)
<platforms><Files.App>\Extensions\ImageSourceExtensions.cs (1 issue)

Gains

  • UI will not freeze while disposing a resource

Requirements

  • Convert all asynchronous using to async using

Comments

image

It's possible to make a single PR using this button :)

@gumbarros gumbarros added the codebase quality Issues that are not bugs, but still might be worth improving (eg, code hygiene or maintainability) label Apr 1, 2024
@0x5bfa
Copy link
Member

0x5bfa commented Apr 1, 2024

Out of curious, what IDE are you using?
I also wanna generate this list lol.

@gumbarros
Copy link
Contributor Author

gumbarros commented Apr 1, 2024

Out of curious, what IDE are you using? I also wanna generate this list lol.

Rider, but you can install ReSharper at VS to obtain the same result. You can get a free license if you are a FOSS contribuitor.

@0x5bfa
Copy link
Member

0x5bfa commented Apr 1, 2024

Oh they are kind. Why do you think those warnings won't be shown in VS2022 by default and what should we do to should those issues that would improve performance.

@0x5bfa
Copy link
Member

0x5bfa commented Apr 1, 2024

@yaira2 Can I use the name of Files Community for:
image

@gumbarros
Copy link
Contributor Author

Oh they are kind. Why do you think those warnings won't be shown in VS2022 by default and what should we do to should those issues that would improve performance.

I guess this is why JetBrains makes money lol, if VS showed these problems ReSharper wouldn't exist. Maybe because of some limitation?

Yair said about benchmarking, I think this is valid. There is also dozens of issues types when I run the analyzer, but I opened just the most importants, some of them I think they don't make sense, like var instead of the explicit type, not worth a PR.

image

@mafra99
Copy link
Contributor

mafra99 commented Apr 1, 2024

I'm not sure if Files counts as a project, since users have to pay for the version in the Microsoft Store

From here https://www.jetbrains.com/community/opensource/#support

image

@0x5bfa
Copy link
Member

0x5bfa commented Apr 1, 2024

That's absolutely right lol I was wondering why VS doesn't show warnings that comes from the official analyzers(IDE????, C????) while Rider shows. But I seemed to have misunderstood. Thanks.

Really nice features.

@gumbarros
Copy link
Contributor Author

I'm not sure if Files counts as a project, since users have to pay for the version in the Microsoft Store

From here https://www.jetbrains.com/community/opensource/#support

image

image
I saw some projects with "Thanks for JetBrains" at the end of the README file, maybe if you contact JetBrains sales they can make a exception for Files as this is a big project .

@0x5bfa
Copy link
Member

0x5bfa commented Apr 1, 2024

But that's for donation.

@yaira2
Copy link
Member

yaira2 commented Apr 1, 2024

I'm not sure if Files counts as a project, since users have to pay for the version in the Microsoft Store

I wouldn't consider the store version as commercial, the sideload version has all the same features and users get the same level of support. In fact, the sideload version has many times the number of users as the store version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codebase quality Issues that are not bugs, but still might be worth improving (eg, code hygiene or maintainability)
Projects
Status: 🆕 New
Development

No branches or pull requests

4 participants