@snowplow/react-native-tracker 1.3.0 → 2.0.0

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

@@ -0,0 +1,308 @@
+/*
+ * 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', () => {
+  it('tests compare with null, numbers, strings, booleans', () => {
+    // null
+    expect(Micro.compare(null, null)).toBe(true);
+    expect(Micro.compare(null, [])).toBe(false);
+    expect(Micro.compare('not null', null)).toBe(false);
+
+    // numbers
+    expect(Micro.compare(1, 1)).toBe(true);
+    expect(Micro.compare(2.3, 0)).toBe(false);
+
+    // strings
+    expect(Micro.compare('a', 'a')).toBe(true);
+    expect(Micro.compare('a', 'ab')).toBe(false);
+    expect(Micro.compare('', 'b')).toBe(false);
+
+    // booleans
+    expect(Micro.compare(false, false)).toBe(true);
+    expect(Micro.compare(true, false)).toBe(false);
+  });
+
+  it('tests compare with arrays', () => {
+    // arrays and nested arrays
+    expect(Micro.compare([], [])).toBe(true);
+
+    expect(Micro.compare([], [1, 2])).toBe(true);
+
+    expect(Micro.compare([1, 2], [])).toBe(false);
+
+    expect(Micro.compare([1, 2], [2])).toBe(false);
+
+    expect(Micro.compare([1, 2], [2, 1])).toBe(true);
+
+    expect(Micro.compare([1, 2, 3], [4, 2, 5, 3, 1, 6])).toBe(true);
+
+    expect(Micro.compare([1, [2, 3], 4], [5, 4, [3, 2, 0], 0, 1])).toBe(true);
+  });
+
+  it('tests compare with objects', () => {
+    expect(Micro.compare({}, {})).toBe(true);
+
+    expect(Micro.compare({}, {a: 1})).toBe(true);
+
+    expect(Micro.compare({a: 1}, {})).toBe(false);
+
+    expect(
+      Micro.compare(
+        {
+          a: 1,
+          b: 2,
+        },
+        {
+          a: 1,
+          b: 3,
+        },
+      ),
+    ).toBe(false);
+
+    expect(
+      Micro.compare(
+        {
+          a: 1,
+          b: 2,
+        },
+        {
+          b: 2,
+          c: 3,
+          a: 1,
+        },
+      ),
+    ).toBe(true);
+  });
+
+  it('tests compare with arrays of objects', () => {
+    // expected, actual
+    let exp, act;
+
+    exp = [
+      {
+        a: 1,
+        b: 2,
+      },
+      {
+        c: 3,
+      },
+    ];
+    act = [
+      {
+        c: 3,
+        e: 5,
+      },
+      {
+        b: 2,
+        a: 1,
+      },
+      {
+        d: 4,
+      },
+    ];
+    expect(Micro.compare(exp, act)).toBe(true);
+
+    exp = [
+      {
+        a: 1,
+        b: 2,
+      },
+      {
+        c: 3,
+      },
+    ];
+    act = [
+      {
+        c: 3,
+        e: 5,
+      },
+      {
+        b: 2,
+        a: 2,
+      },
+    ];
+    expect(Micro.compare(exp, act)).toBe(false);
+
+    exp = [
+      {
+        a: 1,
+      },
+      {
+        c: [
+          {
+            d: 4,
+            e: {
+              f: 6,
+              g: [1, 2],
+            },
+          },
+        ],
+      },
+    ];
+    act = [
+      {
+        z: 10,
+        c: [
+          {
+            e: {
+              g: [3, 2, 1],
+              f: 6,
+              i: 2,
+            },
+            d: 4,
+            h: 7,
+          },
+        ],
+      },
+      {
+        a: 1,
+      },
+    ];
+    expect(Micro.compare(exp, act)).toBe(true);
+  });
+
+  it('tests compare with nested objects', () => {
+    // expected, actual
+    let exp, act_1, act_2;
+
+    exp = {
+      a: {
+        b: {
+          c: [1, 2],
+          d: 'test',
+          e: 5,
+        },
+        f: 1,
+      },
+      aa: [
+        {},
+        {
+          bb: 1,
+          cc: {
+            dd: {
+              ee: {
+                ff: 0,
+              },
+            },
+          },
+        },
+        [
+          [0, 1],
+          {
+            aaa: 'bbb',
+            ccc: [
+              {
+                ddd: 3.14,
+              },
+            ],
+          },
+          0,
+        ],
+        true,
+      ],
+      last: 'thing',
+    };
+
+    // "innocent" diffs
+    act_1 = {
+      diff1: 0,
+      a: {
+        b: {
+          c: [1, 2],
+          diff2: 0,
+          d: 'test',
+          e: 5,
+        },
+        diff3: [0, 0, 0],
+        f: 1,
+      },
+      aa: [
+        {},
+        ['diff41', 'diff42'],
+        {
+          bb: 1,
+          cc: {
+            dd: {
+              ee: {
+                ff: 0,
+                diff6: 0,
+              },
+              diff7: {},
+            },
+          },
+          diff8: 0,
+        },
+        [
+          [0, 1],
+          ['diff9'],
+          {
+            aaa: 'bbb',
+            ccc: [
+              {
+                ddd: 3.14,
+              },
+            ],
+          },
+          0,
+        ],
+        true,
+      ],
+      last: 'thing',
+      diff0: 'last',
+    };
+
+    // pi
+    act_2 = {
+      a: {
+        b: {
+          c: [1, 2],
+          d: 'test',
+          e: 5,
+        },
+        f: 1,
+      },
+      aa: [
+        {},
+        {
+          bb: 1,
+          cc: {
+            dd: {
+              ee: {
+                ff: 0,
+              },
+            },
+          },
+        },
+        [
+          [0, 1],
+          {
+            aaa: 'bbb',
+            ccc: [
+              {
+                ddd: 3.1415, // only diff with exp
+              },
+            ],
+          },
+          0,
+        ],
+        true,
+      ],
+      last: 'thing',
+    };
+
+    expect(Micro.compare(exp, act_1)).toBe(true);
+    expect(Micro.compare(exp, act_2)).toBe(false);
+  });
+});

package/example/e2e/helpers/schemas.js

@@ -0,0 +1,62 @@
+/*
+ * 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';
+const screenView =
+  'iglu:com.snowplowanalytics.mobile/screen_view/jsonschema/1-0-0';
+const adImpression =
+  'iglu:com.snowplowanalytics.snowplow/ad_impression/jsonschema/1-0-0';
+const linkClick =
+  'iglu:com.snowplowanalytics.snowplow/link_click/jsonschema/1-0-1';
+const consentWithdrawn =
+  'iglu:com.snowplowanalytics.snowplow/consent_withdrawn/jsonschema/1-0-0';
+const consentGranted =
+  'iglu:com.snowplowanalytics.snowplow/consent_granted/jsonschema/1-0-0';
+const consentDoc =
+  'iglu:com.snowplowanalytics.snowplow/consent_document/jsonschema/1-0-0';
+const timing = 'iglu:com.snowplowanalytics.snowplow/timing/jsonschema/1-0-0';
+const deepLink =
+  'iglu:com.snowplowanalytics.mobile/deep_link_received/jsonschema/1-0-0';
+const messageNotification =
+  'iglu:com.snowplowanalytics.mobile/message_notification/jsonschema/1-0-0';
+
+// Context schemas
+const mobileApplicationContext =
+  'iglu:com.snowplowanalytics.mobile/application/jsonschema/1-0-0';
+const mobileContext =
+  'iglu:com.snowplowanalytics.snowplow/mobile_context/jsonschema/1-0-3';
+const mobileScreenContext =
+  'iglu:com.snowplowanalytics.mobile/screen/jsonschema/1-0-0';
+const clientSessionContext =
+  'iglu:com.snowplowanalytics.snowplow/client_session/jsonschema/1-0-2';
+const gdprContext = 'iglu:com.snowplowanalytics.snowplow/gdpr/jsonschema/1-0-0';
+
+module.exports = {
+  appInstall,
+  screenView,
+  adImpression,
+  linkClick,
+  consentWithdrawn,
+  consentGranted,
+  consentDoc,
+  timing,
+  mobileApplicationContext,
+  mobileContext,
+  mobileScreenContext,
+  clientSessionContext,
+  gdprContext,
+  deepLink,
+  messageNotification,
+};

package/example/e2e/jest.config.js

@@ -0,0 +1,16 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  maxWorkers: 1,
+  globalSetup: "detox/runners/jest/globalSetup",
+  globalTeardown: "detox/runners/jest/globalTeardown",
+  testEnvironment: "detox/runners/jest/testEnvironment",
+  setupFilesAfterEnv: ["./setup.js"],
+  testRunner: "jest-circus/runner",
+  testTimeout: 300000,
+  testRegex: "\\.e2e.detox\\.js$",
+  transform: {
+    "\\.tsx?$": "ts-jest"
+  },
+  reporters: ["detox/runners/jest/reporter"],
+  verbose: true
+};

package/example/e2e/setup.js

@@ -0,0 +1,4 @@
+beforeAll(async () => {
+  // https://github.com/wix/Detox/blob/master/docs/APIRef.DeviceObjectAPI.md
+  await device.launchApp({delete: true});
+});

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

@@ -0,0 +1,300 @@
+/*
+ * 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');
+
+test('no bad events', async () => {
+  await commands.assertNoBadEvents();
+});
+
+test('number of screen_view events', async () => {
+  await commands.eventsWithSchema(schemas.screenView, 9);
+});
+
+test('number of structured events', async () => {
+  await commands.eventsWithEventType('struct', 6);
+});
+
+test('number of page_view events', async () => {
+  await commands.eventsWithEventType('page_view', 4);
+});
+
+test('screen_view with adImpression context', async () => {
+  await commands.eventsWithProperties(
+    {
+      schema: schemas.screenView,
+      values: {
+        name: 'withContext and screenId',
+      },
+      contexts: [
+        {
+          schema: schemas.adImpression,
+          data: {
+            impressionId: 'test_imp_id',
+          },
+        },
+      ],
+    },
+    1
+  );
+});
+
+test('self-describing ad_impression event', async () => {
+  await commands.eventsWithProperties(
+    {
+      schema: schemas.linkClick,
+      values: {
+        targetUrl: 'test.test',
+      },
+      contexts: [
+        { schema: schemas.mobileApplicationContext },
+        { schema: schemas.mobileContext },
+        { schema: schemas.mobileScreenContext },
+        { schema: schemas.clientSessionContext },
+        { schema: schemas.gdprContext },
+      ],
+    },
+    1
+  );
+});
+
+test('consentWithdrawn event', async () => {
+  await commands.eventsWithProperties(
+    {
+      schema: schemas.consentWithdrawn,
+      values: {
+        all: true,
+      },
+      contexts: [
+        {
+          schema: schemas.consentDoc,
+          data: {
+            id: '0987',
+            version: '0.2.0',
+          },
+        },
+      ],
+    },
+    1
+  );
+});
+
+test('consentGranted event', async () => {
+  await commands.eventsWithProperties(
+    {
+      schema: schemas.consentGranted,
+      values: {
+        expiry: '2022-01-01T00:00:00Z',
+      },
+      contexts: [
+        {
+          schema: schemas.consentDoc,
+          data: {
+            id: '0123',
+            version: '0.1.0',
+          },
+        },
+      ],
+    },
+    1
+  );
+});
+
+test('timing event', async () => {
+  await commands.eventsWithProperties(
+    {
+      schema: schemas.timing,
+      values: {
+        variable: 'testTimingVariable',
+        category: 'testTimingCategory',
+        timing: 10,
+      },
+    },
+    1
+  );
+});
+
+test('transaction item event', async () => {
+  await commands.eventsWithProperties(
+    {
+      parameters: {
+        event: 'transaction_item',
+        ti_orderid: '0000',
+        ti_sku: '123',
+        ti_price: 5,
+        ti_quantity: 2,
+      },
+    },
+    1
+  );
+});
+
+test('ecommerce transaction event', async () => {
+  await commands.eventsWithProperties(
+    {
+      parameters: {
+        event: 'transaction',
+        tr_orderid: '0000',
+        tr_total: 10,
+      },
+    },
+    1
+  );
+});
+
+test('deep link event', async () => {
+  await commands.eventsWithProperties(
+    {
+      schema: schemas.deepLink,
+      values: {
+        url: 'https://deeplink.com',
+        referrer: 'http://refr.com',
+      },
+    },
+    1
+  );
+});
+
+test('message notification event', async () => {
+  await commands.eventsWithProperties(
+    {
+      schema: schemas.messageNotification,
+      values: {
+        title: 'title1',
+        body: 'body1',
+        trigger: 'push',
+        action: 'action1',
+        attachments: [
+          {
+            identifier: 'att_id1',
+            type: 'att_type1',
+            url: 'http://att.url.1',
+          },
+        ],
+        bodyLocArgs: ['bodyArg1', 'bodyArg2'],
+        bodyLocKey: 'bodyKey1',
+        category: 'category1',
+        contentAvailable: true,
+        group: 'group1',
+        icon: 'icon1',
+        notificationCount: 3,
+        notificationTimestamp: '2022-02-02T15:17:42.767Z',
+        sound: 'sound1',
+        subtitle: 'subtitle1',
+        tag: 'tag1',
+        threadIdentifier: 'threadIdentifier1',
+        titleLocArgs: ['titleArg1', 'titleArg2'],
+        titleLocKey: 'titleKey1',
+      },
+    },
+    1
+  );
+});
+
+test('common in all first tracker events', async () => {
+  await commands.eventsWithProperties(
+    {
+      parameters: {
+        app_id: 'DemoAppId',
+        platform: 'iot',
+        name_tracker: 'sp1',
+      },
+      header: 'test: works',
+      contexts: [
+        { schema: schemas.mobileApplicationContext },
+        { schema: schemas.mobileContext },
+        { schema: schemas.mobileScreenContext },
+        { schema: schemas.clientSessionContext },
+        {
+          schema: schemas.gdprContext,
+          data: {
+            basisForProcessing: 'consent',
+            documentDescription: 'test gdpr document',
+            documentId: 'docId',
+            documentVersion: '0.0.1',
+          },
+        },
+        {
+          schema: schemas.adImpression,
+          data: { impressionId: 'test_global_contexts_0' },
+        },
+        {
+          schema: schemas.adImpression,
+          data: { impressionId: 'test_global_contexts_1' },
+        },
+      ],
+    },
+    23
+  );
+});
+
+test('events after resetting the Subject', async () => {
+  await commands.eventsWithProperties(
+    {
+      parameters: {
+        user_id: 'nextTester',
+        dvce_screenwidth: 300,
+        dvce_screenheight: 300,
+        br_lang: 'es',
+        os_timezone: 'Europe/London',
+      },
+      schema: schemas.screenView,
+      values: {
+        name: 'afterSetSubjectTestSV',
+      },
+    },
+    1
+  );
+});
+
+test('second tracker events', async () => {
+  await commands.eventsWithProperties(
+    {
+      parameters: {
+        name_tracker: 'sp2',
+      },
+      contexts: [
+        { schema: schemas.mobileApplicationContext },
+        { schema: schemas.mobileContext },
+        { schema: schemas.mobileScreenContext },
+        { schema: schemas.clientSessionContext },
+      ],
+    },
+    2
+  );
+});
+
+test('anonymous tracker events', async () => {
+  await commands.eventsWithProperties(
+    {
+      parameters: {
+        name_tracker: 'sp_anon',
+        network_userid: '00000000-0000-0000-0000-000000000000',
+      },
+      event: {
+        contexts: {
+          data: [
+            {
+              schema: schemas.clientSessionContext,
+              data: {
+                userId: '00000000-0000-0000-0000-000000000000',
+              },
+            },
+          ],
+        },
+      },
+    },
+    2
+  );
+});

package/example/index.js

@@ -0,0 +1,5 @@
+import { AppRegistry } from 'react-native';
+import App from './src/App';
+import { name as appName } from './app.json';
+
+AppRegistry.registerComponent(appName, () => App);

package/example/ios/.xcode.env

@@ -0,0 +1,11 @@
+# This `.xcode.env` file is versioned and is used to source the environment
+# used when running script phases inside Xcode.
+# To customize your local environment, you can create an `.xcode.env.local`
+# file that is not versioned.
+
+# NODE_BINARY variable contains the PATH to the node executable.
+#
+# Customize the NODE_BINARY variable here.
+# For example, to use nvm with brew, add the following line
+# . "$(brew --prefix nvm)/nvm.sh" --no-use
+export NODE_BINARY=$(command -v node)