Missing ConfigureAwait in TcpClientAdapter

[danielmarbach]

Proposed Changes

Types of Changes

What types of changes does your code introduce to this project?
Put an x in the boxes that apply

• Bug fix (non-breaking change which fixes issue #NNNN)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause an observable behavior change in existing systems)
• Documentation improvements (corrections, new content, etc)
• Cosmetic change (whitespace, formatting, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask on the
mailing list. We're here to help! This is simply a reminder of what we are
going to look for before merging your code.

• I have read the CONTRIBUTING.md document
• I have signed the CA (see https://cla.pivotal.io/sign/rabbitmq)
• All tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)
• Any dependent changes have been merged and published in related repositories

Further Comments

@bording I also saw this

#if NET461
            await Task.Run(() => _sock.Connect(ep, port)).ConfigureAwait(false);
#else
            await _sock.ConnectAsync(ep, port).ConfigureAwait(false);
#endif

any reasons why we are not using

#if NETFRAMEWORK
            await Task.Run(() => _sock.Connect(ep, port)).ConfigureAwait(false);
#else
            await _sock.ConnectAsync(ep, port).ConfigureAwait(false);
#endif

and then what I also wondered is if the else case ever exists? I can't find that method overload. Judging by the history it started with

https://github.com/rabbitmq/rabbitmq-dotnet-client/blame/696ed9be4e337f8472b32f85bd95bc46a48ca781/projects/client/RabbitMQ.Client/src/client/impl/TcpClientAdapter.cs#L35-L39

Any ideas? Something seems off

[bording]

@danielmarbach The else case is an extension method from the SocketTaskExtensions class which is in net471+. That's why the ifdef is currently targeting net461. If the target framework is changed/updated, the new method will be used even if the ifdef was overlooked.

[sungam3r]

Is there any difference in using ConfigureAwait(false) at the end of the method? After all, after this line there is no code and there is no next step of the state machine. Or am I missing something?

[danielmarbach]

There is no difference. Context capturing is applied to the continuation which is the end of the method. Though in general libs that don't need context capture should always opt out for every await. It would be best to even enable i.ex. Fxcop even if only https://docs.microsoft.com/en-us/visualstudio/code-quality/ca2007?view=vs-2019 is activated

[sungam3r]

OK. Also I use ca2007 in everyday work. I have to always disable its warnings for test projects.