Skip to content

[APINotes] Protocols cannot use import-as-member. #4484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

jrose-apple
Copy link
Contributor

@jrose-apple jrose-apple commented Aug 24, 2016

  • Explanation: The import-as-member feature we use with Core Graphics and some other frameworks causes problems when the context being imported onto is a protocol, resulting in crashes when such decls were referenced. This patch disallows protocols as import-as-member contexts and removes the problematic cases where we were doing this for the new CryptoTokenKit framework.
  • Scope: API notes change only affects CryptoTokenKit. Importer change should affect nobody now, but it will keep us from introducing this in the future…though in theory someone could be using this feature and getting away with it. (It only crashes in certain circumstances.)
  • Issue: rdar://problem/27990168
  • Reviewed by: @milseman
  • Risk: Very low.
  • Testing: Verified that with this change the original CryptoTokenKit API notes produced a warning when the module was imported, then ran through all frameworks with API notes and verified that no other warnings were produced.

Before merging this pull request to apple/swift repository:

  • Test pull request on Swift continuous integration.

Triggering Swift CI

The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:

Smoke Testing

Platform Comment
All supported platforms @swift-ci Please smoke test
All supported platforms @swift-ci Please smoke test and merge
OS X platform @swift-ci Please smoke test OS X platform
Linux platform @swift-ci Please smoke test Linux platform

A smoke test on macOS does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library only for macOS. Simulator standard libraries and
    device standard libraries are not built.
  3. lldb is not built.
  4. The test and validation-test targets are run only for macOS. The optimized
    version of these tests are not run.

A smoke test on Linux does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library incrementally.
  3. lldb is built incrementally.
  4. The swift test and validation-test targets are run. The optimized version of these
    tests are not run.
  5. lldb is tested.

Validation Testing

Platform Comment
All supported platforms @swift-ci Please test
All supported platforms @swift-ci Please test and merge
OS X platform @swift-ci Please test OS X platform
OS X platform @swift-ci Please benchmark
Linux platform @swift-ci Please test Linux platform

Lint Testing

Language Comment
Python @swift-ci Please Python lint

Note: Only members of the Apple organization can trigger swift-ci.

@jrose-apple jrose-apple added this to the Swift 3.0 milestone Aug 24, 2016
@jrose-apple
Copy link
Contributor Author

@swift-ci Please test OS X platform

@swift-ci
Copy link
Contributor

Build failed
Jenkins build - Swift Test OS X Platform
Git Commit - 1bf3d38ddcf68449c5251c3d8600a95084e135d2
Test requested by - @jrose-apple

@jrose-apple jrose-apple force-pushed the swift-3.0-protocols-cannot-import-as-member branch from 1bf3d38 to 99c7b0f Compare August 24, 2016 22:02
@jrose-apple
Copy link
Contributor Author

@swift-ci Please test OS X platform

@jrose-apple
Copy link
Contributor Author

(test here)

@swift-ci
Copy link
Contributor

Build failed
Jenkins build - Swift Test OS X Platform
Git Commit - 1bf3d38ddcf68449c5251c3d8600a95084e135d2
Test requested by - @jrose-apple

We could support this in the future but right now it's causing problems.
There's also a potential ambiguity issue here where a protocol and class
could have the same name.

In addition to updating the importer, remove the two entries from the
CryptoTokenKit API notes that were trying to use this feature.

rdar://problem/27990168
@jrose-apple jrose-apple force-pushed the swift-3.0-protocols-cannot-import-as-member branch from 99c7b0f to 6a9540f Compare August 24, 2016 22:22
@jrose-apple
Copy link
Contributor Author

@swift-ci Please test OS X platform

@jrose-apple
Copy link
Contributor Author

@jrose-apple
Copy link
Contributor Author

Tests passed.

@jrose-apple jrose-apple merged commit 111db9e into swiftlang:swift-3.0-branch Aug 24, 2016
@jrose-apple jrose-apple deleted the swift-3.0-protocols-cannot-import-as-member branch August 24, 2016 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants