Skip to content

Commit f2ab47f

Browse files
skurfuerstskurfuerst
authored
Merge pull request #22 from Flowpack/task/adjustments-for-1and1
FEATURE: Support workspaces, UI improvements and canceling specific releases
2 parents c095f18 + 8f82507 commit f2ab47f

10 files changed

Lines changed: 156 additions & 108 deletions

File tree

‎Classes/Command/ContentReleasePrepareCommandController.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,23 @@ class ContentReleasePrepareCommandController extends CommandController
2828
*/
2929
protected $concurrentBuildLock;
3030

31-
public function createContentReleaseCommand(string $contentReleaseIdentifier, string $prunnerJobId)
31+
public function createContentReleaseCommand(string $contentReleaseIdentifier, string $prunnerJobId, string $workspaceName = 'live'): void
3232
{
3333
$contentReleaseIdentifier = ContentReleaseIdentifier::fromString($contentReleaseIdentifier);
3434
$prunnerJobId = PrunnerJobId::fromString($prunnerJobId);
3535
$logger = ContentReleaseLogger::fromConsoleOutput($this->output, $contentReleaseIdentifier);
3636

37-
$this->redisContentReleaseService->createContentRelease($contentReleaseIdentifier, $prunnerJobId, $logger);
37+
$this->redisContentReleaseService->createContentRelease($contentReleaseIdentifier, $prunnerJobId, $logger, $workspaceName);
3838
}
3939

40-
public function ensureAllOtherInProgressContentReleasesWillBeTerminatedCommand(string $contentReleaseIdentifier)
40+
public function ensureAllOtherInProgressContentReleasesWillBeTerminatedCommand(string $contentReleaseIdentifier): void
4141
{
4242
$contentReleaseIdentifier = ContentReleaseIdentifier::fromString($contentReleaseIdentifier);
4343

4444
$this->concurrentBuildLock->ensureAllOtherInProgressContentReleasesWillBeTerminated($contentReleaseIdentifier);
4545
}
4646

47-
public function registerManualTransferJobCommand(string $contentReleaseIdentifier, string $prunnerJobId)
47+
public function registerManualTransferJobCommand(string $contentReleaseIdentifier, string $prunnerJobId): void
4848
{
4949
$contentReleaseIdentifier = ContentReleaseIdentifier::fromString($contentReleaseIdentifier);
5050
$prunnerJobId = PrunnerJobId::fromString($prunnerJobId);

‎Classes/ContentReleaseManager.php‎

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@
44

55
namespace Flowpack\DecoupledContentStore;
66

7+
use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\ContentReleaseIdentifier;
78
use Flowpack\DecoupledContentStore\Core\Domain\ValueObject\RedisInstanceIdentifier;
89
use Flowpack\DecoupledContentStore\Core\Infrastructure\RedisClientManager;
10+
use Neos\ContentRepository\Domain\Model\Workspace;
11+
use Flowpack\Prunner\ValueObject\JobId;
912
use Neos\Flow\Annotations as Flow;
1013
use Flowpack\Prunner\PrunnerApiService;
1114
use Flowpack\Prunner\ValueObject\PipelineName;
@@ -43,27 +46,45 @@ class ContentReleaseManager
4346
const REDIS_CURRENT_RELEASE_KEY = 'contentStore:current';
4447
const NO_PREVIOUS_RELEASE = 'NO_PREVIOUS_RELEASE';
4548

46-
public function startIncrementalContentRelease()
49+
public function startIncrementalContentRelease(string $currentContentReleaseId = null, Workspace $workspace = null, array $additionalVariables = []): ContentReleaseIdentifier
4750
{
4851
$redis = $this->redisClientManager->getPrimaryRedis();
49-
$currentContentReleaseId = $redis->get(self::REDIS_CURRENT_RELEASE_KEY);
52+
if ($currentContentReleaseId) {
53+
$currentContentReleaseId = $redis->get(self::REDIS_CURRENT_RELEASE_KEY);
54+
}
5055

56+
$contentReleaseId = ContentReleaseIdentifier::create();
5157
// the currentContentReleaseId is not used in any pipeline step in this package, but is a common need in other
5258
// use cases in extensions, e.g. calculating the differences between current and new release
53-
$this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), ['contentReleaseId' => (string)time(), 'currentContentReleaseId' => $currentContentReleaseId ?: self::NO_PREVIOUS_RELEASE, 'validate' => true]);
59+
$this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), array_merge($additionalVariables, [
60+
'contentReleaseId' => $contentReleaseId,
61+
'currentContentReleaseId' => $currentContentReleaseId ?: self::NO_PREVIOUS_RELEASE,
62+
'validate' => true,
63+
'workspaceName' => $workspace ? $workspace->getName() : 'live',
64+
]));
65+
return $contentReleaseId;
5466
}
5567

