-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Refactor registry checksum TOFU logic #6190
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift open source project | ||
| // | ||
| // Copyright (c) 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 Dispatch | ||
|
|
||
| import Basics | ||
| import PackageFingerprint | ||
| import PackageModel | ||
|
|
||
| import struct TSCUtility.Version | ||
|
|
||
| struct PackageVersionChecksumTOFU { | ||
| private let fingerprintStorage: PackageFingerprintStorage? | ||
| private let fingerprintCheckingMode: FingerprintCheckingMode | ||
|
|
||
| private let registryClient: RegistryClient | ||
|
|
||
| init( | ||
| fingerprintStorage: PackageFingerprintStorage?, | ||
| fingerprintCheckingMode: FingerprintCheckingMode, | ||
| registryClient: RegistryClient | ||
| ) { | ||
| self.fingerprintStorage = fingerprintStorage | ||
| self.fingerprintCheckingMode = fingerprintCheckingMode | ||
| self.registryClient = registryClient | ||
| } | ||
|
|
||
| func check( | ||
| registry: Registry, | ||
| package: PackageIdentity.RegistryIdentity, | ||
| version: Version, | ||
| checksum: String, | ||
| timeout: DispatchTimeInterval?, | ||
| observabilityScope: ObservabilityScope, | ||
| callbackQueue: DispatchQueue, | ||
| completion: @escaping (Result<Void, Error>) -> Void | ||
| ) { | ||
| self.getExpectedChecksum( | ||
| registry: registry, | ||
| package: package, | ||
| version: version, | ||
| timeout: timeout, | ||
| observabilityScope: observabilityScope, | ||
| callbackQueue: callbackQueue | ||
| ) { result in | ||
| completion( | ||
| result.tryMap { expectedChecksum in | ||
| if checksum != expectedChecksum { | ||
| switch self.fingerprintCheckingMode { | ||
| case .strict: | ||
| throw RegistryError.invalidChecksum(expected: expectedChecksum, actual: checksum) | ||
| case .warn: | ||
| observabilityScope | ||
| .emit( | ||
| warning: "The checksum \(checksum) does not match previously recorded value \(expectedChecksum)" | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private func getExpectedChecksum( | ||
| registry: Registry, | ||
| package: PackageIdentity.RegistryIdentity, | ||
| version: Version, | ||
| timeout: DispatchTimeInterval?, | ||
| observabilityScope: ObservabilityScope, | ||
| callbackQueue: DispatchQueue, | ||
| completion: @escaping (Result<String, Error>) -> Void | ||
| ) { | ||
| // We either use a previously recorded checksum, or fetch it from the registry. | ||
| self.readFromStorage( | ||
| package: package, | ||
| version: version, | ||
| observabilityScope: observabilityScope, | ||
| callbackQueue: callbackQueue | ||
| ) { result in | ||
| switch result { | ||
| case .success(.some(let savedChecksum)): | ||
| completion(.success(savedChecksum)) | ||
| default: | ||
| // Try fetching checksum from registry if: | ||
| // - No storage available | ||
| // - Checksum not found in storage | ||
| // - Reading from storage resulted in error | ||
| self.registryClient.getRawPackageVersionMetadata( | ||
| registry: registry, | ||
| package: package, | ||
| version: version, | ||
| timeout: timeout, | ||
| observabilityScope: observabilityScope, | ||
| callbackQueue: callbackQueue | ||
| ) { result in | ||
| switch result { | ||
| case .success(let metadata): | ||
| guard let sourceArchive = metadata.resources | ||
| .first(where: { $0.name == "source-archive" }) | ||
| else { | ||
| return completion(.failure(RegistryError.missingSourceArchive)) | ||
| } | ||
|
|
||
| guard let checksum = sourceArchive.checksum else { | ||
| return completion(.failure(RegistryError.invalidSourceArchive)) | ||
| } | ||
|
|
||
| self.writeToStorage( | ||
| registry: registry, | ||
| package: package, | ||
| version: version, | ||
| checksum: checksum, | ||
| observabilityScope: observabilityScope, | ||
| callbackQueue: callbackQueue | ||
| ) { writeResult in | ||
| completion(writeResult.tryMap { _ in checksum }) | ||
| } | ||
| case .failure(RegistryError.failedRetrievingReleaseInfo(_, _, _, let error)): | ||
| completion(.failure(RegistryError.failedRetrievingReleaseChecksum( | ||
| registry: registry, | ||
| package: package.underlying, | ||
| version: version, | ||
| error: error | ||
| ))) | ||
| case .failure(let error): | ||
| completion(.failure(RegistryError.failedRetrievingReleaseChecksum( | ||
| registry: registry, | ||
| package: package.underlying, | ||
| version: version, | ||
| error: error | ||
| ))) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private func readFromStorage( | ||
| package: PackageIdentity.RegistryIdentity, | ||
| version: Version, | ||
| observabilityScope: ObservabilityScope, | ||
| callbackQueue: DispatchQueue, | ||
| completion: @escaping (Result<String?, Error>) -> Void | ||
| ) { | ||
| guard let fingerprintStorage = self.fingerprintStorage else { | ||
| return completion(.success(nil)) | ||
| } | ||
|
|
||
| fingerprintStorage.get( | ||
| package: package.underlying, | ||
| version: version, | ||
| kind: .registry, | ||
| observabilityScope: observabilityScope, | ||
| callbackQueue: callbackQueue | ||
| ) { result in | ||
| switch result { | ||
| case .success(let fingerprint): | ||
| completion(.success(fingerprint.value)) | ||
| case .failure(PackageFingerprintStorageError.notFound): | ||
| completion(.success(nil)) | ||
| case .failure(let error): | ||
| observabilityScope | ||
| .emit(error: "Failed to get registry fingerprint for \(package) \(version) from storage: \(error)") | ||
| completion(.failure(error)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private func writeToStorage( | ||
| registry: Registry, | ||
| package: PackageIdentity.RegistryIdentity, | ||
| version: Version, | ||
| checksum: String, | ||
| observabilityScope: ObservabilityScope, | ||
| callbackQueue: DispatchQueue, | ||
| completion: @escaping (Result<Void, Error>) -> Void | ||
| ) { | ||
| guard let fingerprintStorage = self.fingerprintStorage else { | ||
| return completion(.success(())) | ||
| } | ||
|
|
||
| fingerprintStorage.put( | ||
| package: package.underlying, | ||
| version: version, | ||
| fingerprint: .init(origin: .registry(registry.url), value: checksum), | ||
| observabilityScope: observabilityScope, | ||
| callbackQueue: callbackQueue | ||
| ) { result in | ||
| switch result { | ||
| case .success: | ||
| completion(.success(())) | ||
| case .failure(PackageFingerprintStorageError.conflict(_, let existing)): | ||
| switch self.fingerprintCheckingMode { | ||
| case .strict: | ||
| completion(.failure(RegistryError.checksumChanged(latest: checksum, previous: existing.value))) | ||
| case .warn: | ||
| observabilityScope | ||
| .emit( | ||
| warning: "The checksum \(checksum) from \(registry.url.absoluteString) does not match previously recorded value \(existing.value) from \(String(describing: existing.origin.url?.absoluteString))" | ||
| ) | ||
| completion(.success(())) | ||
| } | ||
| case .failure(let error): | ||
| completion(.failure(error)) | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit:
validateprobable a better fit?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will rename it as part of #6184