Nightly auto-update (120.0.20231014050328)

Author: Firefox Sync Engineering

Package.swift

@@ -1,13 +1,13 @@
 // swift-tools-version:5.4
 import PackageDescription
 
-let checksum = "2eb94b2393b6b8cae51c237dc055b8593fa7f7ce4d41949d3c9b9af07fd444ed"
-let version = "120.0.20231013050343"
-let url = "https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/project.application-services.v2.swift.120.20231013050343/artifacts/public/build/MozillaRustComponents.xcframework.zip"
+let checksum = "ab662923bad291baca19c355cbd02ec0739a98b25ee40d5a53b70bd4db50b317"
+let version = "120.0.20231014050328"
+let url = "https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/project.application-services.v2.swift.120.20231014050328/artifacts/public/build/MozillaRustComponents.xcframework.zip"
 
 // Focus xcframework
-let focusChecksum = "084bd8be1c3579a40a4f771f26ae5ea96746d9052696e72b3660d7d942903d69"
-let focusUrl = "https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/project.application-services.v2.swift.120.20231013050343/artifacts/public/build/FocusRustComponents.xcframework.zip"
+let focusChecksum = "4612cbbf65c3e60858790ca26a7e136f49adce0482d55a200ec45990bedb575a"
+let focusUrl = "https://firefox-ci-tc.services.mozilla.com/api/index/v1/task/project.application-services.v2.swift.120.20231014050328/artifacts/public/build/FocusRustComponents.xcframework.zip"
 let package = Package(
     name: "MozillaRustComponentsSwift",
     platforms: [.iOS(.v14)],

swift-source/all/Generated/Metrics/Metrics.swift

@@ -25,7 +25,7 @@ extension GleanMetrics {
             // Intentionally left private, no external user can instantiate a new global object.
         }
 
-        public static let info = BuildInfo(buildDate: DateComponents(calendar: Calendar.current, timeZone: TimeZone(abbreviation: "UTC"), year: 2023, month: 10, day: 13, hour: 5, minute: 31, second: 17))
+        public static let info = BuildInfo(buildDate: DateComponents(calendar: Calendar.current, timeZone: TimeZone(abbreviation: "UTC"), year: 2023, month: 10, day: 14, hour: 5, minute: 26, second: 30))
     }
 
     enum NimbusEvents {

swift-source/all/Generated/suggest.swift

@@ -566,15 +566,13 @@ public func FfiConverterTypeSuggestIngestionConstraints_lower(_ value: SuggestIn
 
 public struct SuggestionQuery {
     public var `keyword`: String
-    public var `includeSponsored`: Bool
-    public var `includeNonSponsored`: Bool
+    public var `providers`: [SuggestionProvider]
 
     // Default memberwise initializers are never public by default, so we
     // declare one manually.
-    public init(`keyword`: String, `includeSponsored`: Bool, `includeNonSponsored`: Bool) {
+    public init(`keyword`: String, `providers`: [SuggestionProvider]) {
         self.`keyword` = `keyword`
-        self.`includeSponsored` = `includeSponsored`
-        self.`includeNonSponsored` = `includeNonSponsored`
+        self.`providers` = `providers`
     }
 }
 
@@ -584,19 +582,15 @@ extension SuggestionQuery: Equatable, Hashable {
         if lhs.`keyword` != rhs.`keyword` {
             return false
         }
-        if lhs.`includeSponsored` != rhs.`includeSponsored` {
-            return false
-        }
-        if lhs.`includeNonSponsored` != rhs.`includeNonSponsored` {
+        if lhs.`providers` != rhs.`providers` {
             return false
         }
         return true
     }
 
     public func hash(into hasher: inout Hasher) {
         hasher.combine(`keyword`)
-        hasher.combine(`includeSponsored`)
-        hasher.combine(`includeNonSponsored`)
+        hasher.combine(`providers`)
     }
 }
 
@@ -605,15 +599,13 @@ public struct FfiConverterTypeSuggestionQuery: FfiConverterRustBuffer {
     public static func read(from buf: inout (data: Data, offset: Data.Index)) throws -> SuggestionQuery {
         return try SuggestionQuery(
             `keyword`: FfiConverterString.read(from: &buf), 
-            `includeSponsored`: FfiConverterBool.read(from: &buf), 
-            `includeNonSponsored`: FfiConverterBool.read(from: &buf)
+            `providers`: FfiConverterSequenceTypeSuggestionProvider.read(from: &buf)
         )
     }
 
     public static func write(_ value: SuggestionQuery, into buf: inout [UInt8]) {
         FfiConverterString.write(value.`keyword`, into: &buf)
-        FfiConverterBool.write(value.`includeSponsored`, into: &buf)
-        FfiConverterBool.write(value.`includeNonSponsored`, into: &buf)
+        FfiConverterSequenceTypeSuggestionProvider.write(value.`providers`, into: &buf)
     }
 }
 
@@ -994,6 +986,28 @@ fileprivate struct FfiConverterSequenceTypeSuggestion: FfiConverterRustBuffer {
     }
 }
 
+fileprivate struct FfiConverterSequenceTypeSuggestionProvider: FfiConverterRustBuffer {
+    typealias SwiftType = [SuggestionProvider]
+
+    public static func write(_ value: [SuggestionProvider], into buf: inout [UInt8]) {
+        let len = Int32(value.count)
+        writeInt(&buf, len)
+        for item in value {
+            FfiConverterTypeSuggestionProvider.write(item, into: &buf)
+        }
+    }
+
+    public static func read(from buf: inout (data: Data, offset: Data.Index)) throws -> [SuggestionProvider] {
+        let len: Int32 = try readInt(&buf)
+        var seq = [SuggestionProvider]()
+        seq.reserveCapacity(Int(len))
+        for _ in 0 ..< len {
+            seq.append(try FfiConverterTypeSuggestionProvider.read(from: &buf))
+        }
+        return seq
+    }
+}
+
 
 
 public func `rawSuggestionUrlMatches`(`rawUrl`: String, `url`: String)  -> Bool {

swift-source/all/Nimbus/FeatureHolder.swift

@@ -12,18 +12,18 @@ public typealias GetSdk = () -> FeaturesInterface?
 ///
 /// There are methods useful for testing, and more advanced uses: these all start with `with`.
 ///
-public class FeatureHolder<T> {
+public class FeatureHolder<T: FMLFeatureInterface> {
     private let lock = NSLock()
     private var cachedValue: T?
 
     private var getSdk: GetSdk
     private let featureId: String
 
-    private var create: (Variables) -> T
+    private var create: (Variables, UserDefaults?) -> T
 
     public init(_ getSdk: @escaping () -> FeaturesInterface?,
                 featureId: String,
-                with create: @escaping (Variables) -> T)
+                with create: @escaping (Variables, UserDefaults?) -> T)
     {
         self.getSdk = getSdk
         self.featureId = featureId
@@ -43,18 +43,22 @@ public class FeatureHolder<T> {
             return v
         }
         var variables: Variables = NilVariables.instance
+        var defaults: UserDefaults?
         if let sdk = getSdk() {
             variables = sdk.getVariables(featureId: featureId, sendExposureEvent: false)
+            defaults = sdk.userDefaults
         }
-        let v = create(variables)
+        let v = create(variables, defaults)
         cachedValue = v
         return v
     }
 
     /// Send an exposure event for this feature. This should be done when the user is shown the feature, and may change
     /// their behavior because of it.
     public func recordExposure() {
-        getSdk()?.recordExposureEvent(featureId: featureId, experimentSlug: nil)
+        if !value().isModified() {
+            getSdk()?.recordExposureEvent(featureId: featureId, experimentSlug: nil)
+        }
     }
 
     /// Send an exposure event for this feature, in the given experiment.
@@ -67,7 +71,9 @@ public class FeatureHolder<T> {
     ///
     /// - Parameter slug the experiment identifier, likely derived from the {value}.
     public func recordExperimentExposure(slug: String) {
-        getSdk()?.recordExposureEvent(featureId: featureId, experimentSlug: slug)
+        if !value().isModified() {
+            getSdk()?.recordExposureEvent(featureId: featureId, experimentSlug: slug)
+        }
     }
 
     /// Send a malformed feature event for this feature.
@@ -121,10 +127,33 @@ public class FeatureHolder<T> {
     /// This changes the mapping between a `Variables` and the feature configuration object.
     ///
     /// This is most likely useful during testing and other generated code.
-    public func with(initializer: @escaping (Variables) -> T) {
+    public func with(initializer: @escaping (Variables, UserDefaults?) -> T) {
         lock.lock()
         defer { self.lock.unlock() }
         cachedValue = nil
         create = initializer
     }
 }
+
+/// A bare-bones interface for the FML generated objects.
+public protocol FMLObjectInterface {}
+
+/// A bare-bones interface for the FML generated features.
+///
+/// App developers should use the generated concrete classes, which
+/// implement this interface.
+///
+public protocol FMLFeatureInterface: FMLObjectInterface {
+    /// A test if the feature configuration has been modified somehow, invalidating any experiment
+    /// that uses it.
+    ///
+    /// This may be `true` if a `pref-key` has been set in the feature manifest and the user has
+    /// set that preference.
+    func isModified() -> Bool
+}
+
+public extension FMLFeatureInterface {
+    func isModified() -> Bool {
+        return false
+    }
+}

swift-source/all/Nimbus/FeatureInterface.swift

@@ -7,6 +7,8 @@ import Foundation
 ///
 /// This is intended to be standalone to allow for testing the Nimbus FML.
 public protocol FeaturesInterface: AnyObject {
+    var userDefaults: UserDefaults? { get }
+
     /// Get the variables needed to configure the feature given by `featureId`.
     ///
     /// - Parameters:
@@ -56,3 +58,9 @@ public protocol FeaturesInterface: AnyObject {
     ///     is malformed, providing more detail to experiment owners of where to look for the problem.
     func recordMalformedConfiguration(featureId: String, with partId: String)
 }
+
+public extension FeaturesInterface {
+    var userDefaults: UserDefaults? {
+        nil
+    }
+}

swift-source/all/Nimbus/Nimbus.swift

@@ -6,6 +6,8 @@ import Foundation
 import Glean
 
 public class Nimbus: NimbusInterface {
+    private let _userDefaults: UserDefaults?
+
     private let nimbusClient: NimbusClientProtocol
 
     private let resourceBundles: [Bundle]
@@ -28,11 +30,13 @@ public class Nimbus: NimbusInterface {
 
     init(nimbusClient: NimbusClientProtocol,
          resourceBundles: [Bundle],
+         userDefaults: UserDefaults?,
          errorReporter: @escaping NimbusErrorReporter)
     {
         self.errorReporter = errorReporter
         self.nimbusClient = nimbusClient
         self.resourceBundles = resourceBundles
+        _userDefaults = userDefaults
         NilVariables.instance.set(bundles: resourceBundles)
     }
 }
@@ -102,6 +106,10 @@ extension Nimbus: NimbusEventStore {
 }
 
 extension Nimbus: FeaturesInterface {
+    public var userDefaults: UserDefaults? {
+        _userDefaults
+    }
+
     public func recordExposureEvent(featureId: String, experimentSlug: String? = nil) {
         if let experimentSlug = experimentSlug {
             recordExposureFromExperiment(featureId: featureId, experimentSlug: experimentSlug)

swift-source/all/Nimbus/NimbusBuilder.swift

@@ -132,7 +132,7 @@ public class NimbusBuilder {
     var resourceBundles: [Bundle] = [.main]
 
     /**
-     * The object generated from the `nimbus.fml.yaml` file and the nimbus-gradle-plugin.
+     * The object generated from the `nimbus.fml.yaml` file.
      */
     @discardableResult
     public func with(featureManifest: FeatureManifestInterface) -> NimbusBuilder {
@@ -142,6 +142,17 @@ public class NimbusBuilder {
 
     var featureManifest: FeatureManifestInterface?
 
+    /**
+     * Main user defaults for the app.
+     */
+    @discardableResult
+    public func with(userDefaults: UserDefaults) -> NimbusBuilder {
+        self.userDefaults = userDefaults
+        return self
+    }
+
+    var userDefaults = UserDefaults.standard
+
     /**
      * The command line arguments for the app. This is useful for QA, and can be safely left in the app in production.
      */
@@ -240,6 +251,7 @@ public class NimbusBuilder {
                           coenrollingFeatureIds: getCoenrollingFeatureIds(),
                           dbPath: dbFilePath,
                           resourceBundles: resourceBundles,
+                          userDefaults: userDefaults,
                           errorReporter: errorReporter)
     }
 

swift-source/all/Nimbus/NimbusCreate.swift

@@ -55,6 +55,7 @@ public extension Nimbus {
         dbPath: String,
         resourceBundles: [Bundle] = [Bundle.main],
         enabled: Bool = true,
+        userDefaults: UserDefaults? = nil,
         errorReporter: @escaping NimbusErrorReporter = defaultErrorReporter
     ) throws -> NimbusInterface {
         guard enabled else {
@@ -84,7 +85,12 @@ public extension Nimbus {
             metricsHandler: GleanMetricsHandler()
         )
 
-        return Nimbus(nimbusClient: nimbusClient, resourceBundles: resourceBundles, errorReporter: errorReporter)
+        return Nimbus(
+            nimbusClient: nimbusClient,
+            resourceBundles: resourceBundles,
+            userDefaults: userDefaults,
+            errorReporter: errorReporter
+        )
     }
 
     static func buildExperimentContext(

swift-source/focus/Generated/Metrics/Metrics.swift

@@ -25,7 +25,7 @@ extension GleanMetrics {
             // Intentionally left private, no external user can instantiate a new global object.
         }
 
-        public static let info = BuildInfo(buildDate: DateComponents(calendar: Calendar.current, timeZone: TimeZone(abbreviation: "UTC"), year: 2023, month: 10, day: 13, hour: 5, minute: 31, second: 20))
+        public static let info = BuildInfo(buildDate: DateComponents(calendar: Calendar.current, timeZone: TimeZone(abbreviation: "UTC"), year: 2023, month: 10, day: 14, hour: 5, minute: 26, second: 33))
     }
 
     enum NimbusEvents {