change key name to allow artificial nudge event delays

macadmins · May 31, 2024 · 4b1f4dd · 4b1f4dd
1 parent 8258ebe
commit 4b1f4dd
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,7 +21,7 @@ Requires macOS 12.0 and higher. Further releases and feature requests may make t
     - `nonActivelyExploitedCVEsSLA` under the `osVersionRequirement` key will default to 21 days
     - `standardInstallationSLA` under the `osVersionRequirement` key will default to 28 days
     - These dates are calculated against the `ReleaseDate` key in the SOFA feed
-      - To artificially change the `ReleaseDate` thereby giving your users a default grace period for all SOFA OS updates, please configure the `sofaPeriodLaunchDelay` key under `userExperience`
+      - To artificially delay the SOFA nudge events, see the details below for `nudgeEventLaunchDelay`
     - If you'd like to not have nudge events for releases without any known CVEs, please configure the `disableNudgeForStandardInstalls` key under `optionalFeatures` to true
 
 ### Fixed
@@ -35,6 +35,7 @@ Requires macOS 12.0 and higher. Further releases and feature requests may make t
 - Fixed errors when moving to Swift 5.10
 
 ### Added
+- To artificially change the `requredInstallationDate` thereby giving your users a default grace period for all Nudge events updates, please configure the `nudgeEventLaunchDelay` key under `userExperience`
 - A local image path can now be specified for the notification event when Nudge terminates and application
   - Please configure the `applicationTerminatedNotificationImagePath` key under `userInterface`
   - Due to limitations within Apple's API, a local path is only supported at this time

diff --git a/Nudge/Preferences/DefaultPreferencesNudge.swift b/Nudge/Preferences/DefaultPreferencesNudge.swift
@@ -364,9 +364,9 @@ struct UserExperienceVariables {
         false
     }
 
-    static var sofaPeriodLaunchDelay: Int {
-        userExperienceProfile?["sofaPeriodLaunchDelay"] as? Int ??
-        userExperienceJSON?.sofaPeriodLaunchDelay ??
+    static var nudgeEventLaunchDelay: Int {
+        userExperienceProfile?["nudgeEventLaunchDelay"] as? Int ??
+        userExperienceJSON?.nudgeEventLaunchDelay ??
         0
     }
 }

diff --git a/Nudge/Preferences/PreferencesStructure.swift b/Nudge/Preferences/PreferencesStructure.swift
@@ -324,7 +324,7 @@ struct UserExperience: Codable {
     var noTimers: Bool?
     var nudgeRefreshCycle: Int?
     var randomDelay: Bool?
-    var sofaPeriodLaunchDelay: Int?
+    var nudgeEventLaunchDelay: Int?
 }
 
 // MARK: UserExperience convenience initializers and mutators
@@ -368,7 +368,7 @@ extension UserExperience {
         noTimers: Bool? = nil,
         nudgeRefreshCycle: Int? = nil,
         randomDelay: Bool? = nil,
-        sofaPeriodLaunchDelay: Int? = nil
+        nudgeEventLaunchDelay: Int? = nil
     ) -> UserExperience {
         return UserExperience(
             allowGracePeriods: allowGracePeriods ?? self.allowGracePeriods,
@@ -393,7 +393,7 @@ extension UserExperience {
             noTimers: noTimers ?? self.noTimers,
             nudgeRefreshCycle: nudgeRefreshCycle ?? self.nudgeRefreshCycle,
             randomDelay: randomDelay ?? self.randomDelay,
-            sofaPeriodLaunchDelay: sofaPeriodLaunchDelay ?? self.sofaPeriodLaunchDelay
+            nudgeEventLaunchDelay: nudgeEventLaunchDelay ?? self.nudgeEventLaunchDelay
         )
     }
 }

diff --git a/Nudge/UI/Main.swift b/Nudge/UI/Main.swift
@@ -264,7 +264,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         handleCommandLineArguments()
         applyGracePeriodLogic()
         sofaPreLaunchLogic()
-        applySOFAPeriodLogic()
+        applydelayNudgeEventLogic()
         applyRandomDelayIfNecessary()
         updateNudgeState()
         handleSoftwareUpdateRequirements()
@@ -340,8 +340,8 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         }
     }
 
-    private func applySOFAPeriodLogic() {
-        _ = AppStateManager().sofaPeriodLogic()
+    private func applydelayNudgeEventLogic() {
+        _ = AppStateManager().delayNudgeEventLogic()
         if nudgePrimaryState.shouldExit {
             exit(0)
         }

diff --git a/Nudge/Utilities/Utils.swift b/Nudge/Utilities/Utils.swift
@@ -176,18 +176,15 @@ struct AppStateManager {
         return calculateNewRequiredInstallationDateIfNeeded(currentDate: currentDate, gracePeriodPathCreationDate: gracePeriodPathCreationDate)
     }
 
-    func sofaPeriodLogic(currentDate: Date = DateManager().getCurrentDate(), testFileDate: Date? = nil) -> Date {
-        if OptionalFeatureVariables.utilizeSOFAFeed {
-            if releaseDate.addingTimeInterval(TimeInterval(UserExperienceVariables.sofaPeriodLaunchDelay * 86400)) > currentDate {
-                LogManager.info("Device within sofaPeriodLaunchDelay, exiting Nudge", logger: uiLog)
-                nudgePrimaryState.shouldExit = true
-                return currentDate
-            } else {
-                LogManager.info("Device outside sofaPeriodLaunchDelay", logger: uiLog)
-                return PrefsWrapper.requiredInstallationDate
-            }
+    func delayNudgeEventLogic(currentDate: Date = DateManager().getCurrentDate(), testFileDate: Date? = nil) -> Date {
+        if releaseDate.addingTimeInterval(TimeInterval(UserExperienceVariables.nudgeEventLaunchDelay * 86400)) > currentDate {
+            LogManager.info("Device within nudgeEventLaunchDelay, exiting Nudge", logger: uiLog)
+            nudgePrimaryState.shouldExit = true
+            return currentDate
+        } else {
+            LogManager.info("Device outside nudgeEventLaunchDelay", logger: uiLog)
+            return PrefsWrapper.requiredInstallationDate
         }
-        return PrefsWrapper.requiredInstallationDate
     }
 
     private func isDeferralAllowed(threshold: Int, logMessage: String) -> Bool {