Detect SyncEngine.isSynchronizing misuse in triggers (#381)

* Detect `SyncEngine.isSynchronizing` misuse in triggers

A warning is raised to suggest `$isSynchronizing`, instead.

* re-record snaps

* wip

* wip

* wip

Author: stephencelis

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

@@ -37,7 +37,7 @@ let package = Package(
     .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.18.4"),
     .package(
       url: "https://github.com/pointfreeco/swift-structured-queries",
-      from: "0.27.0",
+      from: "0.29.0",
       traits: [
         .trait(name: "StructuredQueriesTagged", condition: .when(traits: ["SQLiteDataTagged"]))
       ]

Package.resolved

@@ -28,7 +28,7 @@ let package = Package(
     .package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.9.0"),
     .package(url: "https://github.com/pointfreeco/swift-sharing", from: "2.3.0"),
     .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.18.4"),
-    .package(url: "https://github.com/pointfreeco/swift-structured-queries", from: "0.27.0"),
+    .package(url: "https://github.com/pointfreeco/swift-structured-queries", from: "0.29.0"),
     .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.5.0"),
   ],
   targets: [

Package.swift

@@ -899,7 +899,15 @@
     /// See <doc:CloudKit#Updating-triggers-to-be-compatible-with-synchronization> for more info.
     @DatabaseFunction("sqlitedata_icloud_syncEngineIsSynchronizingChanges")
     public static var isSynchronizing: Bool {
-      _isSynchronizingChanges
+      if _isCreatingTemporaryTrigger {
+        reportIssue(
+          """
+          Invoked 'SyncEngine.isSynchronizing' at trigger creation, which is unexpected. Use \
+          'SyncEngine.$isSynchronizing' to invoke at trigger execution, instead.
+          """
+        )
+      }
+      return _isSynchronizingChanges
     }
 
     @available(*, deprecated, message: "Use 'SyncEngine.$isSynchronizing', instead.")

Package@swift-6.0.swift

@@ -136,7 +136,7 @@ struct AssertQueryTests {
         """
         SELECT "records"."id", "records"."date"
         FROM "records"
-        WHERE ("records"."id") = (1)
+        WHERE (("records"."id") = (1))
         """
       } results: {
         """

Sources/SQLiteData/CloudKit/SyncEngine.swift

@@ -93,6 +93,28 @@
             """
         )
       }
+
+      @Test func isSynchronizingTriggerWarning() {
+        withKnownIssue {
+          _ = Reminder.createTemporaryTrigger(
+            after: .insert { new in
+              Values(SyncEngine.isSynchronizing)
+            }
+          )
+        } matching: { issue in
+          issue.description.hasSuffix(
+            """
+            Invoked 'SyncEngine.isSynchronizing' at trigger creation, which is unexpected. Use \
+            'SyncEngine.$isSynchronizing' to invoke at trigger execution, instead.
+            """
+          )
+        }
+        _ = Reminder.createTemporaryTrigger(
+          after: .insert { new in
+            Values(SyncEngine.$isSynchronizing)
+          }
+        )
+      }
     }
   }