Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[SR-15982] SymbolKit crashes when encoding unknown mixins #174

Closed
franklinsch opened this issue Mar 15, 2022 · 3 comments · Fixed by swiftlang/swift-docc-symbolkit#39 or #369
Closed

[SR-15982] SymbolKit crashes when encoding unknown mixins #174

franklinsch opened this issue Mar 15, 2022 · 3 comments · Fixed by swiftlang/swift-docc-symbolkit#39 or #369
Assignees
@Kyle-Ye
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@franklinsch
Copy link
Contributor

Previous ID SR-15982
Radar rdar://problem/90348996
Original Reporter @franklinsch
Type Improvement
Additional Detail from JIRA
Votes 0
Component/s Swift-DocC
Labels Improvement
Assignee None
Priority Medium

md5: 7a780d28224eef5a62504852074094c5

Issue Description:

SymbolKit decodes unknown Symbol mixins just fine by adding them to Symbol.mixins, but {{fatalError}}s when encoding unknown mixins: https://github.com/apple/swift-docc-symbolkit/blob/main/Sources/SymbolKit/SymbolGraph/Symbol/Symbol.swift#L180.

For example, when decoding a symbol graph from the Swift compiler (which includes the location mixin) and encoding it back, SymbolKit crashes.

We should make SymbolKit encode unknown mixins.
@franklinsch
Copy link
Contributor Author

@swift-ci create

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from swiftlang/swift May 3, 2022
@theMomax
Copy link
Contributor

theMomax commented Oct 2, 2022

This issue was solved by swiftlang/swift-docc-symbolkit#39.

This was linked to pull requests Oct 5, 2022
Make Symbol Graph Format Extensible swiftlang/swift-docc-symbolkit#39
Merged
Extensions to External Types (Hierarchical) #369
Merged
@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Oct 5, 2022

apple/swift-docc-symbolfix#39 fix the issue in the upstream.
#369 update the SymbolKit dependency commit in swift-docc.

@Kyle-Ye Kyle-Ye closed this as completed Oct 5, 2022
@Kyle-Ye Kyle-Ye self-assigned this Oct 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kyle-Ye Kyle-Ye

Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Milestone
No milestone
4 participants
@ethan-kusters @franklinsch @theMomax @Kyle-Ye