Skip to content

Commit b4a4010

Browse files
goergisngoergisn
authored
Improving SwiftPackage analyzing (#15)
* Improving SwiftPackage analyzing * Fixing some leftovers * Removing commented out code * Surfacing swift package warnings * Renaming and better warning formatting * Fixing tests * Update README.md (#18) * Adding a comment for clarification --------- Co-authored-by: Alex Guretzki <alexander.guretzki@adyen.com>
1 parent c7af217 commit b4a4010

15 files changed

+975
-345
lines changed

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Alternatively you could use `xcrun swift-api-digester -diagnose-sdk` and pass th
88

99
## How it works
1010

11-
![image](https://github.com/user-attachments/assets/6f8b8927-d08b-487d-9d80-e5ee1b8d8302)
11+
![image](https://github.com/user-attachments/assets/cc04d21a-06f6-42bc-8e73-4aef7af21d7a)
12+
1213

1314
### Project Builder
1415

‎Sources/Helpers/Models/SDKDump/SDKDump+Element+Description.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ private extension SDKDump.Element {
5656
if isObjcAccessible { components += ["@objc"] }
5757
if isInlinable { components += ["@inlinable"] }
5858
if isOverride { components += ["override"] }
59-
if declKind != .import {
59+
if declKind != .import && declKind != .case {
6060
if isOpen {
6161
components += ["open"]
6262
} else if isInternal {

‎Sources/Helpers/Models/SwiftPackageDescription.swift‎

Lines changed: 178 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,150 @@
66

77
import Foundation
88

9-
struct SwiftPackageDescription: Codable {
9+
// See: https://docs.swift.org/package-manager/PackageDescription/index.html
10+
// See: https://github.com/swiftlang/swift-package-manager/blob/main/Sources/PackageDescription/PackageDescriptionSerialization.swift
11+
12+
struct SwiftPackageDescription: Codable, Equatable {
1013

14+
let name: String
15+
let platforms: [Platform]
1116
let defaultLocalization: String?
12-
let products: [Product]
17+
1318
let targets: [Target]
19+
let products: [Product]
20+
let dependencies: [Dependency]
21+
1422
let toolsVersion: String
1523

1624
var warnings = [String]()
1725

26+
init(
27+
defaultLocalization: String?,
28+
name: String,
29+
platforms: [Platform] = [],
30+
products: [Product] = [],
31+
targets: [Target] = [],
32+
dependencies: [Dependency] = [],
33+
toolsVersion: String,
34+
warnings: [String] = []
35+
) {
36+
self.defaultLocalization = defaultLocalization
37+
self.name = name
38+
self.platforms = platforms
39+
self.products = products
40+
self.targets = targets
41+
self.dependencies = dependencies
42+
self.toolsVersion = toolsVersion
43+
self.warnings = warnings
44+
}
45+
1846
enum CodingKeys: String, CodingKey {
1947
case defaultLocalization = "default_localization"
48+
case name
49+
case platforms
2050
case products
2151
case targets
52+
case dependencies
2253
case toolsVersion = "tools_version"
2354
}
2455
}
2556

2657
extension SwiftPackageDescription {
2758

28-
struct Product: Codable {
59+
struct Platform: Codable, Equatable, Hashable {
60+
61+
let name: String
62+
let version: String
63+
}
64+
}
65+
66+
extension SwiftPackageDescription.Platform: CustomStringConvertible {
67+
var description: String {
68+
"\(name)(\(version))"
69+
}
70+
}
71+
72+
extension SwiftPackageDescription {
73+
74+
struct Product: Codable, Equatable, Hashable {
75+
76+
// TODO: Add `rule` property
2977

3078
let name: String
3179
let targets: [String]
3280
}
3381
}
3482

83+
extension SwiftPackageDescription.Product: CustomStringConvertible {
84+
var description: String {
85+
let targetsDescription = targets.map { "\"\($0)\"" }.joined(separator: ", ")
86+
return ".library(name: \"\(name)\", targets: [\(targetsDescription)])"
87+
}
88+
}
89+
90+
extension SwiftPackageDescription {
91+
92+
struct Dependency: Codable, Equatable {
93+
94+
let identity: String
95+
let requirement: Requirement
96+
let type: String
97+
let url: String?
98+
}
99+
}
100+
101+
extension SwiftPackageDescription.Dependency: CustomStringConvertible {
102+
103+
var description: String {
104+
var description = ".package("
105+
106+
var fields = [String]()
107+
108+
if let url {
109+
fields += ["url: \"\(url)\""]
110+
}
111+
112+
fields += [requirement.description]
113+
114+
description += fields.joined(separator: ", ")
115+
116+
description += ")"
117+
return description
118+
}
119+
}
120+
121+
extension SwiftPackageDescription.Dependency {
122+
123+
struct Requirement: Codable, Equatable {
124+
125+
// TODO: Which other requirements exist?
126+
127+
let exact: [String]?
128+
}
129+
}
130+
131+
extension SwiftPackageDescription.Dependency.Requirement: CustomStringConvertible {
132+
133+
var description: String {
134+
if let exactVersion = exact?.first {
135+
return "exact: \"\(exactVersion)\""
136+
}
137+
138+
return "UNKNOWN_REQUIREMENT"
139+
}
140+
}
141+
35142
extension SwiftPackageDescription {
36143

37-
struct Target: Codable {
144+
struct Target: Codable, Equatable {
38145

39-
enum ModuleType: String, Codable {
146+
enum ModuleType: String, Codable, Equatable {
40147
case swiftTarget = "SwiftTarget"
41148
case binaryTarget = "BinaryTarget"
42149
case clangTarget = "ClangTarget"
43150
}
44151

45-
enum TargetType: String, Codable {
152+
enum TargetType: String, Codable, Equatable {
46153
case library = "library"
47154
case binary = "binary"
48155
case test = "test"
@@ -53,30 +160,88 @@ extension SwiftPackageDescription {
53160
let path: String
54161
let moduleType: ModuleType
55162

163+
/// `.product(name: ...)` dependency
56164
let productDependencies: [String]?
57-
let productMemberships: [String]?
58-
let sources: [String]
165+
/// `.target(name: ...) dependency
59166
let targetDependencies: [String]?
60167

61-
let resources: [Resource]?
168+
// Ignoring following properties for now as they are not handled in the `PackageAnalyzer`
169+
// and thus would produce changes that are not visible
170+
//
171+
// let productMemberships: [String]?
172+
// let sources: [String]
173+
// let resources: [Resource]?
174+
175+
init(
176+
name: String,
177+
type: TargetType,
178+
path: String,
179+
moduleType: ModuleType,
180+
productDependencies: [String]? = nil,
181+
targetDependencies: [String]? = nil
182+
) {
183+
self.name = name
184+
self.type = type
185+
self.path = path
186+
self.moduleType = moduleType
187+
self.productDependencies = productDependencies
188+
self.targetDependencies = targetDependencies
189+
}
62190

63191
enum CodingKeys: String, CodingKey {
64192
case moduleType = "module_type"
65193
case name
66194
case productDependencies = "product_dependencies"
67-
case productMemberships = "product_memberships"
68-
case sources
69195
case targetDependencies = "target_dependencies"
70196
case type
71197
case path
72-
case resources
73198
}
74199
}
75200
}
76201

202+
extension SwiftPackageDescription.Target.TargetType: CustomStringConvertible {
203+
var description: String {
204+
switch self {
205+
case .binary: "binaryTarget"
206+
case .library: "target"
207+
case .test: "testTarget"
208+
}
209+
}
210+
}
211+
212+
extension SwiftPackageDescription.Target: CustomStringConvertible {
213+
214+
var description: String {
215+
var description = ".\(type.description)(name: \"\(name)\""
216+
217+
var dependencyDescriptions = [String]()
218+
219+
if let targetDependenciesDescriptions = targetDependencies?.map({ ".target(name: \"\($0)\")" }) {
220+
dependencyDescriptions += targetDependenciesDescriptions
221+
}
222+
223+
if let productDependenciesDescriptions = productDependencies?.map({ ".product(name: \"\($0)\", ...)" }) {
224+
dependencyDescriptions += productDependenciesDescriptions
225+
}
226+
227+
if !dependencyDescriptions.isEmpty {
228+
// `, dependencies: [.target(name: ...), .target(name: ...), .product(name: ...), ...]`
229+
description += ", dependencies: [\(dependencyDescriptions.joined(separator: ", "))]"
230+
}
231+
232+
description += ", path: \"\(path)\""
233+
234+
description += ")"
235+
236+
return description
237+
}
238+
}
239+
77240
extension SwiftPackageDescription.Target {
78241

79-
struct Resource: Codable {
242+
struct Resource: Codable, Equatable {
243+
244+
// TODO: Add `rule` property
80245

81246
let path: String
82247
}

‎Sources/Helpers/PackageFileHelper.swift‎ renamed to ‎Sources/Helpers/SwiftPackageFileHelper.swift‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
import Foundation
88

9-
enum PackageFileHelperError: LocalizedError {
9+
enum SwiftPackageFileHelperError: LocalizedError {
1010
case packageDescriptionError(_ description: String)
1111
case couldNotGeneratePackageDescription
1212
case couldNotConsolidateTargetsInPackageFile
@@ -23,7 +23,7 @@ enum PackageFileHelperError: LocalizedError {
2323
}
2424
}
2525

26-
struct PackageFileHelper {
26+
struct SwiftPackageFileHelper {
2727

2828
private let fileHandler: FileHandling
2929
private let xcodeTools: XcodeTools
@@ -89,7 +89,7 @@ struct PackageFileHelper {
8989

9090
// MARK: Generate Package Description
9191

92-
private extension PackageFileHelper {
92+
private extension SwiftPackageFileHelper {
9393

9494
func generatePackageDescription(at projectDirectoryPath: String) throws -> SwiftPackageDescription {
9595

@@ -109,7 +109,7 @@ private extension PackageFileHelper {
109109
// That we have to get rid of first to generate the description object
110110

111111
if firstLine.starts(with: errorTag) {
112-
throw PackageFileHelperError.packageDescriptionError(result)
112+
throw SwiftPackageFileHelperError.packageDescriptionError(result)
113113
}
114114

115115
if firstLine.starts(with: warningTag) {
@@ -120,23 +120,29 @@ private extension PackageFileHelper {
120120
warnings += [warning]
121121
}
122122

123-
if firstLine.starts(with: "{"),
124-
let packageDescriptionData = packageDescriptionLines.joined(separator: newLine).data(using: .utf8) {
125-
var packageDescription = try JSONDecoder().decode(SwiftPackageDescription.self, from: packageDescriptionData)
126-
packageDescription.warnings = warnings
127-
return packageDescription
123+
if
124+
firstLine.starts(with: "{"),
125+
let packageDescriptionData = packageDescriptionLines.joined(separator: newLine).data(using: .utf8)
126+
{
127+
return try decodePackageDescription(from: packageDescriptionData, warnings: warnings)
128128
}
129129

130130
packageDescriptionLines.removeFirst()
131131
}
132132

133-
throw PackageFileHelperError.couldNotGeneratePackageDescription
133+
throw SwiftPackageFileHelperError.couldNotGeneratePackageDescription
134+
}
135+
136+
func decodePackageDescription(from packageDescriptionData: Data, warnings: [String]) throws -> SwiftPackageDescription {
137+
var packageDescription = try JSONDecoder().decode(SwiftPackageDescription.self, from: packageDescriptionData)
138+
packageDescription.warnings = warnings
139+
return packageDescription
134140
}
135141
}
136142

137143
// MARK: Update Package Content
138144

139-
private extension PackageFileHelper {
145+
private extension SwiftPackageFileHelper {
140146

141147
/// Generates a library entry from the name and available target names to be inserted into the `Package.swift` file
142148
func consolidatedLibraryEntry(
@@ -162,7 +168,7 @@ private extension PackageFileHelper {
162168
if let productsRange = packageContent.range(of: "products: [", options: .caseInsensitive) {
163169
updatedContent.insert(contentsOf: consolidatedEntry, at: productsRange.upperBound)
164170
} else {
165-
throw PackageFileHelperError.couldNotConsolidateTargetsInPackageFile
171+
throw SwiftPackageFileHelperError.couldNotConsolidateTargetsInPackageFile
166172
}
167173
return updatedContent
168174
}

‎Sources/Pipeline/Modules/ABIGenerator/ABIGenerator.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ struct ABIGenerator: ABIGenerating {
1010

1111
private let shell: ShellHandling
1212
private let xcodeTools: XcodeTools
13-
private let packageFileHelper: PackageFileHelper
13+
private let packageFileHelper: SwiftPackageFileHelper
1414
private let fileHandler: FileHandling
1515
private let logger: Logging?
1616

‎Sources/Pipeline/Modules/ABIGenerator/PackageABIGenerator.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ struct PackageABIGenerator: ABIGenerating {
1010

1111
let fileHandler: FileHandling
1212
let xcodeTools: XcodeTools
13-
let packageFileHelper: PackageFileHelper
13+
let packageFileHelper: SwiftPackageFileHelper
1414
let logger: Logging?
1515

1616
func generate(

‎Sources/Pipeline/Modules/ProjectBuilder.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,10 @@ private extension ProjectBuilder {
179179
// If a project scheme was provided we just try to build it
180180
schemeToBuild = scheme
181181
} else {
182-
// Creating an `.library(name: "_allTargets", targets: [ALL_TARGETS])`
182+
// Creating an `.library(name: "_AllTargets", targets: [ALL_TARGETS])`
183183
// so we only have to build once and then can generate ABI files for every module from a single build
184184
schemeToBuild = "_AllTargets"
185-
let packageFileHelper = PackageFileHelper(fileHandler: fileHandler, xcodeTools: xcodeTools)
185+
let packageFileHelper = SwiftPackageFileHelper(fileHandler: fileHandler, xcodeTools: xcodeTools)
186186
try packageFileHelper.preparePackageWithConsolidatedLibrary(named: schemeToBuild, at: projectDirectoryPath)
187187
}
188188

0 commit comments

Comments
 (0)