@jmartins-tillster/analytics-react-native 2.21.3

package/packages/plugins/plugin-advertising-id/src/AdvertisingIdPlugin.ts

@@ -0,0 +1,172 @@
+import {
+  Plugin,
+  PluginType,
+  SegmentClient,
+  getNativeModule,
+  ErrorType,
+  SegmentError,
+  SegmentEvent,
+  EventType,
+  TrackEventType,
+} from '@segment/analytics-react-native';
+
+import { Platform, NativeModule } from 'react-native';
+
+type AdvertisingIDNativeModule = NativeModule & {
+  getAdvertisingId: () => Promise<string>;
+  getIsLimitAdTrackingEnableStatus: () => Promise<boolean>;
+};
+
+export class AdvertisingIdPlugin extends Plugin {
+  type = PluginType.enrichment;
+  queuedEvents: SegmentEvent[] = [];
+  advertisingId: string | undefined | null = undefined;
+  isLimitAdTracking?: boolean = undefined;
+
+  configure(analytics: SegmentClient): void {
+    if (Platform.OS !== 'android') {
+      return;
+    }
+
+    this.analytics = analytics;
+    this.fetchAdvertisingInfo()
+      .then(() => {
+        // Additional logic after the advertising info is fetched
+        this.sendQueued();
+      })
+      .catch((error) => {
+        this.handleError(error);
+      });
+  }
+
+  async execute(event: SegmentEvent) {
+    // Exit early for non-Android platforms
+    if (Platform.OS !== 'android') {
+      return event;
+    }
+
+    // If advertisingId is not set, queue the event
+    if (this.advertisingId === undefined) {
+      this.queuedEvents.push(event);
+      return;
+    }
+
+    // Check current Limit Ad Tracking status
+    const currentLimitAdTrackingStatus =
+      await this.fetchLimitAdTrackingStatus();
+
+    // Initialize tracking status if undefined
+    if (this.isLimitAdTracking === undefined) {
+      this.isLimitAdTracking = currentLimitAdTrackingStatus;
+      return event;
+    }
+
+    // If tracking status has changed, refresh ad info and queue event
+    if (this.isLimitAdTracking !== currentLimitAdTrackingStatus) {
+      try {
+        await this.fetchAdvertisingInfo();
+        console.log(
+          'Advertising info fetched successfully when adTrackingStatus Changed.'
+        );
+      } catch (error) {
+        this.handleError(error);
+      }
+
+      this.queuedEvents.push(event);
+      this.isLimitAdTracking = currentLimitAdTrackingStatus;
+      this.sendQueued();
+      return;
+    }
+
+    // Default return
+    return event;
+  }
+
+  isTrackEvent(event: SegmentEvent): event is TrackEventType {
+    return event.type === EventType.TrackEvent;
+  }
+
+  private async fetchAdvertisingInfo(): Promise<void> {
+    const advertisingIdPromise = this.fetchAdvertisingId();
+    const limitAdTrackingStatusPromise = this.fetchLimitAdTrackingStatus();
+
+    try {
+      // eslint-disable-next-line prefer-const
+      let [id, status] = await Promise.all([
+        advertisingIdPromise,
+        limitAdTrackingStatusPromise,
+      ]);
+      // Handle null status (e.g., native failure) by assuming enabled if id null
+      if (id === null && status === null) {
+        status = true; // Assume enabled on failure
+      }
+
+      if (id === null) {
+        this.advertisingId = null; // CHANGED: Use null for unavailable, not undefined
+      } else {
+        this.advertisingId = id;
+      }
+
+      // NEW: Set isLimitAdTracking here to ensure initialization
+      this.isLimitAdTracking = status ?? true; // Default to true on null
+
+      await this.setContext(id ?? undefined, status ?? true); // CHANGED: Handle nulls safely
+    } catch (error) {
+      this.handleError(error);
+    }
+  }
+
+  async setContext(
+    id: string | undefined,
+    isLimitAdTrackingEnableStatus: boolean
+  ): Promise<void> {
+    try {
+      await this.analytics?.context.set({
+        device: {
+          advertisingId: id,
+          adTrackingEnabled: !isLimitAdTrackingEnableStatus,
+        },
+      });
+    } catch (error) {
+      const message = 'AdvertisingID failed to set context';
+      this.analytics?.reportInternalError(
+        new SegmentError(ErrorType.PluginError, message, error)
+      );
+      this.analytics?.logger.warn(`${message}: ${JSON.stringify(error)}`);
+    }
+  }
+
+  sendQueued() {
+    console.log('Sending queued events:', this.queuedEvents);
+    this.queuedEvents.forEach((event) => {
+      void this.analytics?.process(event);
+    });
+    this.queuedEvents = [];
+  }
+
+  private fetchAdvertisingId(): Promise<string | null> {
+    return (
+      getNativeModule(
+        'AnalyticsReactNativePluginAdvertisingId'
+      ) as AdvertisingIDNativeModule
+    )?.getAdvertisingId();
+  }
+
+  private fetchLimitAdTrackingStatus(): Promise<boolean> {
+    return (
+      getNativeModule(
+        'AnalyticsReactNativePluginAdvertisingId'
+      ) as AdvertisingIDNativeModule
+    )?.getIsLimitAdTrackingEnableStatus();
+  }
+
+  private handleError(error: unknown): void {
+    this.analytics?.reportInternalError(
+      new SegmentError(
+        ErrorType.PluginError,
+        'Error retrieving AdvertisingID',
+        error
+      )
+    );
+  }
+}

