Skip to content

Commit

Permalink
TASK: Remove PropertyCollectionInterface
Browse files Browse the repository at this point in the history
Removes the `PropertyCollectionInterface` in order to achieve
a more reliable behavior and not to give the impression of extension
points that are actually not extensible.

**Note:** This change disables some functional `NodeHelperTest` because
there is currently no easy way to mock the `Node` read model.
We'll address this with #4317

Resolves: #4464
  • Loading branch information
bwaidelich committed Sep 14, 2023
1 parent 020a0e0 commit b911fa0
Show file tree
Hide file tree
Showing 11 changed files with 23 additions and 70 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
use Neos\ContentRepository\Core\Projection\ContentGraph\Filter\FindChildNodesFilter;
use Neos\ContentRepository\Core\Projection\ContentGraph\Filter\FindReferencesFilter;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollectionInterface;
use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
use Neos\ContentRepository\Core\SharedModel\Node\NodeName;
use Neos\ContentRepository\Core\NodeType\NodeTypeName;
Expand Down Expand Up @@ -51,7 +50,6 @@ public static function fromSubgraphAndStartNode(ContentSubgraphInterface $subgra
) {
$childNodes[] = self::fromSubgraphAndStartNode($subgraph, $sourceChildNode);
}
/** @var PropertyCollectionInterface $properties */
$properties = $sourceNode->properties;

