S3ReadmeError → S3Readme.Error

Author: finestructure

Sources/App/Commands/Ingest.swift

@@ -180,7 +180,7 @@ extension Ingestion {
             }.get()
 
             let s3Readme: S3Readme?
-            do throws(S3ReadmeError) {
+            do throws(S3Readme.Error) {
                 s3Readme = try await storeS3Readme(client: client, repository: repo, metadata: metadata, readme: readme)
             } catch {
                 // We don't want to fail ingestion in case storing the readme fails - warn and continue.
@@ -213,7 +213,7 @@ extension Ingestion {
     }
 
 
-    static func storeS3Readme(client: Client, repository: Repository, metadata: Github.Metadata, readme: Github.Readme?) async throws(S3ReadmeError) -> S3Readme? {
+    static func storeS3Readme(client: Client, repository: Repository, metadata: Github.Metadata, readme: Github.Readme?) async throws(S3Readme.Error) -> S3Readme? {
         if let upstreamEtag = readme?.etag,
            repository.s3Readme?.needsUpdate(upstreamEtag: upstreamEtag) ?? true,
            let owner = metadata.repositoryOwner,

Sources/App/Core/AppEnvironment.swift

@@ -51,9 +51,9 @@ struct AppEnvironment: Sendable {
     var siteURL: @Sendable () -> String
     var storeS3Readme: @Sendable (_ owner: String,
                                   _ repository: String,
-                                  _ readme: String) async throws(S3ReadmeError) -> String
+                                  _ readme: String) async throws(S3Readme.Error) -> String
     var storeS3ReadmeImages: @Sendable (_ client: Client,
-                                        _ imagesToCache: [Github.Readme.ImageToCache]) async throws(S3ReadmeError) -> Void
+                                        _ imagesToCache: [Github.Readme.ImageToCache]) async throws(S3Readme.Error) -> Void
     var timeZone: @Sendable () -> TimeZone
     var triggerBuild: @Sendable (_ client: Client,
                                  _ buildId: Build.Id,
@@ -88,7 +88,7 @@ extension AppEnvironment {
         fetchLicense: { client, owner, repo in await Github.fetchLicense(client:client, owner: owner, repository: repo) },
         fetchMetadata: { client, owner, repo in try await Github.fetchMetadata(client:client, owner: owner, repository: repo) },
         fetchReadme: { client, owner, repo in await Github.fetchReadme(client:client, owner: owner, repository: repo) },
-        fetchS3Readme: { client, owner, repo in try await S3Store.fetchReadme(client:client, owner: owner, repository: repo) },
+        fetchS3Readme: { client, owner, repo in try await S3Readme.fetchReadme(client:client, owner: owner, repository: repo) },
         fileManager: .live,
         getStatusCount: { client, status in
             try await Gitlab.Builder.getStatusCount(client: client,
@@ -131,11 +131,11 @@ extension AppEnvironment {
         setLogger: { logger in Self.logger = logger },
         shell: .live,
         siteURL: { Environment.get("SITE_URL") ?? "http://localhost:8080" },
-        storeS3Readme: { owner, repo, readme throws(S3ReadmeError) in
-            try await S3Store.storeReadme(owner: owner, repository: repo, readme: readme)
+        storeS3Readme: { owner, repo, readme throws(S3Readme.Error) in
+            try await S3Readme.storeReadme(owner: owner, repository: repo, readme: readme)
         },
-        storeS3ReadmeImages: { client, images throws(S3ReadmeError) in
-            try await S3Store.storeReadmeImages(client: client, imagesToCache: images)
+        storeS3ReadmeImages: { client, images throws(S3Readme.Error) in
+            try await S3Readme.storeReadmeImages(client: client, imagesToCache: images)
         },
         timeZone: { .current },
         triggerBuild: { client, buildId, cloneURL, isDocBuild, platform, ref, swiftVersion, versionID in

Sources/App/Core/Extensions/S3Store+ext.swift

@@ -16,36 +16,35 @@ import S3Store
 import Vapor
 import Dependencies
 
-#warning("Make this S3Store.Error")
-enum S3ReadmeError: Swift.Error {
-    case envVariableNotSet(String)
-    case invalidURL(String)
-    case missingBody
-    case requestFailed(key: S3Store.Key, error: Swift.Error)
-    case storeReadmeFailed
-    case storeImagesFailed
-}
 
-extension S3Store {
+extension S3Readme {
+    enum Error: Swift.Error {
+        case envVariableNotSet(String)
+        case invalidURL(String)
+        case missingBody
+        case requestFailed(key: S3Store.Key, error: Swift.Error)
+        case storeReadmeFailed
+        case storeImagesFailed
+    }
 
-    static func fetchReadme(client: Client, owner: String, repository: String) async throws(S3ReadmeError) -> String {
-        let key = try Key.readme(owner: owner, repository: repository)
+    static func fetchReadme(client: Client, owner: String, repository: String) async throws(S3Readme.Error) -> String {
+        let key = try S3Store.Key.readme(owner: owner, repository: repository)
         let response: ClientResponse
         do {
             response = try await client.get(URI(string: key.objectUrl))
         } catch {
             throw .requestFailed(key: key, error: error)
         }
-        guard let body = response.body else { throw S3ReadmeError.missingBody }
+        guard let body = response.body else { throw .missingBody }
         return body.asString()
     }
 
-    static func storeReadme(owner: String, repository: String, readme: String) async throws(S3ReadmeError) -> String {
+    static func storeReadme(owner: String, repository: String, readme: String) async throws(S3Readme.Error) -> String {
         @Dependency(\.environment) var environment
         guard let accessKeyId = environment.awsAccessKeyId() else { throw .envVariableNotSet("AWS_ACCESS_KEY_ID") }
         guard let secretAccessKey = environment.awsSecretAccessKey() else { throw .envVariableNotSet("AWS_SECRET_ACCESS_KEY")}
         let store = S3Store(credentials: .init(keyId: accessKeyId, secret: secretAccessKey))
-        let key = try Key.readme(owner: owner, repository: repository)
+        let key = try S3Store.Key.readme(owner: owner, repository: repository)
 
         Current.logger().debug("Copying readme to \(key.s3Uri) ...")
         do {
@@ -57,7 +56,7 @@ extension S3Store {
         return key.objectUrl
     }
 
-    static func storeReadmeImages(client: Client, imagesToCache: [Github.Readme.ImageToCache]) async throws(S3ReadmeError) {
+    static func storeReadmeImages(client: Client, imagesToCache: [Github.Readme.ImageToCache]) async throws(S3Readme.Error) {
         @Dependency(\.environment) var environment
         guard let accessKeyId = environment.awsAccessKeyId() else { throw .envVariableNotSet("AWS_ACCESS_KEY_ID") }
         guard let secretAccessKey = environment.awsSecretAccessKey() else { throw .envVariableNotSet("AWS_SECRET_ACCESS_KEY")}
@@ -80,7 +79,7 @@ extension S3Store {
 
 
 extension S3Store.Key {
-    static func readme(owner: String, repository: String, imageUrl: String? = nil) throws(S3ReadmeError) -> Self {
+    static func readme(owner: String, repository: String, imageUrl: String? = nil) throws(S3Readme.Error) -> Self {
         @Dependency(\.environment) var environment
         guard let bucket = environment.awsReadmeBucket() else { throw .envVariableNotSet("AWS_README_BUCKET") }
 

Tests/AppTests/IngestorTests.swift

@@ -596,7 +596,7 @@ class IngestorTests: AppTestCase {
                          imagesToCache: [])
         }
         let storeCalls = QueueIsolated(0)
-        Current.storeS3Readme = { owner, repo, html throws(S3ReadmeError) in
+        Current.storeS3Readme = { owner, repo, html throws(S3Readme.Error) in
             storeCalls.increment()
             throw .storeReadmeFailed
         }