woocommerce/plugins/woocommerce-blocks/tests/utils/get-toggle-id-by-label.ts

43 lines
1.4 KiB
TypeScript

/**
* External dependencies
*/
import { canvas } from '@wordpress/e2e-test-utils';
/**
* Internal dependencies
*/
import { DEFAULT_TIMEOUT } from './constants';
import { getFormElementIdByLabel } from './get-form-element-id-by-label';
/**
* Get the ID of the setting toogle so test can manipulate the toggle using
* unsetCheckbox and setCheckbox utilities.
*
* We're using 'adaptive timeout' here as the id of the toggle is changed on
* every render, so we wait a bit for the toggle to finish rerendering, then
* check if the node still attached to the document before returning its
* ID. If the node is detached, it means that the toggle is rendered, then
* we retry by calling this function again with increased retry argument. We
* will retry until the default timeout is reached, which is 30s.
*/
export const getToggleIdByLabel = async (
label: string,
retry = 0
): Promise< string > => {
const delay = 1000;
// Wait a bit for toggle to finish rerendering.
await canvas().waitForTimeout( delay );
const checkboxId = await getFormElementIdByLabel(
label,
'components-toggle-control__label'
);
const checkbox = await canvas().$( checkboxId );
if ( ! checkbox ) {
if ( retry * delay < DEFAULT_TIMEOUT ) {
return await getToggleIdByLabel( label, retry + 1 );
}
throw new Error( `Can't find toggle with label ${ label }` );
}
return checkboxId;
};