Move Current.maintenanceMessage to EnvironmentClient.maintenanceMessage

Author: finestructure

Sources/App/Core/AppEnvironment.swift

@@ -30,7 +30,6 @@ struct AppEnvironment: Sendable {
     var gitlabApiToken: @Sendable () -> String?
     var gitlabPipelineToken: @Sendable () -> String?
     var gitlabPipelineLimit: @Sendable () -> Int
-    var maintenanceMessage: @Sendable () -> String?
     var loadSPIManifest: @Sendable (String) -> SPIManifest.Manifest?
     var logger: @Sendable () -> Logger
     var metricsPushGatewayUrl: @Sendable () -> String?
@@ -76,9 +75,6 @@ extension AppEnvironment {
             Environment.get("GITLAB_PIPELINE_LIMIT").flatMap(Int.init)
             ?? Constants.defaultGitlabPipelineLimit
         },
-        maintenanceMessage: {
-            Environment.get("MAINTENANCE_MESSAGE").flatMap(\.trimmed)
-        },
         loadSPIManifest: { path in SPIManifest.Manifest.load(in: path) },
         logger: { logger },
         metricsPushGatewayUrl: { Environment.get("METRICS_PUSHGATEWAY_URL") },

Sources/App/Core/Dependencies/EnvironmentClient.swift

@@ -41,6 +41,7 @@ struct EnvironmentClient {
     var current: @Sendable () -> Environment = { XCTFail("current"); return .development }
     var dbId: @Sendable () -> String?
     var hideStagingBanner: @Sendable () -> Bool = { XCTFail("hideStagingBanner"); return Constants.defaultHideStagingBanner }
+    var maintenanceMessage: @Sendable () -> String?
     var mastodonCredentials: @Sendable () -> Mastodon.Credentials?
     var random: @Sendable (_ range: ClosedRange<Double>) -> Double = { XCTFail("random"); return Double.random(in: $0) }
 
@@ -107,6 +108,9 @@ extension EnvironmentClient: DependencyKey {
                 Environment.get("HIDE_STAGING_BANNER").flatMap(\.asBool)
                     ?? Constants.defaultHideStagingBanner
             },
+            maintenanceMessage: {
+                Environment.get("MAINTENANCE_MESSAGE").flatMap(\.trimmed)
+            },
             mastodonCredentials: {
                 Environment.get("MASTODON_ACCESS_TOKEN")
                     .map(Mastodon.Credentials.init(accessToken:))

Sources/App/routes.swift

@@ -26,7 +26,7 @@ func routes(_ app: Application) throws {
 
     do {  // home page
         app.get { req in
-            if let maintenanceMessage = Current.maintenanceMessage() {
+            if let maintenanceMessage = environment.maintenanceMessage() {
                 let model = MaintenanceMessageIndex.Model(markdown: maintenanceMessage)
                 return MaintenanceMessageIndex.View(path: req.url.path, model: model).document()
             } else {

Tests/AppTests/AppEnvironmentTests.swift

@@ -12,10 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import XCTest
+
 @testable import App
 
+import Dependencies
 import Vapor
-import XCTest
 
 
 class AppEnvironmentTests: XCTestCase {
@@ -31,26 +33,30 @@ class AppEnvironmentTests: XCTestCase {
 
     func test_maintenanceMessage() throws {
         defer { unsetenv("MAINTENANCE_MESSAGE") }
-        Current.maintenanceMessage = AppEnvironment.live.maintenanceMessage
-        do {
-            unsetenv("MAINTENANCE_MESSAGE")
-            XCTAssertEqual(Current.maintenanceMessage(), nil)
-        }
-        do {
-            setenv("MAINTENANCE_MESSAGE", "foo", 1)
-            XCTAssertEqual(Current.maintenanceMessage(), "foo")
-        }
-        do {
-            setenv("MAINTENANCE_MESSAGE", "", 1)
-            XCTAssertEqual(Current.maintenanceMessage(), nil)
-        }
-        do {
-            setenv("MAINTENANCE_MESSAGE", " ", 1)
-            XCTAssertEqual(Current.maintenanceMessage(), nil)
-        }
-        do {
-            setenv("MAINTENANCE_MESSAGE", " \t\n ", 1)
-            XCTAssertEqual(Current.maintenanceMessage(), nil)
+        withDependencies {
+            $0.environment.maintenanceMessage = EnvironmentClient.liveValue.maintenanceMessage
+        } operation: {
+            @Dependency(\.environment) var environment
+            do {
+                unsetenv("MAINTENANCE_MESSAGE")
+                XCTAssertEqual(environment.maintenanceMessage(), nil)
+            }
+            do {
+                setenv("MAINTENANCE_MESSAGE", "foo", 1)
+                XCTAssertEqual(environment.maintenanceMessage(), "foo")
+            }
+            do {
+                setenv("MAINTENANCE_MESSAGE", "", 1)
+                XCTAssertEqual(environment.maintenanceMessage(), nil)
+            }
+            do {
+                setenv("MAINTENANCE_MESSAGE", " ", 1)
+                XCTAssertEqual(environment.maintenanceMessage(), nil)
+            }
+            do {
+                setenv("MAINTENANCE_MESSAGE", " \t\n ", 1)
+                XCTAssertEqual(environment.maintenanceMessage(), nil)
+            }
         }
     }
 

Tests/AppTests/Mocks/AppEnvironment+mock.swift

@@ -29,7 +29,6 @@ extension AppEnvironment {
             gitlabApiToken: { nil },
             gitlabPipelineToken: { nil },
             gitlabPipelineLimit: { Constants.defaultGitlabPipelineLimit },
-            maintenanceMessage: { nil },
             loadSPIManifest: { _ in nil },
             logger: { logger },
             metricsPushGatewayUrl: { "http://pushgateway:9091" },

Tests/AppTests/RoutesTests.swift

@@ -83,8 +83,8 @@ final class RoutesTests: AppTestCase {
     func test_maintenanceMessage() throws {
         try withDependencies {
             $0.environment.dbId = { nil }
+            $0.environment.maintenanceMessage = { "MAINTENANCE_MESSAGE" }
         } operation: {
-            Current.maintenanceMessage = { "MAINTENANCE_MESSAGE" }
 
             try app.test(.GET, "/") { res in
                 XCTAssertContains(res.body.string, "MAINTENANCE_MESSAGE")