Update warning for uncached stores. (#2764)

* Update warning for uncached stores.

* update warnings

* Update tests'

* Update Store+Observation.swift

* Update ScopeCacheTests.swift

---------

Co-authored-by: Stephen Celis <stephen@stephencelis.com>

Sources/ComposableArchitecture/Observation/IdentifiedArray+Observation.swift

@@ -57,13 +57,7 @@
     ) -> some RandomAccessCollection<Store<ElementState, ElementAction>> {
       #if DEBUG
         if !self.canCacheChildren {
-          runtimeWarn(
-            """
-            Scoping from uncached \(self) is not compatible with observation. Ensure that all \
-            parent store scoping operations take key paths and case key paths instead of transform \
-            functions, which have been deprecated.
-            """
-          )
+          runtimeWarn(uncachedStoreWarning(self))
         }
       #endif
       return _StoreCollection(self.scope(state: state, action: action))

Sources/ComposableArchitecture/Observation/Store+Observation.swift

@@ -84,13 +84,7 @@
     ) -> Store<ChildState, ChildAction>? {
       #if DEBUG
         if !self.canCacheChildren {
-          runtimeWarn(
-            """
-            Scoping from uncached \(self) is not compatible with observation. Ensure that all \
-            parent store scoping operations take key paths and case key paths instead of transform \
-            functions, which have been deprecated.
-            """
-          )
+          runtimeWarn(uncachedStoreWarning(self))
         }
       #endif
       guard var childState = self.state[keyPath: state]
@@ -302,4 +296,24 @@
       }
     }
   }
+
+  func uncachedStoreWarning<State, Action>(_ store: Store<State, Action>) -> String {
+    """
+    Scoping from uncached \(store) is not compatible with observation.
+
+    This can happen for one of two reasons:
+
+    • A parent view scopes on a store using transform functions, which has been \
+    deprecated, instead of with key paths and case paths. Read the migration guide for 1.5 \
+    to update these scopes: https://pointfreeco.github.io/swift-composable-architecture/\
+    main/documentation/composablearchitecture/migratingto1.5
+
+    • A parent feature is using deprecated navigation APIs, such as 'IfLetStore', \
+    'SwitchStore', 'ForEachStore', or any navigation view modifiers taking stores instead of \
+    bindings. Read the migration guide for 1.7 to update those APIs: \
+    https://pointfreeco.github.io/swift-composable-architecture/main/documentation/\
+    composablearchitecture/migratingto1.7
+    """
+  }
+
 #endif

Tests/ComposableArchitectureTests/ScopeCacheTests.swift

@@ -18,10 +18,21 @@
             .send(.show)
         } issueMatcher: {
           $0.compactDescription == """
-            Scoping from uncached StoreOf<Feature> is not compatible with observation. Ensure that all \
-            parent store scoping operations take key paths and case key paths instead of transform \
-            functions, which have been deprecated.
-            """
+          Scoping from uncached StoreOf<Feature> is not compatible with observation.
+
+          This can happen for one of two reasons:
+
+          • A parent view scopes on a store using transform functions, which has been \
+          deprecated, instead of with key paths and case paths. Read the migration guide for 1.5 \
+          to update these scopes: https://pointfreeco.github.io/swift-composable-architecture/\
+          main/documentation/composablearchitecture/migratingto1.5
+
+          • A parent feature is using deprecated navigation APIs, such as 'IfLetStore', \
+          'SwitchStore', 'ForEachStore', or any navigation view modifiers taking stores instead of \
+          bindings. Read the migration guide for 1.7 to update those APIs: \
+          https://pointfreeco.github.io/swift-composable-architecture/main/documentation/\
+          composablearchitecture/migratingto1.7
+          """
         }
         store.send(.child(.dismiss))
       #endif
@@ -68,10 +79,21 @@
           _ = cancellable
         } issueMatcher: {
           $0.compactDescription == """
-            Scoping from uncached StoreOf<Feature> is not compatible with observation. Ensure that all \
-            parent store scoping operations take key paths and case key paths instead of transform \
-            functions, which have been deprecated.
-            """
+          Scoping from uncached StoreOf<Feature> is not compatible with observation.
+
+          This can happen for one of two reasons:
+
+          • A parent view scopes on a store using transform functions, which has been \
+          deprecated, instead of with key paths and case paths. Read the migration guide for 1.5 \
+          to update these scopes: https://pointfreeco.github.io/swift-composable-architecture/\
+          main/documentation/composablearchitecture/migratingto1.5
+
+          • A parent feature is using deprecated navigation APIs, such as 'IfLetStore', \
+          'SwitchStore', 'ForEachStore', or any navigation view modifiers taking stores instead of \
+          bindings. Read the migration guide for 1.7 to update those APIs: \
+          https://pointfreeco.github.io/swift-composable-architecture/main/documentation/\
+          composablearchitecture/migratingto1.7
+          """
         }
       #endif
     }
@@ -104,10 +126,21 @@
           )
         } issueMatcher: {
           $0.compactDescription == """
-            Scoping from uncached StoreOf<Feature> is not compatible with observation. Ensure that all \
-            parent store scoping operations take key paths and case key paths instead of transform \
-            functions, which have been deprecated.
-            """
+          Scoping from uncached StoreOf<Feature> is not compatible with observation.
+
+          This can happen for one of two reasons:
+
+          • A parent view scopes on a store using transform functions, which has been \
+          deprecated, instead of with key paths and case paths. Read the migration guide for 1.5 \
+          to update these scopes: https://pointfreeco.github.io/swift-composable-architecture/\
+          main/documentation/composablearchitecture/migratingto1.5
+
+          • A parent feature is using deprecated navigation APIs, such as 'IfLetStore', \
+          'SwitchStore', 'ForEachStore', or any navigation view modifiers taking stores instead of \
+          bindings. Read the migration guide for 1.7 to update those APIs: \
+          https://pointfreeco.github.io/swift-composable-architecture/main/documentation/\
+          composablearchitecture/migratingto1.7
+          """
         }
       #endif
     }