TASK: Improve flow cr:status

[mhsdesign]

Followup to #4846

• require a $details string for all non-ok status
• print "No details available." if verbose and non-ok and no details are available
• dont wortbreak details in verbose mode but print them with indentation of 2 full line per line
• print new line after printing details
• add details to AssetUsageProjection's setupRequired

[dlubitz]

Suggested change

	$emptyString = '';
	return new self(CheckpointStorageStatusType::OK, $emptyString);
	return new self(CheckpointStorageStatusType::OK, '');

[mhsdesign]

see this is a hack

/** @var non-empty-string $emptyString phpstan doesnt support that $details is only a non-empty-string if the type is not ok */

thats why i just fake it for this one case :/

[bwaidelich]

The @param non-empty-string $details in the constructor does not make sense with the empty string. I'd say: remove the param annotation and use Dennys version

[bwaidelich]

Or – does conditional typing work for params, too?

[mhsdesign]

Yes sadly not. I even had a discussion with the phpstan author :D
see phpstan/phpstan#10471

Assertions on properties are not build yet, there is a feature request, maybe ill do it :D
phpstan/phpstan#10463

but until then ill use phpstan ignore next line.
The reason im that strict is to enforce that there is a message for error cases, which should be statically linted.

[bwaidelich]

It does work with some generics magic: https://phpstan.org/r/fbed24c2-e5ba-48ec-a145-5df341986d9f

[bwaidelich]

...but I'm not sure whether that helps in our case

[mhsdesign]

Yes i have been there :D

but it doesnt work when passing it to a function:

function fooMe(CheckpointStorageStatus $foo): void
{
    if ($foo->type === CheckpointStorageStatusType::ERROR) {
        // how to teach phpstan this relation?
	\PHPStan\Testing\assertType('non-empty-string', $foo->details);
    }
}

[mhsdesign]

thats why i went with this compromise ... i hope its okay.

[bwaidelich]

That should be removed IMO

[mhsdesign]

the reason its there to enforce that there is a message for error cases, which should be statically enforced.
Otherwise we might lazy and forget it :D

[mhsdesign]

Otherwise we cant write this

Parameter #1 $details of static method Neos\ContentRepository\Core\Projection\ProjectionStatus::error() expects non-empty-string, string given.

$checkpointStorageStatus = $this->checkpointStorage->status();
if ($checkpointStorageStatus->type === CheckpointStorageStatusType::ERROR) {
    return ProjectionStatus::error($checkpointStorageStatus->details);
}

[mhsdesign]

CI fails because #4870 is not merged

[bwaidelich]

Fine for me, thanks for taking care!