-
Notifications
You must be signed in to change notification settings - Fork 586
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
6 changed files
with
233 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| //////////////////////////////////////////////////////////////////////////// | ||
| // | ||
| // Copyright 2024 Realm Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| //////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| import { act } from "@testing-library/react-native"; | ||
| import { EstimateProgressNotificationCallback, ProgressRealmPromise, Realm } from "realm"; | ||
| import { sleep } from "../helpers"; | ||
|
|
||
| /** | ||
| * Mocks {@link Realm.ProgressRealmPromise} with a custom | ||
| * promise completion and progress handler. | ||
| */ | ||
| export class MockedProgressRealmPromise extends Promise<Realm> implements ProgressRealmPromise { | ||
| private progressHandler?: (callback: EstimateProgressNotificationCallback) => void; | ||
| private cancelHandler?: () => void; | ||
| private realmPromise!: Promise<Realm>; | ||
|
|
||
| constructor( | ||
| getRealm: () => Promise<Realm>, | ||
| options?: { | ||
| progress?: (callback: EstimateProgressNotificationCallback) => void; | ||
| cancel?: () => void; | ||
| }, | ||
| ) { | ||
| let realmPromise: Promise<Realm>; | ||
| super((resolve) => { | ||
| realmPromise = getRealm(); | ||
| realmPromise.then((realm) => resolve(realm)); | ||
| }); | ||
| // @ts-expect-error realmPromise value will be assigned right away | ||
| this.realmPromise = realmPromise; | ||
| this.progressHandler = options?.progress; | ||
| this.cancelHandler = options?.cancel; | ||
| } | ||
|
|
||
| get [Symbol.toStringTag]() { | ||
| return "MockedProgressRealmPromise"; | ||
| } | ||
|
|
||
| cancel = () => { | ||
| if (!this.cancelHandler) { | ||
| throw new Error("cancel handler not set"); | ||
| } | ||
| this.cancelHandler(); | ||
| }; | ||
|
|
||
| then<TResult1 = Realm, TResult2 = never>( | ||
| onfulfilled?: ((value: Realm) => TResult1 | PromiseLike<TResult1>) | null | undefined, | ||
| onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined, | ||
| ): Promise<TResult1 | TResult2> { | ||
| return this.realmPromise.then(onfulfilled, onrejected); | ||
| } | ||
|
|
||
| progress = (callback: EstimateProgressNotificationCallback) => { | ||
| if (!this.progressHandler) { | ||
| throw new Error("progress handler not set"); | ||
| } | ||
| this.progressHandler(callback); | ||
| return this; | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Mocked {@link ProgressRealmPromise} which resolves after a set delay. | ||
| * If `options.progressValues` is specified, passes it through an | ||
| * equal interval to `Realm.open(...).progress(...)` callback. | ||
| */ | ||
| export class MockedProgressRealmPromiseWithDelay extends MockedProgressRealmPromise { | ||
| public currentProgressIndex = 0; | ||
| public progressValues: number[] | undefined; | ||
| private progressTimeout: NodeJS.Timeout | undefined; | ||
|
|
||
| constructor( | ||
| options: { | ||
| delay?: number; | ||
| /** Progress values which the `Realm.open(...).progress(...)` will receive in an equal interval. */ | ||
| progressValues?: number[]; | ||
| } = {}, | ||
| ) { | ||
| const { progressValues, delay = 100 } = options; | ||
| super( | ||
| async () => { | ||
| await sleep(delay); | ||
| return new Realm(); | ||
| }, | ||
| { | ||
| progress: (callback) => { | ||
| this.progressTimeout = callMockedProgressNotifications(callback, delay, progressValues); | ||
| }, | ||
| cancel: () => clearTimeout(this.progressTimeout), | ||
| }, | ||
| ); | ||
| this.progressValues = progressValues; | ||
| } | ||
| } | ||
|
|
||
| /** Calls given callbacks with progressValues in an equal interval */ | ||
| export function callMockedProgressNotifications( | ||
| callback: EstimateProgressNotificationCallback, | ||
| timeFrame: number, | ||
| progressValues: number[] = [0, 0.25, 0.5, 0.75, 1], | ||
| ): NodeJS.Timeout { | ||
| let progressIndex = 0; | ||
| let progressInterval: NodeJS.Timeout | undefined = undefined; | ||
| const sendProgress = () => { | ||
| // Uses act as this causes a component state update. | ||
| act(() => callback(progressValues[progressIndex])); | ||
| progressIndex++; | ||
|
|
||
| if (progressIndex >= progressValues.length) { | ||
| // Send the next progress update in equidistant time | ||
| clearInterval(progressInterval); | ||
| } | ||
| }; | ||
| progressInterval = setInterval(sendProgress, timeFrame / (progressValues.length + 1)); | ||
| sendProgress(); | ||
| return progressInterval; | ||
| } | ||
|
|
||
| /** | ||
| * Mocks the Realm.open operation with a delayed, predictable Realm creation. | ||
| * @returns Promise which resolves when the Realm is opened. | ||
| */ | ||
| export function mockRealmOpen( | ||
| progressRealmPromise: MockedProgressRealmPromise = new MockedProgressRealmPromiseWithDelay(), | ||
| ): MockedProgressRealmPromise { | ||
| const delayedRealmOpen = jest.spyOn(Realm, "open"); | ||
| delayedRealmOpen.mockImplementation(() => progressRealmPromise); | ||
| return progressRealmPromise; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters