@snowplow/react-native-tracker 2.0.0 → 2.1.1

package/.github/workflows/build.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -38,7 +38,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -52,7 +52,7 @@ jobs:
       TURBO_CACHE_DIR: .turbo/android
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -106,7 +106,12 @@ jobs:
       TURBO_CACHE_DIR: .turbo/ios
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: setup-cocoapods
+        uses: maxim-lobanov/setup-cocoapods@v1
+        with:
+          version: 1.15.2
 
       - name: Setup
         uses: ./.github/actions/setup

package/.github/workflows/deploy.yml

@@ -1,24 +1,20 @@
 name: Deploy
 
 on:
-  workflow_run:
-    workflows: [Build]
-    types: [completed]
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+*'
 
 jobs:
 
   version_check:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }} && startsWith(github.ref, 'refs/tags/') }}
     runs-on: ubuntu-latest
     outputs:
       v_tracker: ${{ steps.version.outputs.RN_TRACKER_VERSION}}
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Setup
-      uses: ./.github/actions/setup
+      uses: actions/checkout@v4
 
     - name: Get tag and tracker versions
       id: version
@@ -27,7 +23,7 @@ jobs:
         ANDR_VER_FILEPATH: 'android/src/main/java/com/snowplow/reactnativetracker/util/TrackerVersion.kt'
         JS_VER_FILEPATH: 'src/jsCore.ts'
       run: |
-        echo "TAG_VERSION=${{ github.event.workflow_run.head_branch }}" >> $GITHUB_OUTPUT
+        echo "TAG_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
         echo "RN_TRACKER_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
         echo "RN_IOS_TRACKER_VERSION=$(cat "${IOS_VER_FILEPATH}" | sed -n -e 's/^.*kRNTrackerVersion = "rn-\(.*\)"/\1/p')" >> $GITHUB_OUTPUT
         echo "RN_ANDROID_TRACKER_VERSION=$(cat "${ANDR_VER_FILEPATH}" | sed -n -e 's/^.*RN_TRACKER_VERSION = "rn-\(.*\)"/\1/p')" >> $GITHUB_OUTPUT
@@ -58,11 +54,14 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Setup
       uses: ./.github/actions/setup
 
+    - name: Run unit tests
+      run: yarn test
+
     - name: Build dist files
       run: |
         yarn

package/.github/workflows/e2e-android.yml

@@ -5,14 +5,14 @@ on:
 
 jobs:
   e2e:
-    runs-on: macos-latest
+    runs-on: macos-12
     timeout-minutes: 60
     env:
       TURBO_CACHE_DIR: .turbo/android-e2e
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup

package/.github/workflows/e2e-ios.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   e2e:
-    runs-on: macos-latest
+    runs-on: macos-12
     timeout-minutes: 60
     env:
       TURBO_CACHE_DIR: .turbo/ios-e2e
@@ -14,6 +14,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
+      - name: setup-cocoapods
+        uses: maxim-lobanov/setup-cocoapods@v1
+        with:
+          version: 1.15.2
+
       - name: Setup
         uses: ./.github/actions/setup
 

package/.github/workflows/snyk.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Run Snyk to check for vulnerabilities
       uses: snyk/actions/node@master

package/CHANGELOG

