Make sure CheckAndThrow is invoked only within ambient Cancellable context

[majocha]

See: #18002 (comment)

Basically, when Cancelable.CheckAndThrow() throws the exception, we don't want the exception to leak.
It should be caught inside Cancellable.run here:

fsharp/src/Compiler/Utilities/Cancellable.fs

Lines 44 to 52 in e44ae1d

	let inline run (ct: CancellationToken) (Cancellable oper) =
	if ct.IsCancellationRequested then
	ValueOrCancelled.Cancelled(OperationCanceledException ct)
	else
	try
	use _ = Cancellable.UsingToken(ct)
	oper ct
	with :? OperationCanceledException as e ->
	ValueOrCancelled.Cancelled(OperationCanceledException e.CancellationToken)

The idea of CheckAndThrow is that it is invoked from code that is unaware of Cancellable CE somewhere deeper on the callstack.
This PR checks the static AsyncLocal<CancellationToken voption> token. If it is default VNone, we know the invocation is outside of Cancellable. If there is a token present, we know Cancellable.run deeper on the stack has set it and we're good.

TODO: fix ModuleReaderCancellationTests.

cc @auduchinok

[github-actions]

❗ Release notes required

@majocha,

Caution

No release notes found for the changed paths (see table below).

Please make sure to add an entry with an informative description of the change as well as link to this pull request, issue and language suggestion if applicable. Release notes for this repository are based on Keep A Changelog format.

The following format is recommended for this repository:

* <Informative description>. ([PR #XXXXX](https://github.com/dotnet/fsharp/pull/XXXXX))

See examples in the files, listed in the table below or in th full documentation at https://fsharp.github.io/fsharp-compiler-docs/release-notes/About.html.

If you believe that release notes are not necessary for this PR, please add NO_RELEASE_NOTES label to the pull request.

You can open this PR in browser to add release notes: open in github.dev

Change path	Release notes path	Description
src/Compiler	docs/release-notes/.FSharp.Compiler.Service/9.0.200.md	No release notes found or release notes format is not correct

[majocha]

This just installs the check globally for the whole test run.

[auduchinok]

Maybe it'd make sense to have this assert not in the tests only? I can imagine some FCS APIs that may trigger analysis and that don't take a cancellation token. If there're no tests for such APIs, it's going to be very difficult to uncover these, as they'd only manifest themself when cancelled at some unfortunate moment. The sooner we catch all these exceptions, the better.

Maybe we could have some global property or other way to control it. With this way we'd enable these asserts in the internal and EAP Rider builds, but could turn it off just in case in the release ones, at least for the time being.

[majocha]

TBH my initial thought was to just put a hard failwith where the assert is. It would surface as a internal error (see the failing tests) if CheckAndThrow is misused anywhere. This would be immediately discoverable.

[majocha]

Added DISABLE_CHECKANDTHROW_ASSERT env variable that can be set in case of emergencies.

[psfinaki]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[psfinaki]

@majocha do I get it right that the TODO in the description is already done?

[majocha]

@majocha do I get it right that the TODO in the description is already done?

Yes, forgot to edit this.