Analytics in an Aspect Oriented manner V2.0

The presentation took place at GDG Android Athens meetup. https://www.meetup.com/GDG-Android-Athens/events/251174805/

Transcript

1. Analytics in an Aspect Oriented manner Spiros I. Economakis
2. Product Manager
3. Why analytics are important?
4. Why analytics are important? • Help to build an efficient marketing strategy
5. Why analytics are important? • Help to build an efficient marketing strategy • Measure performance of the features
6. Why analytics are important? • Help to build an efficient marketing strategy • Measure performance of the features • Measure retention of the users
7. Why analytics are important? • Help to build an efficient marketing strategy • Measure performance of the features • Measure retention of the users • Optimise flow processes/funnels
15. More tracking, more code @OnClick(R.id.signUpBtn) fun signUpClicked() { KISSmetricsAPI.sharedAPI().record("signupStartEvent") FirebaseAnalytics.getInstance(this).logEvent("signupStartEvent", null) Answers.getInstance().logCustom(CustomEvent("signupStartEvent")) AppEventsLogger.newLogger(this).logEvent("signupStartEvent") }
16. More tracking, more code @OnClick(R.id.signUpBtn) fun signUpClicked() { KISSmetricsAPI.sharedAPI().record("signupStartEvent") FirebaseAnalytics.getInstance(this).logEvent("signupStartEvent", null) Answers.getInstance().logCustom(CustomEvent("signupStartEvent")) AppEventsLogger.newLogger(this).logEvent("signupStartEvent") }
17. More tracking, more code @OnClick(R.id.signUpBtn) fun signUpClicked() { KISSmetricsAPI.sharedAPI().record("signupStartEvent") FirebaseAnalytics.getInstance(this).logEvent("signupStartEvent", null) Answers.getInstance().logCustom(CustomEvent("signupStartEvent")) AppEventsLogger.newLogger(this).logEvent("signupStartEvent") }
18. Tracking event @OnClick(R.id.signUpBtn) fun signUpClicked() { KISSmetricsAPI.sharedAPI().record("signupStartEvent") FirebaseAnalytics.getInstance(this).logEvent("signupStartEvent", null) Answers.getInstance().logCustom(CustomEvent(“signupStartEvent")) AppEventsLogger.newLogger(this).logEvent("signupStartEvent") }
19. Tracking with data private val stateObserver = Observer<SignUpViewState> { state -> state.let { when (state) { is SignUpSuccessViewState -> { this.renderSuccess(state.user) } } } }
20. Tracking with data private fun renderSuccess(user: UserViewModel) { val trackingData = mapOf("id" to user.id, "name" to user.fulName) KISSmetricsAPI.sharedAPI().record("signupSuccess", trackingData) Answers.getInstance().logSignUp(SignUpEvent().putSuccess(true)) val trackingBundle = Bundle().apply { putString("id", user.id) putString("name", user.fulName) } FirebaseAnalytics.getInstance(this).logEvent("signupSuccess", trackingBundle) AppEventsLogger.newLogger(this).logEvent("signupSuccess", trackingBundle) }
21. More tracking data, 
 more code private fun renderSuccess(user: UserViewModel) { val trackingData = mapOf("id" to user.id, "name" to user.fulName) KISSmetricsAPI.sharedAPI().record("signupSuccess", trackingData) Answers.getInstance().logSignUp(SignUpEvent().putSuccess(true)) val trackingBundle = Bundle().apply { putString("id", user.id) putString("name", user.fulName) } FirebaseAnalytics.getInstance(this).logEvent("signupSuccess", trackingBundle) AppEventsLogger.newLogger(this).logEvent("signupSuccess", trackingBundle) }
22. More tracking data, 
 more code private fun renderSuccess(user: UserViewModel) { val trackingData = mapOf("id" to user.id, "name" to user.fulName) KISSmetricsAPI.sharedAPI().record("signupSuccess", trackingData) Answers.getInstance().logSignUp(SignUpEvent().putSuccess(true)) val trackingBundle = Bundle().apply { putString("id", user.id) putString("name", user.fulName) } FirebaseAnalytics.getInstance(this).logEvent("signupSuccess", trackingBundle) AppEventsLogger.newLogger(this).logEvent("signupSuccess", trackingBundle) }
23. Hide - Singleton object AnalyticsTracker { fun initialise(ctx: Context) { //initialise tools } fun log(event: String) { //all tools to track } fun log(event: String, data: Map<String, Any>) { //all tools to track } }
24. Hide - Singleton @OnClick(R.id.signUpBtn) fun signUpClicked() { AnalyticsTracker.log("signupStartEvent") }
25. Hide - Singleton private fun renderSuccess(user: UserViewModel) { val trackingData = mapOf("id" to user.id, "name" to user.fulName) AnalyticsTracker.log("signupSuccess", trackingData) }
26. Composition class TrackingDelegator constructor(ctx: Context) { fun onSignUpClicked() { //all tools to track } fun onSignUpSuccess(user: UserViewModel) { //all tools to track } }
27. Composition override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_main) this.trackingDelegator = TrackingDelegator(this) }
28. Composition @OnClick(R.id.signUpBtn) fun signUpClicked() { this.trackingDelegator.onSignUpClicked() }
29. Composition private fun renderSuccess(user: UserViewModel) { this.trackingDelegator.onSignUpSuccess(userViewModel) }
30. Tracking is a Cross-Cutting Concern The concerns representing functionalities for secondary requirements are referred to as crosscutting concerns or system-wide concerns.
31. Cross-Cutting Concerns- Examples •Tracking analytics •Logging •Persistence •Performance monitoring •Data Validation •Caching
32. Aspect oriented Programming
33. Definition Aspect-oriented programming entails breaking down program logic into "concerns". This means, that with AOP, we can add executable blocks to some source code without explicitly changing it. This programming paradigm pretends that “cross-cutting concerns” should be implemented once and injected it many times into those places.
34. Terminology Join point: Join points are points in the execution of the system, such as method calls or method entry Pointcut: An expression which tells a code injection tool where to inject a particular piece of code eg. to which join points to apply a particular advice. Advice: The code that is injected to a class file. Typically we talk about before, after, and around advices, which are executed before, after, or instead of a target method.
35. Terminology Join point: Join points are points in the execution of the system, such as method calls or method entry Pointcut: An expression which tells a code injection tool where to inject a particular piece of code eg. to which join points to apply a particular advice. Advice: The code that is injected to a class file. Typically we talk about before, after, and around advices, which are executed before, after, or instead of a target method.
36. Terminology Join point: Join points are points in the execution of the system, such as method calls or method entry Pointcut: An expression which tells a code injection tool where to inject a particular piece of code eg. to which join points to apply a particular advice. Advice: The code that is injected to a class file. Typically we talk about before, after, and around advices, which are executed before, after, or instead of a target method.
37. Terminology Aspect: The combination of the pointcut and the advice is termed an aspect. For instance, we add a tracking aspect to our application by defining a pointcut and giving the correct advice. Weaving: The process of injecting code – advices – into the target places – join points.
38. Terminology Aspect: The combination of the pointcut and the advice is termed an aspect. For instance, we add a tracking aspect to our application by defining a pointcut and giving the correct advice. Weaving: The process of injecting code – advices – into the target places – join points.
39. Advice Join points Program execution Pointcut Diagram
40. Compare Old way Analytics Analytics AOP way weaving
41. Clueso
42. Pointcuts with Annotations @TrackEvent - constructor & method @TrackEventAttribute - method params only @TrackStaticAttribute - method params only
43. Pointcuts with Annotations @TrackEvent - constructor & method
 @TrackEventAttribute - method params only @TrackStaticAttribute - method params only
44. Pointcuts with Annotations @TrackEvent - constructor & method @TrackEventAttribute - method params only
 @TrackStaticAttribute - method params only
45. Pointcuts with Annotations @TrackSession - constructor & method @TrackSessionAttribute - method params only
46. Pointcuts with Annotations @TrackSession - constructor & method
 @TrackSessionAttribute - method params only
47. Aspect @Aspect class TrackEventAspect { @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent * *(..))") fun methodAnnotatedWithTrackEvent() { } @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent *.new(..))") fun constructorAnnotatedTrackEvent() { } @Around("methodAnnotatedWithTrackEvent() || constructorAnnotatedTrackEvent()") @Throws(Throwable::class) fun weaveJoinPointTrackEvent(joinPoint: ProceedingJoinPoint): Any { } }
48. Aspect @Aspect class TrackEventAspect { @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent * *(..))") fun methodAnnotatedWithTrackEvent() { } @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent *.new(..))") fun constructorAnnotatedTrackEvent() { } @Around("methodAnnotatedWithTrackEvent() || constructorAnnotatedTrackEvent()") @Throws(Throwable::class) fun weaveJoinPointTrackEvent(joinPoint: ProceedingJoinPoint): Any { } }
49. Aspect @Aspect class TrackEventAspect { @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent * *(..))") fun methodAnnotatedWithTrackEvent() { } @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent *.new(..))") fun constructorAnnotatedTrackEvent() { } @Around("methodAnnotatedWithTrackEvent() || constructorAnnotatedTrackEvent()") @Throws(Throwable::class) fun weaveJoinPointTrackEvent(joinPoint: ProceedingJoinPoint): Any { } }
50. Aspect @Aspect class TrackEventAspect { @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent * *(..))") fun methodAnnotatedWithTrackEvent() { } @Pointcut("execution(@com.clueso.tracking.annotation.TrackEvent *.new(..))") fun constructorAnnotatedTrackEvent() { } @Around("methodAnnotatedWithTrackEvent() || constructorAnnotatedTrackEvent()") @Throws(Throwable::class) fun weaveJoinPointTrackEvent(joinPoint: ProceedingJoinPoint): Any { } }
51. Tracking Adapters class AnswersTrackingAdapter : TrackAdapter { override fun track(event: TrackEvent, attributes: Map<String, Any>) { //tracking } }
52. Tracking Adapters class AnswersTrackingAdapter : TrackAdapter { override fun track(event: TrackEvent, attributes: Map<String, Any>) { //tracking } }
53. Create Clueso val answersAdapter = AnswersTrackingAdapter() val firebaseAdapter = FirebaseTrackingAdapter() Clueso.create { isDebuggable = true adapters = listOf(answersAdapter, firebaseAdapter) }
54. Create Clueso val answersAdapter = AnswersTrackingAdapter() val firebaseAdapter = FirebaseTrackingAdapter() Clueso.create { isDebuggable = true adapters = listOf(answersAdapter, firebaseAdapter) }
55. Clueso in practice @OnClick(R.id.signUpBtn) fun signUpClicked() { this.trackingDelegator.onSignUpClicked() }
56. Clueso in practice @TrackEvent("signupStartEvent") @OnClick(R.id.signUpBtn) fun signUpClicked() { }
57. Clueso in practice private fun renderSuccess(user: UserViewModel) { this.trackingDelegator.onSignUpSuccess(userViewModel) }
58. Clueso in practice @TrackEvent("signupSuccess") private fun renderSuccess(@TrackEventAttribute user: UserViewModel) { }
59. Polyglot AOP AOP within the language, or as an external library: • Python • Haskell • Ruby • Swift • Lua • Delphi
60. Conclusion • Enhance SRP of the SOLID principles
61. Conclusion • Enhance SRP of the SOLID principles • Clean, readable and reusable code
62. Conclusion • Enhance SRP of the SOLID principles • Clean, readable and reusable code • Increases modularity
63. Conclusion • Enhance SRP of the SOLID principles • Clean, readable and reusable code • Increases modularity • Testable code
64. Conclusion • Enhance SRP of the SOLID principles • Clean, readable and reusable code • Increases modularity • Testable code • Build or load time code injection. Source-code weaving
65. Questions?