Avoid full URL parsing to trim a known prefix from a reference string #1323
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
|
@swift-ci please test |
anferbui
approved these changes
Oct 21, 2025
| let linkString = unresolvedReference.topicURL.url.withoutHostAndPortAndScheme().standardized.absoluteString | ||
| let linkString = String( | ||
| unresolvedReferenceString.dropFirst(6) // "doc://" | ||
| .drop(while: { $0 != "/" }) // the known identifier (host component) |
There was a problem hiding this comment.
Since we know the bundle ID, should we drop that instead of dropping until the first /?
There was a problem hiding this comment.
Either way works. I don't have a strong opinion on how to implement. IMO the current implementation is fine, isn't externally visible, and is covered by tests so we can always change it in the future if we feel a need.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Bug/issue #, if applicable: rdar://162860967
Summary
This uses simpler string trimming instead of full URL parsing to trim a known prefix from a reference string.
Doing so avoids a crash when the written link has two or more slashes after the identifier (corresponding to a host component in a URL.
Dependencies
None.
Testing
See #1320 but include
<doc://com.test.bundle//path/to/something>(with two slashes after the identifier).Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded[ ] Updated documentation if necessary