return new self(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ public function __construct(
*
* To read the serialized properties, call properties->serialized().
*
* @return PropertyCollectionInterface Property values, indexed by their name
* @param PropertyCollection $properties Property values, indexed by their name
*/
public readonly PropertyCollectionInterface $properties,
public readonly PropertyCollection $properties,
public readonly ?NodeName $nodeName,
public readonly Timestamps $timestamps,
) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
use Neos\ContentRepository\Core\Infrastructure\Property\PropertyConverter;

/**
* The property collection implementation
* @internal
* The property collection that provides access to the serialized and deserialized properties of a node
* @api This object should not be instantiated by 3rd parties, but it is part of the {@see Node} read model
*/
final class PropertyCollection implements PropertyCollectionInterface
final class PropertyCollection
{
/**
* Properties from Nodes
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ final class Reference
public function __construct(
public readonly Node $node,
public readonly ReferenceName $name,
public readonly ?PropertyCollectionInterface $properties
public readonly ?PropertyCollection $properties
) {
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
namespace Neos\ContentRepository\NodeMigration\Filter;

use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollectionInterface;

/**
* Filter nodes having the given property and its value not empty.
Expand Down Expand Up @@ -45,7 +44,6 @@ public function matches(Node $node): bool
if (is_null($this->propertyName) || !$node->hasProperty($this->propertyName)) {
return false;
}
/** @var PropertyCollectionInterface $properties */
$properties = $node->properties;
$serializedPropertyValue = $properties->serialized()->getProperty($this->propertyName);
if (!$serializedPropertyValue) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,8 @@
use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
use Neos\ContentRepository\Core\Feature\NodeModification\Command\SetSerializedNodeProperties;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollectionInterface;
use Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValue;
use Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValues;
use Neos\ContentRepository\Core\SharedModel\User\UserId;

/**
* Change the value of a given property.
Expand Down Expand Up @@ -107,7 +105,6 @@ public function execute(
ContentStreamId $contentStreamForWriting
): ?CommandResult {
if ($node->hasProperty($this->propertyName)) {
/** @var PropertyCollectionInterface $properties */
$properties = $node->properties;
$currentProperty = $properties->serialized()->getProperty($this->propertyName);
/** @var \Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValue $currentProperty safe since Node::hasProperty */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,10 @@
use Neos\ContentRepository\Core\CommandHandler\CommandResult;
use Neos\ContentRepository\Core\ContentRepository;
use Neos\ContentRepository\Core\DimensionSpace\DimensionSpacePointSet;
use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
use Neos\ContentRepository\Core\Feature\NodeModification\Command\SetSerializedNodeProperties;
use Neos\ContentRepository\Core\Feature\NodeAggregateCommandHandler;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollectionInterface;
use Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValues;
use Neos\ContentRepository\Core\SharedModel\User\UserId;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;

/**
* Remove the property
Expand Down Expand Up @@ -64,7 +61,6 @@ public function execute(
): ?CommandResult
{
if ($node->hasProperty($this->from)) {
/** @var PropertyCollectionInterface $properties */
$properties = $node->properties;
return $this->contentRepository->handle(
SetSerializedNodeProperties::create(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,11 @@
use Neos\ContentRepository\Core\CommandHandler\CommandResult;
use Neos\ContentRepository\Core\ContentRepository;
use Neos\ContentRepository\Core\DimensionSpace\DimensionSpacePointSet;
use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
use Neos\ContentRepository\Core\Feature\NodeModification\Command\SetSerializedNodeProperties;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollectionInterface;
use Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValue;
use Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValues;
use Neos\ContentRepository\Core\SharedModel\User\UserId;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;

/**
* Strip all tags on a given property
Expand Down Expand Up @@ -56,9 +54,8 @@ public function execute(
ContentStreamId $contentStreamForWriting
): ?CommandResult {
if ($node->hasProperty($this->propertyName)) {
/** @var PropertyCollectionInterface $properties */
$properties = $node->properties;
/** @var \Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValue $serializedPropertyValue safe since Node::hasProperty */
/** @var SerializedPropertyValue $serializedPropertyValue safe since Node::hasProperty */
$serializedPropertyValue = $properties->serialized()->getProperty($this->propertyName);
$propertyValue = $serializedPropertyValue->value;
if (!is_string($propertyValue)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,15 @@

use Neos\ContentRepository\Core\EventStore\Events;
use Neos\ContentRepository\Core\EventStore\EventsToPublish;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Feature\ContentStreamEventStreamName;
use Neos\ContentRepository\Core\Feature\NodeModification\Event\NodePropertiesWereSet;
use Neos\ContentRepository\Core\Projection\ContentGraph\NodeAggregate;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollectionInterface;
use Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValue;
use Neos\ContentRepository\Core\Feature\NodeModification\Dto\SerializedPropertyValues;
use Neos\ContentRepository\Core\SharedModel\User\UserId;
use Neos\EventStore\Model\EventStream\ExpectedVersion;
use Neos\ContentRepository\Core\NodeType\NodeTypeName;
use Neos\ContentRepository\Core\Feature\NodeModification\Event\NodePropertiesWereSet;
use Neos\ContentRepository\Core\NodeType\NodeTypeManager;
use Neos\ContentRepository\Core\NodeType\NodeTypeName;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Projection\ContentGraph\NodeAggregate;
use Neos\EventStore\Model\EventStream\ExpectedVersion;

class PropertyAdjustment
{
Expand Down Expand Up @@ -44,7 +42,6 @@ public function findAdjustmentsForNodeType(NodeTypeName $nodeTypeName): \Generat
foreach ($nodeAggregate->getNodes() as $node) {
$propertyKeysInNode = [];

/** @var PropertyCollectionInterface $properties */
$properties = $node->properties;
foreach ($properties->serialized() as $propertyKey => $property) {
$propertyKeysInNode[$propertyKey] = $propertyKey;
Expand Down
13 changes: 7 additions & 6 deletions Neos.Neos/Tests/Functional/Fusion/NodeHelperTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@
*/

use Neos\ContentRepository\Core\DimensionSpace\DimensionSpacePoint;
use Neos\ContentRepository\Core\DimensionSpace\OriginDimensionSpacePoint;
use Neos\ContentRepository\Core\Factory\ContentRepositoryId;
use Neos\ContentRepository\Core\NodeType\NodeType;
use Neos\ContentRepository\Core\NodeType\NodeTypeName;
use Neos\ContentRepository\Core\Projection\ContentGraph\ContentSubgraphIdentity;
use Neos\ContentRepository\Core\Projection\ContentGraph\Node;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollectionInterface;
use Neos\ContentRepository\Core\Projection\ContentGraph\PropertyCollection;
use Neos\ContentRepository\Core\Projection\ContentGraph\Timestamps;
use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateClassification;
use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId;
use Neos\ContentRepository\Core\DimensionSpace\OriginDimensionSpacePoint;
use Neos\ContentRepository\Core\NodeType\NodeType;
use Neos\ContentRepository\Core\NodeType\NodeTypeName;
use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints;
use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId;
use Neos\Fusion\Tests\Functional\FusionObjects\AbstractFusionObjectTest;
use PHPUnit\Framework\MockObject\MockObject;
Expand Down Expand Up @@ -115,6 +115,7 @@ protected function buildView()

protected function setUp(): void
{
$this->markTestSkipped('Skipped until we find a better way to mock node read models (see https://github.com/neos/neos-development-collection/issues/4317)');
parent::setUp();

$nodeType = $this
Expand All @@ -130,7 +131,7 @@ protected function setUp(): void
->willReturn('Content.Text');

$textNodeProperties = $this
->getMockBuilder(PropertyCollectionInterface::class)
->getMockBuilder(PropertyCollection::class)
->getMock();
$textNodeProperties
->method('offsetExists')
Expand Down

0 comments on commit b911fa0

Please sign in to comment.