@@ -1,3 +1,17 @@
+Version 2.1.1 (2024-07-03)
+--------------------------
+Update tracker and example app dependencies
+
+Version 2.1.0 (2024-02-21)
+--------------------------
+Upgrade to mobile trackers version 6 and add screen engagement tracking (close #90)
+Fix SelfDescribing extension type (close #204)
+Update JavaScript tracker core version to 3.21.0
+Fix running deploy action only on new tags
+Update cocoapods version
+Lock yarn version to 1.22.19
+Update copyright headers
+
 Version 2.0.0 (2023-09-29)
 --------------------------
 Upgrade project structure and update native trackers to version 5 (#199)

package/CONTRIBUTING.md

@@ -68,7 +68,7 @@ If your pull request is fairly chunky, there might be a non-trivial delay betwee
 ### Contributor license agreement
 
 We require outside contributors to sign a Contributor license agreement (or CLA) before we can merge their pull requests.  
-You can find more information on the topic in [the dedicated wiki page](https://github.com/snowplow/snowplow/wiki/CLA).  
+You can find more information on the topic in [the dedicated wiki page](https://docs.snowplow.io/docs/contributing/contributor-license-agreement/).  
 The @snowplowcla bot will guide you through the process.
 
 ## Getting in touch
@@ -77,4 +77,4 @@ The @snowplowcla bot will guide you through the process.
 
 Please do not log an issue if you are asking for support, all of our community support requests go through our Discourse forum: https://discourse.snowplowanalytics.com/.
 
-Posting your problem there ensures more people will see it and you should get support faster than creating a new issue on GitHub. Please do create a new issue on GitHub if you think you've found a bug though!
+Posting your problem there ensures more people will see it and you should get support faster than creating a new issue on GitHub. Please do create a new issue on GitHub if you think you've found a bug though!

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright (c) 2020-2023 Snowplow Analytics Ltd, 2019 DataCamp.
+   Copyright (c) 2020-present Snowplow Analytics Ltd, 2019 DataCamp.
    All rights reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");

package/README.md

@@ -48,7 +48,7 @@ tracker.trackScreenViewEvent({ name: 'myScreenName' });
 
 The Snowplow React Native Tracker also provides first-class support for TypeScript, as it is fully typed.
 
-See also our [DemoApp][demoapp] for an example implementation.
+See also our [DemoApp](example) for an example implementation.
 
 ## Find out more
 
@@ -113,7 +113,7 @@ Feedback and contributions are welcome - if you have identified a bug, please lo
 
 ## Copyright and license
 
-The Snowplow React Native Tracker is copyright 2020-2023 Snowplow Analytics Ltd, 2019 DataCamp.
+The Snowplow React Native Tracker is copyright 2020-present Snowplow Analytics Ltd, 2019 DataCamp.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.

package/android/build.gradle

@@ -97,7 +97,7 @@ dependencies {
   //noinspection GradleDynamicVersion
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation "com.snowplowanalytics:snowplow-android-tracker:5.4.4"
+  implementation "com.snowplowanalytics:snowplow-android-tracker:6.0.+"
   implementation "com.squareup.okhttp3:okhttp:4.10.0"
 }
 

package/android/src/main/java/com/snowplow/reactnativetracker/ReactNativeTrackerModule.kt

@@ -177,7 +177,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val sdj: SelfDescribingJson = EventUtil.createSelfDescribingJson(argmap)
       val event = SelfDescribing(sdj)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -197,7 +197,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: Structured = EventUtil.createStructuredEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -217,7 +217,47 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: ScreenView = EventUtil.createScreenViewEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
+      trackerController.track(event)
+      promise.resolve(true)
+    } catch (t: Throwable) {
+      promise.reject("ERROR", t.message)
+    }
+  }
+
+  @ReactMethod
+  fun trackScrollChangedEvent(
+    details: ReadableMap,
+    promise: Promise
+  ) {
+    try {
+      val namespace = details.getString("tracker")
+      val argmap = details.getMap("eventData")!!
+      val contexts = details.getArray("contexts")!!
+      val trackerController = getTracker(namespace)
+      val event: ScrollChanged = EventUtil.createScrollChangedEvent(argmap)
+      val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
+      event.entities.addAll(evCtxts)
+      trackerController.track(event)
+      promise.resolve(true)
+    } catch (t: Throwable) {
+      promise.reject("ERROR", t.message)
+    }
+  }
+
+  @ReactMethod
+  fun trackListItemViewEvent(
+    details: ReadableMap,
+    promise: Promise
+  ) {
+    try {
+      val namespace = details.getString("tracker")
+      val argmap = details.getMap("eventData")!!
+      val contexts = details.getArray("contexts")!!
+      val trackerController = getTracker(namespace)
+      val event: ListItemView = EventUtil.createListItemViewEvent(argmap)
+      val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -237,7 +277,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: PageView = EventUtil.createPageViewEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -257,7 +297,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: Timing = EventUtil.createTimingEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -277,7 +317,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: ConsentGranted = EventUtil.createConsentGrantedEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -297,7 +337,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: ConsentWithdrawn = EventUtil.createConsentWithdrawnEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -317,7 +357,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: EcommerceTransaction = EventUtil.createEcommerceTransactionEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -337,7 +377,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: DeepLinkReceived = EventUtil.createDeepLinkReceivedEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {
@@ -357,7 +397,7 @@ class ReactNativeTrackerModule(val reactContext: ReactApplicationContext) :
       val trackerController = getTracker(namespace)
       val event: MessageNotification = EventUtil.createMessageNotificationEvent(argmap)
       val evCtxts: List<SelfDescribingJson> = EventUtil.createContexts(contexts)
-      event.customContexts.addAll(evCtxts)
+      event.entities.addAll(evCtxts)
       trackerController.track(event)
       promise.resolve(true)
     } catch (t: Throwable) {

package/android/src/main/java/com/snowplow/reactnativetracker/util/ConfigUtil.kt

@@ -54,6 +54,9 @@ object ConfigUtil {
     if (trackerConfig.hasKey("screenViewAutotracking")) {
       trackerConfiguration.screenViewAutotracking(trackerConfig.getBoolean("screenViewAutotracking"))
     }
+    if (trackerConfig.hasKey("screenEngagementAutotracking")) {
+      trackerConfiguration.screenEngagementAutotracking(trackerConfig.getBoolean("screenEngagementAutotracking"))
+    }
     if (trackerConfig.hasKey("lifecycleAutotracking")) {
       trackerConfiguration.lifecycleAutotracking(trackerConfig.getBoolean("lifecycleAutotracking"))
     }
@@ -252,8 +255,8 @@ object ConfigUtil {
   private fun mkBufferOption(bufferOpt: String): BufferOption? {
     return when (bufferOpt) {
       "single" -> BufferOption.Single
-      "default" -> BufferOption.DefaultGroup
-      "large" -> BufferOption.HeavyGroup
+      "small" -> BufferOption.SmallGroup
+      "large" -> BufferOption.LargeGroup
       else -> null
     }
   }

package/android/src/main/java/com/snowplow/reactnativetracker/util/EventUtil.kt

@@ -50,6 +50,26 @@ object EventUtil {
     return event
   }
 
+  fun createScrollChangedEvent(argmap: ReadableMap): ScrollChanged {
+    val event = ScrollChanged(
+      yOffset = if (argmap.hasKey("yOffset")) { argmap.getDouble("yOffset").toInt() } else { null },
+      xOffset = if (argmap.hasKey("xOffset")) { argmap.getDouble("xOffset").toInt() } else { null },
+      viewHeight = if (argmap.hasKey("viewHeight")) { argmap.getDouble("viewHeight").toInt() } else { null },
+      viewWidth = if (argmap.hasKey("viewWidth")) { argmap.getDouble("viewWidth").toInt() } else { null },
+      contentHeight = if (argmap.hasKey("contentHeight")) { argmap.getDouble("contentHeight").toInt() } else { null },
+      contentWidth = if (argmap.hasKey("contentWidth")) { argmap.getDouble("contentWidth").toInt() } else { null },
+    )
+    return event
+  }
+
+  fun createListItemViewEvent(argmap: ReadableMap): ListItemView {
+    val event = ListItemView(
+      index = argmap.getDouble("index").toInt(),
+      itemsCount = if (argmap.hasKey("itemsCount")) { argmap.getDouble("itemsCount").toInt() } else { null },
+    )
+    return event
+  }
+
   fun createPageViewEvent(argmap: ReadableMap): PageView {
     val event = PageView(argmap.getString("pageUrl")!!)
     argmap.getString("pageTitle")?.let { event.pageTitle(it) }

package/android/src/main/java/com/snowplow/reactnativetracker/util/TrackerVersion.kt

@@ -1,5 +1,5 @@
 package com.snowplow.reactnativetracker.util
 
 object TrackerVersion {
-  const val RN_TRACKER_VERSION = "rn-2.0.0"
+  const val RN_TRACKER_VERSION = "rn-2.1.1"
 }

package/example/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # You may use http://rbenv.org/ or https://rvm.io/ to install and use this version
 ruby ">= 2.6.10"
 
-gem 'cocoapods', '~> 1.12'
+gem 'cocoapods', '1.15.2'

package/example/e2e/emitEvents.e2e.detox.js

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 const commands = require('./helpers/microCommands.js');
 
 describe('Example', () => {

package/example/e2e/helpers/microCommands.js

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 const Micro = require('./microHelpers.js');
 
 const microUrl = '0.0.0.0';

package/example/e2e/helpers/microHelpers.js

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 const http = require('http');
 
 /**

package/example/e2e/helpers/microHelpers.test.js

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 const Micro = require('./microHelpers.js');
 
 describe('tests helper functions of helpers.js', () => {

package/example/e2e/helpers/schemas.js

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 // Self-describing schemas
 const appInstall =
   'iglu:com.snowplowanalytics.mobile/application_install/jsonschema/1-0-0';

package/example/e2e/testEvents.micro.test.js

@@ -1,16 +1,3 @@
-/*
- * Copyright (c) 2020-2023 Snowplow Analytics Ltd. All rights reserved.
- *
- * This program is licensed to you under the Apache License Version 2.0,
- * and you may not use this file except in compliance with the Apache License Version 2.0.
- * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the Apache License Version 2.0 is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
- */
-
 const commands = require('./helpers/microCommands.js');
 const schemas = require('./helpers/schemas.js');
 
@@ -235,7 +222,7 @@ test('common in all first tracker events', async () => {
         },
       ],
     },
-    23
+    29
   );
 });
 

package/example/ios/Podfile

@@ -60,5 +60,3 @@ target 'ReactNativeTrackerExample' do
     __apply_Xcode_12_5_M1_post_install_workaround(installer)
   end
 end
-
-pod 'FMDB', :modular_headers => true