Merge pull request #291 from edx/test/segment_plus_firebase

Firebase and Segment integration
openedx · Feb 26, 2024 · cf65ce9 · cf65ce9
2 parents 7db3b35 + fb22073
commit cf65ce9
Show file tree

Hide file tree

Showing 22 changed files with 312 additions and 198 deletions.
diff --git a/Authorization/Authorization/Presentation/AuthorizationAnalytics.swift b/Authorization/Authorization/Presentation/AuthorizationAnalytics.swift
@@ -30,7 +30,7 @@ public enum SocialAuthMethod: String {
 
 //sourcery: AutoMockable
 public protocol AuthorizationAnalytics {
-    func setUserID(_ id: String)
+    func identify(id: String, username: String, email: String)
     func userLogin(method: AuthMethod)
     func signUpClicked()
     func createAccountClicked()
@@ -41,7 +41,7 @@ public protocol AuthorizationAnalytics {
 
 #if DEBUG
 class AuthorizationAnalyticsMock: AuthorizationAnalytics {
-    public func setUserID(_ id: String) {}
+    func identify(id: String, username: String, email: String) {}
     public func userLogin(method: AuthMethod) {}
     public func signUpClicked() {}
     public func createAccountClicked() {}

diff --git a/Authorization/Authorization/Presentation/Login/SignInViewModel.swift b/Authorization/Authorization/Presentation/Login/SignInViewModel.swift
@@ -79,7 +79,7 @@ public class SignInViewModel: ObservableObject {
         isShowProgress = true
         do {
             let user = try await interactor.login(username: username, password: password)
-            analytics.setUserID("\(user.id)")
+            analytics.identify(id: "\(user.id)", username: user.username, email: user.email)
             analytics.userLogin(method: .password)
             router.showMainOrWhatsNewScreen(sourceScreen: sourceScreen)
         } catch let error {
@@ -110,7 +110,7 @@ public class SignInViewModel: ObservableObject {
         isShowProgress = true
         do {
             let user = try await interactor.login(externalToken: externalToken, backend: backend)
-            analytics.setUserID("\(user.id)")
+            analytics.identify(id: "\(user.id)", username: user.username, email: user.email)
             analytics.userLogin(method: authMethod)
             router.showMainOrWhatsNewScreen(sourceScreen: sourceScreen)
         } catch let error {

diff --git a/Authorization/Authorization/Presentation/Registration/SignUpViewModel.swift b/Authorization/Authorization/Presentation/Registration/SignUpViewModel.swift
@@ -131,7 +131,7 @@ public class SignUpViewModel: ObservableObject {
                 fields: validateFields,
                 isSocial: externalToken != nil
             )
-            analytics.setUserID("\(user.id)")
+            analytics.identify(id: "\(user.id)", username: user.username, email: user.email)
             analytics.registrationSuccess()
             isShowProgress = false
             router.showMainOrWhatsNewScreen(sourceScreen: sourceScreen)
@@ -188,7 +188,7 @@ public class SignUpViewModel: ObservableObject {
         do {
             isShowProgress = true
             let user = try await interactor.login(externalToken: response.token, backend: backend)
-            analytics.setUserID("\(user.id)")
+            analytics.identify(id: "\(user.id)", username: user.username, email: user.email)
             analytics.userLogin(method: authMethod)
             isShowProgress = false
             router.showMainOrWhatsNewScreen(sourceScreen: sourceScreen)

diff --git a/Authorization/AuthorizationTests/AuthorizationMock.generated.swift b/Authorization/AuthorizationTests/AuthorizationMock.generated.swift
@@ -509,10 +509,10 @@ open class AuthorizationAnalyticsMock: AuthorizationAnalytics, Mock {
 
 
 
-    open func setUserID(_ id: String) {
-        addInvocation(.m_setUserID__id(Parameter<String>.value(`id`)))
-		let perform = methodPerformValue(.m_setUserID__id(Parameter<String>.value(`id`))) as? (String) -> Void
-		perform?(`id`)
+    open func identify(id: String, username: String, email: String) {
+        addInvocation(.m_identify__id_idusername_usernameemail_email(Parameter<String>.value(`id`), Parameter<String>.value(`username`), Parameter<String>.value(`email`)))
+		let perform = methodPerformValue(.m_identify__id_idusername_usernameemail_email(Parameter<String>.value(`id`), Parameter<String>.value(`username`), Parameter<String>.value(`email`))) as? (String, String, String) -> Void
+		perform?(`id`, `username`, `email`)
     }
 
     open func userLogin(method: AuthMethod) {
@@ -553,7 +553,7 @@ open class AuthorizationAnalyticsMock: AuthorizationAnalytics, Mock {
 
 
     fileprivate enum MethodType {
-        case m_setUserID__id(Parameter<String>)
+        case m_identify__id_idusername_usernameemail_email(Parameter<String>, Parameter<String>, Parameter<String>)
         case m_userLogin__method_method(Parameter<AuthMethod>)
         case m_signUpClicked
         case m_createAccountClicked
@@ -563,9 +563,11 @@ open class AuthorizationAnalyticsMock: AuthorizationAnalytics, Mock {
 
         static func compareParameters(lhs: MethodType, rhs: MethodType, matcher: Matcher) -> Matcher.ComparisonResult {
             switch (lhs, rhs) {
-            case (.m_setUserID__id(let lhsId), .m_setUserID__id(let rhsId)):
+            case (.m_identify__id_idusername_usernameemail_email(let lhsId, let lhsUsername, let lhsEmail), .m_identify__id_idusername_usernameemail_email(let rhsId, let rhsUsername, let rhsEmail)):
 				var results: [Matcher.ParameterComparisonResult] = []
-				results.append(Matcher.ParameterComparisonResult(Parameter.compare(lhs: lhsId, rhs: rhsId, with: matcher), lhsId, rhsId, "_ id"))
+				results.append(Matcher.ParameterComparisonResult(Parameter.compare(lhs: lhsId, rhs: rhsId, with: matcher), lhsId, rhsId, "id"))
+				results.append(Matcher.ParameterComparisonResult(Parameter.compare(lhs: lhsUsername, rhs: rhsUsername, with: matcher), lhsUsername, rhsUsername, "username"))
+				results.append(Matcher.ParameterComparisonResult(Parameter.compare(lhs: lhsEmail, rhs: rhsEmail, with: matcher), lhsEmail, rhsEmail, "email"))
 				return Matcher.ComparisonResult(results)
 
             case (.m_userLogin__method_method(let lhsMethod), .m_userLogin__method_method(let rhsMethod)):
@@ -591,7 +593,7 @@ open class AuthorizationAnalyticsMock: AuthorizationAnalytics, Mock {
 
         func intValue() -> Int {
             switch self {
-            case let .m_setUserID__id(p0): return p0.intValue
+            case let .m_identify__id_idusername_usernameemail_email(p0, p1, p2): return p0.intValue + p1.intValue + p2.intValue
             case let .m_userLogin__method_method(p0): return p0.intValue
             case .m_signUpClicked: return 0
             case .m_createAccountClicked: return 0
@@ -602,7 +604,7 @@ open class AuthorizationAnalyticsMock: AuthorizationAnalytics, Mock {
         }
         func assertionName() -> String {
             switch self {
-            case .m_setUserID__id: return ".setUserID(_:)"
+            case .m_identify__id_idusername_usernameemail_email: return ".identify(id:username:email:)"
             case .m_userLogin__method_method: return ".userLogin(method:)"
             case .m_signUpClicked: return ".signUpClicked()"
             case .m_createAccountClicked: return ".createAccountClicked()"
@@ -627,7 +629,7 @@ open class AuthorizationAnalyticsMock: AuthorizationAnalytics, Mock {
     public struct Verify {
         fileprivate var method: MethodType
 
-        public static func setUserID(_ id: Parameter<String>) -> Verify { return Verify(method: .m_setUserID__id(`id`))}
+        public static func identify(id: Parameter<String>, username: Parameter<String>, email: Parameter<String>) -> Verify { return Verify(method: .m_identify__id_idusername_usernameemail_email(`id`, `username`, `email`))}
         public static func userLogin(method: Parameter<AuthMethod>) -> Verify { return Verify(method: .m_userLogin__method_method(`method`))}
         public static func signUpClicked() -> Verify { return Verify(method: .m_signUpClicked)}
         public static func createAccountClicked() -> Verify { return Verify(method: .m_createAccountClicked)}
@@ -640,8 +642,8 @@ open class AuthorizationAnalyticsMock: AuthorizationAnalytics, Mock {
         fileprivate var method: MethodType
         var performs: Any
 
-        public static func setUserID(_ id: Parameter<String>, perform: @escaping (String) -> Void) -> Perform {
-            return Perform(method: .m_setUserID__id(`id`), performs: perform)
+        public static func identify(id: Parameter<String>, username: Parameter<String>, email: Parameter<String>, perform: @escaping (String, String, String) -> Void) -> Perform {
+            return Perform(method: .m_identify__id_idusername_usernameemail_email(`id`, `username`, `email`), performs: perform)
         }
         public static func userLogin(method: Parameter<AuthMethod>, perform: @escaping (AuthMethod) -> Void) -> Perform {
             return Perform(method: .m_userLogin__method_method(`method`), performs: perform)

diff --git a/Core/Core.xcodeproj/project.pbxproj b/Core/Core.xcodeproj/project.pbxproj
@@ -126,6 +126,7 @@
 		07DDFCBD29A780BB00572595 /* UINavigationController+Animation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 07DDFCBC29A780BB00572595 /* UINavigationController+Animation.swift */; };
 		07E0939F2B308D2800F1E4B2 /* Data_Certificate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 07E0939E2B308D2800F1E4B2 /* Data_Certificate.swift */; };
 		141F1D302B7328D4009E81EB /* WebviewCookiesUpdateProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = 141F1D2F2B7328D4009E81EB /* WebviewCookiesUpdateProtocol.swift */; };
+		A51CDBE72B6D21F2009B6D4E /* SegmentConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = A51CDBE62B6D21F2009B6D4E /* SegmentConfig.swift */; };
 		142EDD6C2B831D1400F9F320 /* BranchSDK in Frameworks */ = {isa = PBXBuildFile; productRef = 142EDD6B2B831D1400F9F320 /* BranchSDK */; };
 		A53A32352B233DEC005FE38A /* ThemeConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = A53A32342B233DEC005FE38A /* ThemeConfig.swift */; };
 		A595689B2B6173DF00ED4F90 /* BranchConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = A595689A2B6173DF00ED4F90 /* BranchConfig.swift */; };
@@ -304,6 +305,7 @@
 		3B74C6685E416657F3C5F5A8 /* Pods-App-Core.releaseprod.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-App-Core.releaseprod.xcconfig"; path = "Target Support Files/Pods-App-Core/Pods-App-Core.releaseprod.xcconfig"; sourceTree = "<group>"; };
 		60153262DBC2F9E660D7E11B /* Pods-App-Core.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-App-Core.release.xcconfig"; path = "Target Support Files/Pods-App-Core/Pods-App-Core.release.xcconfig"; sourceTree = "<group>"; };
 		9D5B06CAA99EA5CD49CBE2BB /* Pods-App-Core.debugdev.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-App-Core.debugdev.xcconfig"; path = "Target Support Files/Pods-App-Core/Pods-App-Core.debugdev.xcconfig"; sourceTree = "<group>"; };
+		A51CDBE62B6D21F2009B6D4E /* SegmentConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SegmentConfig.swift; sourceTree = "<group>"; };
 		A53A32342B233DEC005FE38A /* ThemeConfig.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ThemeConfig.swift; sourceTree = "<group>"; };
 		A595689A2B6173DF00ED4F90 /* BranchConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BranchConfig.swift; sourceTree = "<group>"; };
 		A5F4E7B42B61544A00ACD166 /* BrazeConfig.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BrazeConfig.swift; sourceTree = "<group>"; };
@@ -783,6 +785,7 @@
 				DBF6F2402B014ADA0098414B /* FirebaseConfig.swift */,
 				A5F4E7B42B61544A00ACD166 /* BrazeConfig.swift */,
 				A595689A2B6173DF00ED4F90 /* BranchConfig.swift */,
+				A51CDBE62B6D21F2009B6D4E /* SegmentConfig.swift */,
 				DBF6F2492B0380E00098414B /* FeaturesConfig.swift */,
 				DBF6F2452B01DAFE0098414B /* AgreementConfig.swift */,
 				BAFB99812B0E2354007D09F9 /* FacebookConfig.swift */,
@@ -1029,6 +1032,7 @@
 				02B3E3B32930198600A50475 /* AVPlayerViewControllerExtension.swift in Sources */,
 				BAD9CA332B28A8F300DE790A /* AjaxProvider.swift in Sources */,
 				0295C885299B99DD00ABE571 /* RefreshableScrollView.swift in Sources */,
+				A51CDBE72B6D21F2009B6D4E /* SegmentConfig.swift in Sources */,
 				0282DA7328F98CC9003C3F07 /* WebUnitView.swift in Sources */,
 				E0D586362B314CD3009B4BA7 /* LogistrationBottomView.swift in Sources */,
 				0727878128D25EFD002E9142 /* SnackBarView.swift in Sources */,

diff --git a/Core/Core/Configuration/Config/Config.swift b/Core/Core/Configuration/Config/Config.swift
@@ -27,6 +27,7 @@ public protocol ConfigProtocol {
     var discovery: DiscoveryConfig { get }
     var braze: BrazeConfig { get }
     var branch: BranchConfig { get }
+    var segment: SegmentConfig { get }
     var program: DiscoveryConfig { get }
     var URIScheme: String { get }
 }

diff --git a/Core/Core/Configuration/Config/FirebaseConfig.swift b/Core/Core/Configuration/Config/FirebaseConfig.swift
@@ -6,7 +6,6 @@
 //
 
 import Foundation
-import FirebaseCore
 
 private enum FirebaseKeys: String {
     case enabled = "ENABLED"
@@ -76,25 +75,6 @@ public final class FirebaseConfig: NSObject {
     public var isAnalyticsSourceFirebase: Bool {
         return analyticsSource == AnalyticsSource.firebase
     }
-
-    public var firebaseOptions: FirebaseOptions? {
-        if enabled,
-           requiredKeysAvailable,
-           let bundleID = bundleID,
-           let googleAppID = googleAppID,
-           let gcmSenderID = gcmSenderID {
-            let firebaseOptions = FirebaseOptions(googleAppID: googleAppID,
-                                                  gcmSenderID: gcmSenderID)
-            firebaseOptions.apiKey = apiKey
-            firebaseOptions.projectID = projectID
-            firebaseOptions.bundleID = bundleID
-            firebaseOptions.clientID = clientID
-            firebaseOptions.storageBucket = storageBucket
-            firebaseOptions.databaseURL = databaseURL
-        }
-
-        return nil
-    }
 }
 
 private let firebaseKey = "FIREBASE"

diff --git a/Core/Core/Configuration/Config/SegmentConfig.swift b/Core/Core/Configuration/Config/SegmentConfig.swift
@@ -0,0 +1,31 @@
+//
+//  SegmentConfig.swift
+//  Core
+//
+//  Created by Anton Yarmolenka on 02/02/2024.
+//
+
+import Foundation
+
+private enum SegmentKeys: String, RawStringExtractable {
+    case enabled = "ENABLED"
+    case writeKey = "SEGMENT_IO_WRITE_KEY"
+}
+
+public final class SegmentConfig: NSObject {
+    public var enabled: Bool = false
+    public var writeKey: String = ""
+
+    init(dictionary: [String: AnyObject]) {
+        super.init()
+        writeKey = dictionary[SegmentKeys.writeKey] as? String ?? ""
+        enabled = dictionary[SegmentKeys.enabled] as? Bool == true && !writeKey.isEmpty
+    }
+}
+
+private let segmentKey = "SEGMENT_IO"
+extension Config {
+    public var segment: SegmentConfig {
+        SegmentConfig(dictionary: self[segmentKey] as? [String: AnyObject] ?? [:])
+    }
+}
diff --git a/Core/CoreTests/Configuration/ConfigTests.swift b/Core/CoreTests/Configuration/ConfigTests.swift
@@ -60,6 +60,10 @@ class ConfigTests: XCTestCase {
         "BRANCH": [
             "ENABLED": true,
             "KEY": "testBranchKey"
+        ],
+        "SEGMENT_IO": [
+            "ENABLED": true,
+            "SEGMENT_IO_WRITE_KEY": "testSegmentKey"
         ]
     ]
 
@@ -136,4 +140,11 @@ class ConfigTests: XCTestCase {
         XCTAssertTrue(config.branch.enabled)
         XCTAssertEqual(config.branch.key, "testBranchKey")
     }
+
+    func testSegmentConfigInitialization() {
+        let config = Config(properties: properties)
+
+        XCTAssertTrue(config.segment.enabled)
+        XCTAssertEqual(config.segment.writeKey, "testSegmentKey")
+    }
 }
diff --git a/Discussion/Discussion/Presentation/DiscussionTopics/DiscussionTopicsViewModel.swift b/Discussion/Discussion/Presentation/DiscussionTopics/DiscussionTopicsViewModel.swift
@@ -8,7 +8,6 @@
 import Foundation
 import SwiftUI
 import Core
-import FirebaseCrashlytics
 
 public class DiscussionTopicsViewModel: ObservableObject {