Replace Prefire with a very similar but simpler and more direct appro…

…ach (#3232)

* Replace Prefire with a very similar but simpler and more direct approach

* Move PreviewTest snapshots to their new location (snapshotting default, mirrors UITests)

* Update acknowledgements

* Switch snapshot configuration extensions to a custom version

* Exclude snapshots from the PreviewTests target

* Fix acknowledgements

* Rename snapshotting preference keys

* Remove `skipPackagePluginValidation`

.gitattributes

@@ -1,4 +1,4 @@
 UITests/Sources/__Snapshots__/** filter=lfs diff=lfs merge=lfs -text
 UnitTests/Resources/** filter=lfs diff=lfs merge=lfs -text
 UnitTests/__Snapshots__/** filter=lfs diff=lfs merge=lfs -text
-PreviewTests/__Snapshots__/** filter=lfs diff=lfs merge=lfs -text
+PreviewTests/Sources/__Snapshots__/** filter=lfs diff=lfs merge=lfs -text

ElementX.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -1,5 +1,5 @@
 {
-  "originHash" : "1b1fb14b1ac1438c44ffd2f0151af65c83018d71b8674cd7f13ec21abeb31bcd",
+  "originHash" : "52385e2a478cc9455693d0b93dc33b988ac1d4742acceeaee288944dff8b78e0",
   "pins" : [
     {
       "identity" : "compound-design-tokens",

ElementX/Sources/Other/Extensions/Snapshotting.swift

@@ -0,0 +1,58 @@
+//
+// Copyright 2024 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+public struct SnapshotDelayPreferenceKey: PreferenceKey {
+    public static var defaultValue: TimeInterval = 0.0
+
+    public static func reduce(value: inout TimeInterval, nextValue: () -> TimeInterval) {
+        value = nextValue()
+    }
+}
+
+public struct SnapshotPrecisionPreferenceKey: PreferenceKey {
+    public static var defaultValue: Float = 1.0
+
+    public static func reduce(value: inout Float, nextValue: () -> Float) {
+        value = nextValue()
+    }
+}
+
+public struct SnapshotPerceptualPrecisionPreferenceKey: PreferenceKey {
+    public static var defaultValue: Float = 1.0
+
+    public static func reduce(value: inout Float, nextValue: () -> Float) {
+        value = nextValue()
+    }
+}
+
+public extension SwiftUI.View {
+    /// Use this modifier when you want to apply snapshot-specific preferences,
+    /// like delay and precision, to the view.
+    /// These preferences can then be retrieved and used elsewhere in your view hierarchy.
+    ///
+    /// - Parameters:
+    ///   - delay: The delay time in seconds that you want to set as a preference to the View.
+    ///   - precision: The percentage of pixels that must match.
+    ///   - perceptualPrecision: The percentage a pixel must match the source pixel to be considered a match. 98-99% mimics the precision of the human eye.
+    @inlinable
+    func snapshotPreferences(delay: TimeInterval = .zero, precision: Float = 1.0, perceptualPrecision: Float = 1.0) -> some SwiftUI.View {
+        preference(key: SnapshotDelayPreferenceKey.self, value: delay)
+            .preference(key: SnapshotPrecisionPreferenceKey.self, value: precision)
+            .preference(key: SnapshotPerceptualPrecisionPreferenceKey.self, value: perceptualPrecision)
+    }
+}

ElementX/Sources/Other/TestablePreview.swift

@@ -7,6 +7,4 @@
 
 import SwiftUI
 
-import Prefire
-
-protocol TestablePreview: PrefireProvider { }
+protocol TestablePreview { }

ElementX/Sources/Screens/EmojiPickerScreen/View/EmojiPickerScreen.swift

@@ -86,7 +86,7 @@ struct EmojiPickerScreen_Previews: PreviewProvider, TestablePreview {
     static var previews: some View {
         EmojiPickerScreen(context: viewModel.context, selectedEmojis: ["😀", "😄"])
             .previewDisplayName("Screen")
-            .snapshot(delay: 0.5)
+            .snapshotPreferences(delay: 0.5)
     }
 }
 

ElementX/Sources/Screens/HomeScreen/View/HomeScreen.swift

@@ -202,13 +202,13 @@ struct HomeScreen_Previews: PreviewProvider, TestablePreview {
             HomeScreen(context: emptyViewModel.context)
         }
         .previewDisplayName("Empty")
-        .snapshot(delay: 4.0)
+        .snapshotPreferences(delay: 4.0)
 
         NavigationStack {
             HomeScreen(context: loadedViewModel.context)
         }
         .previewDisplayName("Loaded")
-        .snapshot(delay: 4.0)
+        .snapshotPreferences(delay: 4.0)
     }
 
     static func viewModel(_ mode: HomeScreenRoomListMode) -> HomeScreenViewModel {

ElementX/Sources/Screens/JoinRoomScreen/View/JoinRoomScreen.swift

@@ -111,25 +111,25 @@ struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
             JoinRoomScreen(context: unknownViewModel.context)
         }
         .previewDisplayName("Unknown")
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
 
         NavigationStack {
             JoinRoomScreen(context: knockViewModel.context)
         }
         .previewDisplayName("Knock")
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
 
         NavigationStack {
             JoinRoomScreen(context: joinViewModel.context)
         }
         .previewDisplayName("Join")
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
 
         NavigationStack {
             JoinRoomScreen(context: inviteViewModel.context)
         }
         .previewDisplayName("Invite")
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
     }
 
     static func makeViewModel(mode: JoinRoomScreenInteractionMode) -> JoinRoomScreenViewModel {

ElementX/Sources/Screens/Onboarding/IdentityConfirmationScreen/View/IdentityConfirmationScreen.swift

@@ -113,7 +113,7 @@ struct IdentityConfirmationScreen_Previews: PreviewProvider, TestablePreview {
         NavigationStack {
             IdentityConfirmationScreen(context: viewModel.context)
         }
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
     }
 
     private static var viewModel: IdentityConfirmationScreenViewModel {

ElementX/Sources/Screens/RoomDetailsEditScreen/View/RoomDetailsEditScreen.swift

@@ -172,12 +172,12 @@ struct RoomDetailsEditScreen_Previews: PreviewProvider, TestablePreview {
             RoomDetailsEditScreen(context: readOnlyViewModel.context)
         }
         .previewDisplayName("Read only")
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
 
         NavigationStack {
             RoomDetailsEditScreen(context: editableViewModel.context)
         }
         .previewDisplayName("Editable")
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
     }
 }

ElementX/Sources/Screens/RoomDetailsScreen/View/RoomDetailsScreen.swift

@@ -392,12 +392,12 @@ struct RoomDetailsScreen_Previews: PreviewProvider, TestablePreview {
     static var previews: some View {
         RoomDetailsScreen(context: simpleRoomViewModel.context)
             .previewDisplayName("Simple Room")
-            .snapshot(delay: 2)
+            .snapshotPreferences(delay: 2)
         RoomDetailsScreen(context: dmRoomViewModel.context)
             .previewDisplayName("DM Room")
-            .snapshot(delay: 0.25)
+            .snapshotPreferences(delay: 0.25)
         RoomDetailsScreen(context: genericRoomViewModel.context)
             .previewDisplayName("Generic Room")
-            .snapshot(delay: 0.25)
+            .snapshotPreferences(delay: 0.25)
     }
 }

ElementX/Sources/Screens/RoomDirectorySearchScreen/View/RoomDirectorySearchScreen.swift

@@ -98,6 +98,6 @@ struct RoomDirectorySearchScreen_Previews: PreviewProvider, TestablePreview {
 
     static var previews: some View {
         RoomDirectorySearchScreen(context: viewModel.context)
-            .snapshot(delay: 1.0)
+            .snapshotPreferences(delay: 1.0)
     }
 }

ElementX/Sources/Screens/RoomMemberDetailsScreen/View/RoomMemberDetailsScreen.swift

@@ -124,13 +124,13 @@ struct RoomMemberDetailsScreen_Previews: PreviewProvider, TestablePreview {
     static var previews: some View {
         RoomMemberDetailsScreen(context: otherUserViewModel.context)
             .previewDisplayName("Other User")
-            .snapshot(delay: 0.25)
+            .snapshotPreferences(delay: 0.25)
         RoomMemberDetailsScreen(context: accountOwnerViewModel.context)
             .previewDisplayName("Account Owner")
-            .snapshot(delay: 0.25)
+            .snapshotPreferences(delay: 0.25)
         RoomMemberDetailsScreen(context: ignoredUserViewModel.context)
             .previewDisplayName("Ignored User")
-            .snapshot(delay: 0.25)
+            .snapshotPreferences(delay: 0.25)
     }
 
     static func makeViewModel(member: RoomMemberProxyMock) -> RoomMemberDetailsScreenViewModel {

ElementX/Sources/Screens/RoomMemberListScreen/View/RoomMembersListManageMemberSheet.swift

@@ -72,13 +72,13 @@ struct RoomMembersListManageMemberSheet_Previews: PreviewProvider, TestablePrevi
                                          actions: [.kick, .ban],
                                          context: viewModel.context)
             .previewDisplayName("Joined")
-            .snapshot(delay: 0.2)
+            .snapshotPreferences(delay: 0.2)
 
         RoomMembersListManageMemberSheet(member: .init(withProxy: RoomMemberProxyMock.mockBanned[3]),
                                          actions: [],
                                          context: viewModel.context)
             .previewDisplayName("Banned")
-            .snapshot(delay: 0.2)
+            .snapshotPreferences(delay: 0.2)
     }
 }
 

ElementX/Sources/Screens/RoomMemberListScreen/View/RoomMembersListScreen.swift

@@ -117,31 +117,31 @@ struct RoomMembersListScreen_Previews: PreviewProvider, TestablePreview {
         NavigationStack {
             RoomMembersListScreen(context: viewModel.context)
         }
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
         .previewDisplayName("Member")
 
         NavigationStack {
             RoomMembersListScreen(context: invitesViewModel.context)
         }
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
         .previewDisplayName("Invites")
 
         NavigationStack {
             RoomMembersListScreen(context: adminViewModel.context)
         }
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
         .previewDisplayName("Admin: Members")
 
         NavigationStack {
             RoomMembersListScreen(context: bannedViewModel.context)
         }
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
         .previewDisplayName("Admin: Banned")
 
         NavigationStack {
             RoomMembersListScreen(context: emptyBannedViewModel.context)
         }
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
         .previewDisplayName("Admin: Empty Banned")
     }
 

ElementX/Sources/Screens/RoomPollsHistoryScreen/View/RoomPollsHistoryScreen.swift

@@ -151,12 +151,12 @@ struct RoomPollsHistoryScreen_Previews: PreviewProvider, TestablePreview {
             RoomPollsHistoryScreen(context: viewModelEmpty.context)
         }
         .previewDisplayName("No polls")
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
 
         NavigationStack {
             RoomPollsHistoryScreen(context: viewModel.context)
         }
         .previewDisplayName("polls")
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
     }
 }

ElementX/Sources/Screens/SecureBackup/SecureBackupScreen/View/SecureBackupScreen.swift

@@ -148,7 +148,7 @@ struct SecureBackupScreen_Previews: PreviewProvider, TestablePreview {
             }
             .previewDisplayName("Recovery incomplete")
         }
-        .snapshot(delay: 1.0)
+        .snapshotPreferences(delay: 1.0)
     }
 
     static func viewModel(keyBackupState: SecureBackupKeyBackupState,

ElementX/Sources/Screens/Settings/NotificationSettingsScreen/View/NotificationSettingsScreen.swift

@@ -253,9 +253,9 @@ struct NotificationSettingsScreen_Previews: PreviewProvider, TestablePreview {
 
     static var previews: some View {
         NotificationSettingsScreen(context: viewModel.context)
-            .snapshot(delay: 2.0)
+            .snapshotPreferences(delay: 2.0)
         NotificationSettingsScreen(context: viewModelConfigurationMismatch.context)
-            .snapshot(delay: 2.0)
+            .snapshotPreferences(delay: 2.0)
             .previewDisplayName("Configuration mismatch")
     }
 }

ElementX/Sources/Screens/Settings/SettingsScreen/View/SettingsScreen.swift

@@ -224,7 +224,7 @@ struct SettingsScreen_Previews: PreviewProvider, TestablePreview {
     static var previews: some View {
         NavigationStack {
             SettingsScreen(context: viewModel.context)
-                .snapshot(delay: 1.0)
+                .snapshotPreferences(delay: 1.0)
         }
     }
 }

ElementX/Sources/Screens/Timeline/View/Replies/TimelineReplyView.swift

@@ -317,7 +317,7 @@ struct TimelineReplyView_Previews: PreviewProvider, TestablePreview {
         .padding()
         .environmentObject(viewModel.context)
         // Allow member names to load. Reduce precission as the `imageSource` randomly renders slightly differently
-        .snapshot(delay: 0.2, precision: 0.98)
+        .snapshotPreferences(delay: 0.2, precision: 0.98)
         .previewLayout(.sizeThatFits)
     }
 }

ElementX/Sources/Screens/Timeline/View/TimelineItemViews/FormattedBodyText.swift

@@ -205,7 +205,7 @@ struct FormattedBodyText_Previews: PreviewProvider, TestablePreview {
             .padding()
         }
         .previewLayout(.sizeThatFits)
-        .snapshot(delay: 0.25)
+        .snapshotPreferences(delay: 0.25)
     }
 }
 

ElementX/Sources/Screens/UserProfileScreen/View/UserProfileScreen.swift

@@ -97,10 +97,10 @@ struct UserProfileScreen_Previews: PreviewProvider, TestablePreview {
     static var previews: some View {
         UserProfileScreen(context: otherUserViewModel.context)
             .previewDisplayName("Other User")
-            .snapshot(delay: 0.25)
+            .snapshotPreferences(delay: 0.25)
         UserProfileScreen(context: accountOwnerViewModel.context)
             .previewDisplayName("Account Owner")
-            .snapshot(delay: 0.25)
+            .snapshotPreferences(delay: 0.25)
     }
 
     static func makeViewModel(userID: String) -> UserProfileScreenViewModel {

ElementX/SupportingFiles/target.yml

@@ -139,14 +139,26 @@ targets:
         else
             echo "warning: SwiftGen not installed, download from https://github.com/SwiftGen/SwiftGen"
         fi
-    - name: 🧙 Sourcery
+    - name: 🧙 Sourcery - Generate mocks
       runOnlyWhenInstalling: false
       basedOnDependencyAnalysis: false
       shell: /bin/sh
       script: |
         export PATH="$PATH:/opt/homebrew/bin"
         if which sourcery >/dev/null; then
-            sourcery --config Tools/Sourcery/sourcery_automockable_config.yml
+            sourcery --config Tools/Sourcery/AutoMockableConfig.yml
+        else
+            echo "warning: Sourcery not installed, run swift run tools setup-project"
+        fi
+
+    - name: 🧙 Sourcery - Generate preview tests
+      runOnlyWhenInstalling: false
+      basedOnDependencyAnalysis: false
+      shell: /bin/sh
+      script: |
+        export PATH="$PATH:/opt/homebrew/bin"
+        if which sourcery >/dev/null; then
+            sourcery --config Tools/Sourcery/PreviewTestsConfig.yml
         else
             echo "warning: Sourcery not installed, run swift run tools setup-project"
         fi
@@ -202,7 +214,6 @@ targets:
     - package: Version
     - package: Emojibase
     - package: WysiwygComposer
-    - package: Prefire
     - package: SwiftOGG
     - package: DSWaveformImage
       product: DSWaveformImageViews

NSE/SupportingFiles/target.yml

@@ -40,7 +40,6 @@ targets:
       - package: DeviceKit
       - package: DTCoreText
       - package: LRUCache
-      - package: Prefire
       - package: Version
 
     info:
@@ -76,7 +75,8 @@ targets:
     - path: ../../ElementX/Sources/AppHooks/AppHooks.swift
     - path: ../../ElementX/Sources/AppHooks/Hooks/ClientBuilderHook.swift
     - path: ../../ElementX/Sources/Application/AppSettings.swift
-    - path: ../../ElementX/Sources/Generated
+    - path: ../../ElementX/Sources/Generated/Assets.swift
+    - path: ../../ElementX/Sources/Generated/Strings.swift
     - path: ../../ElementX/Sources/Other/AvatarSize.swift
     - path: ../../ElementX/Sources/Other/CurrentValuePublisher.swift
     - path: ../../ElementX/Sources/Other/Extensions/AttributedString.swift