Add SerializedJSON type as string literal escaping helper
#6730
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
Also added a custom `AbsolutePath` interpolation to the new type, which removes the need to call `_nativePathString` when paths are interpolated in JSON strings.
MaxDesiatov
requested review from
abertelrud,
neonichu and
tomerd
as code owners
|
@swift-ci smoke test |
|
@swift-ci smoke test |
|
@swift-ci test windows |
1 similar comment
|
@swift-ci test windows |
This was referenced Jul 19, 2023
compnerd
approved these changes
Jul 19, 2023
| @@ -348,15 +348,15 @@ final class DestinationTests: XCTestCase { | |||
| otherToolsNoRoot, | |||
| someToolsWithRoot, | |||
| invalidToolset, | |||
| ] { | |||
| try fs.writeFileContents(AbsolutePath(validating: testFile.path), string: testFile.json) | |||
| ] as [(path: AbsolutePath, json: SerializedJSON)] { | |||
There was a problem hiding this comment.
Why not move this into the variable declaration?
for testFile: [(AbsolutePath, SerializedJSON)] in [
...
] {
try fs.writeFileContents($0.path, string: $0.json.underlying)
}There was a problem hiding this comment.
Separated out into a file-local private let declaration in the latest commit.
|
@swift-ci smoke test |
|
@swift-ci test windows |
tomerd
reviewed
Jul 20, 2023
| @@ -31,7 +31,7 @@ private let extraFlags = BuildFlags( | |||
| ) | |||
|
|
|||
| private let destinationV1 = ( | |||
| path: "\(bundleRootPath)/destinationV1.json", | |||
| path: bundleRootPath.appending(component: "destinationV1.json"), | |||
tomerd
reviewed
Jul 20, 2023
| @@ -59,11 +59,11 @@ private let destinationV2 = ( | |||
| "extraCXXFlags": \#(extraFlags.cxxCompilerFlags), | |||
| "extraLinkerFlags": \#(extraFlags.linkerFlags) | |||
| } | |||
| """# | |||
| """# as SerializedJSON | |||
There was a problem hiding this comment.
make SerializedJSON ExpressibleByStringLiteral so this case can go away
There was a problem hiding this comment.
oh, this is tuple... maybe use a type to avoid the cast than
tomerd
reviewed
Jul 20, 2023
| ) | ||
|
|
||
| private let usrBinTools = Dictionary(uniqueKeysWithValues: Toolset.KnownTool.allCases.map { | ||
| ($0, "/usr/bin/\($0.rawValue)") | ||
| }) | ||
|
|
||
| private let otherToolsNoRoot = ( | ||
| path: "/tools/otherToolsNoRoot.json", | ||
| path: try! AbsolutePath(validating: "/tools/otherToolsNoRoot.json"), |
There was a problem hiding this comment.
try validating: is not required in tests (there is an extension that does the force try)
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.
Motivation:
Currently we have to call
_nativePathStringmanually in a lot of places whereAbsolutePathis interpolated into strings. We also need to take into account whether_nativePathStringshould be called withescaped: trueorescaped: falsearguments, which is prone to errors. The serialization format should carry the knowledge of its correct escaping algorithm, not the path representation itself.We can make this much cleaner if string interpolations call
_nativePathStringautomatically where needed, and serialization formats add proper escaping on top of that.Let's mplements this for JSON, specifically where it is used in Swift SDKs.
Modifications:
Added
SerializedJSONtype as string literal escaping helper.Also added a custom
AbsolutePathinterpolation to the new type, which removes the need to call_nativePathStringwhen paths are interpolated in JSON strings.Result:
We don't have to call
_nativePathStringmanually in as many places. In future PRs_nativePathStringshould be declaredprivateor at leastinternalso that it's hidden as an implementation detail of appropriate string interpolations.