Skip to content

Improve update error log cases #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2025
Merged

Improve update error log cases #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 23 additions & 11 deletions app/Jobs/UpdateSite.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,13 @@ public function handle(): void
// Notify users
$connection->notificationSuccess(["fromVersion" => $healthResult->cms_version, "toVersion" => $this->targetVersion]);

// Done, log successful update!
$this->site->updates()->create([
'old_version' => $this->site->cms_version,
'new_version' => $this->targetVersion,
'result' => true
]);

// Trigger site health check to write the update version back to the db
CheckSiteHealth::dispatch($this->site);
}
Expand Down Expand Up @@ -193,13 +200,6 @@ protected function performExtraction(PrepareUpdate $prepareResult): void
"task" => "finalizeUpdate"
]
);

// Done, log successful update!
$this->site->updates()->create([
'old_version' => $this->site->cms_version,
'new_version' => $this->targetVersion,
'result' => true
]);
}

public function failed(\Exception $exception): void
Expand All @@ -212,17 +212,29 @@ public function failed(\Exception $exception): void
/** @var Connection $connection */
$connection = $this->site->connection;

// Get base execption information
$failedStep = $exception instanceof UpdateException ? $exception->getStep() : null;
$failedMessage = $exception->getMessage();
$failedTrace = $exception->getTraceAsString();

// Notify users
$connection->notificationFailed(["fromVersion" => $this->site->cms_version, "toVersion" => $this->targetVersion]);
try {
$connection->notificationFailed(["fromVersion" => $this->site->cms_version, "toVersion" => $this->targetVersion]);
} catch (\Throwable $e) {
// If the notification fails, we have to catch the exception and combine both errors into a combined result
$failedStep .= " + notificationFailed";
$failedMessage .= " + " . $e->getMessage();
$failedTrace .= " + " . $e->getTraceAsString();
}

// We log any issues during the update to the DB
$this->site->updates()->create([
'old_version' => $this->site->cms_version,
'new_version' => $this->targetVersion,
'result' => false,
'failed_step' => $exception instanceof UpdateException ? $exception->getStep() : null,
'failed_message' => $exception->getMessage(),
'failed_trace' => $exception->getTraceAsString()
'failed_step' => $failedStep,
'failed_message' => $failedMessage,
'failed_trace' => $failedTrace
]);
}
}