File size: 4,227 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
import { makeSelectorFromBlockName, validatePublishedFormFields } from './shared';
import { BlockFlow, EditorContext, PublishedPostContext } from '.';
interface ConfigurationData {
prompt: string;
}
interface ValidationData {
sampleInputLabel: string;
submitButtonText: string;
}
/**
* Class representing the flow of using an block in the editor.
*/
export class FormAiFlow implements BlockFlow {
private configurationData: ConfigurationData;
private validationData: ValidationData | undefined;
/**
* Constructs an instance of this block flow with data to be used when configuring and validating the block.
*
* @param {ConfigurationData} configurationData data with which to configure and validate the block
*/
constructor( configurationData: ConfigurationData ) {
this.configurationData = configurationData;
}
blockSidebarName = 'Form';
blockTestName = 'Form (AI)';
blockEditorSelector = makeSelectorFromBlockName( 'Form' );
/**
* Configure the block in the editor with the configuration data from the constructor
*
* @param {EditorContext} context The current context for the editor at the point of test execution
*/
async configure( context: EditorContext ): Promise< void > {
const aiInputParentLocator = await context.editorPage.getEditorCanvas();
const possiblePlaceholders = [
// New random placeholders.
'Example: a contact form with name, email, and message fields',
'Example: a pizza ordering form with name, address, phone number and toppings',
'Example: a survey form with multiple choice questions',
// Old placeholder. Can remove once new code is deployed everywhere.
'Ask Jetpack AI to edit…',
];
const aiInputReadyLocator = await Promise.any(
possiblePlaceholders.map( async ( placeholder ) => {
const locator = aiInputParentLocator.getByPlaceholder( placeholder );
await locator.waitFor();
return locator;
} )
);
const aiInputBusyLocator = aiInputParentLocator.getByRole( 'button', {
name: 'Stop request',
} );
const sendButtonLocator = aiInputParentLocator.getByRole( 'button', {
name: 'Send request',
} );
await aiInputReadyLocator.fill( this.configurationData.prompt );
await sendButtonLocator.click();
await aiInputBusyLocator.waitFor( { state: 'detached' } );
// Grab a first sample input label and submit button text to use for validation.
this.validationData = {
sampleInputLabel: await this.getFirstTextFieldLabel( context ),
submitButtonText: await this.getSubmitButtonText( context ),
};
}
/**
* Gets the label text for the first text-input field in the form in the editor.
*
* @param {EditorContext} context The editor context object.
* @returns {Promise<string>} The label text of the first text-input field.
*/
private async getFirstTextFieldLabel( context: EditorContext ): Promise< string > {
return await context.addedBlockLocator
.getByRole( 'document', {
// The form will always have one of these input fields, and they are easy
// to validate later in the editor with accessible checks!
name: /^Block: (Text input|Name|Email|Multi-line text) field$/,
} )
.locator( 'label' )
.first()
.innerText();
}
/**
* Gets the innerText on the submit button on the form in the editor.
*
* @param {EditorContext} context The editor context object.
* @returns {Promise<string>} The innerText of the submit button.
*/
private async getSubmitButtonText( context: EditorContext ): Promise< string > {
return await context.addedBlockLocator
.getByRole( 'document', {
name: 'Block: Button',
} )
.first()
.innerText();
}
/**
* Validate the block in the published post
*
* @param {PublishedPostContext} context The current context for the published post at the point of test execution
*/
async validateAfterPublish( context: PublishedPostContext ): Promise< void > {
if ( ! this.validationData ) {
throw new Error( 'Unable to find fields in the editor from the AI form.' );
}
await validatePublishedFormFields( context.page, [
{ type: 'textbox', accessibleName: this.validationData.sampleInputLabel },
{ type: 'button', accessibleName: this.validationData.submitButtonText },
] );
}
}
|