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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-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 Swift project authors
*/
import Foundation
extension Benchmark {
/// A hash metric produced off the externally resolved links.
///
/// Use this metric to verify that your code changes did not affect external link resolution.
public class ExternalTopicsHash: BenchmarkMetric {
public static let identifier = "external-topics-hash"
public static let displayName = "External Topics Checksum"
/// Creates a new metric that stores the checksum of the successfully externally resolved links.
/// - Parameter context: A documentation context that the external links were resolved in.
public init(context: DocumentationContext) {
// If there are no externally resolved topics return quickly.
guard !context.externallyResolvedLinks.isEmpty else {
return
}
// Make a flat string of all successfully resolved external topics.
// Note: We have to sort the URLs to produce a stable checksum.
let sourceString = context.externallyResolvedLinks.values.compactMap({
switch $0 {
case .success(let resolved):
return resolved.absoluteString
case .failure(_, _):
return nil
}
}).sorted().joined()
result = .checksum(Checksum.md5(of: Data(sourceString.utf8)))
}
public var result: MetricValue?
}
}
|
