Change authTokens to be a function instead

Author: yim-lee

Sources/PackageCollections/PackageCollections+Configuration.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2020 Apple Inc. and the Swift project authors
+ Copyright (c) 2020-2021 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
@@ -16,9 +16,9 @@ extension PackageCollections {
         // JSONPackageCollectionValidator: maximumPackageCount, maximumMajorVersionCount, maximumMinorVersionCount
 
         /// Auth tokens for the collections or metadata provider
-        public var authTokens: [AuthTokenType: String]?
+        public var authTokens: () -> [AuthTokenType: String]?
 
-        public init(authTokens: [AuthTokenType: String]? = nil) {
+        public init(authTokens: @escaping () -> [AuthTokenType: String]? = { nil }) {
             self.authTokens = authTokens
         }
     }

Sources/PackageCollections/PackageCollections.swift

@@ -21,11 +21,11 @@ public struct PackageCollections: PackageCollectionsProtocol {
     static let isSupportedPlatform = false
     #endif
 
-    var configuration: Configuration
+    let configuration: Configuration
     private let diagnosticsEngine: DiagnosticsEngine?
     private let storageContainer: (storage: Storage, owned: Bool)
     private let collectionProviders: [Model.CollectionSourceType: PackageCollectionProvider]
-    var metadataProvider: PackageMetadataProvider
+    let metadataProvider: PackageMetadataProvider
 
     private var storage: Storage {
         self.storageContainer.storage
@@ -68,14 +68,6 @@ public struct PackageCollections: PackageCollectionsProtocol {
         try self.metadataProvider.close()
     }
 
-    public mutating func updateAuthTokens(_ authTokens: [AuthTokenType: String]?) {
-        self.configuration.authTokens = authTokens
-        if var metadataProvider = self.metadataProvider as? GitHubPackageMetadataProvider {
-            metadataProvider.configuration.authTokens = authTokens
-            self.metadataProvider = metadataProvider
-        }
-    }
-
     // MARK: - Collections
 
     public func listCollections(identifiers: Set<PackageCollectionsModel.CollectionIdentifier>? = nil,

Sources/PackageCollections/Providers/GitHubPackageMetadataProvider.swift

@@ -194,7 +194,7 @@ struct GitHubPackageMetadataProvider: PackageMetadataProvider {
         options.validResponseCodes = validResponseCodes
         options.authorizationProvider = { url in
             url.host.flatMap { host in
-                self.configuration.authTokens?[.github(host)].flatMap { token in
+                self.configuration.authTokens()?[.github(host)].flatMap { token in
                     "token \(token)"
                 }
             }
@@ -212,22 +212,22 @@ struct GitHubPackageMetadataProvider: PackageMetadataProvider {
     }
 
     public struct Configuration {
+        public var authTokens: () -> [AuthTokenType: String]?
         public var apiLimitWarningThreshold: Int
-        public var authTokens: [AuthTokenType: String]?
         public var cacheDir: AbsolutePath
-        public var cacheSizeInMegabytes: Int
         public var cacheTTLInSeconds: Int
+        public var cacheSizeInMegabytes: Int
 
-        public init(authTokens: [AuthTokenType: String]? = nil,
+        public init(authTokens: @escaping () -> [AuthTokenType: String]? = { nil },
                     apiLimitWarningThreshold: Int? = nil,
                     cacheDir: AbsolutePath? = nil,
                     cacheTTLInSeconds: Int? = nil,
                     cacheSizeInMegabytes: Int? = nil) {
             self.authTokens = authTokens
             self.apiLimitWarningThreshold = apiLimitWarningThreshold ?? 5
             self.cacheDir = cacheDir.map(resolveSymlinks) ?? localFileSystem.swiftPMCacheDirectory.appending(components: "package-metadata")
-            self.cacheSizeInMegabytes = cacheSizeInMegabytes ?? 10
             self.cacheTTLInSeconds = cacheTTLInSeconds ?? 3600
+            self.cacheSizeInMegabytes = cacheSizeInMegabytes ?? 10
         }
     }
 

Tests/PackageCollectionsTests/GitHubPackageMetadataProviderTests.swift

@@ -226,7 +226,7 @@ class GitHubPackageMetadataProviderTests: XCTestCase {
             var configuration = GitHubPackageMetadataProvider.Configuration()
             configuration.cacheDir = tmpPath
             var provider = GitHubPackageMetadataProvider(configuration: configuration, httpClient: httpClient)
-            provider.configuration.authTokens = authTokens
+            provider.configuration.authTokens = { authTokens }
             defer { XCTAssertNoThrow(try provider.close()) }
 
             let reference = PackageReference(repository: RepositorySpecifier(url: repoURL))
@@ -335,7 +335,7 @@ class GitHubPackageMetadataProviderTests: XCTestCase {
         httpClient.configuration.requestHeaders!.add(name: "Cache-Control", value: "no-cache")
         var configuration = GitHubPackageMetadataProvider.Configuration()
         if let token = ProcessEnv.vars["GITHUB_API_TOKEN"] {
-            configuration.authTokens = [.github("api.github.com"): token]
+            configuration.authTokens = { [.github("api.github.com"): token] }
         }
         configuration.apiLimitWarningThreshold = 50
         configuration.cacheTTLInSeconds = -1 // Disable cache so we hit the API

Tests/PackageCollectionsTests/PackageCollectionsTests.swift

@@ -19,31 +19,35 @@ import TSCUtility
 
 final class PackageCollectionsTests: XCTestCase {
     func testUpdateAuthTokens() throws {
-        let configuration = PackageCollections.Configuration()
+        var authTokens: [AuthTokenType: String]? = [:]
+
+        let configuration = PackageCollections.Configuration(authTokens: { authTokens })
         let storage = makeMockStorage()
         defer { XCTAssertNoThrow(try storage.close()) }
 
-        let metadataProviderConfig = GitHubPackageMetadataProvider.Configuration(cacheTTLInSeconds: -1)
+        // disable cache for this test to avoid setup/cleanup
+        let metadataProviderConfig = GitHubPackageMetadataProvider.Configuration(authTokens: configuration.authTokens, cacheTTLInSeconds: -1)
         let metadataProvider = GitHubPackageMetadataProvider(configuration: metadataProviderConfig)
-        var packageCollections = PackageCollections(configuration: configuration, storage: storage, collectionProviders: [:], metadataProvider: metadataProvider)
+        let packageCollections = PackageCollections(configuration: configuration, storage: storage, collectionProviders: [:], metadataProvider: metadataProvider)
 
-        XCTAssertNil(packageCollections.configuration.authTokens)
+        XCTAssertEqual(0, packageCollections.configuration.authTokens()?.count)
         do {
             guard let githubMetadataProvider = packageCollections.metadataProvider as? GitHubPackageMetadataProvider else {
                 return XCTFail("Expected GitHubPackageMetadataProvider")
             }
-            XCTAssertNil(githubMetadataProvider.configuration.authTokens)
+            XCTAssertEqual(0, githubMetadataProvider.configuration.authTokens()?.count)
         }
 
-        let authTokens: [AuthTokenType: String] = [.github("github.test"): "topsekret"]
-        packageCollections.updateAuthTokens(authTokens)
+        authTokens![.github("github.test")] = "topsekret"
 
-        XCTAssertEqual(authTokens, packageCollections.configuration.authTokens)
+        // Check that authTokens change is propagated to PackageMetadataProvider
+        XCTAssertEqual(1, packageCollections.configuration.authTokens()?.count)
         do {
             guard let githubMetadataProvider = packageCollections.metadataProvider as? GitHubPackageMetadataProvider else {
                 return XCTFail("Expected GitHubPackageMetadataProvider")
             }
-            XCTAssertEqual(authTokens, githubMetadataProvider.configuration.authTokens)
+            XCTAssertEqual(1, githubMetadataProvider.configuration.authTokens()?.count)
+            XCTAssertEqual(authTokens, githubMetadataProvider.configuration.authTokens())
         }
     }