|
| 1 | +/* |
| 2 | + This source file is part of the Swift.org open source project |
| 3 | + |
| 4 | + Copyright (c) 2021 Apple Inc. and the Swift project authors |
| 5 | + Licensed under Apache License v2.0 with Runtime Library Exception |
| 6 | + |
| 7 | + See http://swift.org/LICENSE.txt for license information |
| 8 | + See http://swift.org/CONTRIBUTORS.txt for Swift project authors |
| 9 | + */ |
| 10 | + |
| 11 | +import Basics |
| 12 | +import Dispatch |
| 13 | +import Foundation |
| 14 | +import PackageModel |
| 15 | +import TSCBasic |
| 16 | +import TSCUtility |
| 17 | + |
| 18 | +public struct FilePackageFingerprintStorage: PackageFingerprintStorage { |
| 19 | + let fileSystem: FileSystem |
| 20 | + let directoryPath: AbsolutePath |
| 21 | + |
| 22 | + private let encoder: JSONEncoder |
| 23 | + private let decoder: JSONDecoder |
| 24 | + |
| 25 | + init(fileSystem: FileSystem, directoryPath: AbsolutePath) { |
| 26 | + self.fileSystem = fileSystem |
| 27 | + self.directoryPath = directoryPath |
| 28 | + |
| 29 | + self.encoder = JSONEncoder.makeWithDefaults() |
| 30 | + self.decoder = JSONDecoder.makeWithDefaults() |
| 31 | + } |
| 32 | + |
| 33 | + public func get(package: PackageIdentity, |
| 34 | + version: Version, |
| 35 | + observabilityScope: ObservabilityScope, |
| 36 | + callbackQueue: DispatchQueue, |
| 37 | + callback: @escaping (Result<[Fingerprint.Kind: Fingerprint], Error>) -> Void) |
| 38 | + { |
| 39 | + let callback = self.makeAsync(callback, on: callbackQueue) |
| 40 | + |
| 41 | + do { |
| 42 | + let packageFingerprints = try self.withLock { |
| 43 | + try self.loadFromDisk(package: package) |
| 44 | + } |
| 45 | + |
| 46 | + guard let fingerprints = packageFingerprints[version] else { |
| 47 | + throw PackageFingerprintStorageError.notFound |
| 48 | + } |
| 49 | + |
| 50 | + callback(.success(fingerprints)) |
| 51 | + } catch { |
| 52 | + callback(.failure(error)) |
| 53 | + } |
| 54 | + } |
| 55 | + |
| 56 | + public func put(package: PackageIdentity, |
| 57 | + version: Version, |
| 58 | + fingerprint: Fingerprint, |
| 59 | + observabilityScope: ObservabilityScope, |
| 60 | + callbackQueue: DispatchQueue, |
| 61 | + callback: @escaping (Result<Void, Error>) -> Void) |
| 62 | + { |
| 63 | + let callback = self.makeAsync(callback, on: callbackQueue) |
| 64 | + |
| 65 | + do { |
| 66 | + try self.withLock { |
| 67 | + var packageFingerprints = try self.loadFromDisk(package: package) |
| 68 | + |
| 69 | + if let existing = packageFingerprints[version]?[fingerprint.origin.kind] { |
| 70 | + // Error if we try to write a different fingerprint |
| 71 | + guard fingerprint == existing else { |
| 72 | + throw PackageFingerprintStorageError.conflict(given: fingerprint, existing: existing) |
| 73 | + } |
| 74 | + // Don't need to do anything if fingerprints are the same |
| 75 | + return |
| 76 | + } |
| 77 | + |
| 78 | + var fingerprints = packageFingerprints.removeValue(forKey: version) ?? [:] |
| 79 | + fingerprints[fingerprint.origin.kind] = fingerprint |
| 80 | + packageFingerprints[version] = fingerprints |
| 81 | + |
| 82 | + try self.saveToDisk(package: package, fingerprints: packageFingerprints) |
| 83 | + } |
| 84 | + callback(.success(())) |
| 85 | + } catch { |
| 86 | + callback(.failure(error)) |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + private func loadFromDisk(package: PackageIdentity) throws -> PackageFingerprints { |
| 91 | + let path = self.directoryPath.appending(component: package.fingerprintFilename) |
| 92 | + |
| 93 | + guard self.fileSystem.exists(path) else { |
| 94 | + return .init() |
| 95 | + } |
| 96 | + |
| 97 | + let buffer = try fileSystem.readFileContents(path).contents |
| 98 | + guard buffer.count > 0 else { |
| 99 | + return .init() |
| 100 | + } |
| 101 | + |
| 102 | + let container = try self.decoder.decode(StorageModel.Container.self, from: Data(buffer)) |
| 103 | + return try container.packageFingerprints() |
| 104 | + } |
| 105 | + |
| 106 | + private func saveToDisk(package: PackageIdentity, fingerprints: PackageFingerprints) throws { |
| 107 | + if !self.fileSystem.exists(self.directoryPath) { |
| 108 | + try self.fileSystem.createDirectory(self.directoryPath, recursive: true) |
| 109 | + } |
| 110 | + |
| 111 | + let container = StorageModel.Container(fingerprints) |
| 112 | + let buffer = try encoder.encode(container) |
| 113 | + |
| 114 | + let path = self.directoryPath.appending(component: package.fingerprintFilename) |
| 115 | + try self.fileSystem.writeFileContents(path, bytes: ByteString(buffer)) |
| 116 | + } |
| 117 | + |
| 118 | + private func withLock<T>(_ body: () throws -> T) throws -> T { |
| 119 | + if !self.fileSystem.exists(self.directoryPath) { |
| 120 | + try self.fileSystem.createDirectory(self.directoryPath, recursive: true) |
| 121 | + } |
| 122 | + return try self.fileSystem.withLock(on: self.directoryPath, type: .exclusive, body) |
| 123 | + } |
| 124 | + |
| 125 | + private func makeAsync<T>(_ closure: @escaping (Result<T, Error>) -> Void, on queue: DispatchQueue) -> (Result<T, Error>) -> Void { |
| 126 | + { result in queue.async { closure(result) } } |
| 127 | + } |
| 128 | +} |
| 129 | + |
| 130 | +private enum StorageModel { |
| 131 | + struct Container: Codable { |
| 132 | + let versionFingerprints: [String: [String: StoredFingerprint]] |
| 133 | + |
| 134 | + init(_ versionFingerprints: PackageFingerprints) { |
| 135 | + self.versionFingerprints = Dictionary(uniqueKeysWithValues: versionFingerprints.map { version, fingerprints in |
| 136 | + let fingerprintByKind: [String: StoredFingerprint] = Dictionary(uniqueKeysWithValues: fingerprints.map { kind, fingerprint in |
| 137 | + let origin: String |
| 138 | + switch fingerprint.origin { |
| 139 | + case .sourceControl(let url): |
| 140 | + origin = url.absoluteString |
| 141 | + case .registry(let url): |
| 142 | + origin = url.absoluteString |
| 143 | + } |
| 144 | + return (kind.rawValue, StoredFingerprint(origin: origin, fingerprint: fingerprint.value)) |
| 145 | + }) |
| 146 | + return (version.description, fingerprintByKind) |
| 147 | + }) |
| 148 | + } |
| 149 | + |
| 150 | + func packageFingerprints() throws -> PackageFingerprints { |
| 151 | + try Dictionary(uniqueKeysWithValues: self.versionFingerprints.map { version, fingerprints in |
| 152 | + let fingerprintByKind: [Fingerprint.Kind: Fingerprint] = try Dictionary(uniqueKeysWithValues: fingerprints.map { kind, fingerprint in |
| 153 | + guard let kind = Fingerprint.Kind(rawValue: kind) else { |
| 154 | + throw SerializationError.unknownKind(kind) |
| 155 | + } |
| 156 | + guard let originURL = Foundation.URL(string: fingerprint.origin) else { |
| 157 | + throw SerializationError.invalidURL(fingerprint.origin) |
| 158 | + } |
| 159 | + |
| 160 | + let origin: Fingerprint.Origin |
| 161 | + switch kind { |
| 162 | + case .sourceControl: |
| 163 | + origin = .sourceControl(originURL) |
| 164 | + case .registry: |
| 165 | + origin = .registry(originURL) |
| 166 | + } |
| 167 | + |
| 168 | + return (kind, Fingerprint(origin: origin, value: fingerprint.fingerprint)) |
| 169 | + }) |
| 170 | + return (Version(stringLiteral: version), fingerprintByKind) |
| 171 | + }) |
| 172 | + } |
| 173 | + } |
| 174 | + |
| 175 | + struct StoredFingerprint: Codable { |
| 176 | + let origin: String |
| 177 | + let fingerprint: String |
| 178 | + } |
| 179 | +} |
| 180 | + |
| 181 | +extension PackageIdentity { |
| 182 | + var fingerprintFilename: String { |
| 183 | + "\(self.description).json" |
| 184 | + } |
| 185 | +} |
| 186 | + |
| 187 | +private enum SerializationError: Error { |
| 188 | + case unknownKind(String) |
| 189 | + case invalidURL(String) |
| 190 | +} |
0 commit comments