Skip to content

Extra column in database for parameters in json format #60

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
thorewi merged 1 commit into from
Dec 9, 2025
Merged

Extra column in database for parameters in json format #60

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"doctrine/dbal": "^2.0|^3.0|^4.0",
"symfony/console": "^4.0|^5.0|^6.0",
"psr/log": "^1.0|^2.0|^3.0",
"adt/utils": "^2.10",
"adt/utils": "^2.14",
"adt/command-lock": "^1.1"
},
"autoload": {
Expand Down
5 changes: 3 additions & 2 deletions src/BackgroundQueue.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public function __construct(array $config)
$config['bulkSize'] = 1;
}
if (!isset($config['parametersFormat'])) {
$config['parametersFormat'] = BackgroundJob::PARAMETERS_FORMAT_SERIALIZE;
$config['parametersFormat'] = BackgroundJob::PARAMETERS_FORMAT_JSON;
}
if (!in_array($config['parametersFormat'], BackgroundJob::PARAMETERS_FORMATS, true)) {
throw new Exception('Unsupported parameters format: ' . $config['parametersFormat']);
Expand Down Expand Up @@ -691,7 +691,8 @@ public function updateSchema(bool $force = false): void
$table->addColumn('queue', Types::STRING, ['length' => 255])->setNotnull(true);
$table->addColumn('priority', Types::INTEGER)->setNotnull(false);
$table->addColumn('callback_name', Types::STRING, ['length' => 255])->setNotnull(true);
$table->addColumn('parameters', Types::BLOB)->setNotnull(true);
$table->addColumn('parameters', Types::BLOB)->setNotnull(false);
$table->addColumn('parameters_json', Types::JSON)->setNotnull(false);
$table->addColumn('state', Types::SMALLINT)->setNotnull(true);
$table->addColumn('created_at', Types::DATETIME_IMMUTABLE)->setNotnull(true);
$table->addColumn('last_attempt_at', Types::DATETIME_IMMUTABLE)->setNotnull(false);
Expand Down
37 changes: 27 additions & 10 deletions src/Entity/BackgroundJob.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace ADT\BackgroundQueue\Entity;

use ADT\Utils\Utils;
use DateTime;
use DateTimeImmutable;
use Exception;
Expand Down Expand Up @@ -44,6 +45,7 @@ final class BackgroundJob
private ?int $priority;
private string $callbackName;
private $parameters; /** @see self::setParameters() */
private $parameters_json = null; /** @see self::setParameters() */
private int $state = self::STATE_READY;
private DateTimeImmutable $createdAt;
private ?DateTimeImmutable $lastAttemptAt = null;
Expand Down Expand Up @@ -134,19 +136,26 @@ public function setSerialGroup(?string $serialGroup): self
public function getParameters(): array
{
$this->parameters = is_resource($this->parameters) ? stream_get_contents($this->parameters) : $this->parameters;
if (substr($this->parameters, 0, 2) === 'a:') {

if (!is_null($this->parameters)) {
return unserialize($this->parameters);
}

return json_decode($this->parameters, true);
$parametersJson = json_decode($this->parameters_json, true);
$parameters = [];
foreach ($parametersJson as $key => $value) {
$parameters[$key] = Utils::getDateTimeFromArray($value, true);
}
return $parameters;
}

/**
* Parametry ukládá jako serializované pole nebo jako json.
* Formát určuje parametr v BackgroundQueue `parametersFormat`.
* - `serialize` => ukládá jako serializované pole a je bez omezení
* - `json` => parametry mohou obsahovat pouze skalární typy, pole a NULL
* - `json` => ukládá jako json
* - parametry mohou obsahovat pouze skalární typy, pole, NULL a \DateTimeInterface
* - pokud je nějaký z parametrů objekt, automaticky se použije "serialize"
*
* @param object|array|string|int|float|bool|null $parameters
* @param string $parametersFormat
Expand All @@ -156,17 +165,23 @@ public function setParameters($parameters, string $parametersFormat): self
{
$parameters = is_array($parameters) ? $parameters : [$parameters];

if ($parametersFormat == self::PARAMETERS_FORMAT_JSON) {
foreach ($parameters as $parameter) {
if (!is_scalar($parameter) && !is_array($parameter) && !is_null($parameter) && !($parameter instanceof \DateTimeInterface)) {
$parametersFormat = self::PARAMETERS_FORMAT_SERIALIZE;
break;
}
}
}

switch ($parametersFormat) {
case self::PARAMETERS_FORMAT_SERIALIZE:
$this->parameters = serialize($parameters);
$this->parameters_json = null;
break;
case self::PARAMETERS_FORMAT_JSON:
foreach ($parameters as $idx => $parameter) {
if (!is_scalar($parameter) && !is_array($parameter) && !is_null($parameter)) {
throw new Exception("Unsupported type '" . gettype($parameter) . "' for \$parameters[$idx] using parametersFormat = " . self::PARAMETERS_FORMAT_JSON);
}
}
$this->parameters = json_encode($parameters);
$this->parameters = null;
$this->parameters_json = json_encode($parameters);
break;
default:
throw new Exception("Unsupported parameters format: $parametersFormat");
Expand Down Expand Up @@ -327,6 +342,7 @@ public static function createEntity(array $values): self
$entity->priority = $values['priority'];
$entity->callbackName = $values['callback_name'];
$entity->parameters = $values['parameters'];
$entity->parameters_json = $values['parameters_json'];
$entity->state = $values['state'];
$entity->createdAt = new DateTimeImmutable($values['created_at']);
$entity->lastAttemptAt = $values['last_attempt_at'] ? new DateTimeImmutable($values['last_attempt_at']) : null;
Expand All @@ -353,6 +369,7 @@ public function getDatabaseValues(): array
'priority' => $this->priority,
'callback_name' => $this->callbackName,
'parameters' => $this->parameters,
'parameters_json' => $this->parameters_json,
'state' => $this->state,
'created_at' => $this->createdAt->format('Y-m-d H:i:s'),
'last_attempt_at' => $this->lastAttemptAt ? $this->lastAttemptAt->format('Y-m-d H:i:s') : null,
Expand Down