5668
// the validate parameter can be used to intentionally skip the validation step for this release
57-
public function startFullContentRelease(bool $validate = true)
69+
public function startFullContentRelease(bool $validate = true, string $currentContentReleaseId = null, Workspace $workspace = null, array $additionalVariables = []): ContentReleaseIdentifier
5870
{
5971
$redis = $this->redisClientManager->getPrimaryRedis();
60-
$currentContentReleaseId = $redis->get(self::REDIS_CURRENT_RELEASE_KEY);
72+
if ($currentContentReleaseId) {
73+
$currentContentReleaseId = $redis->get(self::REDIS_CURRENT_RELEASE_KEY);
74+
}
6175

76+
$contentReleaseId = ContentReleaseIdentifier::create();
6277
$this->contentCache->flush();
63-
$this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), ['contentReleaseId' => (string)time(), 'currentContentReleaseId' => $currentContentReleaseId ?: self::NO_PREVIOUS_RELEASE, 'validate' => $validate]);
78+
$this->prunnerApiService->schedulePipeline(PipelineName::create('do_content_release'), array_merge($additionalVariables, [
79+
'contentReleaseId' => $contentReleaseId,
80+
'currentContentReleaseId' => $currentContentReleaseId ?: self::NO_PREVIOUS_RELEASE,
81+
'validate' => $validate,
82+
'workspaceName' => $workspace ? $workspace->getName() : 'live',
83+
]));
84+
return $contentReleaseId;
6485
}
6586

66-
public function cancelAllRunningContentReleases()
87+
public function cancelAllRunningContentReleases(): void
6788
{
6889
$result = $this->prunnerApiService->loadPipelinesAndJobs();
6990
$runningJobs = $result->getJobs()->forPipeline(PipelineName::create('do_content_release'))->running();
@@ -72,7 +93,22 @@ public function cancelAllRunningContentReleases()
7293
}
7394
}
7495

