@jmartins-tillster/analytics-react-native 2.21.3

package/packages/plugins/plugin-device-token/src/methods/___tests__/DeviceTokenPlugin.test.ts

@@ -0,0 +1,94 @@
+import { SegmentClient } from '@segment/analytics-react-native';
+import {
+  getMockLogger,
+  MockSegmentStore,
+} from '@segment/analytics-react-native/src/test-helpers';
+import { Platform } from 'react-native';
+
+import { DeviceTokenPlugin } from '../../DeviceTokenPlugin';
+
+const mockRequestPermission = jest.fn().mockReturnValue(1);
+const mockGetAPNSToken = jest.fn().mockReturnValue('device-token');
+const mockGetDeviceToken = jest.fn().mockReturnValue('device-token');
+
+jest.mock('@react-native-firebase/messaging', () => () => ({
+  getAPNSToken: mockGetAPNSToken,
+  getToken: mockGetDeviceToken,
+  hasPermission: mockRequestPermission,
+}));
+
+jest.mock('react-native/Libraries/Utilities/Platform', () => ({
+  OS: 'ios',
+  select: () => null,
+}));
+
+describe('DeviceTokenPlugin', () => {
+  const store = new MockSegmentStore();
+  const clientArgs = {
+    logger: getMockLogger(),
+    config: {
+      writeKey: '123-456',
+      trackApplicationLifecycleEvents: true,
+      flushInterval: 0,
+    },
+    store,
+  };
+  let plugin: DeviceTokenPlugin = new DeviceTokenPlugin();
+
+  beforeEach(() => {
+    store.reset();
+    jest.clearAllMocks();
+    plugin = new DeviceTokenPlugin();
+  });
+
+  it('requests authorization when configure is called', async () => {
+    const analytics = new SegmentClient(clientArgs);
+
+    await plugin.configure(analytics);
+
+    expect(mockRequestPermission).toHaveBeenCalled();
+  });
+
+  it('retrieves the APNS value if authorized and OS is iOS', async () => {
+    Platform.OS = 'ios';
+    const analytics = new SegmentClient(clientArgs);
+    await plugin.configure(analytics);
+
+    expect(mockRequestPermission).toHaveReturnedWith(1);
+    expect(mockGetAPNSToken).toHaveBeenCalled();
+  });
+
+  it('retrieves the device token for Android builds', async () => {
+    Platform.OS = 'android';
+    const analytics = new SegmentClient(clientArgs);
+
+    await plugin.configure(analytics);
+
+    expect(mockGetDeviceToken).toHaveBeenCalled();
+  });
+
+  it('retrieves the device token when updatePermissions is called', async () => {
+    Platform.OS = 'ios';
+
+    await plugin.updatePermissionStatus();
+
+    expect(mockGetAPNSToken).toHaveBeenCalled();
+  });
+
+  it('sets the device token in context for iOS', async () => {
+    const analytics = new SegmentClient(clientArgs);
+    await plugin.configure(analytics);
+
+    const token = await store.context.get(true);
+    expect(token).toEqual({ device: { token: 'device-token' } });
+  });
+
+  it('sets the device token in context for Android', async () => {
+    Platform.OS = 'android';
+    const analytics = new SegmentClient(clientArgs);
+    await plugin.configure(analytics);
+
+    const token = await store.context.get(true);
+    expect(token).toEqual({ device: { token: 'device-token' } });
+  });
+});

package/packages/plugins/plugin-device-token/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "lib/typescript",
+    "rootDir": ".",
+    "baseUrl": "."
+  },
+  "include": ["src/**/*", "types.d.ts"],
+  "references": [{ "path": "../../core" }]
+}

package/packages/plugins/plugin-facebook-app-events/CHANGELOG.md

