aa57f20aa2
Old codes relied on some assumptions, so: * When a "key in form descriptor" is provided, the 'name' param can't be set otherwise the js wouldn't be able to find it. * When a "name for submission" (with 'wp' prefix or same as the 'name' param) is provided, it works on the client-side but something might be broken on the server-side. Since the documented usage is to use "key in form descriptor" and most use case is fine, the use of "name for submission" is explicitly disallowed here. Use cases simply with the 'wp' prefix would still keep working on both sides though. Depends-On: I27fd8fa9643d611b37e3f47e77b698245814d539 Change-Id: I9a42417a6161f42181badd8cdbec81ba85dc62f6
356 lines
10 KiB
PHP
356 lines
10 KiB
PHP
<?php
|
|
|
|
use Wikimedia\TestingAccessWrapper;
|
|
|
|
/**
|
|
* @covers HTMLFormField
|
|
*/
|
|
class HTMLFormFieldTest extends PHPUnit\Framework\TestCase {
|
|
|
|
use MediaWikiCoversValidator;
|
|
|
|
public function getNewForm( $descriptor, $requestData ) {
|
|
$request = new FauxRequest( $requestData, true );
|
|
$context = new DerivativeContext( RequestContext::getMain() );
|
|
$context->setRequest( $request );
|
|
$form = HTMLForm::factory( 'ooui', $descriptor, $context );
|
|
$form->setTitle( Title::newFromText( 'Main Page' ) )->setSubmitCallback( static function () {
|
|
return true;
|
|
} )->prepareForm();
|
|
$status = $form->trySubmit();
|
|
$this->assertTrue( $status );
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* @covers HTMLFormField::isHidden
|
|
* @covers HTMLFormField::isDisabled
|
|
* @covers HTMLFormField::checkStateRecurse
|
|
* @covers HTMLFormField::validateCondState
|
|
* @covers HTMLFormField::getNearestField
|
|
* @covers HTMLFormField::getNearestFieldValue
|
|
* @dataProvider provideCondState
|
|
*/
|
|
public function testCondState( $fieldInfo, $requestData, $callback, $exception = null ) {
|
|
if ( $exception ) {
|
|
$this->expectException( $exception[0] );
|
|
$this->expectExceptionMessageMatches( $exception[1] );
|
|
}
|
|
$form = $this->getNewForm( wfArrayPlus2d( $fieldInfo, [
|
|
'check1' => [ 'type' => 'check' ],
|
|
'check2' => [ 'type' => 'check', 'invert' => true ],
|
|
'check3' => [ 'type' => 'check', 'name' => 'foo' ],
|
|
'select1' => [ 'type' => 'select', 'options' => [ 'a' => 'a', 'b' => 'b', 'c' => 'c' ], 'default' => 'b' ],
|
|
'text1' => [ 'type' => 'text' ],
|
|
] ), $requestData );
|
|
$callback( $form, $form->mFieldData );
|
|
}
|
|
|
|
public function provideCondState() {
|
|
yield 'Field hidden if "check" field is checked' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', 'check1', '1' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck1' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden if "check" field is not checked' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', 'check1', '' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field not hidden if "check" field is not checked' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', 'check1', '1' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertFalse( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden if "check" field (invert) is checked' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', 'check2', '1' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck2' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden if "check" field (invert) is not checked' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '!==', 'check2', '1' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field not hidden if "check" field (invert) is checked' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '!==', 'check2', '1' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck2' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertFalse( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden if "select" field has value' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', 'select1', 'a' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wpselect1' => 'a',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden if "text" field has value' => [
|
|
'fieldInfo' => [
|
|
'select1' => [ 'hide-if' => [ '===', 'text1', 'hello' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wptext1' => 'hello',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'select1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
|
|
yield 'Field hidden using AND conditions' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ 'AND',
|
|
[ '===', 'check1', '1' ],
|
|
[ '===', 'select1', 'a' ]
|
|
] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck1' => '1',
|
|
'wpselect1' => 'a',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden using OR conditions' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ 'OR',
|
|
[ '===', 'check1', '1' ],
|
|
[ '===', 'select1', 'a' ]
|
|
] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck1' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden using NAND conditions' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ 'NAND',
|
|
[ '===', 'check1', '1' ],
|
|
[ '===', 'select1', 'a' ]
|
|
] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck1' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden using NOR conditions' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ 'NOR',
|
|
[ '===', 'check1', '1' ],
|
|
[ '===', 'select1', 'a' ]
|
|
] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field hidden using complex conditions' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ 'OR',
|
|
[ 'NOT', [ 'AND',
|
|
[ '===', 'check1', '1' ],
|
|
[ '===', 'check2', '1' ]
|
|
] ],
|
|
[ '===', 'select1', 'a' ]
|
|
] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isHidden( $fieldData ) );
|
|
}
|
|
];
|
|
|
|
yield 'Invalid conditional specification (unsupported)' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '>', 'test1', '10' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => null,
|
|
'exception' => [ MWException::class, '/Unknown operation/' ],
|
|
];
|
|
yield 'Invalid conditional specification (NOT)' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ 'NOT', '===', 'check1', '1' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => null,
|
|
'exception' => [ MWException::class, '/NOT takes exactly one parameter/' ],
|
|
];
|
|
yield 'Invalid conditional specification (AND/OR/NAND/NOR)' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ 'AND', '===', 'check1', '1' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => null,
|
|
'exception' => [ MWException::class, '/Expected array, found string/' ],
|
|
];
|
|
yield 'Invalid conditional specification (===/!==) 1' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', 'check1' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => null,
|
|
'exception' => [ MWException::class, '/=== takes exactly two parameters/' ],
|
|
];
|
|
yield 'Invalid conditional specification (===/!==) 2' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', [ '===', 'check1', '1' ], '1' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => null,
|
|
'exception' => [ MWException::class, '/Parameters for === must be strings/' ],
|
|
];
|
|
|
|
yield 'Field disabled if "check" field is checked' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'disable-if' => [ '===', 'check1', '1' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck1' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isDisabled( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field disabled if hidden' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'hide-if' => [ '===', 'check1', '1' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck1' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isDisabled( $fieldData ) );
|
|
}
|
|
];
|
|
|
|
yield 'Field disabled even the field it relied on is named' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'disable-if' => [ '===', 'check3', '1' ] ],
|
|
],
|
|
'requestData' => [
|
|
'foo' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isDisabled( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field disabled even the \'wp\' prefix is used (back-compat)' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'disable-if' => [ '===', 'wpcheck1', '1' ] ],
|
|
],
|
|
'requestData' => [
|
|
'wpcheck1' => '1',
|
|
],
|
|
'callback' => function ( $form, $fieldData ) {
|
|
$this->assertTrue( $form->getField( 'text1' )->isDisabled( $fieldData ) );
|
|
}
|
|
];
|
|
yield 'Field name does not exist' => [
|
|
'fieldInfo' => [
|
|
'text1' => [ 'disable-if' => [ '===', 'foo', '1' ] ],
|
|
],
|
|
'requestData' => [],
|
|
'callback' => null,
|
|
'exception' => [ DomainException::class, '/no field named foo/' ],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @covers HTMLFormField::parseCondState
|
|
* @dataProvider provideParseCondState
|
|
*/
|
|
public function testParseCondState( $fieldName, $condState, $excepted ) {
|
|
$form = $this->getNewForm( [
|
|
'normal' => [ 'type' => 'check' ],
|
|
'named' => [ 'type' => 'check', 'name' => 'foo' ],
|
|
'test' => [ 'type' => 'text' ],
|
|
'cloner' => [
|
|
'class' => HTMLFormFieldCloner::class,
|
|
'fields' => [
|
|
'normal' => [ 'type' => 'check' ],
|
|
'named' => [ 'type' => 'check', 'name' => 'foo' ],
|
|
'test' => [ 'type' => 'text' ],
|
|
]
|
|
]
|
|
], [] );
|
|
$field = $form->getField( $fieldName ?? 'test' );
|
|
$wrapped = TestingAccessWrapper::newFromObject( $field );
|
|
if ( $field instanceof HTMLFormFieldCloner ) {
|
|
$field = $wrapped->getFieldsForKey( 0 )['test'];
|
|
$wrapped = TestingAccessWrapper::newFromObject( $field );
|
|
}
|
|
$parsed = $wrapped->parseCondState( $condState );
|
|
$this->assertSame( $excepted, $parsed );
|
|
}
|
|
|
|
public function provideParseCondState() {
|
|
yield 'Normal' => [
|
|
null,
|
|
[ '===', 'normal', '1' ],
|
|
[ '===', 'wpnormal', '1' ],
|
|
];
|
|
yield 'With the \'wp\' prefix' => [
|
|
null,
|
|
[ '===', 'wpnormal', '1' ],
|
|
[ '===', 'wpnormal', '1' ],
|
|
];
|
|
yield 'Named' => [
|
|
null,
|
|
[ '===', 'named', '1' ],
|
|
[ '===', 'foo', '1' ],
|
|
];
|
|
|
|
yield 'Normal in cloner' => [
|
|
'cloner',
|
|
[ '===', 'normal', '1' ],
|
|
[ '===', 'wpcloner[0][normal]', '1' ],
|
|
];
|
|
yield 'Named in cloner' => [
|
|
'cloner',
|
|
[ '===', 'named', '1' ],
|
|
[ '===', 'wpcloner[0][foo]', '1' ],
|
|
];
|
|
}
|
|
}
|