Add sessionContext and devicePlatform options to React Native tracker configuration (#1401)

Author: matus-tomlein

api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionconfiguration.md

@@ -18,4 +18,5 @@ export interface SessionConfiguration
 |  --- | --- | --- |
 |  [backgroundSessionTimeout?](./react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md) | number | <i>(Optional)</i> The amount of time in seconds before the session id is updated while the app is in the background |
 |  [foregroundSessionTimeout?](./react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md) | number | <i>(Optional)</i> The amount of time in seconds before the session id is updated while the app is in the foreground |
+|  [sessionContext?](./react-native-tracker.sessionconfiguration.sessioncontext.md) | boolean | <i>(Optional)</i> Whether session context is attached to tracked events. |
 

api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionconfiguration.sessioncontext.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) &gt; [sessionContext](./react-native-tracker.sessionconfiguration.sessioncontext.md)
+
+## SessionConfiguration.sessionContext property
+
+Whether session context is attached to tracked events.
+
+<b>Signature:</b>
+
+```typescript
+sessionContext?: boolean;
+```

api-docs/docs/react-native-tracker/markdown/react-native-tracker.trackerconfiguration.deviceplatform.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) &gt; [devicePlatform](./react-native-tracker.trackerconfiguration.deviceplatform.md)
+
+## TrackerConfiguration.devicePlatform property
+
+The device platform the tracker runs on.
+
+<b>Signature:</b>
+
+```typescript
+devicePlatform?: Platform;
+```

api-docs/docs/react-native-tracker/markdown/react-native-tracker.trackerconfiguration.md

@@ -17,6 +17,7 @@ export interface TrackerConfiguration
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [appId?](./react-native-tracker.trackerconfiguration.appid.md) | string | <i>(Optional)</i> The application ID |
+|  [devicePlatform?](./react-native-tracker.trackerconfiguration.deviceplatform.md) | Platform | <i>(Optional)</i> The device platform the tracker runs on. |
 |  [encodeBase64?](./react-native-tracker.trackerconfiguration.encodebase64.md) | boolean | <i>(Optional)</i> Whether unstructured events and custom contexts should be base64 encoded. |
 |  [namespace](./react-native-tracker.trackerconfiguration.namespace.md) | string | The namespace of the tracker |
 |  [plugins?](./react-native-tracker.trackerconfiguration.plugins.md) | BrowserPlugin\[\] | <i>(Optional)</i> Inject plugins which will be evaluated for each event |

api-docs/docs/react-native-tracker/react-native-tracker.api.md

@@ -6,6 +6,7 @@
 
 import { BrowserPlugin } from '@snowplow/browser-tracker-core';
 import { BrowserPluginConfiguration } from '@snowplow/browser-tracker-core';
+import { Platform } from '@snowplow/browser-tracker-core';
 import { ScreenTrackingConfiguration } from '@snowplow/browser-plugin-screen-tracking';
 
 // @public
@@ -464,6 +465,7 @@ export type SelfDescribing<T = Record<string, unknown>> = SelfDescribingJson<T>;
 export interface SessionConfiguration {
     backgroundSessionTimeout?: number;
     foregroundSessionTimeout?: number;
+    sessionContext?: boolean;
 }
 
 // @public
@@ -511,6 +513,7 @@ export type TimingProps = {
 // @public
 export interface TrackerConfiguration {
     appId?: string;
+    devicePlatform?: Platform;
     encodeBase64?: boolean;
     namespace: string;
     plugins?: BrowserPlugin[];

trackers/react-native-tracker/src/plugins/session/index.ts

@@ -54,6 +54,7 @@ async function resumeStoredSession(namespace: string): Promise<SessionState> {
  */
 export async function newSessionPlugin({
   namespace,
+  sessionContext = true,
   foregroundSessionTimeout,
   backgroundSessionTimeout,
 }: TrackerConfiguration & SessionConfiguration): Promise<SessionPlugin> {
@@ -105,10 +106,12 @@ export async function newSessionPlugin({
     }
 
     // add session context to the payload
-    payloadBuilder.addContextEntity({
-      schema: CLIENT_SESSION_ENTITY_SCHEMA,
-      data: { ...sessionState },
-    });
+    if (sessionContext) {
+      payloadBuilder.addContextEntity({
+        schema: CLIENT_SESSION_ENTITY_SCHEMA,
+        data: { ...sessionState },
+      });
+    }
   };
 
   return {

trackers/react-native-tracker/src/tracker.ts

@@ -64,7 +64,7 @@ export async function newTracker(
 
   const core = trackerCore({ base64: encodeBase64, callback });
 
-  core.setPlatform('mob'); // default platform
+  core.setPlatform(configuration.devicePlatform ?? 'mob');
   core.setTrackerVersion('rn-' + version);
   core.setTrackerNamespace(namespace);
   if (appId) {

trackers/react-native-tracker/src/types.ts

@@ -1,4 +1,4 @@
-import { BrowserPlugin, BrowserPluginConfiguration } from '@snowplow/browser-tracker-core';
+import { BrowserPlugin, BrowserPluginConfiguration, Platform } from '@snowplow/browser-tracker-core';
 import {
   ConditionalContextProvider,
   ContextPrimitive,
@@ -40,6 +40,11 @@ export interface SessionConfiguration {
    * @defaultValue 1800
    */
   backgroundSessionTimeout?: number;
+  /**
+   * Whether session context is attached to tracked events.
+   * @defaultValue true
+   */
+  sessionContext?: boolean;
 }
 
 /**
@@ -53,15 +58,15 @@ export interface AppLifecycleConfiguration {
    * Foreground event schema: `iglu:com.snowplowanalytics.snowplow/application_foreground/jsonschema/1-0-0`
    * Background event schema: `iglu:com.snowplowanalytics.snowplow/application_background/jsonschema/1-0-0`
    * Context entity schema: `iglu:com.snowplowanalytics.mobile/application_lifecycle/jsonschema/1-0-0`
-   * 
+   *
    * @defaultValue true
    */
   lifecycleAutotracking?: boolean;
   /**
    * Whether to automatically track app install event on first run.
    *
    * Schema: `iglu:com.snowplowanalytics.mobile/application_install/jsonschema/1-0-0`
-   * 
+   *
    * @defaultValue false
    */
   installAutotracking?: boolean;
@@ -98,6 +103,11 @@ export interface TrackerConfiguration {
    * @defaultValue []
    */
   plugins?: BrowserPlugin[];
+  /**
+   * The device platform the tracker runs on.
+   * @defaultValue 'mob'
+   */
+  devicePlatform?: Platform;
 }
 
 export enum PlatformContextProperty {