Merge pull request #4 from Scode-Njnjas/test/update-test-code-for-lib

test: update test code for lib and corrrecting step run example app in README

Author: MinhOmega

.gitignore

@@ -29,6 +29,7 @@ DerivedData
 *.xcuserstate
 project.xcworkspace
 example/ios/.xcode.env.local
+xcshareddata
 
 
 # Android/IJ

README.md

@@ -87,6 +87,9 @@ Returns an object with the following methods:
 
 Check the `example` folder for a complete implementation example.
 
+> [!NOTE]
+> If you encounter an error while installing pods in `example/ios`, please refer to this solution: [https://stackoverflow.com/a/78874710/12355129](https://stackoverflow.com/a/78874710/12355129)
+
 ## Development
 
 To develop the SDK locally:
@@ -110,7 +113,7 @@ To develop the SDK locally:
    - iOS:
 
      ```bash
-     cd example/ios && pod install && cd ..
+     cd example/ios && pod install && cd ../..
      yarn example ios
      ```
 

example/ios/ConvertedInSdkExample.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -1,40 +1,97 @@
-// @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';
+import { render, waitFor } from '@testing-library/react-native';
+import React from 'react';
+import {
+  RNConvertInSDK,
+  RNConvertInSDKProvider,
+} from '../context/RNConvertedInSdkProvider';
+import * as RNConvertedInSdkModule from '../RNConvertedInSdkModule';
+import type { RNConvertInSDKContextType } from '../context/RNConvertedInSdkProvider';
 
-jest.mock('../../src/RNConvertedInSdkModule', () => ({
+jest.mock('../RNConvertedInSdkModule', () => ({
   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('RNConvertInSDKProvider', () => {
-  it('should throw an error if pixelId or storeUrl is not provided', () => {
-    console.error = jest.fn(); // Suppress console.error for this test
-    expect(() =>
+  const mockPixelId = 'test-pixel-id';
+  const mockStoreUrl = 'https://test-store.com';
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('initializes SDK on mount', async () => {
+    await waitFor(() => {
+      render(
+        <RNConvertInSDKProvider pixelId={mockPixelId} storeUrl={mockStoreUrl}>
+          <></>
+        </RNConvertInSDKProvider>
+      );
+    });
+
+    expect(RNConvertedInSdkModule.initializeSDK).toHaveBeenCalledWith({
+      pixelId: mockPixelId,
+      storeUrl: mockStoreUrl,
+    });
+  });
+
+  it('throws error if pixelId or storeUrl is not provided', () => {
+    const originalConsoleError = console.error;
+    console.error = jest.fn();
+
+    expect(() => {
       render(
-        <RNConvertInSDKProvider pixelId="" storeUrl="">
+        <RNConvertInSDKProvider pixelId="" storeUrl={mockStoreUrl}>
           <></>
         </RNConvertInSDKProvider>
-      )
-    ).toThrow(
+      );
+    }).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(() => {
+      render(
+        <RNConvertInSDKProvider pixelId={mockPixelId} storeUrl="">
+          <></>
+        </RNConvertInSDKProvider>
+      );
+    }).toThrow(
+      'Both pixelId and storeUrl must be provided to initialize the SDK'
     );
 
-    expect(RNConvertedInSdkModule.initializeSDK).toHaveBeenCalledWith({
-      pixelId: 'test-pixel-id',
-      storeUrl: 'https://test-store.com',
+    console.error = originalConsoleError;
+  });
+
+  it('provides SDK functions through context', async () => {
+    let contextValue: RNConvertInSDKContextType | undefined;
+    const TestComponent = () => {
+      contextValue = React.useContext(RNConvertInSDK);
+      return null;
+    };
+
+    await waitFor(() => {
+      render(
+        <RNConvertInSDKProvider pixelId={mockPixelId} storeUrl={mockStoreUrl}>
+          <TestComponent />
+        </RNConvertInSDKProvider>
+      );
     });
+
+    expect(contextValue).toBeDefined();
+    expect(contextValue?.isInitialized).toBe(true);
+    expect(typeof contextValue?.initializeSDK).toBe('function');
+    expect(typeof contextValue?.identifyUser).toBe('function');
+    expect(typeof contextValue?.addEvent).toBe('function');
+    expect(typeof contextValue?.viewContentEvent).toBe('function');
+    expect(typeof contextValue?.addToCartEvent).toBe('function');
+    expect(typeof contextValue?.initiateCheckoutEvent).toBe('function');
+    expect(typeof contextValue?.purchaseEvent).toBe('function');
+    expect(typeof contextValue?.registerEvent).toBe('function');
   });
 });

src/__tests__/RNConvertedInSdkProvider.test.tsx

@@ -1,6 +1,6 @@
 // @ts-ignore
 import * as React from 'react';
-import { renderHook } from '@testing-library/react-hooks/native';
+import { act, renderHook } from '@testing-library/react-hooks/native';
 import { RNConvertInSDKProvider } from '../context/RNConvertedInSdkProvider';
 import { useConvertedIn } from '../hooks/useConvertedInSdk';
 
@@ -16,14 +16,25 @@ jest.mock('../../src/RNConvertedInSdkModule', () => ({
 }));
 
 describe('useConvertedIn', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
   it('should throw an error when used outside of RNConvertInSDKProvider', () => {
+    const consoleErrorSpy = jest
+      .spyOn(console, 'error')
+      .mockImplementation(() => {});
+
     const { result } = renderHook(() => useConvertedIn());
+
     expect(result.error).toEqual(
       Error('useConvertedIn must be used within a ConvertedInProvider')
     );
+
+    consoleErrorSpy.mockRestore();
   });
 
-  it('should return all SDK functions when used within RNConvertInSDKProvider', () => {
+  it('should return all SDK functions when used within RNConvertInSDKProvider', async () => {
     const wrapper = ({ children }: { children: React.ReactNode }) => (
       <RNConvertInSDKProvider
         pixelId="test-pixel-id"
@@ -35,6 +46,10 @@ describe('useConvertedIn', () => {
 
     const { result } = renderHook(() => useConvertedIn(), { wrapper });
 
+    await act(async () => {
+      await result.current.initializeSDK();
+    });
+
     expect(result.current).toHaveProperty('initializeSDK');
     expect(result.current).toHaveProperty('identifyUser');
     expect(result.current).toHaveProperty('addEvent');

src/__tests__/useConvertedInSdk.test.tsx

@@ -17,7 +17,7 @@ interface RNConvertInSDKProps {
   storeUrl: string;
 }
 
-interface RNConvertInSDKType {
+export interface RNConvertInSDKContextType {
   isInitialized: boolean;
   initializeSDK: () => Promise<void>;
   identifyUser: (email: string, countryCode: string, phone: string) => void;
@@ -38,9 +38,9 @@ interface RNConvertInSDKType {
   registerEvent: () => void;
 }
 
-export const RNConvertInSDK = createContext<RNConvertInSDKType | undefined>(
-  undefined
-);
+export const RNConvertInSDK = createContext<
+  RNConvertInSDKContextType | undefined
+>(undefined);
 
 export const RNConvertInSDKProvider: React.FC<RNConvertInSDKProps> = ({
   children,