Merge pull request #3 from Scode-Njnjas/feature/implement-test-case-and-fix-issue-initialize-twice-in-example-app

feat: implement test case and fix issue: initialize twice in the example app

Author: MinhOmega

README.md

@@ -54,33 +54,34 @@ const AppContent = () => {
 
 ### `RNConvertInSDKProvider`
 
-| Prop | Type | Required |
-|------|------|----------|
-| `pixelId` | string | Yes |
-| `storeUrl` | string | Yes |
+| Prop       | Type   | Required | Description               |
+| ---------- | ------ | -------- | ------------------------- |
+| `pixelId`  | string | Yes      | Your ConvertedIn pixel ID |
+| `storeUrl` | string | Yes      | Your store URL            |
 
 ### `useConvertedIn`
 
 Returns an object with the following methods:
 
-| Method | Parameters | Return Type |
-|--------|------------|-------------|
-| `initializeSDK` | None | `Promise<void>` |
-| `identifyUser` | `email: string, countryCode: string, phone: string` | `void` |
-| `addEvent` | `name: string, currency: string, total: number, products: Product[]` | `void` |
-| `viewContentEvent` | `currency: string, total: number, products: Product[]` | `void` |
-| `addToCartEvent` | `currency: string, total: number, products: Product[]` | `void` |
-| `initiateCheckoutEvent` | `currency: string, total: number, products: Product[]` | `void` |
-| `purchaseEvent` | `currency: string, total: number, products: Product[]` | `void` |
-| `registerEvent` | None | `void` |
+| Method                  | Parameters                                                                | Return Type     | Description                                                                                                                                         |
+| ----------------------- | ------------------------------------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `isInitialized`         | None                                                                      | `boolean`       | Returns whether the SDK has been initialized.                                                                                                       |
+| `initializeSDK`         | `config: { pixelId: string, storeUrl: string }`                           | `Promise<void>` | Initializes the SDK with the provided configuration. Call this as early as possible in your app's lifecycle.                                        |
+| `identifyUser`          | `email: string, countryCode: string, phoneNumber: string`                 | `void`          | Identifies a user with their email, country code, and phone number. This helps in tracking user-specific events and improving personalization.      |
+| `addEvent`              | `eventName: string, currency: string, total: number, products: Product[]` | `void`          | Adds a custom event with the specified name, currency, total, and products. This allows tracking of specific actions or milestones in your app.     |
+| `viewContentEvent`      | `currency: string, total: number, products: Product[]`                    | `void`          | Tracks a view content event when a user views a product or content page. Includes details like currency, total value, and viewed products.          |
+| `addToCartEvent`        | `currency: string, total: number, products: Product[]`                    | `void`          | Tracks an add to cart event when a user adds items to their shopping cart. Includes details about the added products, total value, and currency.    |
+| `initiateCheckoutEvent` | `currency: string, total: number, products: Product[]`                    | `void`          | Tracks the initiation of the checkout process. This event should be called when a user starts the purchasing process.                               |
+| `purchaseEvent`         | `currency: string, total: number, products: Product[]`                    | `void`          | Tracks a completed purchase event. This should be called when a user successfully completes a transaction, including details of purchased products. |
+| `registerEvent`         | None                                                                      | `void`          | Tracks a user registration event. This should be called when a new user creates an account in your app.                                             |
 
 ### `Product` Interface
 
-| Property | Type |
-|----------|------|
-| `id` | number |
-| `quantity` | number |
-| `name` | string |
+| Property   | Type   | Description                           |
+| ---------- | ------ | ------------------------------------- |
+| `id`       | number | The unique identifier of the product. |
+| `quantity` | number | The quantity of the product.          |
+| `name`     | string | The name of the product.              |
 
 ## Example
 
@@ -127,6 +128,16 @@ Run tests with:
 yarn test
 ```
 
+### Error Handling
+
+If any SDK method is called before initialization, an error will be thrown with the message:
+
+```txt
+SDK must be initialized before calling this method.
+```
+
+Make sure to initialize the SDK using the `initializeSDK` method before invoking any other SDK methods.
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

example/ios/ConvertedInSdkExample.xcodeproj/project.pbxproj

@@ -593,7 +593,10 @@
 					"-DFOLLY_CFG_NO_COROUTINES=1",
 					"-DFOLLY_HAVE_CLOCK_GETTIME=1",
 				);
-				OTHER_LDFLAGS = "$(inherited)  ";
+				OTHER_LDFLAGS = (
+					"$(inherited)",
+					" ",
+				);
 				REACT_NATIVE_PATH = "${PODS_ROOT}/../../node_modules/react-native";
 				SDKROOT = iphoneos;
 				SWIFT_ACTIVE_COMPILATION_CONDITIONS = "$(inherited) DEBUG";
@@ -666,7 +669,10 @@
 					"-DFOLLY_CFG_NO_COROUTINES=1",
 					"-DFOLLY_HAVE_CLOCK_GETTIME=1",
 				);
-				OTHER_LDFLAGS = "$(inherited)  ";
+				OTHER_LDFLAGS = (
+					"$(inherited)",
+					" ",
+				);
 				REACT_NATIVE_PATH = "${PODS_ROOT}/../../node_modules/react-native";
 				SDKROOT = iphoneos;
 				USE_HERMES = true;

example/src/App.tsx

@@ -1,4 +1,3 @@
-import { useEffect, useState } from 'react';
 import { ActivityIndicator, StyleSheet, View } from 'react-native';
 import {
   RNConvertInSDKProvider,
@@ -9,35 +8,11 @@ import CustomEventOpenApp from './components/custom-event-open-app';
 import IdentifyUser from './components/identify-user';
 import InitiateCheckoutEvent from './components/initiate-checkout';
 import PurchaseEvent from './components/purchase';
-import ViewContent from './components/view-content';
 import Register from './components/register';
+import ViewContent from './components/view-content';
 
-const AppContent = () => {
-  const [isInitialized, setIsInitialized] = useState(false);
-  const { initializeSDK } = useConvertedIn();
-
-  useEffect(() => {
-    let isMounted = true;
-
-    const initialize = async () => {
-      if (!isInitialized) {
-        try {
-          await initializeSDK();
-          if (isMounted) {
-            setIsInitialized(true);
-          }
-        } catch (error) {
-          console.error('Failed to initialize SDK:', error);
-        }
-      }
-    };
-
-    initialize();
-
-    return () => {
-      isMounted = false;
-    };
-  }, [initializeSDK, isInitialized]);
+const AppContent: React.FC = () => {
+  const { isInitialized } = useConvertedIn();
 
   if (!isInitialized) {
     return <ActivityIndicator size="large" />;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-converted-in-sdk",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Converted In SDK for React Native",
   "source": "src/index.ts",
   "main": "lib/commonjs/index.js",
@@ -43,7 +43,15 @@
   "keywords": [
     "react-native",
     "ios",
-    "android"
+    "android",
+    "converted-in",
+    "sdk",
+    "tracking",
+    "events",
+    "react-native-converted-in-sdk",
+    "com.github.convertedin",
+    "android-pixel-sdk",
+    "iOS_ConvertedinMobileSDK"
   ],
   "repository": {
     "type": "git",
@@ -63,8 +71,11 @@
     "@evilmartians/lefthook": "^1.5.0",
     "@react-native/eslint-config": "^0.73.1",
     "@release-it/conventional-changelog": "^5.0.0",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@testing-library/react-native": "^12.6.1",
     "@types/jest": "^29.5.5",
     "@types/react": "^18.2.44",
+    "@types/testing-library__react-hooks": "^4.0.0",
     "commitlint": "^17.0.2",
     "del-cli": "^5.1.0",
     "eslint": "^8.51.0",
@@ -75,6 +86,7 @@
     "react": "18.3.1",
     "react-native": "0.75.2",
     "react-native-builder-bob": "^0.30.0",
+    "react-test-renderer": "^18.3.1",
     "release-it": "^15.0.0",
     "turbo": "^1.10.7",
     "typescript": "^5.2.2"

src/RNConvertedInSdkModule.ts

@@ -10,49 +10,60 @@ interface Product {
 
 let isInitialized = false;
 
-interface InitializeSDKParams {
+export const __test__ = {
+  resetInitialization: () => {
+    isInitialized = false;
+  },
+};
+
+interface SDKConfig {
   pixelId: string;
   storeUrl: string;
 }
 
-export const initializeSDK = async ({
-  pixelId,
-  storeUrl,
-}: InitializeSDKParams): Promise<void> => {
-  try {
-    await ConvertedInSDKModule.initializeSDK({ pixelId, storeUrl });
-    isInitialized = true;
-    console.log('SDK Initialized Successfully');
-  } catch (error: any) {
-    console.error('Failed to initialize SDK:', error);
-    throw error;
-  }
-};
-
 const checkInitialization = () => {
   if (!isInitialized) {
     throw new Error('SDK must be initialized before calling this method.');
   }
 };
 
-export const identifyUser = (
+export async function initializeSDK(config: SDKConfig): Promise<void> {
+  if (isInitialized) {
+    console.log('SDK already initialized');
+    return;
+  }
+  await NativeModules.ConvertedInSDKModule.initializeSDK(config);
+  console.log('SDK Initialized Successfully');
+  isInitialized = true;
+}
+
+export function identifyUser(
   email: string,
   countryCode: string,
-  phone: string
-) => {
+  phoneNumber: string
+): void {
   checkInitialization();
-  ConvertedInSDKModule.identifyUser(email, countryCode, phone);
-};
+  NativeModules.ConvertedInSDKModule.identifyUser(
+    email,
+    countryCode,
+    phoneNumber
+  );
+}
 
-export const addEvent = (
-  name: string,
+export function addEvent(
+  eventName: string,
   currency: string,
   total: number,
   products: Product[]
-) => {
+): void {
   checkInitialization();
-  ConvertedInSDKModule.addEvent(name, currency, total, products);
-};
+  NativeModules.ConvertedInSDKModule.addEvent(
+    eventName,
+    currency,
+    total,
+    products
+  );
+}
 
 export const viewContentEvent = (
   currency: string,

src/__tests__/RNConvertedInSdkModule.test.ts

@@ -0,0 +1,64 @@
+import * as RNConvertedInSdkModule from '../RNConvertedInSdkModule';
+
+jest.mock('react-native', () => ({
+  NativeModules: {
+    ConvertedInSDKModule: {
+      initializeSDK: jest.fn(),
+      identifyUser: jest.fn(),
+      addEvent: jest.fn(),
+      viewContentEvent: jest.fn(),
+      addToCartEvent: jest.fn(),
+      initiateCheckoutEvent: jest.fn(),
+      purchaseEvent: jest.fn(),
+      registerEvent: jest.fn(),
+    },
+  },
+}));
+
+describe('RNConvertedInSdkModule', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+    RNConvertedInSdkModule.__test__.resetInitialization();
+  });
+
+  it('should throw an error when calling methods before initialization', () => {
+    expect(() =>
+      RNConvertedInSdkModule.identifyUser(
+        'test@example.com',
+        '+1',
+        '1234567890'
+      )
+    ).toThrow('SDK must be initialized before calling this method.');
+  });
+
+  it('should throw an error when calling identifyUser before initialization', () => {
+    expect(() =>
+      RNConvertedInSdkModule.identifyUser(
+        'test@example.com',
+        '+1',
+        '1234567890'
+      )
+    ).toThrow('SDK must be initialized before calling this method.');
+  });
+
+  it('should throw errors when calling other methods before initialization', () => {
+    expect(() =>
+      RNConvertedInSdkModule.addEvent('test_event', 'USD', 100, [])
+    ).toThrow('SDK must be initialized before calling this method.');
+    expect(() =>
+      RNConvertedInSdkModule.viewContentEvent('USD', 50, [])
+    ).toThrow('SDK must be initialized before calling this method.');
+    expect(() => RNConvertedInSdkModule.addToCartEvent('USD', 75, [])).toThrow(
+      'SDK must be initialized before calling this method.'
+    );
+    expect(() =>
+      RNConvertedInSdkModule.initiateCheckoutEvent('USD', 150, [])
+    ).toThrow('SDK must be initialized before calling this method.');
+    expect(() => RNConvertedInSdkModule.purchaseEvent('USD', 200, [])).toThrow(
+      'SDK must be initialized before calling this method.'
+    );
+    expect(() => RNConvertedInSdkModule.registerEvent()).toThrow(
+      'SDK must be initialized before calling this method.'
+    );
+  });
+});

src/__tests__/RNConvertedInSdkProvider.test.tsx

@@ -0,0 +1,40 @@
+// @ts-ignore
+import * as React from 'react';
+import { render } from '@testing-library/react-native';
+import { RNConvertInSDKProvider } from '../../src/context/RNConvertedInSdkProvider';
+import * as RNConvertedInSdkModule from '../../src/RNConvertedInSdkModule';
+
+jest.mock('../../src/RNConvertedInSdkModule', () => ({
+  initializeSDK: jest.fn(),
+}));
+
+describe('RNConvertInSDKProvider', () => {
+  it('should throw an error if pixelId or storeUrl is not provided', () => {
+    console.error = jest.fn(); // Suppress console.error for this test
+    expect(() =>
+      render(
+        <RNConvertInSDKProvider pixelId="" storeUrl="">
+          <></>
+        </RNConvertInSDKProvider>
+      )
+    ).toThrow(
+      'Both pixelId and storeUrl must be provided to initialize the SDK'
+    );
+  });
+
+  it('should initialize SDK on mount', () => {
+    render(
+      <RNConvertInSDKProvider
+        pixelId="test-pixel-id"
+        storeUrl="https://test-store.com"
+      >
+        <></>
+      </RNConvertInSDKProvider>
+    );
+
+    expect(RNConvertedInSdkModule.initializeSDK).toHaveBeenCalledWith({
+      pixelId: 'test-pixel-id',
+      storeUrl: 'https://test-store.com',
+    });
+  });
+});