Skip to content

Commit 2cea7d9

Browse files
Mati365Mati365
authored
Merge pull request #543 from ckeditor/ck/542
Improve cleanup of tests
2 parents 4f3e475 + d6955fe commit 2cea7d9

17 files changed

+91
-104
lines changed

‎src/hooks/useAsyncValue.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
import type { DependencyList } from 'react';
77

8-
import { useInstantEffect } from './useInstantEffect.js';
98
import { useAsyncCallback, type AsyncCallbackState } from './useAsyncCallback.js';
9+
import { useInstantEffect } from './useInstantEffect.js';
1010

1111
/**
1212
* A hook that allows to execute an asynchronous function and provides the state of the execution.
@@ -37,8 +37,8 @@ import { useAsyncCallback, type AsyncCallbackState } from './useAsyncCallback.js
3737
* }
3838
* ```
3939
*/
40-
export const useAsyncValue = <A extends Array<unknown>, R>(
41-
callback: ( ...args: A ) => Promise<R>,
40+
export const useAsyncValue = <R>(
41+
callback: () => Promise<R>,
4242
deps: DependencyList
4343
): AsyncValueHookResult<R> => {
4444
const [ asyncCallback, asyncState ] = useAsyncCallback( callback );

‎src/useMultiRootEditor.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -396,6 +396,7 @@ const useMultiRootEditor = ( props: MultiRootHookProps ): MultiRootHookReturns =
396396
} );
397397

