@youversion/platform-react-hooks 1.18.1 → 1.20.0

package/src/useVersions.test.tsx

@@ -1,15 +1,13 @@
 import { renderHook, waitFor, act } from '@testing-library/react';
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import type { ReactNode } from 'react';
+import { describe, expect, vi, beforeEach, it } from 'vitest';
 import { useVersions } from './useVersions';
-import { YouVersionContext } from './context';
 import { type BibleClient, type Collection, type BibleVersion } from '@youversion/platform-core';
 import { useBibleClient } from './useBibleClient';
+import { createYVWrapper } from './test/utils';
 
 vi.mock('./useBibleClient');
 
 describe('useVersions', () => {
-  const mockAppKey = 'test-app-key';
   const mockGetVersions = vi.fn();
 
   const mockVersions: Collection<BibleVersion> = {
@@ -38,15 +36,7 @@ describe('useVersions', () => {
     next_page_token: null,
   };
 
-  const createWrapper = (contextValue: { appKey: string }) => {
-    return ({ children }: { children: ReactNode }) => (
-      <YouVersionContext.Provider value={contextValue}>{children}</YouVersionContext.Provider>
-    );
-  };
-
   beforeEach(() => {
-    vi.resetAllMocks();
-
     mockGetVersions.mockResolvedValue(mockVersions);
 
     const mockClient: Partial<BibleClient> = { getVersions: mockGetVersions };
@@ -55,10 +45,7 @@ describe('useVersions', () => {
 
   describe('fetching versions', () => {
     it('should fetch versions with default language range', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions(), { wrapper });
 
       expect(result.current.loading).toBe(true);
@@ -68,60 +55,48 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledWith('en', undefined, undefined);
-      expect(result.current.versions).toEqual(mockVersions);
+      expect.soft(mockGetVersions).toHaveBeenCalledWith('en', undefined, undefined);
+      expect.soft(result.current.versions).toEqual(mockVersions);
     });
 
     it('should fetch versions with custom language range string', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('es'), { wrapper });
 
       await waitFor(() => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledWith('es', undefined, undefined);
-      expect(result.current.versions).toEqual(mockVersions);
+      expect.soft(mockGetVersions).toHaveBeenCalledWith('es', undefined, undefined);
+      expect.soft(result.current.versions).toEqual(mockVersions);
     });
 
     it('should fetch versions with language range array', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions(['en', 'es', 'fr']), { wrapper });
 
       await waitFor(() => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledWith(['en', 'es', 'fr'], undefined, undefined);
-      expect(result.current.versions).toEqual(mockVersions);
+      expect.soft(mockGetVersions).toHaveBeenCalledWith(['en', 'es', 'fr'], undefined, undefined);
+      expect.soft(result.current.versions).toEqual(mockVersions);
     });
 
     it('should fetch versions with license ID', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en', 123), { wrapper });
 
       await waitFor(() => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledWith('en', 123, undefined);
-      expect(result.current.versions).toEqual(mockVersions);
+      expect.soft(mockGetVersions).toHaveBeenCalledWith('en', 123, undefined);
+      expect.soft(result.current.versions).toEqual(mockVersions);
     });
 
     it('should fetch versions with string license ID', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en', 'license-abc'), { wrapper });
 
       await waitFor(() => {
@@ -134,10 +109,7 @@ describe('useVersions', () => {
 
   describe('fetching with options', () => {
     it('should fetch versions with page_size option', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en', undefined, { page_size: 10 }), {
         wrapper,
       });
@@ -155,10 +127,7 @@ describe('useVersions', () => {
     });
 
     it('should fetch versions with page_size "*" and fields', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(
         () => useVersions('en', undefined, { page_size: '*', fields: ['id', 'abbreviation'] }),
         { wrapper },
@@ -177,10 +146,7 @@ describe('useVersions', () => {
     });
 
     it('should fetch versions with page_token option', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(
         () => useVersions('en', undefined, { page_token: 'next-page-token' }),
         { wrapper },
@@ -199,10 +165,7 @@ describe('useVersions', () => {
     });
 
     it('should fetch versions with fields option', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(
         () => useVersions('en', undefined, { fields: ['id', 'title', 'abbreviation'] }),
         { wrapper },
@@ -221,10 +184,7 @@ describe('useVersions', () => {
     });
 
     it('should fetch versions with all_available option', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en', undefined, { all_available: true }), {
         wrapper,
       });
@@ -242,10 +202,7 @@ describe('useVersions', () => {
     });
 
     it('should fetch versions with all options combined', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(
         () =>
           useVersions('en', 456, {
@@ -272,10 +229,7 @@ describe('useVersions', () => {
 
   describe('refetch behavior', () => {
     it('should refetch when languageRanges changes', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result, rerender } = renderHook(({ lang }) => useVersions(lang), {
         wrapper,
         initialProps: { lang: 'en' as string | string[] },
@@ -285,8 +239,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, undefined);
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, undefined);
 
       rerender({ lang: 'es' });
 
@@ -294,15 +248,12 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(2);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(2, 'es', undefined, undefined);
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(2);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(2, 'es', undefined, undefined);
     });
 
     it('should refetch when languageRanges array changes', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result, rerender } = renderHook(({ lang }) => useVersions(lang), {
         wrapper,
         initialProps: { lang: ['en', 'es'] as string | string[] },
@@ -312,8 +263,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, ['en', 'es'], undefined, undefined);
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, ['en', 'es'], undefined, undefined);
 
       rerender({ lang: ['en', 'fr'] });
 
@@ -321,15 +272,12 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(2);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(2, ['en', 'fr'], undefined, undefined);
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(2);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(2, ['en', 'fr'], undefined, undefined);
     });
 
     it('should refetch when licenseId changes', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result, rerender } = renderHook(({ license }) => useVersions('en', license), {
         wrapper,
         initialProps: { license: 123 as string | number | undefined },
@@ -339,8 +287,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', 123, undefined);
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', 123, undefined);
 
       rerender({ license: 456 });
 
@@ -348,15 +296,12 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(2);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', 456, undefined);
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(2);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', 456, undefined);
     });
 
     it('should refetch when page_size changes', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result, rerender } = renderHook(
         ({ options }) => useVersions('en', undefined, options),
         {
@@ -369,8 +314,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
         page_size: 10,
         page_token: undefined,
         fields: undefined,
@@ -383,8 +328,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(2);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(2);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
         page_size: 20,
         page_token: undefined,
         fields: undefined,
@@ -393,10 +338,7 @@ describe('useVersions', () => {
     });
 
     it('should refetch when page_token changes', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result, rerender } = renderHook(
         ({ options }) => useVersions('en', undefined, options),
         {
@@ -409,8 +351,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
         page_size: undefined,
         page_token: 'token-1',
         fields: undefined,
@@ -423,8 +365,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(2);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(2);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
         page_size: undefined,
         page_token: 'token-2',
         fields: undefined,
@@ -433,10 +375,7 @@ describe('useVersions', () => {
     });
 
     it('should refetch when fields changes', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result, rerender } = renderHook(
         ({ options }) => useVersions('en', undefined, options),
         {
@@ -449,8 +388,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
         page_size: undefined,
         page_token: undefined,
         fields: ['id'],
@@ -463,8 +402,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(2);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(2);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
         page_size: undefined,
         page_token: undefined,
         fields: ['id', 'title'],
@@ -473,10 +412,7 @@ describe('useVersions', () => {
     });
 
     it('should refetch when all_available changes', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result, rerender } = renderHook(
         ({ options }) => useVersions('en', undefined, options),
         {
@@ -489,8 +425,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, {
         page_size: undefined,
         page_token: undefined,
         fields: undefined,
@@ -503,8 +439,8 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(2);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(2);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(2, 'en', undefined, {
         page_size: undefined,
         page_token: undefined,
         fields: undefined,
@@ -515,10 +451,7 @@ describe('useVersions', () => {
 
   describe('enabled option', () => {
     it('should not fetch when enabled is false', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en', undefined, { enabled: false }), {
         wrapper,
       });
@@ -527,15 +460,12 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).not.toHaveBeenCalled();
-      expect(result.current.versions).toBe(null);
+      expect.soft(mockGetVersions).not.toHaveBeenCalled();
+      expect.soft(result.current.versions).toBe(null);
     });
 
     it('should fetch when enabled is true', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en', undefined, { enabled: true }), {
         wrapper,
       });
@@ -544,15 +474,12 @@ describe('useVersions', () => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalled();
-      expect(result.current.versions).toEqual(mockVersions);
+      expect.soft(mockGetVersions).toHaveBeenCalled();
+      expect.soft(result.current.versions).toEqual(mockVersions);
     });
 
     it('should fetch when enabled is not specified', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en', undefined, { page_size: 10 }), {
         wrapper,
       });
@@ -567,31 +494,25 @@ describe('useVersions', () => {
 
   describe('error handling', () => {
     it('should handle fetch errors', async () => {
+      const wrapper = createYVWrapper();
       const error = new Error('Failed to fetch versions');
       mockGetVersions.mockRejectedValueOnce(error);
 
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
       const { result } = renderHook(() => useVersions('en'), { wrapper });
 
       await waitFor(() => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(result.current.error).toEqual(error);
-      expect(result.current.versions).toBe(null);
+      expect.soft(result.current.error).toEqual(error);
+      expect.soft(result.current.versions).toBe(null);
     });
 
     it('should clear error on successful refetch', async () => {
+      const wrapper = createYVWrapper();
       const error = new Error('Failed to fetch versions');
       mockGetVersions.mockRejectedValueOnce(error).mockResolvedValueOnce(mockVersions);
 
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
       const { result } = renderHook(() => useVersions('en'), { wrapper });
 
       await waitFor(() => {
@@ -609,25 +530,22 @@ describe('useVersions', () => {
         expect(result.current.error).toBe(null);
       });
 
-      expect(result.current.error).toBe(null);
-      expect(result.current.versions).toEqual(mockVersions);
+      expect.soft(result.current.error).toBe(null);
+      expect.soft(result.current.versions).toEqual(mockVersions);
     });
   });
 
   describe('manual refetch', () => {
     it('should support manual refetch', async () => {
-      const wrapper = createWrapper({
-        appKey: mockAppKey,
-      });
-
+      const wrapper = createYVWrapper();
       const { result } = renderHook(() => useVersions('en'), { wrapper });
 
       await waitFor(() => {
         expect(result.current.loading).toBe(false);
       });
 
-      expect(mockGetVersions).toHaveBeenCalledTimes(1);
-      expect(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, undefined);
+      expect.soft(mockGetVersions).toHaveBeenCalledTimes(1);
+      expect.soft(mockGetVersions).toHaveBeenNthCalledWith(1, 'en', undefined, undefined);
 
       act(() => {
         result.current.refetch();