53,715

Downloads

851

Downloads of v 1.1.5

69

Average downloads per day

2017-02-21

Last published

Share on Social Networks

AsyncFixer

1.1.5

AsyncFixer helps developers in finding and correcting common async/await misuses (anti-patterns). AsyncFixer was tested with hundreds of open-source C# apps and successfully handles many corner cases. Here are anti-patterns that AsyncFixer can detect:

1) AsyncFixer01: Unnecessary async/await Methods

There are some async methods where there is no need to use async/await keywords. It is important to detect this kind of misuse because adding the async modifier comes at a price. AsyncFixer automatically removes async/await keywords from those methods.

2) AsyncFixer02: Using Long-running Operations under Async Methods

Developers use some potentially long running or blocking operations under async methods even though there are corresponding asynchronous versions of these methods in .NET or third-party libraries. Some example for such operations: Task.Wait(), Task.Result, Task.WaitAll(...), StreamReader.ReadToEnd(...), Thread.Sleep(...), etc.

AsyncFixer automatically replaces these operations with their corresponding asynchronous operations and inserts 'await' expression. For instance, it converts 'Thread.Sleep(...)' to 'await Task.Delay(...)'.

3) AsyncFixer03: Fire & Forget Async Void Methods

Some async methods are 'fire & forget', which return void. Unless a method is only called as an event handler, it must be awaitable. Otherwise, it is a code smell because it complicates control flow and makes error detection & correction difficult.

4) AsyncFixer04: Fire & Forget Async Call In the Using Block

In an using block, developers use a fire & forget async call which uses disposable object as a parameter or target object. It can cause potential exception or wrong result. For instance, developers create a Stream in the using statement, pass it to the asynchronous method, and then stream will be implicitly disposed via using block. When the asynchronous method comes around to writing to the Stream, it is (very likely) already disposed and you will have an exception.

5) AsyncFixer05: Implicit Downcasting from Task<T> to Task

Implicit downcasting from Task<T> to Task is dangerous. There is no efficient way to get the result of the Task<T> after downcasting. It is even more dangerous to downcast from Task<Task> to Task.

Usage:

The nuget package will work as a project-local analyzer that participates in builds. Attaching an analyzer to a project means that the analyzer travels with the project to source control and so it is easy to apply the same rule for the team. It also means that commandline builds report the issues reported by the analyzer. Download the nuget package from here: https://www.nuget.org/packages/AsyncFixer

If you want AsyncFixer to work just in the IDE and to work as an analyzer on every project you open in Visual Studio, please download the VSIX extension instead of this nuget package from here: https://visualstudiogallery.msdn.microsoft.com/03448836-db42-46b3-a5c7-5fc5d36a8308

Notes:

- The detection and fixing of more concurrency anti-patterns are being implemented.

- Please send your bug report or feedback to semih.okur@gmail.com

- Learn more information about these misuses from our website: LearnAsync.NET

To install AsyncFixer, run the following command in the Package Manager Console

Install-Package AsyncFixer

Release Notes

v1.1.5 @ 02.20.2017: Added a license. Changed nuspec as a development dependency. Fixed several bugs in fixing anti-patterns.
v1.1.4 @ 09.06.2016: Fixed false positives.
v1.1.3 @ 03.22.2016: Depending on CodeAnalysis 1.0.0 instead of 1.1.1 due to compatibility issues for some users.
v1.1.2 @ 03.21.2016: Fixed false positives for new analyzers.
v1.1.0 @ 03.13.2016: Added 2 new code analyzers and improved accuracy of existing analyzers.
v1.0.0 @ 07.29.2015: 3 code analyzers to detect and fix very common async anti-patterns.

Owners

Authors

Semih Okur

Copyright

Copyright (c) AsyncFixer 2015-2017

Tags

Dependencies

This package has no dependencies.

Version History

Version Downloads Last updated
AsyncFixer 1.1.4 3,273 Tuesday, September 6, 2016
AsyncFixer 1.1.3 48,238 Wednesday, March 23, 2016
AsyncFixer 1.1.2 93 Monday, March 21, 2016
AsyncFixer 1.1.1 112 Saturday, March 19, 2016
AsyncFixer 1.1.0 114 Sunday, March 13, 2016
AsyncFixer 1.0.0 622 Wednesday, July 29, 2015
AsyncFixer 0.9.0 412 Saturday, February 14, 2015