1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Foundation
import RegexBuilder
/// All the information necessary to replay a sourcektid request.
@_spi(Testing)
public struct RequestInfo: Sendable {
/// The JSON request object. Contains the following dynamic placeholders:
/// - `$OFFSET`: To be replaced by `offset` before running the request
/// - `$FILE`: Will be replaced with a path to the file that contains the reduced source code.
/// - `$COMPILER_ARGS`: Will be replaced by the compiler arguments of the request
var requestTemplate: String
/// The offset at which the sourcekitd request should be run. Replaces the
/// `$OFFSET` placeholder in the request template.
var offset: Int
/// The compiler arguments of the request. Replaces the `$COMPILER_ARGS`placeholder in the request template.
@_spi(Testing)
public var compilerArgs: [String]
/// The contents of the file that the sourcekitd request operates on.
@_spi(Testing)
public var fileContents: String
@_spi(Testing)
public func request(for file: URL) throws -> String {
let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted
guard var compilerArgs = String(data: try encoder.encode(compilerArgs), encoding: .utf8) else {
throw ReductionError("Failed to encode compiler arguments")
}
// Drop the opening `[` and `]`. The request template already contains them
compilerArgs = String(compilerArgs.dropFirst().dropLast())
return
requestTemplate
.replacingOccurrences(of: "$OFFSET", with: String(offset))
.replacingOccurrences(of: "$COMPILER_ARGS", with: compilerArgs)
.replacingOccurrences(of: "$FILE", with: file.path)
}
/// A fake value that is used to indicate that we are reducing a `swift-frontend` issue instead of a sourcekitd issue.
static let fakeRequestTemplateForFrontendIssues = """
{
key.request: sourcekit-lsp-fake-request-for-frontend-crash
key.compilerargs: [
$COMPILER_ARGS
]
}
"""
@_spi(Testing)
public init(requestTemplate: String, offset: Int, compilerArgs: [String], fileContents: String) {
self.requestTemplate = requestTemplate
self.offset = offset
self.compilerArgs = compilerArgs
self.fileContents = fileContents
}
/// Creates `RequestInfo` from the contents of the JSON sourcekitd request at `requestPath`.
///
/// The contents of the source file are read from disk.
@_spi(Testing)
public init(request: String) throws {
var requestTemplate = request
// Extract offset
let offsetRegex = Regex {
"key.offset: "
Capture(ZeroOrMore(.digit))
}
if let offsetMatch = requestTemplate.matches(of: offsetRegex).only {
offset = Int(offsetMatch.1)!
requestTemplate.replace(offsetRegex, with: "key.offset: $OFFSET")
} else {
offset = 0
}
// If the request contained source text, remove it. We want to pick it up from the file on disk and most (possibly
// all) sourcekitd requests use key.sourcefile if key.sourcetext is missing.
requestTemplate.replace(#/ *key.sourcetext: .*\n/#, with: "")
// Extract source file
let sourceFileRegex = Regex {
#"key.sourcefile: ""#
Capture(ZeroOrMore(#/[^"]/#))
"\""
}
guard let sourceFileMatch = requestTemplate.matches(of: sourceFileRegex).only else {
throw ReductionError("Failed to find key.sourcefile in the request")
}
let sourceFilePath = String(sourceFileMatch.1)
requestTemplate.replace(sourceFileMatch.1, with: "$FILE")
// Extract compiler arguments
let compilerArgsExtraction = try extractCompilerArguments(from: requestTemplate)
requestTemplate = compilerArgsExtraction.template
compilerArgs = compilerArgsExtraction.compilerArgs
self.requestTemplate = requestTemplate
fileContents = try String(contentsOf: URL(fileURLWithPath: sourceFilePath))
}
/// Create a `RequestInfo` that is used to reduce a `swift-frontend issue`
init(frontendArgs: [String]) throws {
var frontendArgsWithFilelistInlined: [String] = []
var iterator = frontendArgs.makeIterator()
// Inline the file list so we can reduce the compiler arguments by removing individual source files.
// A couple `output-filelist`-related compiler arguments don't work with the file list inlined. Remove them as they
// are unlikely to be responsible for the swift-frontend cache.
// `-index-system-modules` is invalid when no output file lists are specified.
while let frontendArg = iterator.next() {
switch frontendArg {
case "-supplementary-output-file-map", "-output-filelist", "-index-unit-output-path-filelist",
"-index-system-modules":
_ = iterator.next()
case "-filelist":
guard let fileList = iterator.next() else {
throw ReductionError("Expected file path after -filelist command line argument")
}
frontendArgsWithFilelistInlined += try String(contentsOfFile: fileList)
.split(separator: "\n")
.map { String($0) }
default:
frontendArgsWithFilelistInlined.append(frontendArg)
}
}
// File contents are not known because there are multiple input files. Will usually be set after running
// `mergeSwiftFiles`.
self.init(
requestTemplate: Self.fakeRequestTemplateForFrontendIssues,
offset: 0,
compilerArgs: frontendArgsWithFilelistInlined,
fileContents: ""
)
}
}
private func extractCompilerArguments(
from requestTemplate: String
) throws -> (template: String, compilerArgs: [String]) {
let lines = requestTemplate.components(separatedBy: "\n")
guard
let compilerArgsStartIndex = lines.firstIndex(where: { $0.contains("key.compilerargs: [") }),
let compilerArgsEndIndex = lines[compilerArgsStartIndex...].firstIndex(where: {
$0.trimmingCharacters(in: .whitespacesAndNewlines).hasPrefix("]")
})
else {
return (requestTemplate, [])
}
let template = lines[...compilerArgsStartIndex] + ["$COMPILER_ARGS"] + lines[compilerArgsEndIndex...]
let compilerArgsJson = "[" + lines[(compilerArgsStartIndex + 1)..<compilerArgsEndIndex].joined(separator: "\n") + "]"
let compilerArgs = try JSONDecoder().decode([String].self, from: compilerArgsJson)
return (template.joined(separator: "\n"), compilerArgs)
}
|
