[Executors] Do not consider Loc validity in determining to emit error/warning about enqueue(_:) #67957
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ror if all implementations are "default from stdlib" because end-user MUST implement at least one of them
ktoso
requested review from
kavon,
hborla,
slavapestov and
xedin
as code owners
ktoso
commented
Aug 16, 2023
…er them The standard library's enqueue() does not play by the same rules -- we provide "deprecated" implementations in order to remain source/binary compatible, and showing warnings about this when users make mistake will only be misleading.
ktoso
commented
Aug 16, 2023
| auto extensionModule = extension->getParentModule(); | ||
| if (extensionModule != concurrencyModule) { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
This is important because otherwise user code would be getting non-actionable and very confusing warnings about the standard library.
ktoso
commented
Aug 16, 2023
|
|
||
|
|
||
| extension Executor { | ||
| func enqueue(_ job: UnownedJob) { // expected-warning{{'Executor.enqueue(UnownedJob)' is deprecated as a protocol requirement; conform type 'NoneExecutor' to 'Executor' by implementing 'func enqueue(ExecutorJob)' instead}} |
There was a problem hiding this comment.
Now that we prevent warnings about the "default implementations in the stdlib" on purpose by looking for it, rather than relying on the LoC check, we add this test to make sure we've not accidentally prevented those warnings we DO want to emit -- whenever anything other than the Concurrency module does implement these.
ktoso
commented
Aug 16, 2023
| @@ -1,12 +1,9 @@ | |||
| // RUN: %target-typecheck-verify-swift -enable-experimental-move-only -disable-availability-checking | |||
There was a problem hiding this comment.
✅ the flag is not doing anything anymore -> remove
ktoso
commented
Aug 16, 2023
| // REQUIRES: concurrency | ||
|
|
||
| // rdar://106849189 move-only types should be supported in freestanding mode | ||
| // UNSUPPORTED: freestanding | ||
|
|
||
| // FIXME: rdar://107112715 test failing on iOS simulator, investigating |
There was a problem hiding this comment.
✅ radar was resolved resolved a while ago
ktoso
force-pushed
the
wip-dont-use-loc-validness-in-diagnostics-determination-113913291
branch
from
9b33435 to
5e43ba9
Compare
|
@swift-ci please test |
ktoso
added
the
concurrency
ktoso
deleted the
wip-dont-use-loc-validness-in-diagnostics-determination-113913291
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description: The introduction of new protocol requirements in
protocol Executorrequired careful and custom handling by the compiler in order to not break ABI/API. This logic made a wrong assumption that it can rely on valid/invalid source location information to determine if "this decl exists and is valid" -- while in reality, we cannot rely on loc at all for making this decision. This happened to work in tests and swiftpm projects because source location was always available.Symbols may not have valid loc attached just because they're in a different module and we don't have swiftsourceinfo for them. E.g. with Xcode the Archive action does not copy the swiftsourceinfo and thus we end up ALWAYS emitting the error that an implementation is missing -- even if it is there, but we simply trigger the "illegal loc!" case incorrectly.
Solution: Stop relying on the incorrect assumption that a "valid loc" can be used to determine if we have the method or not. This worked by accident, since in swift the unit test suite we entered this missing loc code path.
Instead, we must manually inspect the witnesses and determine that at least one of them is NOT the default implementation provided in the stdlib (because we implement ALL of the requirements in order to introduce the new protocol requirement without breaking API/ABI). The same goes about warnings, since we do not want to emit warnings about the standard library when end-users do something slightly wrong in their adoption -- it is their conformance mistake we must warn about.
Risk: Low
Risk details: The primary error fix is about removing the use of loc information entirely from decision making about emitting errors, i.e. we're removing a buggy source of information from the decision making -- the primary logic all remains the same.
Due to that removal, we also add some warning suppression that previously occurred naturally (correctly "by accident"), by concretely handling the special casing of the concrete extension in
_Concurrencymodule that performs actions we should not warn about in stdlib due to it implementing bin-compat concerns.Reward: Medium,
Reward details: Projects built in a way where
swiftsourceinfois not available (e.g. in Xcode by running "Archive") are now able to adopt libraries that adopted custom executors -- e.g. like Swift NIO. The reward is medium because custom executor adoption in this pattern isn't quite wide-spread yet.Review by: @DougGregor @owenv
Testing: Warnings and errors emitted by this are well tested; We also verified a known reproducer using Xcode and "Archive" action is resolved by a compiler with this fix.
Scope: This is a compiler only change.
Radar: rdar://113913291