/*
This file is part of GNU Taler
(C) 2022 Taler Systems S.A.
GNU Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
GNU Taler; see the file COPYING. If not, see
*/
import { NotificationType } from "@gnu-taler/taler-util";
// import {
// WalletCoreApiClient,
// WalletCoreOpKeys,
// WalletCoreRequestType,
// WalletCoreResponseType,
// } from "@gnu-taler/taler-wallet-core";
import {
ComponentChildren,
Fragment,
FunctionalComponent,
h as create,
options,
render as renderIntoDom,
VNode,
} from "preact";
import { render as renderToString } from "preact-render-to-string";
// import { BackgroundApiClient, wxApi } from "./wxApi.js";
// When doing tests we want the requestAnimationFrame to be as fast as possible.
// without this option the RAF will timeout after 100ms making the tests slower
options.requestAnimationFrame = (fn: () => void) => {
return fn();
};
export function createExample(
Component: FunctionalComponent,
props: Partial | (() => Partial),
): ComponentChildren {
const evaluatedProps = typeof props === "function" ? props() : props;
const Render = (args: any): VNode => create(Component, args);
return {
component: Render,
props: evaluatedProps
};
}
export function createExampleWithCustomContext(
Component: FunctionalComponent,
props: Partial | (() => Partial),
ContextProvider: FunctionalComponent,
contextProps: Partial,
): ComponentChildren {
/**
* FIXME:
* This may not be useful since the example can be created with context
* already
*/
const evaluatedProps = typeof props === "function" ? props() : props;
const Render = (args: any): VNode => create(Component, args);
const WithContext = (args: any): VNode =>
create(ContextProvider, {
...contextProps,
children: [Render(args)],
} as any);
return {
component: WithContext,
props: evaluatedProps
};
}
const isNode = typeof window === "undefined";
/**
* To be used on automated unit test.
* So test will run under node or browser
* @param Component
* @param args
*/
export function renderNodeOrBrowser(Component: any, args: any): void {
const vdom = create(Component, args);
if (isNode) {
renderToString(vdom);
} else {
const div = document.createElement("div");
document.body.appendChild(div);
renderIntoDom(vdom, div);
renderIntoDom(null, div);
document.body.removeChild(div);
}
}
type RecursiveState = S | (() => RecursiveState);
interface Mounted {
unmount: () => void;
pullLastResultOrThrow: () => Exclude;
assertNoPendingUpdate: () => void;
// waitNextUpdate: (s?: string) => Promise;
waitForStateUpdate: () => Promise;
}
/**
* Main test API, mount the hook and return testing API
* @param callback
* @param Context
* @returns
*/
export function mountHook(
callback: () => RecursiveState,
Context?: ({ children }: { children: any }) => VNode,
): Mounted {
let lastResult: Exclude | Error | null = null;
const listener: Array<() => void> = [];
// component that's going to hold the hook
function Component(): VNode {
try {
let componentOrResult = callback();
while (typeof componentOrResult === "function") {
componentOrResult = componentOrResult();
}
//typecheck fails here
const l: Exclude void> = componentOrResult as any;
lastResult = l;
} catch (e) {
if (e instanceof Error) {
lastResult = e;
} else {
lastResult = new Error(`mounting the hook throw an exception: ${e}`);
}
}
// notify to everyone waiting for an update and clean the queue
listener.splice(0, listener.length).forEach((cb) => cb());
return create(Fragment, {});
}
// create the vdom with context if required
const vdom = !Context
? create(Component, {})
: create(Context, { children: [create(Component, {})] });
const customElement = {} as Element;
const parentElement = isNode ? customElement : document.createElement("div");
if (!isNode) {
document.body.appendChild(parentElement);
}
renderIntoDom(vdom, parentElement);
// clean up callback
function unmount(): void {
if (!isNode) {
document.body.removeChild(parentElement);
}
}
function pullLastResult(): Exclude {
const copy: Exclude = lastResult;
lastResult = null;
return copy;
}
function pullLastResultOrThrow(): Exclude {
const r = pullLastResult();
if (r instanceof Error) throw r;
if (!r) throw Error("there was no last result");
return r;
}
async function assertNoPendingUpdate(): Promise {
await new Promise((res, rej) => {
const tid = setTimeout(() => {
res(undefined);
}, 10);
listener.push(() => {
clearTimeout(tid);
rej(
Error(`Expecting no pending result but the hook got updated.
If the update was not intended you need to check the hook dependencies
(or dependencies of the internal state) but otherwise make
sure to consume the result before ending the test.`),
);
});
});
const r = pullLastResult();
if (r)
throw Error(`There are still pending results.
This may happen because the hook did a new update but the test didn't consume the result using pullLastResult`);
}
async function waitForStateUpdate(): Promise {
return await new Promise((res, rej) => {
const tid = setTimeout(() => {
res(false);
}, 10);
listener.push(() => {
clearTimeout(tid);
res(true);
});
});
}
return {
unmount,
pullLastResultOrThrow,
waitForStateUpdate,
assertNoPendingUpdate,
};
}
export const nullFunction = (): void => { null }
export const nullAsyncFunction = (): Promise => { return Promise.resolve() }