Homepage Interstitial -> Maintenance Message.

Author: daveverwer

FrontEnd/styles/maintenance.scss

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // -------------------------------------------------------------------------
-// Site maintenance page, set by HOMEPAGE_INTERSTITIAL in the environment.
+// Site maintenance page which replaces the home page when enabled.
 // -------------------------------------------------------------------------
 
 body.maintenance {
@@ -29,7 +29,7 @@ body.maintenance {
             background-position: top center;
             background-repeat: no-repeat;
             background-size: 40px;
-            background-image: var(--image-warning);
+            background-image: var(--image-info);
         }
     }
 }

Sources/App/Core/AppEnvironment.swift

@@ -59,7 +59,7 @@ struct AppEnvironment: Sendable {
     var gitlabPipelineToken: @Sendable () -> String?
     var gitlabPipelineLimit: @Sendable () -> Int
     var hideStagingBanner: @Sendable () -> Bool
-    var homepageInterstitial: @Sendable () -> String?
+    var maintenanceMessage: @Sendable () -> String?
     var httpClient: @Sendable () -> Client
     var loadSPIManifest: @Sendable (String) -> SPIManifest.Manifest?
     var logger: @Sendable () -> Logger
@@ -195,8 +195,8 @@ extension AppEnvironment {
             Environment.get("HIDE_STAGING_BANNER").flatMap(\.asBool)
                 ?? Constants.defaultHideStagingBanner
         },
-        homepageInterstitial: {
-            Environment.get("HOMEPAGE_INTERSTITIAL").flatMap(\.trimmed)
+        maintenanceMessage: {
+            Environment.get("MAINTENANCE_MESSAGE").flatMap(\.trimmed)
         },
         httpClient: { httpClient },
         loadSPIManifest: { path in SPIManifest.Manifest.load(in: path) },

Sources/App/Views/Maintenance/Maintenance+Model.swift renamed to Sources/App/Views/MaintenanceMessage/Maintenance+Model.swift

@@ -15,7 +15,7 @@
 import Foundation
 import Ink
 
-enum MaintenanceIndex {
+enum MaintenanceMessageIndex {
 
     struct Model {
 

Sources/App/Views/Maintenance/Maintenance+View.swift renamed to Sources/App/Views/MaintenanceMessage/Maintenance+View.swift

@@ -15,7 +15,7 @@
 import Foundation
 import Plot
 
-extension MaintenanceIndex {
+extension MaintenanceMessageIndex {
 
     class View: PublicPage {
 

Sources/App/routes.swift

@@ -23,9 +23,9 @@ import VaporToOpenAPI
 func routes(_ app: Application) throws {
     do {  // home page
         app.get { req in
-            if let interstitial = Current.homepageInterstitial() {
-                let model = MaintenanceIndex.Model(markdown: interstitial)
-                return MaintenanceIndex.View(path: req.url.path, model: model).document()
+            if let maintenanceMessage = Current.maintenanceMessage() {
+                let model = MaintenanceMessageIndex.Model(markdown: maintenanceMessage)
+                return MaintenanceMessageIndex.View(path: req.url.path, model: model).document()
             } else {
                 let model = try await HomeIndex.Model.query(database: req.db)
                 return HomeIndex.View(path: req.url.path, model: model).document()

Tests/AppTests/AppEnvironmentTests.swift

@@ -29,28 +29,28 @@ class AppEnvironmentTests: XCTestCase {
         XCTAssertEqual(Current.fileManager.checkoutsDirectory(), "/tmp/foo")
     }
 
-    func test_homepageInterstitial() throws {
-        defer { unsetenv("HOMEPAGE_INTERSTITIAL") }
-        Current.homepageInterstitial = AppEnvironment.live.homepageInterstitial
+    func test_maintenanceMessage() throws {
+        defer { unsetenv("MAINTENANCE_MESSAGE") }
+        Current.maintenanceMessage = AppEnvironment.live.maintenanceMessage
         do {
-            unsetenv("HOMEPAGE_INTERSTITIAL")
-            XCTAssertEqual(Current.homepageInterstitial(), nil)
+            unsetenv("MAINTENANCE_MESSAGE")
+            XCTAssertEqual(Current.maintenanceMessage(), nil)
         }
         do {
-            setenv("HOMEPAGE_INTERSTITIAL", "foo", 1)
-            XCTAssertEqual(Current.homepageInterstitial(), "foo")
+            setenv("MAINTENANCE_MESSAGE", "foo", 1)
+            XCTAssertEqual(Current.maintenanceMessage(), "foo")
         }
         do {
-            setenv("HOMEPAGE_INTERSTITIAL", "", 1)
-            XCTAssertEqual(Current.homepageInterstitial(), nil)
+            setenv("MAINTENANCE_MESSAGE", "", 1)
+            XCTAssertEqual(Current.maintenanceMessage(), nil)
         }
         do {
-            setenv("HOMEPAGE_INTERSTITIAL", " ", 1)
-            XCTAssertEqual(Current.homepageInterstitial(), nil)
+            setenv("MAINTENANCE_MESSAGE", " ", 1)
+            XCTAssertEqual(Current.maintenanceMessage(), nil)
         }
         do {
-            setenv("HOMEPAGE_INTERSTITIAL", " \t\n ", 1)
-            XCTAssertEqual(Current.homepageInterstitial(), nil)
+            setenv("MAINTENANCE_MESSAGE", " \t\n ", 1)
+            XCTAssertEqual(Current.maintenanceMessage(), nil)
         }
     }
 

Tests/AppTests/Mocks/AppEnvironment+mock.swift

@@ -62,7 +62,7 @@ extension AppEnvironment {
             gitlabPipelineToken: { nil },
             gitlabPipelineLimit: { Constants.defaultGitlabPipelineLimit },
             hideStagingBanner: { false },
-            homepageInterstitial: { nil },
+            maintenanceMessage: { nil },
             httpClient: { httpClient },
             loadSPIManifest: { _ in nil },
             logger: { logger },

Tests/AppTests/RoutesTests.swift

@@ -65,11 +65,11 @@ final class RoutesTests: AppTestCase {
         }
     }
 
-    func test_HomePageInterstitial() throws {
-        Current.homepageInterstitial = { "HOMEPAGE_INTERSTITIAL" }
+    func test_maintenanceMessage() throws {
+        Current.maintenanceMessage = { "MAINTENANCE_MESSAGE" }
 
         try app.test(.GET, "/") { res in
-            XCTAssertContains(res.body.string, "HOMEPAGE_INTERSTITIAL")
+            XCTAssertContains(res.body.string, "MAINTENANCE_MESSAGE")
         }
     }
 

Tests/AppTests/WebpageSnapshotTests.swift

@@ -48,17 +48,17 @@ class WebpageSnapshotTests: SnapshotTestCase {
         assertSnapshot(of: page, as: .html)
     }
 
-    func test_MaintenanceIndexView() throws {
-        let interstitial = """
+    func test_MaintenanceMessageIndexView() throws {
+        let maintenanceMessage = """
             # ⚠️ Server Maintenance ⚠️
             
             We are currently performing an update to our database server.
             
             Service should be restored within a few minutes.
             """
 
-        let model = MaintenanceIndex.Model(markdown: interstitial)
-        let page = { MaintenanceIndex.View(path: "/", model: model).document() }
+        let model = MaintenanceMessageIndex.Model(markdown: maintenanceMessage)
+        let page = { MaintenanceMessageIndex.View(path: "/", model: model).document() }
 
         assertSnapshot(of: page, as: .html)
     }