@@ -0,0 +1,78 @@
+### Dependencies
+
+* **@segment/analytics-react-native:** upgraded to 2.20.0
+
+### Dependencies
+
+* **@segment/analytics-react-native:** upgraded to 2.18.0
+* **@segment/sovran-react-native:** upgraded to 1.1.0
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.5.4](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.5.3...@segment/analytics-react-native-plugin-facebook-app-events-v0.5.4) (2023-09-14)
+
+
+### Bug Fixes
+
+* switch FBSDK logTime to number ([#878](https://github.com/segmentio/analytics-react-native/issues/878)) ([2ed6d34](https://github.com/segmentio/analytics-react-native/commit/2ed6d34c46063330c6573774906cae5afc9d5e06))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.5.3](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.5.2...@segment/analytics-react-native-plugin-facebook-app-events-v0.5.3) (2023-08-21)
+
+
+### Bug Fixes
+
+* package dependency fixes ([#869](https://github.com/segmentio/analytics-react-native/issues/869)) ([08d415e](https://github.com/segmentio/analytics-react-native/commit/08d415e3b1cfd8499f5f6984f2859a30a851da12))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.5.2](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.5.1...@segment/analytics-react-native-plugin-facebook-app-events-v0.5.2) (2023-04-18)
+
+
+### Bug Fixes
+
+* stricter linting, improved handling of plugin errrors ([#795](https://github.com/segmentio/analytics-react-native/issues/795)) ([1ddb4d5](https://github.com/segmentio/analytics-react-native/commit/1ddb4d571df794bc7eaa5c5302ed27b90faf9a73)), closes [#799](https://github.com/segmentio/analytics-react-native/issues/799) [#803](https://github.com/segmentio/analytics-react-native/issues/803) [#802](https://github.com/segmentio/analytics-react-native/issues/802)
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.5.1](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.5.0...@segment/analytics-react-native-plugin-facebook-app-events-v0.5.1) (2023-03-14)
+
+
+### Bug Fixes
+
+* async-storage as optional peer dependency ([#779](https://github.com/segmentio/analytics-react-native/issues/779)) ([f3d5bc0](https://github.com/segmentio/analytics-react-native/commit/f3d5bc024fe3ae988386aac8b9f6f3fc6d84677a))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.5.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.4.1...@segment/analytics-react-native-plugin-facebook-app-events-v0.5.0) (2022-11-30)
+
+
+### Features
+
+* added errorHandler option to client ([#713](https://github.com/segmentio/analytics-react-native/issues/713)) ([b95788b](https://github.com/segmentio/analytics-react-native/commit/b95788ba8ecb547ffc9f43ba94f628c25f3660d1))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.4.1](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.4.0...@segment/analytics-react-native-plugin-facebook-app-events-v0.4.1) (2022-09-13)
+
+
+### Bug Fixes
+
+* apply facebook mapping and settings ([#663](https://github.com/segmentio/analytics-react-native/issues/663)) ([c3434f0](https://github.com/segmentio/analytics-react-native/commit/c3434f0b9347375b1aad6d4a755f75aaaf57d471))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.4.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.3.1...@segment/analytics-react-native-plugin-facebook-app-events-v0.4.0) (2022-08-10)
+
+
+### Features
+
+* prepare facebook app events  for release ([#636](https://github.com/segmentio/analytics-react-native/issues/636)) ([ed43310](https://github.com/segmentio/analytics-react-native/commit/ed433101267ab26140b13c2362f63130920690fc))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.3.1](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.3.0...@segment/analytics-react-native-plugin-facebook-app-events-v0.3.1) (2022-07-28)
+
+
+### Bug Fixes
+
+* replace allSettled shim, fix imports from plugins ([#620](https://github.com/segmentio/analytics-react-native/issues/620)) ([18f8ecd](https://github.com/segmentio/analytics-react-native/commit/18f8ecdb291d8c5ecb02e087aa0043df4fc72e97))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.3.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.2.3...@segment/analytics-react-native-plugin-facebook-app-events-v0.3.0) (2022-07-15)
+
+
+### Features
+
+* spin off the queue handling into a reusable plugin ([#502](https://github.com/segmentio/analytics-react-native/issues/502)) ([55d7988](https://github.com/segmentio/analytics-react-native/commit/55d798821163d5a41902a6bc099b1bfcbd853a17))
+
+## [@segment/analytics-react-native-plugin-facebook-app-events-v0.2.3](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-facebook-app-events-v0.2.2...@segment/analytics-react-native-plugin-facebook-app-events-v0.2.3) (2022-06-24)
+
+
+### Bug Fixes
+
+* map correct facebook events ([#579](https://github.com/segmentio/analytics-react-native/issues/579)) ([e700ca8](https://github.com/segmentio/analytics-react-native/commit/e700ca823e71e0087cb51cfc67857b8982fbf582))

package/packages/plugins/plugin-facebook-app-events/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Segment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/packages/plugins/plugin-facebook-app-events/README.md

@@ -0,0 +1,73 @@
+# @segment/analytics-react-native-plugin-facebook-app-events
+
+`DestinationPlugin` for [Facebook App Events](https://developers.facebook.com/docs/app-events/). Wraps [`react-native-fbsdk-next`](https://www.npmjs.com/package/react-native-fbsdk-next).
+
+## Installation
+
+You need to install the `@segment/analytics-react-native-plugin-facebook-app-events` and the `react-native-fbsdk-next` dependency.
+
+Using NPM:
+```bash
+npm install --save @segment/analytics-react-native-plugin-facebook-app-events react-native-fbsdk-next
+```
+
+Using Yarn:
+```bash
+yarn add @segment/analytics-react-native-plugin-facebook-app-events react-native-fbsdk-next
+```
+
+Run `pod install` after the installation to autolink the Facebook SDK.
+
+Follow the instructions in [Configure projects](https://github.com/thebergamo/react-native-fbsdk-next#3-configure-projects) of React-Native-fbsdk-next to finish the setup of FBSDK.
+
+See [React Native FBSDK Next](https://github.com/thebergamo/react-native-fbsdk-next) for more details of this dependency. The plugin automatically calls the `Settings.initializeSDK();` method, so you do not need to explictly add that code to your app. Adding the method again may result in an error.
+## Usage
+
+Follow the [instructions for adding plugins](https://github.com/segmentio/analytics-react-native#adding-plugins) on the main Analytics client:
+
+In your code where you initialize the analytics client call the `.add(plugin)` method with an `FacebookAppEventsPlugin` instance:
+
+```ts
+import { createClient } from '@segment/analytics-react-native';
+
+import { FacebookAppEventsPlugin } from '@segment/analytics-react-native-plugin-facebook-app-events';
+
+const segmentClient = createClient({
+  writeKey: 'SEGMENT_KEY'
+});
+
+segmentClient.add({ plugin: new FacebookAppEventsPlugin() });
+```
+
+## Support
+
+Please use Github issues, Pull Requests, or feel free to reach out to our [support team](https://segment.com/help/).
+
+## Integrating with Segment
+
+Interested in integrating your service with us? Check out our [Partners page](https://segment.com/partners/) for more details.
+
+## License
+```
+MIT License
+
+Copyright (c) 2021 Segment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

package/packages/plugins/plugin-facebook-app-events/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: ['module:metro-react-native-babel-preset'],
+};

package/packages/plugins/plugin-facebook-app-events/jest.config.js

@@ -0,0 +1,5 @@
+const baseConfig = require('@segment/analytics-rn-shared/jest.config.base');
+
+module.exports = {
+  ...baseConfig,
+};

package/packages/plugins/plugin-facebook-app-events/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@segment/analytics-react-native-plugin-facebook-app-events",
+  "version": "0.7.0",
+  "description": "The hassle-free way to add Segment analytics to your React-Native app.",
+  "main": "lib/commonjs/index",
+  "scripts": {
+    "build": "bob build",
+    "test": "jest",
+    "typescript": "tsc --noEmit",
+    "clean": "rimraf lib node_modules"
+  },
+  "keywords": [
+    "segment",
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "module": "lib/module/index",
+  "types": "lib/typescript/src/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "segment-analytics-react-native.podspec",
+    "package.json",
+    "!src/**/*.e2e.mock.js",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/segmentio/analytics-react-native.git",
+    "directory": "packages/core"
+  },
+  "author": "Segment <hello@segment.com> (https://segment.com/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/segmentio/analytics-react-native/issues"
+  },
+  "homepage": "https://github.com/segmentio/analytics-react-native/tree/master/packages/plugins/plugin-facebook-app-events#readme",
+  "peerDependencies": {
+    "@segment/analytics-react-native": "^2.18.0",
+    "react-native-fbsdk-next": "^12"
+  },
+  "devDependencies": {
+    "@segment/analytics-react-native": "^2.18.0",
+    "@segment/analytics-rn-shared": "workspace:^",
+    "@segment/sovran-react-native": "^1.1.0",
+    "jest": "^29.7.0",
+    "react-native-builder-bob": "^0.23.1",
+    "react-native-fbsdk-next": "^12",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.2.2"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      "typescript"
+    ]
+  },
+  "engines": {
+    "node": ">=12"
+  }
+}

package/packages/plugins/plugin-facebook-app-events/release.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['../../../release.config.js'],
+};

package/packages/plugins/plugin-facebook-app-events/src/FacebookAppEventsPlugin.ts

@@ -0,0 +1,192 @@
+import {
+  Context,
+  DestinationPlugin,
+  ErrorType,
+  generateMapTransform,
+  IntegrationSettings,
+  isNumber,
+  isObject,
+  PluginType,
+  ScreenEventType,
+  SegmentAPISettings,
+  SegmentClient,
+  SegmentError,
+  TrackEventType,
+  unknownToString,
+  UpdateType,
+} from '@segment/analytics-react-native';
+import { AppEventsLogger, Settings } from 'react-native-fbsdk-next';
+
+import screen from './methods/screen';
+import { mapEventProps, transformMap } from './parameterMapping';
+import { sanitizeValue } from './utils';
+
+const FB_PLUGIN_KEY = 'Facebook App Events';
+// FB Event Names must be <= 40 characters
+const MAX_CHARACTERS_EVENT_NAME = 40;
+const mappedPropNames = generateMapTransform(mapEventProps, transformMap);
+
+interface FBPluginSettings extends Record<string, unknown> {
+  trackScreenEvent?: boolean;
+  limitedDataUse?: boolean;
+  appEvents?: { [key: string]: string };
+}
+
+const isFBPluginSettings = (
+  settings: IntegrationSettings
+): settings is FBPluginSettings => {
+  return (
+    typeof settings === 'object' &&
+    Object.keys(settings).some(
+      (k) =>
+        k === 'trackScreenEvents' || k === 'appEvents' || k === 'limitedDataUse'
+    )
+  );
+};
+
+const sanitizeEvent = (
+  event: Record<string, unknown>
+): { [key: string]: string | number } => {
+  const properties = event.properties;
+  if (!isObject(properties)) {
+    return {};
+  }
+
+  const products = Array.isArray(properties.products)
+    ? properties.products
+    : [];
+  const productCount = isNumber(properties.fb_num_items)
+    ? properties.fb_num_items
+    : products.length;
+  const params: { [key: string]: string | number } = {};
+
+  for (const key of Object.keys(properties)) {
+    if (Object.values(mapEventProps).includes(key)) {
+      const sanitized = sanitizeValue(properties[key]);
+      if (sanitized !== undefined) {
+        params[key] = sanitized;
+      }
+    }
+  }
+
+  if (isNumber(event._logTime)) {
+    params._logTime = event._logTime;
+  }
+
+  // Map messageId to event_id to support FB deduplication
+  // https://developers.facebook.com/docs/marketing-api/conversions-api/deduplicate-pixel-and-server-events#event-deduplication-options
+  const messageId = unknownToString(event.messageId);
+  if (messageId !== null && messageId !== undefined && messageId !== '') {
+    params.event_id = messageId;
+  }
+
+  return {
+    ...params,
+    fb_num_items: productCount,
+    _appVersion: (event.context as Context).app.version,
+  };
+};
+
+export class FacebookAppEventsPlugin extends DestinationPlugin {
+  type = PluginType.destination;
+  key = FB_PLUGIN_KEY;
+  trackScreens = false;
+  limitedDataUse = false;
+  /**
+   * Mappings for event names from Segment Settings
+   */
+  appEvents: { [key: string]: string } = {};
+
+  async configure(analytics: SegmentClient) {
+    this.analytics = analytics;
+    const adTrackingEnabled = this.analytics?.adTrackingEnabled.get();
+
+    this.analytics.adTrackingEnabled.onChange((value) => {
+      void (async () => {
+        try {
+          await Settings.setAdvertiserTrackingEnabled(value);
+        } catch (error) {
+          this.analytics?.reportInternalError(
+            new SegmentError(
+              ErrorType.PluginError,
+              'Facebook failed to set AdvertiserTrackingEnabled',
+              error
+            )
+          );
+        }
+      })();
+    });
+
+    //you will likely need consent first
+    //this example assumes consentManager plugin is used
+    Settings.initializeSDK();
+
+    if (adTrackingEnabled) {
+      try {
+        await Settings.setAdvertiserTrackingEnabled(true);
+      } catch (e) {
+        //handle error
+        this.analytics?.reportInternalError(
+          new SegmentError(ErrorType.PluginError, JSON.stringify(e), e)
+        );
+        this.analytics?.logger.warn('Add Tracking Enabled Error', e);
+      }
+    }
+
+    //default facebook data processing options
+    Settings.setDataProcessingOptions([], 0, 0);
+  }
+
+  update(settings: SegmentAPISettings, _: UpdateType) {
+    const fbSettings = settings.integrations[this.key];
+
+    if (isFBPluginSettings(fbSettings)) {
+      this.trackScreens = fbSettings.trackScreenEvent ?? false;
+      this.limitedDataUse = fbSettings.limitedDataUse ?? false;
+      this.appEvents = fbSettings.appEvents ?? {};
+
+      if (this.limitedDataUse) {
+        // Enable LDU
+        Settings.setDataProcessingOptions(['LDU']);
+      }
+    }
+  }
+
+  track(event: TrackEventType) {
+    const safeEvent = mappedPropNames(
+      event as unknown as Record<string, unknown>
+    );
+    const convertedName = safeEvent.event as string;
+    const safeName = this.sanitizeEventName(convertedName);
+    const safeProps = sanitizeEvent(safeEvent);
+    const currency = (safeProps.fb_currency as string | undefined) ?? 'USD';
+
+    if (
+      safeProps._valueToSum !== undefined &&
+      safeName === 'fb_mobile_purchase'
+    ) {
+      const purchasePrice = safeProps._valueToSum as number;
+
+      AppEventsLogger.logPurchase(purchasePrice, currency, safeProps);
+    } else if (typeof safeProps._valueToSum === 'number') {
+      AppEventsLogger.logEvent(safeName, safeProps._valueToSum, safeProps);
+    } else {
+      AppEventsLogger.logEvent(safeName, safeProps);
+    }
+    return event;
+  }
+
+  screen(event: ScreenEventType) {
+    if (this.trackScreens === true) {
+      screen(event);
+    }
+    return event;
+  }
+
+  private sanitizeEventName(name: string) {
+    //Facebook expects '_' instead of '.'
+    const fbName = this.appEvents[name] ?? name;
+    const sanitizedName = fbName.replace('.', '_');
+    return sanitizedName.substring(0, MAX_CHARACTERS_EVENT_NAME);
+  }
+}