Merge branch 'release/0.5.0'

snowplow · Dec 5, 2023 · b489be0 · b489be0
2 parents 11965f8 + 531cb68
commit b489be0
Show file tree

Hide file tree

Showing 17 changed files with 107 additions and 80 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.5.0
+
+*  Add lifecycle autotracking config option (#39)
+
 # 0.4.0
 
 * Add configuration for setting custom HTTP headers for requests to the collector (#34)

diff --git a/README.md b/README.md
@@ -20,18 +20,19 @@ It is build on top of Snowplow's native [iOS](https://github.com/snowplow/snowpl
 
 ## Features
 
-| Feature | Android | iOS | Web |
-|---|---|---|---|
-| Manual tracking of events: screen views, self-describing, structured, timing, consent granted and withdrawal | ✔ | ✔ | ✔ |
-| Automatic tracking of views events from Navigator API | ✔ | ✔ | ✔ |
-| Adding custom context entities to events | ✔ | ✔ | ✔ |
-| Support for multiple trackers | ✔ | ✔ | ✔ |
-| Configurable subject properties | ✔ | ✔ | partly |
-| Session context entity added to events | ✔ | ✔ | ✔ |
-| Geo-location context entity | ✔ | ✔ | ✔ |
-| Mobile platform context entity | ✔ | ✔ | |
-| Web page context entity | | | ✔ |
-| Configurable GDPR context entity | ✔ | ✔ | ✔ |
+| Feature                                                                                                      | Android | iOS | Web    |
+|--------------------------------------------------------------------------------------------------------------|---|---|--------|
+| Manual tracking of events: screen views, self-describing, structured, timing, consent granted and withdrawal | ✔ | ✔ | ✔      |
+| Automatic tracking of views events from Navigator API                                                        | ✔ | ✔ | ✔      |
+| Adding custom context entities to events                                                                     | ✔ | ✔ | ✔      |
+| Support for multiple trackers                                                                                | ✔ | ✔ | ✔      |
+| Configurable subject properties                                                                              | ✔ | ✔ | partly |
+| Session context entity added to events                                                                       | ✔ | ✔ | ✔      |
+| Geo-location context entity                                                                                  | ✔ | ✔ | ✔      |
+| Mobile platform context entity                                                                               | ✔ | ✔ |        |
+| Web page context entity                                                                                      | | | ✔      |
+| Configurable GDPR context entity                                                                             | ✔ | ✔ | ✔      |
+| Lifecycle autotracking                                                                                       | ✔ | ✔ |        |
 
 ## Quick Start
 
@@ -47,7 +48,7 @@ This will add a line with the dependency like this to your `pubspec.yaml`:
 
 ```yml
 dependencies:
-    snowplow_tracker: ^0.4.0
+    snowplow_tracker: ^0.5.0
 ```
 
 Import the package into your Dart code:

diff --git a/android/src/main/kotlin/com/snowplowanalytics/snowplow_tracker/TrackerVersion.kt b/android/src/main/kotlin/com/snowplowanalytics/snowplow_tracker/TrackerVersion.kt
@@ -12,5 +12,5 @@
 package com.snowplowanalytics.snowplow_tracker
 
 object TrackerVersion {
-    val TRACKER_VERSION = "flutter-0.4.0"
+    val TRACKER_VERSION = "flutter-0.5.0"
 }
diff --git a/...m/snowplowanalytics/snowplow_tracker/readers/configurations/TrackerConfigurationReader.kt b/...m/snowplowanalytics/snowplow_tracker/readers/configurations/TrackerConfigurationReader.kt
@@ -28,6 +28,7 @@ class TrackerConfigurationReader(values: Map<String, Any>) {
     val userAnonymisation: Boolean? by valuesDefault
     val screenContext: Boolean? by valuesDefault
     val applicationContext: Boolean? by valuesDefault
+    val lifecycleAutotracking: Boolean? by valuesDefault
 
 
     fun toConfiguration(context: Context): TrackerConfiguration {
@@ -52,6 +53,7 @@ class TrackerConfigurationReader(values: Map<String, Any>) {
         userAnonymisation?.let { trackerConfig.userAnonymisation(it) }
         screenContext?.let { trackerConfig.screenContext(it) }
         applicationContext?.let { trackerConfig.applicationContext(it) }
+        lifecycleAutotracking?.let { trackerConfig.lifecycleAutotracking(it) }
 
         return trackerConfig
     }

diff --git a/doc/01-getting-started.md b/doc/01-getting-started.md
@@ -16,7 +16,7 @@ This will add a line with the dependency like to your pubspec.yaml:
 
 ```yml
 dependencies:
-    snowplow_tracker: ^0.4.0
+    snowplow_tracker: ^0.5.0
 ```
 
 Import the package into your Dart code:

diff --git a/doc/02-configuration.md b/doc/02-configuration.md
@@ -34,23 +34,26 @@ Setting a custom POST path can be useful in avoiding adblockers; it replaces the
 
 `TrackerConfiguration` provides options to configure properties and features of the tracker. In addition to setting the app identifier and device platform, the configuration enables turning several automatic context entities on and off.
 
-| Attribute | Type | Description | Android | iOS | Web | Default |
-|---|---|---|---|---|---|---|
-| `appId` | `String?` | Identifier of the app. | ✔ | ✔ | ✔ | null on Web, bundle identifier on iOS/Android |
-| `devicePlatform` | `DevicePlatform?` | The device platform the tracker runs on. Available options are provided by the `DevicePlatform` enum. | ✔ | ✔ | ✔ | "web" on Web, "mob" on iOS/Android |
-| `base64Encoding` | `bool?` | Indicates whether payload JSON data should be base64 encoded. | ✔ | ✔ | ✔ | true |
-| `platformContext` | `bool?` | Indicates whether [platform](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/mobile_context/jsonschema/1-0-2) (mobile) context should be attached to tracked events. | ✔ | ✔ | | true |
-| `geoLocationContext` | `bool?` | Indicates whether [geo-location](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/geolocation_context/jsonschema/1-1-0) context should be attached to tracked events. | ✔ | ✔ | ✔ | false |
-| `sessionContext` | `bool?` | Indicates whether [session](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/client_session/jsonschema/1-0-2) context should be attached to tracked events. | ✔ | ✔ | ✔ | true |
-| `webPageContext` | `bool?` | Indicates whether context about current [web page](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/web_page/jsonschema/1-0-0) should be attached to tracked events. | | | ✔ | true |
-| `screenContext` | `bool?` | Indicates whether [screen](http://iglucentral.com/schemas/com.snowplowanalytics.mobile/screen/jsonschema/1-0-0) context should be attached to tracked events. | ✔ | ✔ | | true |
-| `applicationContext` | `bool?` | Indicates whether [application](http://iglucentral.com/schemas/com.snowplowanalytics.mobile/application/jsonschema/1-0-0) context should be attached to tracked events. | ✔ | ✔ | | true |
-| `webActivityTracking` | WebActivityTracking?` | Enables activity tracking using page views and pings on the Web. | | | ✔ | true |
-| `userAnonymisation` | `bool?` | Anonymises certain user identifiers. | ✔ | ✔ | ✔ | false |
+| Attribute               | Type | Description                                                                                                                                                                       | Android | iOS | Web | Default                                       |
+|-------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|-----------------------------------------------|
+| `appId`                 | `String?` | Identifier of the app.                                                                                                                                                            | ✔ | ✔ | ✔ | null on Web, bundle identifier on iOS/Android |
+| `devicePlatform`        | `DevicePlatform?` | The device platform the tracker runs on. Available options are provided by the `DevicePlatform` enum.                                                                             | ✔ | ✔ | ✔ | "web" on Web, "mob" on iOS/Android            |
+| `base64Encoding`        | `bool?` | Indicates whether payload JSON data should be base64 encoded.                                                                                                                     | ✔ | ✔ | ✔ | true                                          |
+| `platformContext`       | `bool?` | Indicates whether [platform](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/mobile_context/jsonschema/1-0-2) (mobile) entity should be attached to tracked events. | ✔ | ✔ | | true                                          |
+| `geoLocationContext`    | `bool?` | Indicates whether [geo-location](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/geolocation_context/jsonschema/1-1-0) entity should be attached to tracked events. | ✔ | ✔ | ✔ | false                                         |
+| `sessionContext`        | `bool?` | Indicates whether [session](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/client_session/jsonschema/1-0-2) entity should be attached to tracked events.           | ✔ | ✔ | ✔ | true                                          |
+| `webPageContext`        | `bool?` | Indicates whether context about current [web page](http://iglucentral.com/schemas/com.snowplowanalytics.snowplow/web_page/jsonschema/1-0-0) should be attached to tracked events. | | | ✔ | true                                          |
+| `screenContext`         | `bool?` | Indicates whether [screen](http://iglucentral.com/schemas/com.snowplowanalytics.mobile/screen/jsonschema/1-0-0) entity should be attached to tracked events.                      | ✔ | ✔ | | true                                          |
+| `applicationContext`    | `bool?` | Indicates whether [application](http://iglucentral.com/schemas/com.snowplowanalytics.mobile/application/jsonschema/1-0-0) entity should be attached to tracked events.            | ✔ | ✔ | | true                                          |
+| `webActivityTracking`   | `WebActivityTracking?` | Enables activity tracking using page views and pings on the Web.                                                                                                                  | | | ✔ | true                                          |
+| `userAnonymisation`     | `bool?` | Anonymises certain user identifiers.                                                                                                                                              | ✔ | ✔ | ✔ | false                                         |
+| `lifecycleAutotracking` | `bool?` | Indicates whether the [lifecycle](iglu:com.snowplowanalytics.mobile/application_lifecycle/jsonschema/1-0-0) entity and foreground and background events should be autotracked.    | ✔ | ✔ | | false                                         |
 
 The optional `WebActivityTracking` property configures page tracking on Web. Initializing the configuration will inform `SnowplowObserver` observers (see section on auto-tracking in "Tracking events") to auto track `PageViewEvent` events instead of `ScreenView` events on navigation changes. Further, setting the `minimumVisitLength` and `heartbeatDelay` properties of the `WebActivityTracking` instance will enable activity tracking using 'page ping' events on Web.
 
-Activity tracking monitors whether a user continues to engage with a page over time, and record how he / she digests content on the page over time.  That is accomplished using 'page ping' events. If activity tracking is enabled, the web page is monitored to see if a user is engaging with it. (E.g. is the tab in focus, does the mouse move over the page, does the user scroll etc.) If any of these things occur in a set period of time (`minimumVisitLength` seconds from page load and every `heartbeatDelay` seconds after that), a page ping event fires, and records the maximum scroll left / right and up / down in the last ping period. If there is no activity in the page (e.g. because the user is on a different tab in his / her browser), no page ping fires.
+Activity tracking monitors whether a user continues to engage with a page over time, and record how they digest content on the page over time.  That is accomplished using 'page ping' events. If activity tracking is enabled, the web page is monitored to see if a user is engaging with it. (E.g. is the tab in focus, does the mouse move over the page, does the user scroll etc.) If any of these things occur in a set period of time (`minimumVisitLength` seconds from page load and every `heartbeatDelay` seconds after that), a page ping event fires, and records the maximum scroll left / right and up / down in the last ping period. If there is no activity in the page (e.g. because the user is on a different tab in their browser), no page ping fires.
+
+Lifecycle autotracking is only available on mobile apps (iOS and Android). When configured, a Lifecycle context entity is attached to all events. It records whether the app was visible or not when the event was tracked. In addition, a `Background` event will be tracked when the app is moved to background, and a `Foreground` event when the app moves back to foreground (becomes visible on the screen).
 
 See the separate page for information about anonymous tracking.
 

diff --git a/example/android/build.gradle b/example/android/build.gradle
@@ -6,7 +6,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.0.4'
+        classpath 'com.android.tools.build:gradle:7.1.3'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }

diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock
@@ -5,7 +5,7 @@ PODS:
   - FMDB/standard (2.7.5)
   - integration_test (0.0.1):
     - Flutter
-  - snowplow_tracker (0.4.0):
+  - snowplow_tracker (0.5.0):
     - Flutter
     - SnowplowTracker (~> 5.4)
   - SnowplowTracker (5.4.0):
@@ -33,9 +33,9 @@ SPEC CHECKSUMS:
   Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854
   FMDB: 2ce00b547f966261cd18927a3ddb07cb6f3db82a
   integration_test: 13825b8a9334a850581300559b8839134b124670
-  snowplow_tracker: 022a7e65a05a6f6043043d58d8df870b379efe5d
+  snowplow_tracker: 941f2de51ed3c6964ccab206ac5ba75f326a188a
   SnowplowTracker: a7fa5ae461955637f773a51c941635f39a5b0747
 
 PODFILE CHECKSUM: ef19549a9bc3046e7bb7d2fab4d021637c0c58a3
 
-COCOAPODS: 1.12.0
+COCOAPODS: 1.12.1
diff --git a/example/ios/Runner.xcodeproj/project.pbxproj b/example/ios/Runner.xcodeproj/project.pbxproj
@@ -155,7 +155,7 @@
 		97C146E61CF9000F007C117D /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 1300;
+				LastUpgradeCheck = 1430;
 				ORGANIZATIONNAME = "";
 				TargetAttributes = {
 					97C146ED1CF9000F007C117D = {

diff --git a/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1300"
+   LastUpgradeVersion = "1430"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/example/lib/overview.dart b/example/lib/overview.dart
@@ -27,7 +27,7 @@ This will add a line with the dependency like this to your `pubspec.yaml`:
 
 ```yml
 dependencies:
-    snowplow_tracker: ^0.4.0
+    snowplow_tracker: ^0.5.0
 ```
 
 Import the package into your Dart code: