@snowplow/react-native-tracker 0.2.0 → 1.1.0

package/CHANGELOG

@@ -1,3 +1,27 @@
+Version 1.1.0 (2022-02-07)
+--------------------------
+Update mobile tracker dependencies to v3 (#141)
+Add deep link and message notification events (#142)
+Update demo app to show accessing tracker instance from platform native code (#136)
+Fix compilation error for iOS build on ARM macs (#140)
+Fix check for byteLimitGet when reading emitter configuration (#138)
+Fix check for Android version in GitHub Actions (#134) 
+Update year in all copyright notices (#148) 
+Update dependencies (#150) 
+
+Version 1.0.0 (2021-08-09)
+--------------------------
+Fix action-gh-release to specific commit (#133)
+Update devDependencies (#132)
+Publish sourcemaps (#131)
+Lint DemoApp separately (#130)
+Get Session Context Data (#53)
+Update version in podspec (#110)
+Set amended v_tracker indicating react-native (#18)
+Add global contexts (#104)
+Upgrade iOS Tracker and Android Tracker to v2 (#113)
+Add test suite (#60)
+
 Version 0.2.0 (2021-06-21)
 --------------------------
 Bump dependencies in DemoApp (#114)

package/LICENSE

@@ -187,8 +187,8 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Significant portions Copyright (c) 2019 DataCamp. Remainder copyright
-   2020-2021 Snowplow Analytics Ltd. All rights reserved.
+   Copyright (c) 2020-2022 Snowplow Analytics Ltd, 2019 DataCamp.
+   All rights reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,7 +1,7 @@
 
 # @snowplow/react-native-tracker
 
-[![Early Release]][Tracker Classificiation]
+[![actively-maintained]][tracker-classification]
 [![Build Status][gh-actions-image]][gh-actions]
 [![License][license-image]][license]
 
@@ -10,299 +10,179 @@
 [![downloads][downloads-dm-image]][downloads-dm]
 
 
-Feedback and contributions are welcome - if you have identified a bug, please log an issue on this repo. For all other feedback, discussion or questions please open a thread on our [discourse forum](https://discourse.snowplowanalytics.com/).
+Snowplow is a scalable open-source platform for rich, high quality, low-latency data collection. It is designed to collect high quality, complete behavioral data for enterprise business.
 
-## Getting started
+**To find out more, please check out the [Snowplow website][website] and our [documentation][docs].**
 
-From the root of your [React Native][react-native] project:
 
-`$ npm install @snowplow/react-native-tracker --save`
+## Snowplow React-Native Tracker Overview
 
-### Instrumentation
+The Snowplow React Native Tracker allows you to add analytics to your React Native apps when using a [Snowplow][snowplow] pipeline.
 
-To setup, you first need to import the module and then create the tracker object using the `createTracker` function.
+With this library you can collect granular event-level data as your users interact with your React Native applications. It is build on top of Snowplow's [Mobile Native][native-trackers] [iOS][objc-tracker] and [Android][android-tracker] Trackers, in order to support the full range of out-of-the-box Snowplow events and tracking capabilities.
 
-Then you can start tracking events using the relevant tracking methods.
 
-```JavaScript
-import { createTracker } from '@snowplow/react-native-tracker';
+## Quick start
 
-const tracker = createTracker('my-namespace', {
-    // required
-    endpoint: 'test-url',
-    appId: 'my-app-id',
-
-    // optional - defaults shown
-    method: 'post',
-    protocol: 'https',
-    base64Encoded: true,
-    platformContext: true,
-    applicationContext: false,
-    lifecycleEvents: false,
-    screenContext: true,
-    sessionContext: true,
-    foregroundTimeout: 600,
-    backgroundTimeout: 300,
-    checkInterval: 15,
-    installTracking: false,
-  });
-
-tracker.trackSelfDescribingEvent(
-  {
-    schema: 'iglu:com.acme/hello_world_event/jsonschema/1-0-0',
-    data: {
-      message: 'hello world'
-    }
-  }
-);
+From the root of your [React Native][react-native] project:
 
 ```
-
-### Running on iOS
-
-`cd ios && pod install && cd ..`
-
-Run the app with: `react-native run-ios` from the root of the project.
-
-### Running on Android
-
-`react-native run-android` from the root of the project.
-
-## Available tracker methods
-
-All methods take a JSON of named arguments.
-
-
-### Set the subject data:
-
-Setting custom subject data is optional, can be called any time, and can be called again to update the subject. Once set, the specified parameters are set for all subsequent events. (For example, a userid may be set after login, and once set all subsequent events will contain the userid).
-
-```JavaScript
-setSubjectData({ // All parameters optional
-  userId: 'my-userId', // user id, string
-  screenWidth: 123, // screen width, integer
-  screenHeight: 456, // screen height, integer
-  colorDepth: 20, // colour depth, integer
-  timezone: 'Europe/London', // timezone, string enum
-  language: 'en', // language, string enum
-  ipAddress: '123.45.67.89', // IP address, string
-  useragent: '[some-user-agent-string]', // user agent, string
-  networkUserId: '5d79770b-015b-4af8-8c91-b2ed6faf4b1e', // network user id, UUID4 string
-  domainUserId: '5d79770b-015b-4af8-8c91-b2ed6faf4b1e',// domain user id, UUID4 string
-  viewportWidth: 123, // viewport width, integer
-  viewportHeight: 456 // viewport height, integer
-  }
-);
+npm install --save @snowplow/react-native-tracker
+npx pod-install
 ```
 
+Then, instrument the tracker in your app and start tracking events. For example:
 
-### Track a custom event:
-
-```JavaScript
-trackSelfDescribingEvent({ // Self-describing JSON for the custom event
-  schema: 'iglu:com.acme/event/jsonschema/1-0-0',
-  data: {message: 'hello world'}
-});
-```
+```javascript
+import { createTracker } from '@snowplow/react-native-tracker';
 
-### Track a structured event:
-
-```JavaScript
-trackStructuredEvent({
-  // required
-  category: 'my-category',
-  action: 'my-action',
-  // optional
-  label: 'my-label',
-  property: 'my-property',
-  value: 50.00
-  }
+const tracker = createTracker(
+    'my-namespace',
+    { endpoint: 'https://my-collector.endpoint' }
 );
-```
-
-### Track a Screen View:
-
-Note - for the track Screen View method, if previous screen values aren't set, they should be automatically set by the tracker.
 
-```JavaScript
-trackScreenViewEvent({
-  screenName: 'my-screen-name', //required
-  // optional:
-  screenType: 'my-screen-type',
-  transitionType: 'my-transition'
-  }
-);
+tracker.trackScreenViewEvent({ name: 'myScreenName' });
 ```
 
-### Track a Page View:
+The Snowplow React Native Tracker also provides first-class support for TypeScript, as it is fully typed.
 
-```JavaScript
-trackPageViewEvent({
-  pageUrl: 'https://www.my-page-url.com', // required
-  //optional:
-  pageTitle: 'my page title',
-  pageReferrer: 'http://www.my-refr.com'
-  }
-);
-```
+See also our [DemoApp][demoapp] for an example implementation.
 
-### Attaching custom contexts
-
-All track methods take an optional second argument - an array of 0 or more self-describing JSONs for custom contexts that will be attached to the event:
-
-```JavaScript
-
-trackSelfDescribingEvent(
-  // Self-describing JSON for the custom event
-  {
-    schema: 'iglu:com.acme/event/jsonschema/1-0-0',
-    data: {message: 'hello world'}
-  },
-  // array of contexts
-  [
-    {
-      schema: 'iglu:com.acme/entity/jsonschema/1-0-0',
-      data: {myEntityField: 'hello world'}
-    }
-  ]
-);
 
-trackStructuredEvent(
-  // the structured event's properties
-  {
-    // required
-    category: 'my-category',
-    action: 'my-action',
-    // optional
-    label: 'my-label',
-    property: 'my-property',
-    value: 50.00
-  },
-  // the contexts' array
-  [
-    {
-      schema: 'iglu:com.acme/entity/jsonschema/1-0-0',
-      data: {myEntityField: 'hello world'}
-    }
-  ]
-);
+## Find out more
 
-trackScreenViewEvent(
-  // the screen_view event's properties
-  {
-    screenName: 'my-screen-name', //required
-    // optional:
-    screenType: 'my-screen-type',
-    transitionType: 'my-transition'
-  },
-  // the contexts' array
-  [
-    {
-      schema: 'iglu:com.acme/entity/jsonschema/1-0-0',
-      data: {myEntityField: "hello world"}
-    }
-  ]
-);
+| Technical Docs                    | Setup Guide                 |
+|-----------------------------------|-----------------------------|
+| [![i1][techdocs-image]][techdocs] | [![i2][setup-image]][setup] |
+| [Technical Docs][techdocs]        | [Setup Guide][setup]        |
 
-trackPageViewEvent(
-  // the page_view event's properties
-  {
-    pageUrl: 'https://www.my-page-url.com', //required
-    // optional
-    pageTitle: 'my page title',
-    pageReferrer: 'http://www.my-refr.com'
-  },
-  // the context's array
-  [
-    {
-      schema: 'iglu:com.acme/entity/jsonschema/1-0-0',
-      data: {myEntityField: "hello world"}
-    }
-  ]
-);
-```
 
-## Contributing
 
-Please read CONTRIBUTING.md for general guidelines on contributing.
+## Maintainer quick start
 
-### Maintainer quick start
+### Launching the DemoApp
 
-Assuming a [react-native environment][react-native-environment] is set up, from the root of the repository to launch the DemoApp:
+Assuming a [react-native environment][react-native-environment] is set up, from the root of the repository:
 
 ```bash
 npm install
-npm run compile
-
+npm run bootstrap
 cd DemoApp
-yarn install
-
-yarn start # to start Metro
-
 ```
 
-Then in another terminal:
-
-1. For Android
+**For Android:**
 
 ```bash
-cd DemoApp
 yarn android
 ```
+_Note_: Linux users who want to run the DemoApp for Android, would also need to run `yarn start` in a separate terminal.
 
-2. For iOS
+**For iOS:**
 
 ```bash
-cd DemoApp/ios && pod install
-cd .. && yarn ios
+yarn pods && yarn ios
 ```
 
-### Testing
-
-Currently, testing is done manually. It is recommended to use [Snowplow Micro][snowplow-micro] or a [Snowplow Mini][snowplow-mini] instance to test your changes during development.
-
-During development, to quickly test changes, the `.scripts/quickTest.sh` bash script can be used, assuming the DemoApp has already been built before. This simply replaces relevant files in the node_modules folder, and re-runs react native.
+During development, to quickly test changes, the `.scripts/quickTest.sh` bash script can be used.
 
 ```bash
 # android
-
 bash .scripts/quickTest.sh android
-
 # ios
-
 bash .scripts/quickTest.sh ios
-
 # both
-
 bash .scripts/quickTest.sh both
 ```
 
-The `.scripts/cleanBuildAndRun.sh` script offers a naive way to rebuild the entire project with your changes. It uses `npm pack` to create an npm package locally, and installs it to the DemoApp, then it removes pod and gradle lock files and rebuilds all dependencies.
+Similarly, the `.scripts/cleanBuildAndRun.sh` script offers a naive way to clean-rebuild the entire project with your changes.
 
 ```bash
 # android
-
 bash .scripts/cleanBuildAndRun.sh android
-
 # ios
-
 bash .scripts/cleanBuildAndRun.sh ios
-
 # both
-
 bash .scripts/cleanBuildAndRun.sh both
 ```
 
-## Find out more
 
-| Technical Docs              |
-|-----------------------------|
-| ![i1][techdocs-image]       |
-| [Technical Docs][techdocs]  |
+### End-to-end tests
+
+Snowplow React-Native Tracker is being end-to-end tested using [Snowplow Micro][snowplow-micro] and [Detox][detox]. To run these tests locally:
+
+#### Prerequisites
+
+1. **Docker**: Used to launch Snowplow Micro and expose its collector endpoint on `http://0.0.0.0:9090`.
+2. **Perl**: Used to substitute the endpoint placeholders in `DemoApp/App.js` with Micro's endpoint for respective emulator/simulator.
+3. **Detox** platform-specific development environment setup:
+    - [For Android][detox-android-env]. Namely:
+      - Java 8
+      - Android SDK
+      - Android Open-Source Project emulator
+    - [For iOS][detox-ios-env]. Namely:
+      - applesimutils
+
+#### Testing
+
+Once the prerequisites are in place:
+
+```
+npm install
+npm run bootstrap
+cd DemoApp
+```
+
+ - **e2e-android**
+```
+yarn e2e:android:micro
+```
+
+ - **e2e-ios**
+```
+yarn e2e:ios:micro
+```
 
-[Tracker Classificiation]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/
-[Early Release]: https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Early%20Release&color=014477&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC
+The above commands will take care to kill Micro's running container before exiting. If you'd prefer to keep Micro running in order to inspect the tracked events through Micro's REST API, you can alternatively control Micro through:
 
+```
+yarn micro:run
+yarn micro:stop
+```
+and run the e2e-tests on their own:
+```
+yarn e2e:android
+# or
+yarn e2e:ios
+```
+
+
+## Contributing
+
+Feedback and contributions are welcome - if you have identified a bug, please log an issue on this repo. For all other feedback, discussion or questions please open a thread on our [discourse forum][discourse].
+
+| Contributing                              |
+|-------------------------------------------|
+| [![i3][contributing-image]][contributing] |
+| [Contributing][contributing]              |
+
+
+
+## Copyright and license
+
+The Snowplow React Native Tracker is copyright 2020-2022 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.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+[tracker-classification]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/
+[actively-maintained]: https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Actively%20Maintained&color=6638b8&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC
 [gh-actions]: https://github.com/snowplow-incubator/snowplow-react-native-tracker/actions
 [gh-actions-image]: https://github.com/snowplow-incubator/snowplow-react-native-tracker/workflows/build/badge.svg?branch=master
 
@@ -318,10 +198,30 @@ bash .scripts/cleanBuildAndRun.sh both
 [downloads-dm]: https://www.npmjs.com/package/@snowplow/react-native-tracker
 [downloads-dm-image]: https://img.shields.io/npm/dm/@snowplow/react-native-tracker
 
-[techdocs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/react-native-tracker/
+[website]: https://snowplowanalytics.com
+[docs]: https://docs.snowplowanalytics.com
+[snowplow]: https://github.com/snowplow/snowplow
+[discourse]: https://discourse.snowplowanalytics.com
+
+[techdocs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/react-native-tracker/introduction
 [techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
+[setup]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/react-native-tracker/quick-start-guide/
+[setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
+
+[contributing]: https://github.com/snowplow-incubator/snowplow-react-native-tracker/blob/master/CONTRIBUTING.md
+[contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
 
 [react-native]: https://reactnative.dev/
 [react-native-environment]: https://reactnative.dev/docs/environment-setup
 [snowplow-micro]: https://github.com/snowplow-incubator/snowplow-micro
 [snowplow-mini]: https://github.com/snowplow/snowplow-mini
+
+[native-trackers]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/mobile-trackers/mobile-trackers-v2-0
+[objc-tracker]: https://github.com/snowplow/snowplow-objc-tracker
+[android-tracker]: https://github.com/snowplow/snowplow-android-tracker
+
+[demoapp]: https://github.com/snowplow-incubator/snowplow-react-native-tracker/tree/master/DemoApp
+[gh-actions-workflows]: https://github.com/snowplow-incubator/snowplow-react-native-tracker/tree/master/.github/workflows
+[detox]: https://github.com/wix/Detox
+[detox-android-env]: https://github.com/wix/Detox/blob/master/docs/Introduction.AndroidDevEnv.md
+[detox-ios-env]: https://github.com/wix/Detox/blob/master/docs/Introduction.iOSDevEnv.md

package/RNSnowplowTracker.podspec

@@ -0,0 +1,24 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name         = "RNSnowplowTracker"
+  s.version      = package['version']
+  s.license      = package['license']
+
+  s.summary      = "Snowplow React Native tracker"
+  s.description  = package['description']
+  s.homepage     = package['homepage']
+  s.author       = { "Snowplow Analytics Ltd" => "info@snowplowanalytics.com" }
+
+  s.platforms    = { :ios => "9.0" }
+
+  s.source       = { :git => "https://github.com/snowplow-incubator/snowplow-react-native-tracker.git", :tag => "#{s.version}" }
+  s.source_files = "ios/**/*.{h,m}"
+
+  s.requires_arc = true
+
+  s.dependency "React-Core"
+  s.dependency "SnowplowTracker", "~> 3.0"
+end

package/android/build.gradle

@@ -4,24 +4,24 @@ def safeExtGet(prop, fallback) {
 
 buildscript {
     repositories {
-        google()
         mavenCentral()
+        google()
     }
 
     dependencies {
-        classpath "com.android.tools.build:gradle:3.4.1"
+        classpath "com.android.tools.build:gradle:4.2.1"
     }
 }
 
 apply plugin: "com.android.library"
 
 android {
-    compileSdkVersion safeExtGet('compileSdkVersion', 28)
+    compileSdkVersion safeExtGet('compileSdkVersion', 30)
     buildToolsVersion safeExtGet('buildToolsVersion', '28.0.3')
 
     defaultConfig {
-        minSdkVersion safeExtGet('minSdkVersion', 16)
-        targetSdkVersion safeExtGet('targetSdkVersion', 28)
+        minSdkVersion safeExtGet('minSdkVersion', 21)
+        targetSdkVersion safeExtGet('targetSdkVersion', 30)
         versionCode 1
         versionName "1.0"
     }
@@ -44,12 +44,11 @@ repositories {
 }
 
 dependencies {
-    def lifecycle_version = "2.0.0"
     implementation fileTree(dir: "libs", include: ["*.jar"])
-    implementation "androidx.lifecycle:lifecycle-extensions:$lifecycle_version"
+    implementation 'androidx.lifecycle:lifecycle-extensions:2.2.+'
 
     // Required Dependency for the Tracker
-    implementation "com.squareup.okhttp3:okhttp:3.12.1"
+    implementation "com.squareup.okhttp3:okhttp:4.9.3"
     implementation "com.facebook.react:react-native:+"
-    implementation "com.snowplowanalytics:snowplow-android-tracker:1.+"
+    implementation 'com.snowplowanalytics:snowplow-android-tracker:3.+'
 }

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7.1-all.zip