[Sema] Diagnose exportability of decls limited by a non-public import #64014
Conversation
Using an access-level on imports limit how imported types can be used in API. This change extends TypeAccessScopeChecker to return both the access scope of the target type and any import that limits where it can be used. Diagnostics should use this information to raise errors and point to related imports.
xymus
requested review from
hborla,
slavapestov,
xedin and
AnthonyLatsis
as code owners
|
@swift-ci Please smoke test |
| private import PrivateLib // expected-note 2 {{module 'PrivateLib' imported as 'private' here}} | ||
|
|
||
| /// Simple ordering | ||
| public func publicFuncUsesPrivate(_ a: PublicImportType, b: PackageImportType, c: InternalImportType, d: FileprivateImportType, e: PrivateImportType) { // expected-error {{function cannot be declared public because its parameter uses a private type}} |
There was a problem hiding this comment.
Does this diagnostic indicate which type is the problematic type? I ask because I'm not sure if this only matches a fragment of the diagnostic.
There was a problem hiding this comment.
That's the whole text of the error, the problematic type is highlighted. I tested the highlights manually as I don't think we have a way to represent them in the verify mode yet, but that would be useful.
There was a problem hiding this comment.
Got it, I suppose a highlight makes it clear enough.
There was a problem hiding this comment.
Actually, after that error there is also a note pointing to the type definition. From the command line it would tell the type name clearly, from the IDE probably not that much but the highlight does a decent job there.
And then there's the note on the import if it lowered the access level of the problematic type.
Check the API of decls to ensure that imported types are only used in decls with compatible access-level. For example, error on using a type import as internal in a public function, but allow it in internal functions and lower. This change raises errors on wrongful use of types limited by an import and offers a note pointing to the import that did limit the imported type.
xymus
force-pushed
the
access-level-import
branch
from
c896208 to
75255d1
Compare
|
@swift-ci Please smoke test |
|
@swift-ci Please smoke test macOS |
As part of access-level checks, ensure that types imported with a non-public access level are only used in decls with a compatible access-level. For example, we want to error on using a type imported as internal in a public function signature, but allow it in internal functions and lower, as well as allowing it in function bodies.
This change raises errors on wrongful use of types limited by an import and offers a note pointing to the import that did limit the imported type. This affects slightly previous diagnostics when the was wrongful use of a private and a fileprivate type in the same signature, diagnostics now strictly prefer to report the private type even if they both have a file-wide scope.