398398
setTimeout( () => {
399+
/* istanbul ignore next -- @preserve */
399400
if ( props.onReady ) {
400401
props.onReady( watchdog!.editor );
401402
}

‎tests/_utils/turnOffErrors.ts

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/**
2+
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3+
* For licensing, see LICENSE.md.
4+
*/
5+
6+
import type { Awaitable } from '@ckeditor/ckeditor5-integrations-common';
7+
import { timeout } from './timeout.js';
8+
9+
export async function turnOffErrors( callback: () => Awaitable<void> ): Promise<void> {
10+
const handler = ( evt: ErrorEvent ) => {
11+
evt.preventDefault();
12+
};
13+
14+
window.addEventListener( 'error', handler, { capture: true, once: true } );
15+
16+
try {
17+
await callback();
18+
await timeout( 150 );
19+
} finally {
20+
window.removeEventListener( 'error', handler );
21+
}
22+
}

‎tests/_utils/turnoffdefaulterrorcatching.js

-19
This file was deleted.

‎tests/ckeditor.test.tsx

+5-4
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ import MockedEditor from './_utils/editor.js';
1313
import { timeout } from './_utils/timeout.js';
1414
import { createDefer } from './_utils/defer.js';
1515
import { PromiseManager } from './_utils/promisemanager.js';
16-
import turnOffDefaultErrorCatching from './_utils/turnoffdefaulterrorcatching.js';
1716
import CKEditor, { type Props } from '../src/ckeditor.js';
1817
import { expectToBeTruthy } from './_utils/expectToBeTruthy.js';
1918

2019
import type { LifeCycleElementSemaphore } from '../src/lifecycle/LifeCycleElementSemaphore.js';
2120
import type { EditorSemaphoreMountResult } from '../src/lifecycle/LifeCycleEditorSemaphore.js';
21+
import { turnOffErrors } from './_utils/turnOffErrors.js';
2222

2323
const MockEditor = MockedEditor as any;
2424

@@ -1055,13 +1055,14 @@ describe( '<CKEditor> Component', () => {
10551055

10561056
expect( firstEditor ).to.be.instanceOf( MockEditor );
10571057

1058-
await turnOffDefaultErrorCatching( () => {
1059-
return new Promise( res => {
1058+
await manager.all();
1059+
await turnOffErrors( async () => {
1060+
await new Promise( resolve => {
10601061
component?.rerender(
10611062
<CKEditor
10621063
ref={instanceRef}
10631064
editor={MockEditor}
1064-
onReady={res}
1065+
onReady={resolve}
10651066
onAfterDestroy={onAfterDestroySpy}
10661067
/>
10671068
);

‎tests/cloud/useCKEditorCloud.test.tsx

+10-11
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@
44
*/
55

66
import { afterEach, describe, expect, expectTypeOf, it } from 'vitest';
7-
import { renderHook, waitFor, act, cleanup } from '@testing-library/react';
7+
import { renderHook, waitFor, act } from '@testing-library/react';
88

99
import type { CKEditorCloudConfig } from '@ckeditor/ckeditor5-integrations-common';
1010
import { removeAllCkCdnResources } from '@ckeditor/ckeditor5-integrations-common/test-utils';
1111

1212
import useCKEditorCloud from '../../src/cloud/useCKEditorCloud.js';
1313

14-
describe( 'useCKEditorCloud', () => {
14+
describe( 'useCKEditorCloud', { timeout: 8000 }, () => {
1515
afterEach( () => {
16-
cleanup();
1716
removeAllCkCdnResources();
1817
} );
1918

@@ -31,7 +30,7 @@ describe( 'useCKEditorCloud', () => {
3130
if ( result.current.status === 'success' ) {
3231
expect( result.current.CKEditor ).toBeDefined();
3332
}
34-
} );
33+
}, { timeout: 5000 } );
3534
} );
3635

3736
it( 'should load additional bundle after updating deps', async () => {
@@ -52,7 +51,7 @@ describe( 'useCKEditorCloud', () => {
5251
expect( result.current.CKEditor ).toBeDefined();
5352
expect( result.current.CKEditorPremiumFeatures ).toBeUndefined();
5453
}
55-
} );
54+
}, { timeout: 5000 } );
5655

5756
rerender( {
5857
version: '43.0.0',
@@ -70,7 +69,7 @@ describe( 'useCKEditorCloud', () => {
7069
expect( result.current.CKEditor ).toBeDefined();
7170
expect( result.current.CKEditorPremiumFeatures ).toBeDefined();
7271
}
73-
} );
72+
}, { timeout: 5000 } );
7473
} );
7574

7675
describe( 'typings', () => {
@@ -82,7 +81,7 @@ describe( 'useCKEditorCloud', () => {
8281

8382
await waitFor( () => {
8483
expect( result.current.status ).toBe( 'success' );
85-
} );
84+
}, { timeout: 5000 } );
8685

8786
if ( result.current.status === 'success' ) {
8887
expectTypeOf( result.current.CKEditorPremiumFeatures ).not.toBeNullable();
@@ -97,7 +96,7 @@ describe( 'useCKEditorCloud', () => {
9796

9897
await waitFor( () => {
9998
expect( result.current.status ).toBe( 'success' );
100-
} );
99+
}, { timeout: 5000 } );
101100

102101
if ( result.current.status === 'success' ) {
103102
expectTypeOf( result.current.CKEditorPremiumFeatures ).toBeNullable();
@@ -111,7 +110,7 @@ describe( 'useCKEditorCloud', () => {
111110

112111
await waitFor( () => {
113112
expect( result.current.status ).toBe( 'success' );
114-
} );
113+
}, { timeout: 5000 } );
115114

116115
if ( result.current.status === 'success' ) {
117116
expectTypeOf( result.current.CKEditorPremiumFeatures ).toBeNullable();
@@ -128,7 +127,7 @@ describe( 'useCKEditorCloud', () => {
128127

129128
await waitFor( () => {
130129
expect( result.current.status ).toBe( 'success' );
131-
} );
130+
}, { timeout: 5000 } );
132131

133132
if ( result.current.status === 'success' ) {
134133
expectTypeOf( result.current.CKBox ).not.toBeNullable();
@@ -142,7 +141,7 @@ describe( 'useCKEditorCloud', () => {
142141

143142
await waitFor( () => {
144143
expect( result.current.status ).toBe( 'success' );
145-
} );
144+
}, { timeout: 5000 } );
146145

147146
if ( result.current.status === 'success' ) {
148147
expectTypeOf( result.current.CKBox ).toBeNullable();

‎tests/cloud/withCKEditorCloud.test.tsx

+2-3
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,19 @@
55

66
import React, { type MutableRefObject } from 'react';
77
import { afterEach, describe, expect, it } from 'vitest';
8-
import { cleanup, render } from '@testing-library/react';
8+
import { render } from '@testing-library/react';
99

1010
import { createDefer } from '@ckeditor/ckeditor5-integrations-common';
1111
import { removeAllCkCdnResources } from '@ckeditor/ckeditor5-integrations-common/test-utils';
1212

1313
import withCKEditorCloud, { type WithCKEditorCloudHocProps } from '../../src/cloud/withCKEditorCloud.js';
1414

15-
describe( 'withCKEditorCloud', () => {
15+
describe( 'withCKEditorCloud', { timeout: 5000 }, () => {
1616
const lastRenderedMockProps: MutableRefObject<WithCKEditorCloudHocProps | null> = {
1717
current: null
1818
};
1919

2020
afterEach( () => {
21-
cleanup();
2221
removeAllCkCdnResources();
2322
lastRenderedMockProps.current = null;
2423
} );

‎tests/context/ckeditorcontext.test.tsx

+5-6
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ import CKEditorContext, {
1616
import CKEditor from '../../src/ckeditor.js';
1717
import MockedEditor from '../_utils/editor.js';
1818
import { ClassicEditor, ContextWatchdog, CKEditorError } from 'ckeditor5';
19-
import turnOffDefaultErrorCatching from '../_utils/turnoffdefaulterrorcatching.js';
2019
import ContextMock, { DeferredContextMock } from '../_utils/context.js';
2120
import { timeout } from '../_utils/timeout.js';
2221
import { PromiseManager } from '../_utils/promisemanager.js';
22+
import { turnOffErrors } from '../_utils/turnOffErrors.js';
2323

2424
const MockEditor = MockedEditor as any;
2525

@@ -303,20 +303,19 @@ describe( '<CKEditorContext> Component', () => {
303303
} );
304304

305305
const { watchdog } = contextRef.current as ExtractContextWatchdogValueByStatus<'initialized'>;
306-
const error = new CKEditorError( 'foo', watchdog.context );
307306

308-
await turnOffDefaultErrorCatching( async () => {
307+
await turnOffErrors( async () => {
308+
const error = new CKEditorError( 'foo', watchdog.context );
309+
309310
setTimeout( () => {
310311
throw error;
311312
} );
312-
313-
await timeout( 150 );
314313
} );
315314

316315
expect( onErrorSpy ).toHaveBeenCalledOnce();
317316
const errorEventArgs = onErrorSpy.mock.calls[ 0 ];
318317

319-
expect( errorEventArgs[ 0 ] ).to.equal( error );
318+
expect( errorEventArgs[ 0 ] ).to.instanceOf( Error );
320319
expect( errorEventArgs[ 1 ] ).to.deep.equal( {
321320
phase: 'runtime',
322321
willContextRestart: true

‎tests/hooks/useAsyncCallback.test.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@
33
* For licensing, see LICENSE.md.
44
*/
55

6-
import { afterEach, describe, expect, it, vi } from 'vitest';
7-
import { renderHook, act, waitFor, cleanup } from '@testing-library/react';
6+
import { describe, expect, it, vi } from 'vitest';
7+
import { renderHook, act, waitFor } from '@testing-library/react';
88
import { useAsyncCallback } from '../../src/hooks/useAsyncCallback.js';
99
import { timeout } from '../_utils/timeout.js';
1010

1111
describe( 'useAsyncCallback', () => {
12-
afterEach( cleanup );
13-
1412
it( 'should execute the callback and update the state correctly when the callback resolves', async () => {
1513
const fetchData = vi.fn().mockResolvedValue( 'data' );
1614

‎tests/hooks/useAsyncValue.test.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
* For licensing, see LICENSE.md.
44
*/
55

6-
import { afterEach, describe, expect, it } from 'vitest';
7-
import { cleanup, renderHook, waitFor } from '@testing-library/react';
6+
import { describe, expect, it } from 'vitest';
7+
import { renderHook, waitFor } from '@testing-library/react';
88
import { useAsyncValue } from '../../src/hooks/useAsyncValue.js';
99

1010
describe( 'useAsyncValue', () => {
11-
afterEach( cleanup );
12-
1311
it( 'should return a mutable ref object', async () => {
1412
const { result } = renderHook( () => useAsyncValue( async () => 123, [] ) );
1513

‎tests/hooks/useInstantEditorEffect.test.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
* For licensing, see LICENSE.md.
44
*/
55

6-
import { afterEach, describe, expect, it, vi } from 'vitest';
7-
import { cleanup, renderHook } from '@testing-library/react';
6+
import { describe, expect, it, vi } from 'vitest';
7+
import { renderHook } from '@testing-library/react';
88
import { useInstantEditorEffect } from '../../src/hooks/useInstantEditorEffect.js';
99

1010
describe( 'useInstantEditorEffect', () => {
11-
afterEach( cleanup );
12-
1311
it( 'should execute the provided function after mounting of editor', () => {
1412
const semaphore = {
1513
runAfterMount: vi.fn()

‎tests/hooks/useInstantEffect.test.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
* For licensing, see LICENSE.md.
44
*/
55

6-
import { afterEach, describe, expect, it, vi } from 'vitest';
7-
import { cleanup, renderHook } from '@testing-library/react';
6+
import { describe, expect, it, vi } from 'vitest';
7+
import { renderHook } from '@testing-library/react';
88
import { useInstantEffect } from '../../src/hooks/useInstantEffect.js';
99

1010
describe( 'useInstantEffect', () => {
11-
afterEach( cleanup );
12-
1311
it( 'should call the effect function when dependencies change', () => {
1412
const effectFn = vi.fn();
1513
const { rerender } = renderHook( deps => useInstantEffect( effectFn, deps ), {

‎tests/hooks/useIsMountedRef.test.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
* For licensing, see LICENSE.md.
44
*/
55

6-
import { afterEach, describe, expect, it } from 'vitest';
7-
import { cleanup, renderHook } from '@testing-library/react';
6+
import { describe, expect, it } from 'vitest';
7+
import { renderHook } from '@testing-library/react';
88
import { useIsMountedRef } from '../../src/hooks/useIsMountedRef.js';
99

1010
describe( 'useIsMountedRef', () => {
11-
afterEach( cleanup );
12-
1311
it( 'should return a mutable ref object', () => {
1412
const { result } = renderHook( () => useIsMountedRef() );
1513

‎tests/hooks/useIsUnmountedRef.test.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
* For licensing, see LICENSE.md.
44
*/
55

6-
import { afterEach, describe, expect, it } from 'vitest';
7-
import { cleanup, renderHook } from '@testing-library/react';
6+
import { describe, expect, it } from 'vitest';
7+
import { renderHook } from '@testing-library/react';
88
import { useIsUnmountedRef } from '../../src/hooks/useIsUnmountedRef.js';
99

1010
describe( 'useIsUnmountedRef', () => {
11-
afterEach( cleanup );
12-
1311
it( 'should return a mutable ref object', () => {
1412
const { result } = renderHook( () => useIsUnmountedRef() );
1513

‎tests/hooks/useRefSafeCallback.test.tsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
* For licensing, see LICENSE.md.
44
*/
55

6-
import { expect, it, describe, vi, afterEach } from 'vitest';
7-
import { renderHook, act, cleanup } from '@testing-library/react';
6+
import { expect, it, describe, vi } from 'vitest';
7+
import { renderHook, act } from '@testing-library/react';
88
import { useRefSafeCallback } from '../../src/hooks/useRefSafeCallback.js';
99

1010
describe( 'useRefSafeCallback', () => {
11-
afterEach( cleanup );
12-
1311
it( 'should return a function', () => {
1412
const { result } = renderHook( () => useRefSafeCallback( () => {} ) );
1513

0 commit comments

Comments
 (0)