FIX Improve non-inline validation

[emteknetnz]

Issue #1155

Need to merge silverstripe/silverstripe-framework#11213 first to get the has_one RequiredFields validation working correctly and silverstripe/silverstripe-frameworktest#172 to get behat to pass.

There is a mutli-pr CI run linked on the issue

Note that this PR does not touch inline-saving

Scenarios:

1. DataObject validate() addFieldError()
2. DataObject validate() arrError()
3. UrlField validation
4. RequiredFields on default Title field
5. has_one relation to File and RequiredFields
6. has_one relation to SiteTree and RequiredFields

Non-inline editable block:

1. Already worked
2. Already worked
3. Already worked
4. Fixed in this PR - by default it's a composite field and validation works but doesn't show message on front-end
5. Already worked
6. Fixed in framework PR

Inline-editable block page save

1. Already worked - UX is bad not fixed in this PR - issue
2. Already worked - UX is bad not fixed in this PR - issue
3. Fixed in this PR
4. Fixed in this PR
5. Already worked
6. Fixed in framework PR

I used the following blocks to tests these scenarios

<?php

use DNADesign\Elemental\Models\BaseElement;
use SilverStripe\Forms\CompositeValidator;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\Forms\UrlField;
use SilverStripe\Assets\Image;
use SilverStripe\CMS\Model\SiteTree;

class MyBlock extends BaseElement
{
    private static $db = [
        'MyField' => 'Varchar',
        'MyHTML' => 'HTMLText',
        'MyUrl' => 'Varchar',
    ];

    private static $has_one = [
        'MyImage' => Image::class,
        'MyPage' => SiteTree::class,
    ];

    private static $table_name = 'MyBlock';

    private static $singular_name = 'My Block';

    private static $plural_name = 'My Blocks';

    private static $description = 'This is my block';

    private static $icon = 'font-icon-block-content';

    public function getType()
    {
        return 'My Block';
    }

    public function validate()
    {
        $result = parent::validate();
        if ($this->Title == 'x') {
            $result->addFieldError('Title', 'Title cannot be x', 'validation');
        }
        if ($this->MyField == 'x') {
            $result->addFieldError('MyField', 'MyField cannot be x', 'validation');
        }
        $c = trim(strip_tags($this->MyHTML ?? ''));
        if ($c == 'x') {
            $result->addFieldError('MyHTML', 'MyHTML cannot be x', 'validation');
        }
        if ($this->MyField == 'z' && $c == 'z') {
            $result->addError('This is a general error message');
        }
        return $result;
    }

    public function getCMSCompositeValidator(): CompositeValidator
    {
        return CompositeValidator::create([RequiredFields::create(['Title', 'MyImage', 'MyPageID'])]);
    }

    public function getCMSFields()
    {
        $fields = parent::getCMSFields();
        $fields->dataFieldByName('MyHTML')->setRows(5);
        $fields->removeByName('MyUrl');
        // URLfield contains its own validate() methods
        $fields->addFieldToTab('Root.Main', UrlField::create('MyUrl', 'My URL'));
        return $fields;
    }
}

<?php

class MyNonInlineBlock extends MyBlock
{
    private static $inline_editable = false;

    private static $table_name = 'MyNonInlineBlock';

    private static $singular_name = 'My non-inline Block';

    private static $plural_name = 'My non-inline Blocks';

    private static $description = 'This is my non-inline block';

    private static $icon = 'font-icon-block-content';

    public function getType()
    {
        return 'My non-inline Block';
    }
}

[emteknetnz]

Previously FormField validation wasn't happening on fields on elements e.g. $db = [ 'MyUrl' => UrlField::class ] when saving the page (as opposed to editing the element directly)

[GuySartorelli]

If I save the page without expanding the block, none of the validation seems to happen. e.g. with your test blocks from the description, I add the block and immediately save the page - it should trigger validation errors for the missing required fields but it doesn't.

[GuySartorelli]

The problem described in #1178 (review) has not been resolved

[emteknetnz]

If I save the page without expanding the block, none of the validation seems to happen. e.g. with your test blocks from the description, I add the block and immediately save the page - it should trigger validation errors for the missing required fields but it doesn't.

That would be hard to solve.

In the case of inline blocks, currently if they haven't been opened and the page is saved, then then because the child FormBuilder form hasn't been rendered then the element data will not be sent as part of the page form submission. However if the inline-element is opened then page save will submit element data with the rest of the page, and closing the element then saving the page will also send the element data. So to solve this we'd need to render the FormBuilder forms for ALL unopened elements on page save

In the case of non-inline blocks, I really don't know what can be done since their forms are never rendered on the page and and thus their data is never sent.

The fact this doesn't work doesn't actually matter given the AC is Saving/publishing a page will trigger validation on its child block if they are in a a dirty state. - the elements in question aren't dirty, they're just created in an invalid state.

We could split this off as a seperate card, though I honestly don't know how or even if we should attempt a fix here

[GuySartorelli]

We could split this off as a seperate card, though I honestly don't know how or even if we should attempt a fix here

I think that's worth looking into. There's a tradeoff to be made between:

1. always having the form rendered (and just hidden until it's expanded) - which means we never have to do workarounds like explicitly render it when hitting the save button on the block
2. potential performance loss from eagerly getting the required data to render the form for all blocks on a given page

I'll open a separate card about this for discussion.

Edit: #1183

[GuySartorelli]

Just the one thing left and then we're good, I think.

[GuySartorelli]

Reran CI after merging frameworktest. Confirmed they are running with the correct commit:
silverstripe/frameworktest 1.x-dev d12463a
silverstripe/silverstripe-frameworktest@d12463a

[GuySartorelli]

behat failing

[emteknetnz]

I've added an extra code change that's from a different PR that's blocked on this one which is required to get the inline-block-validation.feature behat tests to pass

[emteknetnz]

I've added this code change in from a different PR that's blocked on this one which is required to get the inline-block-validation.feature behat tests to pass

[GuySartorelli]

I don't know how I didn't notice this before, but for inline-editable blocks when you save the page, only one required field validation message appears at a time.

So if I don't enter any data I only get told about the title, then I add a title and I'm told about the image, then I add an image and I'm told about the page.

The HTTP response does have all three validation errors at the same time - at this stage I don't know if getting them to display is part of this card or not so if there's another card to handle this please just link to it and I'll be okay with that.

[GuySartorelli]

Rerunning failed behat tests now that the framework PR is merged, but regardless of whether that goes green I need at least a response to my above comment.

[GuySartorelli]

Still need to respond to #1178 (review)

[emteknetnz]

Split of as separate card that can be refined

[GuySartorelli]

LGTM with the understanding that there's still a few issues left to be done before this functionality is considered 100% working 😅