analyticsv2 PoC #169

mike-dydx · 2024-05-16T14:25:57Z

Description / Intuition

note this is a proof of concept, serves as a starting point to replace all events in the app with a more organized, enumerated set of events.

introduces dydxAnalytics module
introduces AnalyticsEventV2 which is a more prescribed way to log events with metadata.
removes view functions across the project in favor of logging new navigatePage(screen:) event (see comments)
replaces notification/deeplink event with an event name that more closely follows other non-screen view event standards
adds default mobile_path to navigatePage events so that all view controller navigations have at least that. path is reserved for the case when there is a directly corresponding web url path.

Before/After Screenshots or Videos

Before	After
	rec.mov

Type of Change

Bug fix (non-breaking change which fixes an issue)
[x[ New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Refactoring or Technical Debt
Documentation update
Other (please describe: )

mike-dydx · 2024-05-17T18:27:02Z

AppsFlyerStaticInjections/AppsFlyerStaticInjections/_Tracking/AppsFlyerTracking.swift

-    override open func view(_ path: String?, action: String?, data: [String: Any]?, from: String?, time: Date?, revenue: NSNumber?, contextViewController: UIViewController?) {
-        // Only track the ones required by growth
-    }


all view functions were removed in favor of navigatePage analytics v2 event

mike-dydx · 2024-05-17T18:32:37Z

PlatformParticles/PlatformParticles/_ViewController/TrackingViewController.swift

@@ -11,31 +11,25 @@ import PlatformRouting
 import UIToolkits
 import Utilities

-open class TrackingViewController: NavigableViewController, TrackingViewProtocol {
-    public var trackingData: TrackingData?


tracking data moved into ScreenIdentifiable (effectively)

mike-dydx · 2024-05-17T18:33:55Z

PlatformRouting/PlatformRouting/_iOS/_App/MappedUIKitRouter.swift

-                    if success, request.path?.hasPrefix("/action") ?? false {
-                        Tracking.shared?.view(request.path, data: request.params, from: nil, time: nil)
-                    }


actions should not be view events, should be dedicated action events. Did not make scope for this PR

mike-dydx · 2024-05-17T18:34:30Z

PlatformRouting/PlatformRouting/_iOS/_App/MappedUIKitRouter.swift

-    override open func previousTracking() -> TrackingData? {
-        if let vc = UIViewController.topmost() as? TrackingViewProtocol {
-            return vc.trackingData
-        } else {
-            return nil
-        }
-    }


TrackingData was removed in this PR, functionality was replaced

mike-dydx · 2024-05-17T18:35:37Z

RoutingKit/RoutingKit/_Router/MappedRouter.swift

-                        if let viewController = data as? TrackingViewProtocol {
-                            viewController.logView(path: transformed.path, data: nil, from: previousTracking?.path, time: previousTracking?.startTime)
-                        }
                        completion?(nil, true)
                    } else {
                        self?.route(dependencies: map, request: transformed, completion: { [weak self] _, successful in
                            if successful {
                                self?.navigate(to: map, request: transformed, presentation: presentation ?? transformed.presentation, animated: animated, completion: { /* [weak self] */ data, successful in
-                                    if successful, let viewController = data as? TrackingViewProtocol {
-                                        viewController.logView(path: transformed.path, data: nil, from: previousTracking?.path, time: previousTracking?.startTime)
-                                    }


we were logging a view event both here and in the viewDidAppear lifecycle method which resulted in double logging. Removed logging from within Routing Kit in favor of TrackingViewController lmk if u disagree with this decision or if i am missing something

mike-dydx · 2024-05-17T18:39:55Z

dydx/dydxAnalytics/dydxAnalytics/AnalyticsEvent.swift

+    case appStart
+    case navigatePage(screen: ScreenIdentifiable)
+    case deepLinkHandled(url: String, succeeded: Bool)
+    case notificationPermissionsChanged(isAuthorized: Bool)
+    case onboardingStepChanged(step: OnboardingStep, state: OnboardingState)


note these 5 events are just a proof of concept for how this enum would work for all events. see the TODO on ln 71

mike-dydx · 2024-05-17T18:40:54Z

dydx/dydxAnalytics/dydxAnalytics/OnboardingAnalytics.swift

@@ -0,0 +1,35 @@
+//
+//  OnboardingAnalytics.swift


this file was just moved from dydxPresenters to here

mike-dydx · 2024-05-17T18:41:04Z

dydx/dydxAnalytics/dydxAnalytics/TransferAnalytics.swift

@@ -9,12 +9,15 @@ import Foundation
 import Abacus
 import Utilities

-final class TransferAnalytics {
-    func logDeposit(transferInput: TransferInput) {
+public final class TransferAnalytics {


this file was also just moved from dydxPresenters to here

mike-dydx · 2024-05-17T18:46:41Z

dydxV4/dydxV4/_Tracking/dydxCompositeTracking.swift

-        if let transformed = transform(events: onboardingEvents, path: path), let event = parser.asString(transformed["event"]) {
-            var info = parser.asDictionary(transformed["info"]) ?? data ?? [String: Any]()
-            if event == "OnboardingStepChanged" {
-                if let time = time, let previous = transform(events: onboardingEvents, path: from), parser.asString(transformed["event"]) == "OnboardingStepChanged" {
-                    let seconds = Int(Date().timeIntervalSince(time))
-                    info["secondsOnPreviousStep"] = NSNumber(value: seconds)
-                    info["previousStep"] = (previous["info"] as? [String: Any])?["currentStep"]
-                }
-            }
-            log(event: event, data: info, revenue: revenue)
-        }


this functionality was not doing anything, the custom data is nowhere to be found in bigquery. OnboardingStepChanged event is still logged in other files though via the OnboardingAnalytics class. That functionality did not change

mike-dydx · 2024-05-17T18:46:58Z

dydxV4/dydxV4/_Tracking/dydxCompositeTracking.swift

-            log(event: AnalyticsEventScreenView,
-                data: [
-                    AnalyticsParameterScreenName: path as Any,
-                    AnalyticsParameterScreenClass: String(describing: type(of: contextViewController))


this logic was moved to AnalyticsEvent.swift

mike-dydx · 2024-05-17T18:47:44Z

dydxV4/dydxV4/_Tracking/TrackingViewController+Ext.swift

@@ -0,0 +1,59 @@
+//
+//  TrackingViewController+Ext.swift


this files serves the purpose of creating paths to identify the screen based on RoutingRequest data.

mike-dydx · 2024-05-17T18:49:07Z

dydxV4/dydxV4/AppDelegate.swift

-        if successful {
-            if let type = deeplink.params?["notification_type"] {
-                Tracking.shared?.view("/notification/deeplink/" + type, data: data)
-            }
-            Tracking.shared?.view("/notification/deeplink/success", data: data)
-        } else {
-            Tracking.shared?.view("/notification/deeplink/failure", data: data)
-        }


condensed into a single event with an event name instead of a path. Lmk if u disagree with this decision

mike-dydx · 2024-05-17T18:51:48Z

dydx/dydxPresenters/dydxPresenters/_v4/Onboarding/Connect/dydxOnboardConnectViewBuilder.swift

@@ -13,6 +13,7 @@ import RoutingKit
 import ParticlesKit
 import PlatformUI
 import dydxCartera
+import dydxAnalytics


these import statements are necessary because some classes were moved into dydxAnalytics

ruixhuang · 2024-05-20T18:54:24Z

dydx/dydxAnalytics/dydxAnalytics/AnalyticsEvent.swift

+    case notificationPermissionsChanged(isAuthorized: Bool)
+    case onboardingStepChanged(step: OnboardingStep, state: OnboardingState)
+
+    public var name: String {


The long switch statement can be messy when more events are added. Maybe it's cleaner to define each event as a separate struct, e.g.,

struct NavigatePageEvent: TrackableEvent { let screen: ScreenIdentifiable override var name: String ... }

mike-dydx · 2024-05-21T00:58:22Z

dydx/dydxAnalytics/dydxAnalytics/AnalyticsEvent.swift

-            return "OnboardingStepChanged"
-        case .notificationPermissionsChanged:
-            return "NotificationPermissionsChanged"
+public enum AnalyticsEventV2 {


@ruixhuang note I am nesting them in AnalyticsEventV2 so that we can use Xcode's autofill after typing AnalyticsEventV2., also to keep them contained. Lmk if u think this is not worth it and I can put them at the global level.

mike-dydx · 2024-05-21T01:00:51Z

Utilities/Utilities/_Tracker/_Shared/Tracking.swift

+//    func log(trackableEvent: TrackableEvent) {
+//        log(event: trackableEvent.name, data: trackableEvent.customParameters, revenue: nil)
+//    }


deleted this in another commit 😓

* analyticsv2 example * added dydxAnalytics * move files into dydxAnalytics * add default events * remove duplicative tracking * example replacement of app start event * add firebase to dydxAnalytics * interim commit * remove view(...) functions * sorting by name * clean up * address comment, make events unique structs * clean up

mike-dydx added 4 commits May 16, 2024 10:25

analyticsv2 example

3e1b199

added dydxAnalytics

1a7966c

move files into dydxAnalytics

0c62862

add default events

dad49a5

mike-dydx force-pushed the mike/fix-analytics-paths branch from bae30e4 to dad49a5 Compare May 16, 2024 20:16

mike-dydx added 4 commits May 16, 2024 17:20

remove duplicative tracking

48fecd2

example replacement of app start event

c89ee2d

add firebase to dydxAnalytics

afd52e5

interim commit

d722c9b

mike-dydx force-pushed the mike/fix-analytics-paths branch from 6814a5a to d722c9b Compare May 17, 2024 15:51

mike-dydx added 2 commits May 17, 2024 14:25

remove view(...) functions

1541e31

sorting by name

bb93b08

mike-dydx commented May 17, 2024

View reviewed changes

mike-dydx force-pushed the mike/fix-analytics-paths branch from 140e99f to 48a7ca2 Compare May 17, 2024 18:31

mike-dydx commented May 17, 2024

View reviewed changes

mike-dydx force-pushed the mike/fix-analytics-paths branch 2 times, most recently from a713e01 to 774547b Compare May 17, 2024 18:39

mike-dydx commented May 17, 2024

View reviewed changes

mike-dydx force-pushed the mike/fix-analytics-paths branch 2 times, most recently from da1a058 to b04643f Compare May 17, 2024 18:43

mike-dydx commented May 17, 2024

View reviewed changes

clean up

33cdd69

mike-dydx force-pushed the mike/fix-analytics-paths branch from b04643f to 33cdd69 Compare May 17, 2024 18:53

mike-dydx requested a review from ruixhuang May 17, 2024 18:57

mike-dydx marked this pull request as ready for review May 17, 2024 18:57

ruixhuang reviewed May 20, 2024

View reviewed changes

ruixhuang previously approved these changes May 20, 2024

View reviewed changes

mike-dydx dismissed ruixhuang’s stale review via 8e2dbc4 May 21, 2024 00:41

address comment, make events unique structs

6bb5c99

mike-dydx force-pushed the mike/fix-analytics-paths branch from 8e2dbc4 to 6bb5c99 Compare May 21, 2024 00:57

mike-dydx commented May 21, 2024

View reviewed changes

clean up

fd4206b

mike-dydx force-pushed the mike/fix-analytics-paths branch from e785940 to fd4206b Compare May 21, 2024 01:02

ruixhuang approved these changes May 21, 2024

View reviewed changes

mike-dydx merged commit 3740d9a into develop May 21, 2024
2 checks passed

mike-dydx deleted the mike/fix-analytics-paths branch May 21, 2024 17:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

analyticsv2 PoC #169

analyticsv2 PoC #169

mike-dydx commented May 16, 2024 •

edited

Loading

mike-dydx May 17, 2024

mike-dydx May 17, 2024 •

edited

Loading

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

mike-dydx May 17, 2024

ruixhuang May 20, 2024

mike-dydx May 21, 2024

mike-dydx May 21, 2024

analyticsv2 PoC #169

analyticsv2 PoC #169

Conversation

mike-dydx commented May 16, 2024 • edited Loading

Description / Intuition

Before/After Screenshots or Videos

Type of Change

Choose a reason for hiding this comment

mike-dydx May 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mike-dydx commented May 16, 2024 •

edited

Loading

mike-dydx May 17, 2024 •

edited

Loading