75-
public function toggleConfigEpoch(RedisInstanceIdentifier $redisInstanceIdentifier)
96+
/**
97+
* Cancel a single running content release ignoring all others
98+
*/
99+
public function cancelRunningContentRelease(JobId $jobId): void
100+
{
101+
$result = $this->prunnerApiService->loadPipelinesAndJobs();
102+
$runningJobs = $result->getJobs()->forPipeline(PipelineName::create('do_content_release'))->running();
103+
foreach ($runningJobs as $job) {
104+
if ($job->getId() === $jobId) {
105+
$this->prunnerApiService->cancelJob($job);
106+
break;
107+
}
108+
}
109+
}
110+
111+
public function toggleConfigEpoch(RedisInstanceIdentifier $redisInstanceIdentifier): void
76112
{
77113
$currentConfigEpochConfig = $this->configEpochSettings['current'] ?? null;
78114
$previousConfigEpochConfig = $this->configEpochSettings['previous'] ?? null;

‎Classes/Core/Domain/ValueObject/ContentReleaseIdentifier.php‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@
1111
final class ContentReleaseIdentifier implements \JsonSerializable
1212
{
1313

14-
/**
15-
* @var string
16-
*/
17-
private $identifier;
14+
private string $identifier;
1815

1916
private function __construct(string $identifier)
2017
{
@@ -39,9 +36,6 @@ public function jsonSerialize(): string
3936
return $this->identifier;
4037
}
4138

42-
/**
43-
* @return string
44-
*/
4539
public function getIdentifier(): string
4640
{
4741
return $this->identifier;
@@ -51,4 +45,9 @@ public function equals(?ContentReleaseIdentifier $other): bool
5145
{
5246
return $other !== null && $this->identifier === $other->identifier;
5347
}
48+
49+
public function __toString(): string
50+
{
51+
return $this->identifier;
52+
}
5453
}

‎Classes/NodeEnumeration/Domain/Service/NodeContextCombinator.php‎

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,50 @@
11
<?php
2-
namespace Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Service;
2+
declare(strict_types=1);
33

4+
namespace Flowpack\DecoupledContentStore\NodeEnumeration\Domain\Service;
45

6+
use Flowpack\DecoupledContentStore\Exception\NodeNotFoundException;
7+
use Neos\ContentRepository\Domain\Model\Workspace;
8+
use Neos\ContentRepository\Domain\Service\ContextFactoryInterface;
59
use Neos\Flow\Annotations as Flow;
610
use Neos\Neos\Domain\Model\Site;
711
use Neos\ContentRepository\Domain\Model\NodeInterface;
12+
use Neos\Neos\Domain\Repository\SiteRepository;
13+
use Neos\Neos\Domain\Service\ContentDimensionPresetSourceInterface;
814

915
class NodeContextCombinator
1016
{
1117

1218
/**
1319
* @Flow\Inject
14-
* @var \Neos\Neos\Domain\Service\ContentDimensionPresetSourceInterface
20+
* @var ContentDimensionPresetSourceInterface
1521
*/
1622
protected $dimensionPresetSource;
1723

1824
/**
1925
* @Flow\Inject
20-
* @var \Neos\Neos\Domain\Repository\SiteRepository
26+
* @var SiteRepository
2127
*/
2228
protected $siteRepository;
2329

2430
/**
2531
* @Flow\Inject
26-
* @var \Neos\ContentRepository\Domain\Service\ContextFactoryInterface
32+
* @var ContextFactoryInterface
2733
*/
2834
protected $contextFactory;
2935

3036
/**
3137
* Iterate over the node with the given identifier and site in contexts for all available presets (if it exists as a variant)
3238
*
33-
* @param string $nodeIdentifier
34-
* @param Site $site
35-
* @return \Generator
36-
* @throws Exception\NodeNotFoundException
39+
* @return \Generator<NodeInterface>
40+
* @throws NodeNotFoundException
3741
*/
38-
public function nodeInContexts($nodeIdentifier, Site $site)
42+
public function nodeInContexts(string $nodeIdentifier, Site $site, string $workspaceName = 'live'): \Generator
3943
{
4044
$nodeFound = false;
4145

4246
/** @var NodeInterface $siteNode */
43-
foreach ($this->siteNodeInContexts($site) as $siteNode) {
47+
foreach ($this->siteNodeInContexts($site, $workspaceName) as $siteNode) {
4448
$node = $siteNode->getContext()->getNodeByIdentifier($nodeIdentifier);
4549

4650
if ($node instanceof NodeInterface) {
@@ -50,17 +54,17 @@ public function nodeInContexts($nodeIdentifier, Site $site)
5054
}
5155

5256
if (!$nodeFound) {
53-
throw new Exception\NodeNotFoundException('Could not find node by identifier ' . $nodeIdentifier . ' in any context',
57+
throw new NodeNotFoundException('Could not find node by identifier ' . $nodeIdentifier . ' in any context',
5458
1467285561);
5559
}
5660
}
5761

5862
/**
5963
* Iterate over all sites
6064
*
61-
* @return Site[]
65+
* @return \Generator<Site>
6266
*/
63-
public function sites()
67+
public function sites(): \Generator
6468
{
6569
$sites = $this->siteRepository->findAll();
6670

@@ -72,16 +76,15 @@ public function sites()
7276
/**
7377
* Iterate over the site node in all available presets (if it exists)
7478
*
75-
* @param Site $site
76-
* @return NodeInterface[]
79+
* @return \Generator<NodeInterface>
7780
*/
78-
public function siteNodeInContexts(Site $site)
81+
public function siteNodeInContexts(Site $site, string $workspaceName = 'live'): \Generator
7982
{
8083
$presets = $this->dimensionPresetSource->getAllPresets();
8184
if ($presets === []) {
8285
$contentContext = $this->contextFactory->create(array(
8386
'currentSite' => $site,
84-
'workspaceName' => 'live',
87+
'workspaceName' => $workspaceName,
8588
'dimensions' => [],
8689
'targetDimensions' => []
8790
));
@@ -96,7 +99,7 @@ public function siteNodeInContexts(Site $site)
9699

97100
$contentContext = $this->contextFactory->create(array(
98101
'currentSite' => $site,
99-
'workspaceName' => 'live',
102+
'workspaceName' => $workspaceName,
100103
'dimensions' => $dimensions,
101104
'targetDimensions' => []
102105
));
@@ -114,16 +117,15 @@ public function siteNodeInContexts(Site $site)
114117
/**
115118
* Iterate over the given node and all document child nodes recursively
116119
*
117-
* @param NodeInterface $node
118-
* @return NodeInterface[]
120+
* @return \Generator<NodeInterface>
119121
*/
120-
public function recurseDocumentChildNodes(NodeInterface $node)
122+
public function recurseDocumentChildNodes(NodeInterface $node): \Generator
121123
{
122124
yield $node;
123125

124-
foreach ($node->getChildNodes('Neos.Neos:Document') as $node) {
125-
yield from $this->recurseDocumentChildNodes($node);
126+
foreach ($node->getChildNodes('Neos.Neos:Document') as $childNode) {
127+
yield from $this->recurseDocumentChildNodes($childNode);
126128
}
127129
}
128130

129-
}
131+
}

‎Classes/NodeEnumeration/NodeEnumerator.php‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ class NodeEnumerator
5050
*/
5151
protected $nodeTypeWhitelist;
5252

53-
54-
public function enumerateAndStoreInRedis(?Site $site, ContentReleaseLogger $contentReleaseLogger, ContentReleaseIdentifier $releaseIdentifier)
53+
public function enumerateAndStoreInRedis(?Site $site, ContentReleaseLogger $contentReleaseLogger, ContentReleaseIdentifier $releaseIdentifier): void
5554
{
5655
$contentReleaseLogger->info('Starting content release', ['contentReleaseIdentifier' => $releaseIdentifier->jsonSerialize()]);
5756

@@ -61,7 +60,7 @@ public function enumerateAndStoreInRedis(?Site $site, ContentReleaseLogger $cont
6160
$this->redisContentReleaseService->setContentReleaseMetadata($releaseIdentifier, $newMetadata, RedisInstanceIdentifier::primary());
6261

6362
$this->redisEnumerationRepository->clearDocumentNodesEnumeration($releaseIdentifier);
64-
foreach (GeneratorUtility::createArrayBatch($this->enumerateAll($site, $contentReleaseLogger), 100) as $enumeration) {
63+
foreach (GeneratorUtility::createArrayBatch($this->enumerateAll($site, $contentReleaseLogger, $newMetadata->getWorkspaceName()), 100) as $enumeration) {
6564
$this->concurrentBuildLockService->assertNoOtherContentReleaseWasStarted($releaseIdentifier);
6665
// $enumeration is an array of EnumeratedNode, with at most 100 elements in it.
6766
// TODO: EXTENSION POINT HERE, TO ADD ADDITIONAL ENUMERATIONS (.metadata.json f.e.)
@@ -71,22 +70,20 @@ public function enumerateAndStoreInRedis(?Site $site, ContentReleaseLogger $cont
7170
}
7271

7372
/**
74-
* @param Site $site
75-
* @param ContentReleaseLogger $contentReleaseLogger
7673
* @return iterable<EnumeratedNode>
7774
*/
78-
private function enumerateAll(?Site $site, ContentReleaseLogger $contentReleaseLogger): iterable
75+
private function enumerateAll(?Site $site, ContentReleaseLogger $contentReleaseLogger, string $workspaceName): iterable
7976
{
8077
$combinator = new NodeContextCombinator();
8178

8279
$nodeTypeWhitelist = $this->nodeTypeConstraintFactory->parseFilterString($this->nodeTypeWhitelist);
8380

84-
$queueSite = function (Site $site) use ($combinator, &$documentNodeVariantsToRender, $nodeTypeWhitelist, $contentReleaseLogger) {
81+
$queueSite = function (Site $site) use ($combinator, &$documentNodeVariantsToRender, $nodeTypeWhitelist, $contentReleaseLogger, $workspaceName) {
8582
$contentReleaseLogger->debug('Publishing site', [
8683
'name' => $site->getName(),
8784
'domain' => $site->getFirstActiveDomain()
8885
]);
89-
foreach ($combinator->siteNodeInContexts($site) as $siteNode) {
86+
foreach ($combinator->siteNodeInContexts($site, $workspaceName) as $siteNode) {
9087
$dimensionValues = $siteNode->getContext()->getDimensions();
9188

9289
$contentReleaseLogger->debug('Publishing dimension combination', [
@@ -113,7 +110,6 @@ private function enumerateAll(?Site $site, ContentReleaseLogger $contentReleaseL
113110
}
114111
};
115112

116-
117113
if ($site === null) {
118114
foreach ($combinator->sites() as $site) {
119115
yield from $queueSite($site);

‎Classes/NodeRendering/Extensibility/NodeRenderingExtensionManager.php‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,18 +79,21 @@ public function addRenderedDocumentToContentRelease(ContentReleaseIdentifier $co
7979
}
8080
}
8181

82-
static private function instantiateExtensions(array $configuration, string $extensionInterfaceName): array
82+
private static function instantiateExtensions(array $configuration, string $extensionInterfaceName): array
8383
{
84-
$instanciatedExtensions = [];
84+
$instantiatedExtensions = [];
8585
foreach ($configuration as $extensionConfig) {
86+
if (!is_array($extensionConfig)) {
87+
continue;
88+
}
8689
$className = $extensionConfig['className'];
8790
$instance = new $className();
8891
if (!($instance instanceof $extensionInterfaceName)) {
8992
throw new \RuntimeException('Extension ' . get_class($instance) . ' does not implement ' . $extensionInterfaceName);
9093
}
91-
$instanciatedExtensions[] = $instance;
94+
$instantiatedExtensions[] = $instance;
9295

9396
}
94-
return $instanciatedExtensions;
97+
return $instantiatedExtensions;
9598
}
96-
}
99+
}

0 commit comments

Comments
 (0)