package/packages/plugins/plugin-advertising-id/src/index.ts

@@ -0,0 +1 @@
+export * from './AdvertisingIdPlugin';

package/packages/plugins/plugin-advertising-id/src/types.ts

@@ -0,0 +1,3 @@
+export interface AdvertisingIdData {
+  id?: string;
+}

package/packages/plugins/plugin-advertising-id/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-amplitudeSession/CHANGELOG.md

@@ -0,0 +1,46 @@
+### Dependencies
+
+* **@segment/analytics-react-native:** upgraded to 2.18.0
+* **@segment/sovran-react-native:** upgraded to 1.1.0
+
+## @segment/analytics-react-native-plugin-amplitude-session [0.4.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-amplitude-session-v0.3.3...@segment/analytics-react-native-plugin-amplitude-session-v0.4.0) (2023-12-15)
+
+
+### Features
+
+* RN 0.72 Upgrade ([03f13a1](https://github.com/segmentio/analytics-react-native/commit/03f13a19c79d8aaad726639de5f0327c748fed1f))
+
+
+
+### Dependencies
+
+* **@segment/analytics-react-native:** upgraded to 2.18.0
+* **@segment/sovran-react-native:** upgraded to 1.1.0
+
+## [@segment/analytics-react-native-plugin-amplitude-session-v0.3.3](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-amplitude-session-v0.3.2...@segment/analytics-react-native-plugin-amplitude-session-v0.3.3) (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-amplitude-session-v0.3.2](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-amplitude-session-v0.3.1...@segment/analytics-react-native-plugin-amplitude-session-v0.3.2) (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-amplitude-session-v0.3.1](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-amplitude-session-v0.3.0...@segment/analytics-react-native-plugin-amplitude-session-v0.3.1) (2022-07-27)
+
+
+### Bug Fixes
+
+* race condition when using state changing events ([#611](https://github.com/segmentio/analytics-react-native/issues/611)) ([40ede04](https://github.com/segmentio/analytics-react-native/commit/40ede04ce465eef03816185e5a1d3a58f1d8b8a9))
+
+## [@segment/analytics-react-native-plugin-amplitude-session-v0.3.0](https://github.com/segmentio/analytics-react-native/compare/@segment/analytics-react-native-plugin-amplitude-session-v0.2.1...@segment/analytics-react-native-plugin-amplitude-session-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))

package/packages/plugins/plugin-amplitudeSession/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-amplitudeSession/README.md

@@ -0,0 +1,66 @@
+# @segment/analytics-react-native-plugin-amplitude
+
+`DestinationPlugin` for [Amplitude](https://www.amplitude.com/) sessions. This plugin makes it possible to track session info and send it to Amplitude via a Cloud Mode conenction. 
+
+## Installation
+
+Using NPM:
+```bash
+npm install --save @segment/analytics-react-native-plugin-amplitude-session
+```
+
+Using Yarn:
+```bash
+yarn add @segment/analytics-react-native-plugin-amplitude-session
+```
+
+## 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 `AmplitudeSessionPlugin` instance:
+
+```ts
+import { createClient } from '@segment/analytics-react-native';
+
+import { AmplitudeSessionPlugin } from '@segment/analytics-react-native-plugin-amplitude-session';
+
+const segmentClient = createClient({
+  writeKey: 'SEGMENT_KEY'
+});
+
+segmentClient.add({ plugin: new AmplitudeSessionPlugin() });
+```
+
+## 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-amplitudeSession/babel.config.js

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

package/packages/plugins/plugin-amplitudeSession/jest.config.js

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

package/packages/plugins/plugin-amplitudeSession/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@segment/analytics-react-native-plugin-amplitude-session",
+  "version": "0.4.2",
+  "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",
+    "release": "semantic-release"
+  },
+  "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-amplitudeSession#readme",
+  "peerDependencies": {
+    "@segment/analytics-react-native": "^2.18.0"
+  },
+  "devDependencies": {
+    "@segment/analytics-react-native": "^2.21.4",
+    "@segment/analytics-rn-shared": "workspace:^",
+    "@segment/sovran-react-native": "^1.1.0",
+    "@types/jest": "^29.5.8",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      "typescript"
+    ]
+  },
+  "engines": {
+    "node": ">=12"
+  }
+}

package/packages/plugins/plugin-amplitudeSession/release.config.js

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