-
Notifications
You must be signed in to change notification settings - Fork 2
Analytics in common:core module #29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
justasm
wants to merge
5
commits into
main
Choose a base branch
from
analytics
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+112
−1
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e417183
Analytics singleton for consuming events.
justasm 840f8d4
Add mammoth-kt 2.0
justasm a486663
Gradle task to run mammoth using the open-sdk schema.
justasm 194cd4c
Generate the first analytics event.
justasm 5af5e0b
Track tap on a route when using the RoutesResult component.
justasm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
31 changes: 31 additions & 0 deletions
31
common/core/src/commonMain/kotlin/com/trafi/analytics/Analytics.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
package com.trafi.analytics | ||
|
||
import kotlin.native.concurrent.ThreadLocal | ||
|
||
interface AnalyticsDelegate { | ||
fun dispatchEvent(event: Analytics.Event) | ||
|
||
val screenName: String? | ||
val modalName: String? | ||
} | ||
|
||
@ThreadLocal | ||
object Analytics { | ||
|
||
private var delegate: AnalyticsDelegate? = null | ||
|
||
val screenName: String get() = delegate?.screenName ?: "" | ||
val modalName: String get() = delegate?.modalName ?: "" | ||
|
||
fun consume(event: Event) { | ||
delegate?.dispatchEvent(event) | ||
} | ||
|
||
fun set(delegate: AnalyticsDelegate) { | ||
this.delegate = delegate | ||
} | ||
|
||
data class Event(val business: RawEvent?, val publish: RawEvent) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
} | ||
|
||
data class RawEvent(val name: String, val parameters: Map<String, String>) |
55 changes: 55 additions & 0 deletions
55
common/core/src/commonMain/kotlin/com/trafi/analytics/AnalyticsEvent.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
// open-sdk schema version 2 | ||
// Generated with https://github.com/trafi/mammoth-kt | ||
// Do not edit manually. | ||
package com.trafi.analytics | ||
|
||
import kotlin.String | ||
|
||
private const val mammothSchemaVersion: String = "2" | ||
|
||
object AnalyticsEvent { | ||
/** | ||
* Tap on a specific route | ||
* | ||
* @param routeResultId Route search result id | ||
* @param routeId Route id | ||
* @param screenName Name of the active screen | ||
*/ | ||
fun routeTap( | ||
routeResultId: String, | ||
routeId: String, | ||
screenName: String = Analytics.screenName | ||
): Analytics.Event = Analytics.Event( | ||
business = RawEvent( | ||
name = "RouteTap", | ||
parameters = mapOf( | ||
"event_type" to "element_tap", | ||
"object_name" to "Route", | ||
"screen_name" to screenName, | ||
"route_result_id" to routeResultId, | ||
"route_id" to routeId, | ||
"schema_event_id" to "765", | ||
"schema_version" to mammothSchemaVersion | ||
) | ||
), | ||
publish = RawEvent( | ||
name = "element_tap", | ||
parameters = mapOf( | ||
"content" to "Route", | ||
"screen_name" to screenName, | ||
"group_id" to routeResultId, | ||
"item_id" to routeId, | ||
"achievement_id" to "765", | ||
"score" to mammothSchemaVersion | ||
) | ||
) | ||
) | ||
} | ||
|
||
enum class EventType( | ||
val value: String | ||
) { | ||
SCREEN_OPEN("screen_open"), | ||
|
||
ELEMENT_TAP("element_tap"); | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be great to have all these properties and functions static. In Swift we consume events through a static method:
Analytics.consume(event)
. Currently the generated interface requires to instantiate theAnalytics
type and call methods from there.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please experiment to see what Kotlin code gives you the result you expect. Ping me if you'd like to brainstorm ideas together.