Skip to content

Unique key for wcf1_background_job.identifier #6348

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
Cyperghost merged 3 commits into from
Jun 19, 2025
Merged

Unique key for wcf1_background_job.identifier #6348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2fde953
Add unique index for background job identifier
Cyperghost Jun 13, 2025
89f271e
Use `INSERT IGNORE` to handle conflicts gracefully.
Cyperghost Jun 13, 2025
4151fb6
Because of `INSERT IGNORE INTO`, filtering unique jobs already in the…
Cyperghost Jun 18, 2025
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
1 change: 1 addition & 0 deletions com.woltlab.wcf/package.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@

<!--
Required order of the following steps for the update to 6.2:
<instruction type="script">acp/update_com.woltlab.wcf_6.2_backgroundJob.php</instruction>
<instruction type="database" run="standalone">acp/database/update_com.woltlab.wcf_62_step1.php</instruction>
<instruction type="script">acp/update_com.woltlab.wcf_6.2_contactOptions.php</instruction>
<instruction type="database" run="standalone">acp/database/update_com.woltlab.wcf_62_step2.php</instruction>
Expand Down
9 changes: 7 additions & 2 deletions wcfsetup/install/files/acp/database/update_com.woltlab.wcf_6.2_step1.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,17 @@

use wcf\system\database\table\column\IntDatabaseTableColumn;
use wcf\system\database\table\column\MediumtextDatabaseTableColumn;
use wcf\system\database\table\column\TextDatabaseTableColumn;
use wcf\system\database\table\column\TinyintDatabaseTableColumn;
use wcf\system\database\table\index\DatabaseTableForeignKey;
use wcf\system\database\table\index\DatabaseTableIndex;
use wcf\system\database\table\PartialDatabaseTable;

return [
PartialDatabaseTable::create('wcf1_background_job')
->indices([
DatabaseTableIndex::create('identifier')
->type(DatabaseTableIndex::UNIQUE_TYPE)
->columns(['identifier']),
]),
PartialDatabaseTable::create('wcf1_user')
->columns([
IntDatabaseTableColumn::create('avatarFileID')
Expand Down
21 changes: 21 additions & 0 deletions wcfsetup/install/files/acp/update_com.woltlab.wcf_6.2_backgroundJob.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

/**
* This script removes duplicate background jobs.
*/

use wcf\system\WCF;

$sql = "DELETE background_jobs
FROM wcf1_background_job background_jobs
JOIN (
SELECT MIN(jobID) as keepID, identifier
FROM wcf1_background_job
WHERE identifier IS NOT NULL
GROUP BY identifier
HAVING COUNT(*) > 1
) AS duplicates
ON background_jobs.identifier = duplicates.identifier
WHERE background_jobs.jobID <> duplicates.keepID";
$statement = WCF::getDB()->prepare($sql);
$statement->execute();
40 changes: 4 additions & 36 deletions wcfsetup/install/files/lib/system/background/BackgroundQueueHandler.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
use wcf\data\user\User;
use wcf\system\background\job\AbstractBackgroundJob;
use wcf\system\background\job\AbstractUniqueBackgroundJob;
use wcf\system\database\util\PreparedStatementConditionBuilder;
use wcf\system\exception\ParentClassException;
use wcf\system\session\SessionHandler;
use wcf\system\SingletonFactory;
Expand Down Expand Up @@ -73,48 +72,17 @@ public function enqueueAt(AbstractBackgroundJob|array $jobs, int $time): void
$jobs = [$jobs];
}

$identifiers = [];
foreach ($jobs as $job) {
if (!($job instanceof AbstractBackgroundJob)) {
throw new ParentClassException(\get_class($job), AbstractBackgroundJob::class);
}

if ($job instanceof AbstractUniqueBackgroundJob) {
$identifiers[] = $job->identifier();
}
}

if ($identifiers !== []) {
$conditions = new PreparedStatementConditionBuilder();
$conditions->add("identifier IN (?)", [$identifiers]);

$sql = "SELECT DISTINCT identifier
FROM wcf1_background_job
{$conditions}";
$statement = WCF::getDB()->prepare($sql);
$statement->execute($conditions->getParameters());
$existingJobs = $statement->fetchAll(\PDO::FETCH_COLUMN);

$jobs = \array_filter(
$jobs,
function ($job) use ($existingJobs) {
if ($job instanceof AbstractUniqueBackgroundJob && \in_array($job->identifier(), $existingJobs)) {
return false;
}

return true;
}
);

if ($jobs === []) {
return;
}
}

$sql = "INSERT INTO wcf1_background_job
(job, time, identifier)
VALUES (?, ?, ?)";
$sql = "INSERT IGNORE INTO wcf1_background_job
(job, time, identifier)
VALUES (?, ?, ?)";
$statement = WCF::getDB()->prepare($sql);

foreach ($jobs as $job) {
$identifier = null;
if ($job instanceof AbstractUniqueBackgroundJob) {
Expand Down
2 changes: 1 addition & 1 deletion wcfsetup/setup/db/install.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ CREATE TABLE wcf1_background_job (
time INT(10) NOT NULL,
identifier VARCHAR(191) NULL,

KEY identifier (identifier),
UNIQUE KEY identifier (identifier),
KEY (status, time)
);

Expand Down
Loading