keep the original URL when decoding Download/ExternalLocationReference #621
Conversation
This file contains 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 |
Sources/SwiftDocC/Model/Rendering/References/ExternalLocationReference.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/References/ExternalLocationReference.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Model/Rendering/Tutorial/References/DownloadReference.swift
Show resolved
Hide resolved
| } | ||
| } | ||
|
|
||
| static public func ==(lhs: DownloadReference, rhs: DownloadReference) -> Bool { |
There was a problem hiding this comment.
Off-topic but I wonder if it's possible to make an @EquatableIgnored macro like: https://developer.apple.com/documentation/observation/observationignored...
|
@swift-ci Please test |
Sources/SwiftDocC/Model/Rendering/Tutorial/References/DownloadReference.swift
Show resolved
Hide resolved
QuietMisdreavus
force-pushed
the
reference-url-verbatim
branch
from
7b62f5c to
10edeec
Compare
|
@swift-ci Please test |
|
@swift-ci Please test |
|
@swift-ci Please test |
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.
Bug/issue #, if applicable: rdar://110536969
Summary
When a DownloadReference or ExternalLocationReference are decoded from JSON, they both modify URL when re-encoded back to JSON. This can cause issues if the URL is different from what either of these types use as their default (
/downloads/fileand the identifier, respectively). This PR tweaks the Codable logic for both of these types to always use the decoded URL when re-encoding.Dependencies
None
Testing
This bug manifests when the Render JSON is modified after rendering, and then re-encoded after the fact. As such, testing is restricted to the automated test added in this PR.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded