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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2022-2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Basics
import Dispatch
import Foundation
import PackageModel
import protocol TSCBasic.Closable
struct PackageIndex: PackageIndexProtocol, Closable {
private let configuration: PackageIndexConfiguration
private let httpClient: LegacyHTTPClient
private let callbackQueue: DispatchQueue
private let observabilityScope: ObservabilityScope
private let decoder: JSONDecoder
private let cache: SQLiteBackedCache<CacheValue>?
var isEnabled: Bool {
self.configuration.enabled && self.configuration.url != .none
}
init(
configuration: PackageIndexConfiguration,
customHTTPClient: LegacyHTTPClient? = nil,
callbackQueue: DispatchQueue,
observabilityScope: ObservabilityScope
) {
self.configuration = configuration
self.httpClient = customHTTPClient ?? Self.makeDefaultHTTPClient()
self.callbackQueue = callbackQueue
self.observabilityScope = observabilityScope
self.decoder = JSONDecoder.makeWithDefaults()
if configuration.cacheTTLInSeconds > 0 {
var cacheConfig = SQLiteBackedCacheConfiguration()
cacheConfig.maxSizeInMegabytes = configuration.cacheMaxSizeInMegabytes
self.cache = SQLiteBackedCache<CacheValue>(
tableName: "package_index_cache",
path: configuration.cacheDirectory.appending("index-package-metadata.db"),
configuration: cacheConfig
)
} else {
self.cache = nil
}
}
func close() throws {
try self.cache?.close()
}
func getPackageMetadata(
identity: PackageIdentity,
location: String?,
callback: @escaping (Result<PackageCollectionsModel.PackageMetadata, Error>) -> Void
) {
self.runIfConfigured(callback: callback) { url, callback in
if let cached = try? self.cache?.get(key: identity.description),
cached.dispatchTime + DispatchTimeInterval.seconds(self.configuration.cacheTTLInSeconds) > DispatchTime.now() {
return callback(.success((package: cached.package, collections: [], provider: self.createContext(host: url.host, error: nil))))
}
// TODO: rdar://87582621 call package index's get metadata API
let metadataURL = url.appendingPathComponent("packages").appendingPathComponent(identity.description)
self.httpClient.get(metadataURL) { result in
callback(result.tryMap { response in
switch response.statusCode {
case 200:
guard let package = try response.decodeBody(PackageCollectionsModel.Package.self, using: self.decoder) else {
throw PackageIndexError.invalidResponse(metadataURL, "Empty body")
}
do {
try self.cache?.put(
key: identity.description,
value: CacheValue(package: package, timestamp: DispatchTime.now()),
replace: true,
observabilityScope: self.observabilityScope
)
} catch {
self.observabilityScope.emit(
warning: "Failed to save index metadata for package \(identity) to cache",
underlyingError: error
)
}
return (package: package, collections: [], provider: self.createContext(host: url.host, error: nil))
default:
throw PackageIndexError.invalidResponse(metadataURL, "Invalid status code: \(response.statusCode)")
}
})
}
}
}
func findPackages(
_ query: String,
callback: @escaping (Result<PackageCollectionsModel.PackageSearchResult, Error>) -> Void
) {
self.runIfConfigured(callback: callback) { url, callback in
guard var urlComponents = URLComponents(url: url, resolvingAgainstBaseURL: true) else {
return callback(.failure(PackageIndexError.invalidURL(url)))
}
urlComponents.path = (urlComponents.path.last == "/" ? "" : "/") + "search"
urlComponents.queryItems = [
URLQueryItem(name: "q", value: query),
]
// TODO: rdar://87582621 call package index's search API
guard let searchURL = urlComponents.url else {
return callback(.failure(PackageIndexError.invalidURL(url)))
}
self.httpClient.get(searchURL) { result in
callback(result.tryMap { response in
switch response.statusCode {
case 200:
guard let packages = try response.decodeBody([PackageCollectionsModel.Package].self, using: self.decoder) else {
throw PackageIndexError.invalidResponse(searchURL, "Empty body")
}
// Limit the number of items
let items = packages[..<min(packages.count, self.configuration.searchResultMaxItemsCount)].map {
PackageCollectionsModel.PackageSearchResult.Item(package: $0, indexes: [url])
}
return PackageCollectionsModel.PackageSearchResult(items: items)
default:
throw PackageIndexError.invalidResponse(searchURL, "Invalid status code: \(response.statusCode)")
}
})
}
}
}
func listPackages(
offset: Int,
limit: Int,
callback: @escaping (Result<PackageCollectionsModel.PaginatedPackageList, Error>) -> Void
) {
self.runIfConfigured(callback: callback) { url, callback in
guard var urlComponents = URLComponents(url: url, resolvingAgainstBaseURL: true) else {
return callback(.failure(PackageIndexError.invalidURL(url)))
}
urlComponents.path = (urlComponents.path.last == "/" ? "" : "/") + "packages"
urlComponents.queryItems = [
URLQueryItem(name: "offset", value: "\(offset)"),
URLQueryItem(name: "limit", value: "\(limit)"),
]
// TODO: rdar://87582621 call package index's list API
guard let listURL = urlComponents.url else {
return callback(.failure(PackageIndexError.invalidURL(url)))
}
self.httpClient.get(listURL) { result in
callback(result.tryMap { response in
switch response.statusCode {
case 200:
guard let listResponse = try response.decodeBody(ListResponse.self, using: self.decoder) else {
throw PackageIndexError.invalidResponse(listURL, "Empty body")
}
return PackageCollectionsModel.PaginatedPackageList(
items: listResponse.items,
offset: offset,
limit: limit,
total: listResponse.total
)
default:
throw PackageIndexError.invalidResponse(listURL, "Invalid status code: \(response.statusCode)")
}
})
}
}
}
private func runIfConfigured<T>(
callback: @escaping (Result<T, Error>) -> Void,
handler: @escaping (URL, @escaping (Result<T, Error>) -> Void) -> Void
) {
let callback = self.makeAsync(callback)
guard self.configuration.enabled else {
return callback(.failure(PackageIndexError.featureDisabled))
}
guard let url = self.configuration.url else {
return callback(.failure(PackageIndexError.notConfigured))
}
handler(url, callback)
}
private func makeAsync<T>(_ closure: @escaping (Result<T, Error>) -> Void) -> (Result<T, Error>) -> Void {
{ result in self.callbackQueue.async { closure(result) } }
}
private func createContext(host: String?, error: Error?) -> PackageMetadataProviderContext? {
let name = host ?? "package index"
return PackageMetadataProviderContext(
name: name,
// Package index doesn't require auth
authTokenType: nil,
isAuthTokenConfigured: true
)
}
private static func makeDefaultHTTPClient() -> LegacyHTTPClient {
let client = LegacyHTTPClient()
// TODO: make these defaults configurable?
client.configuration.requestTimeout = .seconds(1)
client.configuration.retryStrategy = .exponentialBackoff(maxAttempts: 3, baseDelay: .milliseconds(50))
client.configuration.circuitBreakerStrategy = .hostErrors(maxErrors: 50, age: .seconds(30))
return client
}
private struct CacheValue: Codable {
let package: Model.Package
let timestamp: UInt64
var dispatchTime: DispatchTime {
DispatchTime(uptimeNanoseconds: self.timestamp)
}
init(package: Model.Package, timestamp: DispatchTime) {
self.package = package
self.timestamp = timestamp.uptimeNanoseconds
}
}
}
extension PackageIndex {
struct ListResponse: Codable {
let items: [PackageCollectionsModel.Package]
let total: Int
}
}
// MARK: - PackageMetadataProvider conformance
extension PackageIndex: PackageMetadataProvider {
func get(
identity: PackageIdentity,
location: String,
callback: @escaping (Result<PackageCollectionsModel.PackageBasicMetadata, Error>, PackageMetadataProviderContext?) -> Void
) {
self.getPackageMetadata(identity: identity, location: location) { result in
switch result {
case .failure(let error):
// Package index fails to produce result so it cannot be the provider
callback(.failure(error), nil)
case .success(let metadata):
let package = metadata.package
let basicMetadata = PackageCollectionsModel.PackageBasicMetadata(
summary: package.summary,
keywords: package.keywords,
versions: package.versions.map { version in
PackageCollectionsModel.PackageBasicVersionMetadata(
version: version.version,
title: version.title,
summary: version.summary,
author: version.author,
createdAt: version.createdAt
)
},
watchersCount: package.watchersCount,
readmeURL: package.readmeURL,
license: package.license,
authors: package.authors,
languages: package.languages
)
callback(.success(basicMetadata), metadata.provider)
}
}
}
}
|