Merge pull request #126 from unsignedapps/keith/fvd-safety

Remove dangerous FlagValueDictionary functionality

Author: bok-

Sources/Vexil/Sources/FlagValueDictionary+Collection.swift

@@ -70,6 +70,13 @@ public final class FlagValueDictionary: Identifiable, ExpressibleByDictionaryLit
         })
     }
 
+    // MARK: - Dictionary Access
+
+    /// Returns a copy of the current values in this source
+    var allValues: DictionaryType {
+        storage.withLock { $0 }
+    }
+
     // MARK: - Codable Support
 
     enum CodingKeys: String, CodingKey {
@@ -90,13 +97,3 @@ public final class FlagValueDictionary: Identifiable, ExpressibleByDictionaryLit
     }
 
 }
-
-// MARK: - Equatable Support
-
-extension FlagValueDictionary: Equatable {
-    public static func == (lhs: FlagValueDictionary, rhs: FlagValueDictionary) -> Bool {
-        let left = lhs.storage.withLock { $0 }
-        let right = rhs.storage.withLock { $0 }
-        return lhs.id == rhs.id && left == right
-    }
-}

Sources/Vexil/Sources/FlagValueDictionary.swift

@@ -10,7 +10,7 @@ The Vexil `FlagPole` supports multiple backend flag sources, and ships with the
 |------|-------------|
 | `UserDefaults` | Any `UserDefaults` instance automatically conforms to ``FlagValueSource`` |
 | `NSUbiquitousKeyValueStore` | Any `NSUbiquitousKeyValueStore` instance automatically conforms to ``FlagValueSource`` |
-| ``FlagValueDictionary`` | A dictionary-style type that conforms to `Collection` that is great for testing or other integrations. |
+| ``FlagValueDictionary`` | A wrapper for a simple dictionary that is great for testing or other integrations. |
 | ``Snapshot`` | All snapshots taken of a FlagPole can be used as a source. |
 
 ## Initialisation

Sources/Vexil/Vexil.docc/Sources.md

@@ -56,8 +56,9 @@ struct FlagValueDictionaryTests {
         snapshot.oneFlagGroup.secondLevelFlag = false
         try flagPole.save(snapshot: snapshot, to: source)
 
-        #expect(source["top-level-flag"] == .bool(true))
-        #expect(source["one-flag-group.second-level-flag"] == .bool(false))
+        let allValues = source.allValues
+        #expect(allValues["top-level-flag"] == .bool(true))
+        #expect(allValues["one-flag-group.second-level-flag"] == .bool(false))
     }
 
     // MARK: - Equatable Tests
@@ -94,9 +95,14 @@ struct FlagValueDictionaryTests {
             ]
         )
 
-        #expect(original == same)
-        #expect(original != differentContent)
-        #expect(original != differentIdentifier)
+        let originalValues = original.allValues
+        let sameValues = same.allValues
+        let differentContentValues = differentContent.allValues
+        let differentIdentifierValues = differentIdentifier.allValues
+        #expect(originalValues == sameValues)
+        #expect(originalValues != differentContentValues)
+        #expect(originalValues == differentIdentifierValues)
+        #expect(original.id != differentIdentifier.id)
 
     }
 
@@ -114,7 +120,8 @@ struct FlagValueDictionaryTests {
         let encoded = try JSONEncoder().encode(source)
         let decoded = try JSONDecoder().decode(FlagValueDictionary.self, from: encoded)
 
-        #expect(source == decoded)
+        #expect(source.allValues == decoded.allValues)
+        #expect(source.id == decoded.id)
     }
 
 

Tests/VexilTests/FlagValueDictionaryTests.swift

@@ -96,9 +96,10 @@ struct FlagValueSourceTests {
         try pole.copyFlagValues(from: source, to: destination)
 
         // THEN we expect those two dictionaries to match
-        #expect(destination.count == 2)
-        #expect(destination["test-flag"] == .bool(true))
-        #expect(destination["subgroup.test-flag"] == .bool(true))
+        let destinationValues = destination.allValues
+        #expect(destinationValues.count == 2)
+        #expect(destinationValues["test-flag"] == .bool(true))
+        #expect(destinationValues["subgroup.test-flag"] == .bool(true))
 
     }
 
@@ -116,7 +117,8 @@ struct FlagValueSourceTests {
         try pole.removeFlagValues(in: source)
 
         // THEN the source should now be empty
-        #expect(source.isEmpty)
+        let sourceValues = source.allValues
+        #expect(sourceValues.isEmpty)
 
     }