From a50eb04f3cee332eb4ed90f097a93260c6f5dff3 Mon Sep 17 00:00:00 2001
From: Nico Verbruggen <mail@nicoverbruggen.be>
Date: Sun, 8 Jan 2023 11:50:01 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=91=8C=20Services=20now=20report=20error?=
 =?UTF-8?q?=20status?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../xcschemes/PHP Monitor DEV.xcscheme        |  2 +-
 phpmon/Domain/App/Services/Service.swift      | 13 ++++++++--
 .../Domain/App/Services/ServicesManager.swift | 21 +++++++++++++---
 .../App/Services/ValetServicesManager.swift   | 20 +++++++++++++++
 phpmon/Domain/SwiftUI/Common/HelpButton.swift |  4 +--
 phpmon/Domain/SwiftUI/Menu/ServicesView.swift | 25 ++++++++++++++++---
 phpmon/Localizable.strings                    | 20 ++++++++++++++-
 7 files changed, 91 insertions(+), 14 deletions(-)

diff --git a/PHP Monitor.xcodeproj/xcshareddata/xcschemes/PHP Monitor DEV.xcscheme b/PHP Monitor.xcodeproj/xcshareddata/xcschemes/PHP Monitor DEV.xcscheme
index b0a4d86..8642ae0 100644
--- a/PHP Monitor.xcodeproj/xcshareddata/xcschemes/PHP Monitor DEV.xcscheme	
+++ b/PHP Monitor.xcodeproj/xcshareddata/xcschemes/PHP Monitor DEV.xcscheme	
@@ -91,7 +91,7 @@
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--configuration:~/.phpmon_fconf_working.json"
-            isEnabled = "YES">
+            isEnabled = "NO">
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--configuration:~/.phpmon_fconf_broken.json"
diff --git a/phpmon/Domain/App/Services/Service.swift b/phpmon/Domain/App/Services/Service.swift
index 8fca526..f6bd7ea 100644
--- a/phpmon/Domain/App/Services/Service.swift
+++ b/phpmon/Domain/App/Services/Service.swift
@@ -20,8 +20,12 @@ public struct Service: Hashable {
     init(formula: HomebrewFormula, service: HomebrewService? = nil) {
         self.formula = formula
 
-        if service != nil {
-            self.status = service!.running ? .active : .inactive
+        guard let service else { return }
+
+        self.status = service.running ? .active : .inactive
+
+        if service.status == "error" {
+            self.status = .error
         }
     }
 
@@ -41,6 +45,11 @@ public struct Service: Hashable {
     public enum Status: String {
         case active
         case inactive
+        case error
         case missing
+
+        var asBool: Bool {
+            return self == .active
+        }
     }
 }
diff --git a/phpmon/Domain/App/Services/ServicesManager.swift b/phpmon/Domain/App/Services/ServicesManager.swift
index ebc6f74..579b78d 100644
--- a/phpmon/Domain/App/Services/ServicesManager.swift
+++ b/phpmon/Domain/App/Services/ServicesManager.swift
@@ -34,6 +34,16 @@ class ServicesManager: ObservableObject {
         }
     }
 
+    public var hasError: Bool {
+        if self.services.isEmpty || !self.firstRunComplete {
+            return false
+        }
+
+        return self.services[0...2]
+            .map { $0.status }
+            .contains(.error)
+    }
+
     public var statusMessage: String {
         if self.services.isEmpty || !self.firstRunComplete {
             return "Loading..."
@@ -44,6 +54,9 @@ class ServicesManager: ObservableObject {
         if statuses.contains(.missing) {
             return "A key service is not installed."
         }
+        if statuses.contains(.error) {
+            return "A key service is reporting an error state."
+        }
         if statuses.contains(.inactive) {
             return "A key service is not running."
         }
@@ -57,10 +70,10 @@ class ServicesManager: ObservableObject {
         }
 
         let statuses = self.services[0...2].map { $0.status }
-        if statuses.contains(.missing) {
-            return .red
-        }
-        if statuses.contains(.inactive) {
+
+        if statuses.contains(.missing)
+            || statuses.contains(.inactive)
+            || statuses.contains(.error) {
             return .red
         }
 
diff --git a/phpmon/Domain/App/Services/ValetServicesManager.swift b/phpmon/Domain/App/Services/ValetServicesManager.swift
index 445c4c0..f36c594 100644
--- a/phpmon/Domain/App/Services/ValetServicesManager.swift
+++ b/phpmon/Domain/App/Services/ValetServicesManager.swift
@@ -94,6 +94,10 @@ class ValetServicesManager: ServicesManager {
         }
 
         // Prepare the appropriate command to stop or start a service
+        let before = self.homebrewServices.first { service in
+            return service.name == named
+        }
+
         let action = wrapper.status == .active ? "stop" : "start"
         let command = "services \(action) \(wrapper.formula.name)"
 
@@ -102,5 +106,21 @@ class ValetServicesManager: ServicesManager {
 
         // Reload the services status to confirm this worked
         await ServicesManager.shared.reloadServicesStatus()
+
+        Task { @MainActor in
+            let after = self.homebrewServices.first { service in
+                return service.name == named
+            }
+
+            guard let before else { return }
+            guard let after else { return }
+
+            if before.running == after.running {
+                // The status has not changed, report this to the user
+                Log.err("The service '\(named)' status has not changed. Its status is: \(after.status ?? "empty")")
+            } else {
+                Log.info("The service '\(named)' has been successfully toggled.")
+            }
+        }
     }
 }
diff --git a/phpmon/Domain/SwiftUI/Common/HelpButton.swift b/phpmon/Domain/SwiftUI/Common/HelpButton.swift
index 8fa7c46..20a5266 100644
--- a/phpmon/Domain/SwiftUI/Common/HelpButton.swift
+++ b/phpmon/Domain/SwiftUI/Common/HelpButton.swift
@@ -14,9 +14,7 @@ struct HelpButton: View {
 
     var body: some View {
         Button(action: action, label: {
-            ZStack {
-                Text("?").font(.system(size: 15, weight: .medium))
-            }
+            Text("?").font(.system(size: 12, weight: .medium))
         })
     }
 
diff --git a/phpmon/Domain/SwiftUI/Menu/ServicesView.swift b/phpmon/Domain/SwiftUI/Menu/ServicesView.swift
index 482c4d7..a820b7a 100644
--- a/phpmon/Domain/SwiftUI/Menu/ServicesView.swift
+++ b/phpmon/Domain/SwiftUI/Menu/ServicesView.swift
@@ -80,11 +80,15 @@ struct ServicesView: View {
                         .font(.system(size: 12))
                     if self.manager.statusColor == .red {
                         HelpButton {
+                            let type = manager.hasError
+                                ? "key_service_has_error"
+                                : "key_service_not_running"
+
                             // Show an alert with more information
                             BetterAlert().withInformation(
-                                title: "alert.key_service_not_running.title".localized,
-                                subtitle: "alert.key_service_not_running.subtitle".localized,
-                                description: "alert.key_service_not_running.desc".localized
+                                title: "alert.\(type).title".localized,
+                                subtitle: "alert.\(type).subtitle".localized,
+                                description: "alert.\(type).desc".localized
                             )
                             .withPrimary(text: "generic.ok".localized)
                             .show()
@@ -132,6 +136,21 @@ struct ServiceView: View {
                     .focusable(false)
                     .frame(minWidth: 70, alignment: .center)
                 }
+                if service.status == .error {
+                    Button {
+                        Task {
+                            isBusy = true
+                            await ServicesManager.shared.toggleService(named: service.name)
+                            isBusy = false
+                        }
+                    } label: {
+                        Text("E")
+                            .frame(width: 12.0, height: 12.0)
+                            .foregroundColor(Color("IconColorRed"))
+                    }
+                    .focusable(false)
+                    .frame(width: 25, height: 25)
+                }
                 if service.status == .active || service.status == .inactive {
                     Button {
                         Task {
diff --git a/phpmon/Localizable.strings b/phpmon/Localizable.strings
index 41395c0..7ad381c 100644
--- a/phpmon/Localizable.strings
+++ b/phpmon/Localizable.strings
@@ -10,7 +10,7 @@
 
 "mi_busy" = "PHP Monitor is busy...";
 "mi_unsure" = "We are not sure what version of PHP you are running.";
-"mi_php_version" = "You are running PHP";
+"mi_php_version" = "Global PHP version: PHP";
 "mi_php_switch" = "Switch to PHP";
 "mi_php_broken_1" = "Oof! It appears your PHP installation is broken...";
 "mi_php_broken_2" = "Try running `php -v` in your terminal.";
@@ -556,6 +556,24 @@ Alternatively, you can use `valet stop` and `valet start` in the terminal, which
 
 For further debugging, you may wish to check the GitHub issue tracker, where others may have had similar issues. As the developer, I attempt to make sure every question gets answered :)";
 
+"alert.key_service_has_error.title" = "Due to issues with the Homebrew services required, Valet is currently not working correctly";
+"alert.key_service_has_error.subtitle" = "For Valet to work properly, at least three key services need to be running correctly.
+
+PHP Monitor is reporting that this isn't the case. It appears that one of the affected services is reporting an error state, so I recommend clicking on the 'E'.
+
+PHP Monitor will attempt to restart the service, and should it fail (which is likely) it will offer to locate the log file if it exists, which may contain additional information that might help you debug the issue.";
+"alert.key_service_has_error.desc" = "Unfortunately, if a service reports an error, this is often due to an invalid configuration state, which may be difficult to debug.
+
+COMMON TROUBLESHOOTING TIPS
+
+• Try restarting the service and checking the log file (if it exists) first. You can have PHP Monitor do this by clicking on the 'E' button.
+
+• PHP: If you are seeing an error status, there may be an issue with PHP's configuration. Make sure the .ini files in the Homebrew installation are OK, and there are no socket conflicts.
+
+• nginx: If you are seeing an error status, a site is likely misconfigured (usually noted in the error log). You will likely want to check Valet's nginx folder.
+
+• dnsmasq: If you are seeing an error status, the dnsmasq configuration file is likely broken (usually located at ~/.config/valet/dnsmasq.d).";
+
 // CHECK FOR UPDATES
 
 "updater.alerts.newer_version_available.title" = "PHP Monitor v%@ is now available!";