queue/src/Handlers/RedisHandler.php at develop · codeigniter4/queue · GitHub

History

268 lines (226 loc) · 8.39 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

<?php

declare(strict_types=1);

/**

* This file is part of CodeIgniter Queue.

* (c) CodeIgniter Foundation <admin@codeigniter.com>

* For the full copyright and license information, please view

* the LICENSE file that was distributed with this source code.

namespace CodeIgniter\Queue\Handlers;

use CodeIgniter\Autoloader\FileLocator;

use CodeIgniter\Exceptions\CriticalError;

use CodeIgniter\I18n\Time;

use CodeIgniter\Queue\Config\Queue as QueueConfig;

use CodeIgniter\Queue\Entities\QueueJob;

use CodeIgniter\Queue\Enums\Status;

use CodeIgniter\Queue\Events\QueueEventManager;

use CodeIgniter\Queue\Payloads\Payload;

use CodeIgniter\Queue\Payloads\PayloadMetadata;

use CodeIgniter\Queue\QueuePushResult;

use Redis;

use RedisException;

use RuntimeException;

use Throwable;

class RedisHandler extends BaseHandler

{

private readonly Redis $redis;

private readonly string $luaScript;

public function __construct(protected QueueConfig $config)

{

$this->redis = new Redis();

try {

if (! $this->redis->connect($config->redis['host'], ($config->redis['host'][0] === '/' ? 0 : $config->redis['port']), $config->redis['timeout'])) {

throw new CriticalError('Queue: Redis connection failed. Check your configuration.');

}

if (isset($config->redis['username'], $config->redis['password']) && ! $this->redis->auth([$config->redis['username'], $config->redis['password']])) {

throw new CriticalError('Queue: Redis authentication failed. Check your username and password.');

}

if (isset($config->redis['password']) && ! $this->redis->auth($config->redis['password'])) {

throw new CriticalError('Queue: Redis authentication failed. Check your password.');

}

if (isset($config->redis['database']) && ! $this->redis->select($config->redis['database'])) {

throw new CriticalError('Queue: Redis select database failed.');

}

if (isset($config->redis['prefix']) && ! $this->redis->setOption(Redis::OPT_PREFIX, $config->redis['prefix'])) {

throw new CriticalError('Queue: Redis setting prefix failed.');

}

$locator = new FileLocator(service('autoloader'));

$luaScript = $locator->locateFile('CodeIgniter\Queue\Lua\pop_task', null, 'lua');

if ($luaScript === false) {

throw new CriticalError('Queue: LUA script for Redis is not available.');

}

$this->luaScript = file_get_contents($luaScript);

// Emit connection established event

QueueEventManager::handlerConnectionEstablished(

handler: $this->name(),

config: $config->redis,

);

} catch (RedisException $e) {

// Emit connection failed event

QueueEventManager::handlerConnectionFailed(

handler: $this->name(),

exception: $e,

config: $config->redis,

);

throw new CriticalError('Queue: RedisException occurred with message (' . $e->getMessage() . ').');

}

/**

* Name of the handler.

public function name(): string

{

return 'redis';

}

/**

* Add job to the queue.

* @throws RedisException

public function push(string $queue, string $job, array $data, ?PayloadMetadata $metadata = null): QueuePushResult

{

$this->validateJobAndPriority($queue, $job);

helper('text');

$availableAt = Time::now()->addSeconds($this->delay ?? 0);

$jobId = (int) random_string('numeric', 16);

$queueJob = new QueueJob([

'id' => $jobId,

'queue' => $queue,

'payload' => new Payload($job, $data, $metadata),

'priority' => $this->priority,

'status' => Status::PENDING->value,

'attempts' => 0,

'available_at' => $availableAt,

]);

try {

$result = $this->redis->zAdd("queues:{$queue}:{$this->priority}", $availableAt->timestamp, json_encode($queueJob));

} catch (Throwable $e) {

// Emit push failed event

QueueEventManager::jobPushFailed(

handler: $this->name(),

queue: $queue,

jobClass: $job,

exception: $e,

);

return QueuePushResult::failure('Unexpected Redis error: ' . $e->getMessage());

} finally {

$this->priority = $this->delay = null;

}

if ($result === false) {

$error = new RuntimeException('Failed to add job to Redis.');

QueueEventManager::jobPushFailed(

handler: $this->name(),

queue: $queue,

jobClass: $job,

exception: $error,

);

return QueuePushResult::failure($error->getMessage());

}

if ((int) $result > 0) {

// Emit job pushed event

QueueEventManager::jobPushed(

handler: $this->name(),

queue: $queue,

job: $queueJob,

);

return QueuePushResult::success($jobId);

}

$error = new RuntimeException('Job already exists in the queue.');

QueueEventManager::jobPushFailed(

handler: $this->name(),

queue: $queue,

jobClass: $job,

exception: $error,

);

return QueuePushResult::failure($error->getMessage());

}

/**

* Get job from the queue.

* @throws RedisException

public function pop(string $queue, array $priorities): ?QueueJob

{

$now = Time::now()->timestamp;

// Prepare the arguments for the Lua script

$args = [

'queues:' . $queue, // KEYS[1]

$now, // ARGV[2]

json_encode($priorities), // ARGV[3]

];

// Execute the Lua script

$task = $this->redis->eval($this->luaScript, $args, 1);

if ($task === false) {

return null;

}

$queueJob = new QueueJob(json_decode((string) $task, true));

// Set the actual status as in DB.

$queueJob->status = Status::RESERVED->value;

$queueJob->syncOriginal();

$this->redis->hSet("queues:{$queue}::reserved", (string) $queueJob->id, json_encode($queueJob));

return $queueJob;

}

/**

* Schedule job for later

* @throws RedisException

public function later(QueueJob $queueJob, int $seconds): bool

{

$queueJob->status = Status::PENDING->value;

$queueJob->available_at = Time::now()->addSeconds($seconds);

$result = (int) $this->redis->zAdd(

"queues:{$queueJob->queue}:{$queueJob->priority}",

$queueJob->available_at->timestamp,

json_encode($queueJob),

);

if ($result !== 0) {

$this->redis->hDel("queues:{$queueJob->queue}::reserved", (string) $queueJob->id);

}

return $result > 0;

}

/**

* Move job to failed table or move and delete.

public function failed(QueueJob $queueJob, Throwable $err, bool $keepJob): bool

{

if ($keepJob) {

$this->logFailed($queueJob, $err);

}

return (bool) $this->redis->hDel("queues:{$queueJob->queue}::reserved", (string) $queueJob->id);

}

/**

* Change job status to DONE or delete it.

* @throws RedisException

public function done(QueueJob $queueJob): bool

{

return (bool) $this->redis->hDel("queues:{$queueJob->queue}::reserved", (string) $queueJob->id);

}

/**

* Delete queue jobs

* @throws RedisException

public function clear(?string $queue = null): bool

{

if ($queue !== null) {

$result = ($keys = $this->redis->keys("queues:{$queue}:*")) ? (int) $this->redis->del($keys) > 0 : true;

} elseif ($keys = $this->redis->keys('queues:*')) {

$result = (int) $this->redis->del($keys) > 0;

} else {

$result = true;

}

if ($result) {

// Emit queue cleared event

QueueEventManager::queueCleared(

handler: $this->name(),

queue: $queue,

);

}

return $result;

}

queue/src/Handlers/RedisHandler.php at develop · codeigniter4/queue · GitHub

Uh oh!

Expand file tree

Breadcrumbs

RedisHandler.php

Latest commit

History

Breadcrumbs

RedisHandler.php

File metadata and controls