Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Http/Controllers/ReleasesController.php
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ public function unschedule(Release $release, Request $request): Response
*/
public function publishModal(Release $release, Request $request): JsonResponse
{
abort_unless(Gate::check('publishReleases') && $release->status->isEditable(), Response::HTTP_FORBIDDEN);
abort_unless(Gate::check('publishReleases') && $release->status->canTransitionTo(ReleaseStatus::Publishing), Response::HTTP_FORBIDDEN);

$viewModel = app(ReleaseViewModel::class, [
'release' => $release,
Expand Down
2 changes: 1 addition & 1 deletion src/Http/ViewModels/ReleaseViewModel.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public function release(): ReleaseDetailData
canManage: $canManage,
canSchedule: $canPublish && $this->actor->can('schedule', $this->release),
canPublish: $canPublish,
canUnschedule: $this->release->status === ReleaseStatus::Scheduled
canUnschedule: $this->release->status->canTransitionTo(ReleaseStatus::Draft)
&& $this->actor->can('publishReleases'),
);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Mcp/Capabilities/Releases.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ public function list(#[Schema(definition: self::CriteriaSchema)] array $criteria
}

/** @return array{release: array<string, mixed>} */
#[McpTool(name: 'releases_get', description: 'Reads a release and basic member metadata across sites. Content fields require drafts_get and content view permission.', annotations: new ToolAnnotations(readOnlyHint: true))]
#[McpTool(name: 'releases_get', description: 'Reads a release and basic member metadata across sites. A scheduled release’s publishedAt is the future time it will publish. Content fields require drafts_get and content view permission.', annotations: new ToolAnnotations(readOnlyHint: true))]
public function get(#[Schema(minimum: 1)] int $id): array
{
return ['release' => $this->serializer->serialize($this->release($id))];
Expand Down
17 changes: 17 additions & 0 deletions src/Release/Enums/ReleaseStatus.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,23 @@ public function color(): Color
};
}

/**
* Whether a release can move from this status to the given one.
*
* Publishing runs in a transaction that rolls back when publication fails, so a failed
* attempt moves the release to Failed from the status it had before publishing.
*/
public function canTransitionTo(self $status): bool
{
return match ($this) {
self::Draft => in_array($status, [self::Scheduled, self::Publishing, self::Failed], true),
self::Scheduled => in_array($status, [self::Draft, self::Publishing, self::Failed], true),
self::Failed => in_array($status, [self::Scheduled, self::Publishing, self::Failed], true),
self::Publishing => in_array($status, [self::Published, self::Failed], true),
self::Published => false,
};
}

public function isMutable(): bool
{
return in_array($this, [self::Draft, self::Failed], true);
Expand Down
32 changes: 32 additions & 0 deletions src/Release/Models/Release.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Carbon;
use LogicException;
use RuntimeException;

/**
* @property int $id
Expand Down Expand Up @@ -53,6 +55,36 @@ public function schedulingUser(): BelongsTo
return $this->belongsTo(User::class, 'scheduledById');
}

/**
* Moves the release to a new status, and saves any other given attributes with it.
*
* @param array<string, mixed> $attributes
*
* @throws LogicException if the release can't move from its current status to the given one
* @throws RuntimeException if another request changed the release's status first
*/
public function transitionTo(ReleaseStatus $status, array $attributes = []): void
{
$currentStatus = $this->status;

if (! $currentStatus->canTransitionTo($status)) {
throw new LogicException("Release {$this->getKey()} cannot transition from {$currentStatus->value} to {$status->value}.");
}

$this->forceFill([...$attributes, 'status' => $status]);

$updated = static::query()
->whereKey($this->getKey())
->where('status', $currentStatus)
->update($this->getDirty());

if ($updated !== 1) {
throw new RuntimeException("Release {$this->getKey()} was changed concurrently.");
}

$this->refresh();
}

#[\Override]
protected function casts(): array
{
Expand Down
4 changes: 2 additions & 2 deletions src/Release/Policies/ReleasePolicy.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ public function detach(CraftUser $actor, Release $release, ElementInterface $dra
public function publish(CraftUser $actor, Release $release): bool
{
return $actor->can('publishReleases')
&& $release->status->isEditable()
&& $release->status->canTransitionTo(ReleaseStatus::Publishing)
&& $release->items()->exists();
}

public function schedule(CraftUser $actor, Release $release): bool
{
return $release->status->isMutable() && $this->publish($actor, $release);
return $release->status->canTransitionTo(ReleaseStatus::Scheduled) && $this->publish($actor, $release);
}

public function publishDraft(CraftUser $actor, ElementInterface $draft): bool
Expand Down
97 changes: 67 additions & 30 deletions src/Release/Releases.php
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,9 @@ public function schedule(Release $release, DateTimeInterface $publishAt, CraftUs

return DB::transaction(function () use ($release, $publishAt, $actor): Release {
$release = $this->lockRelease($release->id);
$this->ensureMutable($release);
if (! $release->status->canTransitionTo(ReleaseStatus::Scheduled)) {
throw new ReleaseException(t('Scheduled and completed releases cannot be changed.'));
}
$items = $this->lockReleaseDrafts($release);
if (! $actor->can('publishReleases')) {
throw new ReleaseException(t('You are not allowed to schedule releases.'), Response::HTTP_FORBIDDEN);
Expand All @@ -322,10 +324,9 @@ public function schedule(Release $release, DateTimeInterface $publishAt, CraftUs
throw new ReleaseException(t('The release is not ready to be scheduled.'));
}

$release->update([
$release->transitionTo(ReleaseStatus::Scheduled, [
'publishedAt' => $publishAt,
'scheduledById' => $actor->getCraftUserId(),
'status' => ReleaseStatus::Scheduled,
'lastError' => null,
]);

Expand All @@ -339,14 +340,13 @@ public function unschedule(Release $release, CraftUser $actor): Release

return DB::transaction(function () use ($release): Release {
$release = $this->lockRelease($release->id);
if ($release->status !== ReleaseStatus::Scheduled) {
if (! $release->status->canTransitionTo(ReleaseStatus::Draft)) {
throw new ReleaseException(t('Only scheduled releases can be unscheduled.'));
}

$release->update([
$release->transitionTo(ReleaseStatus::Draft, [
'publishedAt' => null,
'scheduledById' => null,
'status' => ReleaseStatus::Draft,
'lastError' => null,
]);

Expand Down Expand Up @@ -435,17 +435,43 @@ public function publishAheadOfRelease(int $releaseId, ElementInterface $draft, C

private function publishRelease(Release $release, bool $scheduledExecution, ?CraftUser $actor = null): Release
{
[$publishedRelease, $failedRelease, $publicationFailure] = DB::transaction(function () use ($release, $scheduledExecution, $actor): array {
$release = $this->lockRelease($release->id);
$allowedStatuses = $scheduledExecution
? [ReleaseStatus::Scheduled]
: [ReleaseStatus::Draft, ReleaseStatus::Scheduled, ReleaseStatus::Failed];
try {
[$publishedRelease, $failedRelease, $publicationFailure] = $this->publishReleaseInTransaction($release, $scheduledExecution, $actor);
} catch (Throwable $exception) {
$this->failStrandedPublication($release->id, $exception);

if (! in_array($release->status, $allowedStatuses, true)) {
if ($scheduledExecution) {
throw new ReleaseNotDue(t('The release is no longer scheduled.'));
}
throw $exception;
}

if ($publicationFailure instanceof Throwable) {
$this->notifyPublicationFailure($failedRelease, $publicationFailure);

throw $publicationFailure;
}

try {
event(new ReleasePublished($publishedRelease));
} catch (Throwable $exception) {
report($exception);
}

return $publishedRelease;
}

/**
* Publishes the release inside a transaction. If a draft fails to publish, the release moves to Failed.
*
* @return array{Release|null, Release|null, Throwable|null} the published release, or the failed release and its error
*/
private function publishReleaseInTransaction(Release $release, bool $scheduledExecution, ?CraftUser $actor): array
{
return DB::transaction(function () use ($release, $scheduledExecution, $actor): array {
$release = $this->lockRelease($release->id);
if ($scheduledExecution && $release->status !== ReleaseStatus::Scheduled) {
throw new ReleaseNotDue(t('The release is no longer scheduled.'));
}

if (! $release->status->canTransitionTo(ReleaseStatus::Publishing)) {
throw new ReleaseException(t('This release cannot be published in its current state.'));
}

Expand Down Expand Up @@ -477,29 +503,40 @@ private function publishRelease(Release $release, bool $scheduledExecution, ?Cra
}

$release->refresh();
$release->update([
'status' => ReleaseStatus::Failed,
$release->transitionTo(ReleaseStatus::Failed, [
'lastError' => $exception->getMessage(),
'publishAttempts' => $release->publishAttempts + 1,
]);

return [null, $release->refresh(), $exception];
}
}, 3);
}

if ($publicationFailure instanceof Throwable) {
$this->notifyPublicationFailure($failedRelease, $publicationFailure);
/**
* Moves a release that's still publishing to Failed after its publication threw.
*
* Publishing is normally set and resolved in one transaction, so it's never committed. When something commits
* the transaction early, such as a MySQL statement with an implicit commit, the release would otherwise stay
* Publishing, and nothing can publish, schedule or delete a release in that status.
*/
private function failStrandedPublication(int $releaseId, Throwable $exception): void
{
$release = Release::query()->find($releaseId);

throw $publicationFailure;
if ($release?->status !== ReleaseStatus::Publishing) {
return;
}

try {
event(new ReleasePublished($publishedRelease));
} catch (Throwable $exception) {
report($exception);
$release->transitionTo(ReleaseStatus::Failed, ['lastError' => $exception->getMessage()]);
} catch (Throwable $transitionException) {
report($transitionException);

return;
}

return $publishedRelease;
$this->notifyPublicationFailure($release, $exception);
}

/** @param Collection<int, ReleaseItem> $items */
Expand All @@ -511,8 +548,7 @@ private function executePublication(Release $release, Collection $items): Releas
throw new ReleaseException(t('The release has no drafts.'));
}

$release->update([
'status' => ReleaseStatus::Publishing,
$release->transitionTo(ReleaseStatus::Publishing, [
'lastError' => null,
'publishAttempts' => $release->publishAttempts + 1,
]);
Expand Down Expand Up @@ -544,8 +580,7 @@ private function executePublication(Release $release, Collection $items): Releas
}
});

$release->update([
'status' => ReleaseStatus::Published,
$release->transitionTo(ReleaseStatus::Published, [
'publishedAt' => now(),
'lastError' => null,
]);
Expand Down Expand Up @@ -830,9 +865,11 @@ private function ensureEditable(Release $release): void
/** Returns a scheduled release to a draft once it has no drafts left to publish. */
private function unscheduleIfEmpty(Release $release): void
{
// Deleting a draft can already have unscheduled the release through withElementDeletion()
$release->refresh();

if ($release->status === ReleaseStatus::Scheduled && ! $release->items()->exists()) {
$release->update([
'status' => ReleaseStatus::Draft,
$release->transitionTo(ReleaseStatus::Draft, [
'publishedAt' => null,
'scheduledById' => null,
'lastError' => null,
Expand Down
14 changes: 14 additions & 0 deletions tests/Feature/Release/ReleasesTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
use CraftCms\Cms\Release\Enums\ReleaseStatus;
use CraftCms\Cms\Release\Events\ReleasePublished;
use CraftCms\Cms\Release\Exceptions\ReleaseException;
use CraftCms\Cms\Release\Models\Release;
use CraftCms\Cms\Release\Notifications\ReleaseFailed;
use CraftCms\Cms\Release\Releases;
use CraftCms\Cms\Section\Models\Section;
Expand Down Expand Up @@ -424,6 +425,19 @@
->and(EntryElement::find()->id($unscheduledDraft->getCanonicalId())->status(null)->one()->title)->toBe('Unscheduled original');
});

it('rejects a status change made from an outdated copy of a release', function () {
$release = $this->releases->create('Launch', null, $this->actor);
$outdated = Release::query()->findOrFail($release->id);

$release->transitionTo(ReleaseStatus::Scheduled, ['publishedAt' => now()->addDay()]);

expect(fn () => $outdated->transitionTo(ReleaseStatus::Publishing))
->toThrow(RuntimeException::class, 'changed concurrently')
->and(fn () => $release->transitionTo(ReleaseStatus::Scheduled))
->toThrow(LogicException::class, 'cannot transition from scheduled to scheduled')
->and($release->refresh()->status)->toBe(ReleaseStatus::Scheduled);
});

it('requires publication permission to cancel a scheduled release', function () {
Date::setTestNow('2026-10-01 12:00:00');

Expand Down
Loading