1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
|
import calendar
import logging
import time
import traceback
import warnings
from datetime import datetime, timedelta, timezone
from typing import TYPE_CHECKING, Any, Optional, Union, cast
from rq.serializers import resolve_serializer
from .defaults import DEFAULT_FAILURE_TTL
from .exceptions import AbandonedJobError, InvalidJobOperation, NoSuchJobError
from .job import Job, JobStatus
from .queue import Queue
from .timeouts import BaseDeathPenalty, UnixSignalDeathPenalty
from .utils import as_text, backend_class, current_timestamp, now, parse_composite_key
if TYPE_CHECKING:
from redis import Redis
from redis.client import Pipeline
from rq.executions import Execution
from rq.serializers import Serializer
logger = logging.getLogger('rq.registry')
class BaseRegistry:
"""
Base implementation of a job registry, implemented in Redis sorted set.
Each job is stored as a key in the registry, scored by expiration time
(unix timestamp).
"""
job_class = Job
death_penalty_class = UnixSignalDeathPenalty
key_template = 'rq:registry:{0}'
def __init__(
self,
name: str = 'default',
connection: Optional['Redis'] = None,
job_class: Optional[type['Job']] = None,
queue: Optional['Queue'] = None,
serializer: Optional[Union['Serializer', str]] = None,
death_penalty_class: Optional[type[BaseDeathPenalty]] = None,
):
if queue:
self.name = queue.name
self.connection = queue.connection
self.serializer = queue.serializer
else:
self.name = name
self.connection = connection # type: ignore[assignment]
self.serializer = resolve_serializer(serializer)
self.key = self.key_template.format(self.name)
self.job_class = job_class if job_class else Job
self.death_penalty_class = backend_class(self, 'death_penalty_class', override=death_penalty_class) # type: ignore[assignment]
def __len__(self):
"""Returns the number of jobs in this registry"""
return self.count
def __eq__(self, other):
return (
self.name == other.name
and self.connection.connection_pool.connection_kwargs == other.connection.connection_pool.connection_kwargs
)
def __contains__(self, item: Any) -> bool:
"""
Returns a boolean indicating registry contains the given
job instance or job id.
Args:
item (Union[str, Job]): A Job ID or a Job.
"""
job_id = item
if isinstance(item, self.job_class):
job_id = item.id
return self.connection.zscore(self.key, cast(str, job_id)) is not None
@property
def count(self) -> int:
"""Returns the number of jobs in this registry after running cleanup
Returns:
int: _description_
"""
return self.get_job_count(cleanup=True)
def get_job_count(self, cleanup=True) -> int:
"""Returns the number of jobs in this registry after optional cleanup.
Args:
cleanup (bool, optional): _description_. Defaults to True.
Returns:
int: _description_
"""
if cleanup:
self.cleanup()
return self.connection.zcard(self.key)
def add(self, job: Job, ttl: int = 0, pipeline: Optional['Pipeline'] = None, xx: bool = False) -> int:
"""Adds a job to a registry with expiry time of now + ttl, unless it's -1 which is set to +inf
Args:
job (Job): The Job to add, or job_id.
ttl (int, optional): The time to live. Defaults to 0.
pipeline (Optional['Pipeline'], optional): The Redis Pipeline. Defaults to None.
xx (bool, optional): .... Defaults to False.
Returns:
result (int): The ZADD command result
"""
score: Union[int, str] = ttl if ttl < 0 else current_timestamp() + ttl
if score == -1:
score = '+inf'
if pipeline is not None:
return cast(int, pipeline.zadd(self.key, {job.id: score}, xx=xx))
return self.connection.zadd(self.key, {job.id: score}, xx=xx)
def remove(self, job: Union[Job, str], pipeline: Optional['Pipeline'] = None, delete_job: bool = False):
"""Removes job from registry and deletes it if `delete_job == True`
Args:
job (Job|str): The Job to remove from the registry, or job_id
pipeline (Pipeline|None): The Redis Pipeline. Defaults to None.
delete_job (bool, optional): If should delete the job.. Defaults to False.
"""
connection = pipeline if pipeline is not None else self.connection
job_id = job.id if isinstance(job, self.job_class) else job
result = connection.zrem(self.key, job_id)
if delete_job:
if isinstance(job, self.job_class):
job_instance = job
else:
job_instance = Job.fetch(job_id, connection=connection, serializer=self.serializer)
job_instance.delete()
return result
def get_expired_job_ids(self, timestamp: Optional[float] = None):
"""Returns job ids whose score are less than current timestamp.
Returns ids for jobs with an expiry time earlier than timestamp,
specified as seconds since the Unix epoch. timestamp defaults to call
time if unspecified.
"""
score = timestamp if timestamp is not None else current_timestamp()
expired_jobs = self.connection.zrangebyscore(self.key, 0, score)
return [self.parse_job_id(job_id) for job_id in expired_jobs]
def get_job_ids(self, start: int = 0, end: int = -1, desc: bool = False, cleanup: bool = True) -> list[str]:
"""Returns list of all job ids.
Args:
start (int, optional): start rank. Defaults to 0.
end (int, optional): end rank. Defaults to -1.
desc (bool, optional): sort in reversed order. Defaults to False.
cleanup (bool, optional): whether to perform the cleanup. Defaults to True.
Returns:
List[str]: list of the job ids in the registry
"""
if cleanup:
self.cleanup()
return [self.parse_job_id(job_id) for job_id in self.connection.zrange(self.key, start, end, desc=desc)]
def get_queue(self):
"""Returns Queue object associated with this registry."""
return Queue(self.name, connection=self.connection, serializer=self.serializer)
def get_expiration_time(self, job: 'Job') -> datetime:
"""Returns job's expiration time.
Args:
job (Job): The Job to get the expiration
"""
score = self.connection.zscore(self.key, job.id)
return datetime.fromtimestamp(score, timezone.utc) # type: ignore[arg-type]
def requeue(self, job_or_id: Union['Job', str], at_front: bool = False) -> 'Job':
"""Requeues the job with the given job ID.
Args:
job_or_id (Union['Job', str]): The Job or the Job ID
at_front (bool, optional): If the Job should be put at the front of the queue. Defaults to False.
Raises:
InvalidJobOperation: If nothing is returned from the `ZREM` operation.
Returns:
Job: The Requeued Job.
"""
if isinstance(job_or_id, self.job_class):
job = job_or_id
serializer = job.serializer
else:
serializer = self.serializer
job = self.job_class.fetch(job_or_id, connection=self.connection, serializer=serializer)
result = self.connection.zrem(self.key, job.id)
if not result:
raise InvalidJobOperation
with self.connection.pipeline() as pipeline:
queue = Queue(job.origin, connection=self.connection, job_class=self.job_class, serializer=serializer)
job.started_at = None
job.ended_at = None
job._exc_info = '' # TODO: this should be removed
job.save()
job = queue._enqueue_job(job, pipeline=pipeline, at_front=at_front)
pipeline.execute()
return job
@staticmethod
def parse_job_id(entry: str) -> str:
"""Generic function to retrieve the job id from the stored entry.
Some Registries might have a different entry format.
Args:
entry (str): the entry from the registry
Returns:
str: the job_id parsed from the registry.
"""
# base registry only stores job_ids as is.
if not isinstance(entry, str):
entry = as_text(entry) # type: ignore
return entry
def cleanup(self, timestamp: Optional[float] = None, exception_handlers: Optional[list] = None):
"""This method is automatically called by `count()` and `get_job_ids()` methods
implemented in BaseRegistry. Base registry doesn't have any special cleanup instructions"""
class StartedJobRegistry(BaseRegistry):
"""
Registry of currently executing jobs. Each queue maintains a
StartedJobRegistry. Jobs in this registry are ones that are currently
being executed.
Jobs are added to registry right before they are executed and removed
right after completion (success or failure).
Each entry is a {job_id}:{execution_id}
"""
key_template = 'rq:wip:{0}'
def cleanup(self, timestamp: Optional[float] = None, exception_handlers: Optional[list] = None):
"""Remove abandoned jobs from registry and add them to FailedJobRegistry.
Removes jobs with an expiry time earlier than timestamp, specified as
seconds since the Unix epoch. timestamp defaults to call time if
unspecified. Removed jobs are added to the global failed job queue.
Args:
timestamp (datetime): The datetime to use as the limit.
"""
score = timestamp if timestamp is not None else current_timestamp()
job_ids = self.get_expired_job_ids(score)
if job_ids:
queue = self.get_queue()
with self.connection.pipeline() as pipeline:
for job_id in job_ids:
try:
job = self.job_class.fetch(job_id, connection=self.connection, serializer=self.serializer)
except NoSuchJobError:
continue
job.execute_failure_callback(
self.death_penalty_class, AbandonedJobError, AbandonedJobError(), traceback.extract_stack()
)
if exception_handlers:
for handler in exception_handlers:
fallthrough = handler(
job, AbandonedJobError, AbandonedJobError(), traceback.extract_stack()
)
# Only handlers with explicit return values should disable further
# exc handling, so interpret a None return value as True.
if fallthrough is None:
fallthrough = True
if not fallthrough:
break
retry = job.retries_left and job.retries_left > 0
if retry:
job.retry(queue, pipeline)
else:
exc_string = (
f'Moved to {FailedJobRegistry.__name__}, due to {AbandonedJobError.__name__}, at {now()}'
)
logger.warning('%s cleanup: %s %s', self.__class__.__name__, job.id, exc_string)
job.set_status(JobStatus.FAILED, pipeline=pipeline)
job._handle_failure(exc_string, pipeline, worker_name='')
# don't refresh the job status, because the job state is still in the pipeline
queue.enqueue_dependents(job, refresh_job_status=False)
pipeline.zremrangebyscore(self.key, 0, score)
pipeline.execute()
def add_execution(self, execution: 'Execution', pipeline: 'Pipeline', ttl: int = 0, xx: bool = False) -> int:
"""Adds an execution to a registry with expiry time of now + ttl, unless it's -1 which is set to +inf
Args:
execution (Execution): The Execution to add.
pipeline (Pipeline): The Redis Pipeline.
ttl (int, optional): The time to live. Defaults to 0.
xx (bool, optional): .... Defaults to False.
Returns:
result (int): The ZADD command result
"""
score: Union[int, str] = ttl if ttl < 0 else current_timestamp() + ttl
if score == -1:
score = '+inf'
return pipeline.zadd(self.key, {execution.composite_key: score}, xx=xx) # type: ignore
def remove_execution(
self,
execution: 'Execution',
job: Optional[Job] = None,
pipeline: Optional['Pipeline'] = None,
delete_job: bool = False,
) -> None:
"""Removes job from registry and deletes it if `delete_job == True`
Args:
execution (Execution): The Execution to remove
job (Optional[Job]): The Job to remove from the registry
pipeline (Optional['Pipeline'], optional): The Redis Pipeline. Defaults to None.
delete_job (bool, optional): If should delete the job.. Defaults to False.
"""
connection = pipeline if pipeline is not None else self.connection
connection.zrem(self.key, execution.composite_key)
# if delete_job:
# job.delete()
def get_job_and_execution_ids(
self, start: int = 0, end: int = -1, desc: bool = False, cleanup: bool = True
) -> list[tuple[str, str]]:
"""Function to retrieve a list of tuples where the first item is the job id and
the second is the execution id.
Args:
start (int, optional): start rank. Defaults to 0.
end (int, optional): end rank. Defaults to -1.
desc (bool, optional): sort in reversed order. Defaults to False.
cleanup (bool, optional): whether to perform the cleanup. Defaults to True.
Returns:
List[Tuple[str, str]]: a list of tuples where the first item is the job id and
the second is the execution id.
"""
if cleanup:
self.cleanup()
return [
parse_composite_key(as_text(entry)) for entry in self.connection.zrange(self.key, start, end, desc=desc)
]
def __contains__(self, item: Any) -> bool:
"""Method to check if the item is in the registry.
Args:
item (Any): Either a Job (instance of job_class) or a job id.
Returns:
bool: True if the item is in the registry.
"""
job_id = item
if isinstance(item, self.job_class):
job_id = item.id
return cast(str, job_id) in self.get_job_ids(cleanup=False)
def add(self, job: Job, ttl: int = 0, pipeline: Optional['Pipeline'] = None, xx: bool = False) -> int:
raise NotImplementedError()
def remove(self, job: Union[Job, str], pipeline: Optional['Pipeline'] = None, delete_job: bool = False):
raise NotImplementedError()
@staticmethod
def parse_job_id(entry: str) -> str:
# other classes might have a different entry format
# base registry stores just the job id
if not isinstance(entry, str):
entry = as_text(entry) # type: ignore
job_id, _execution_id = parse_composite_key(entry)
return job_id
def remove_executions(self, job: Job, pipeline: Optional['Pipeline'] = None) -> None:
"""Removes job executions from the started job registry.
Args:
job (Job): The Job to remove from the registry
pipeline (Optional['Pipeline']): The Redis Pipeline. Defaults to None.
"""
connection = pipeline if pipeline is not None else self.connection
execution_ids = [execution.composite_key for execution in job.get_executions()]
if execution_ids:
connection.zrem(self.key, *execution_ids)
class FinishedJobRegistry(BaseRegistry):
"""
Registry of jobs that have been completed. Jobs are added to this
registry after they have successfully completed for monitoring purposes.
"""
key_template = 'rq:finished:{0}'
def cleanup(self, timestamp: Optional[float] = None, exception_handlers: Optional[list] = None):
"""Remove expired jobs from registry.
Removes jobs with an expiry time earlier than timestamp, specified as
seconds since the Unix epoch. timestamp defaults to call time if
unspecified.
"""
score = timestamp if timestamp is not None else current_timestamp()
self.connection.zremrangebyscore(self.key, 0, score)
class FailedJobRegistry(BaseRegistry):
"""
Registry of containing failed jobs.
"""
key_template = 'rq:failed:{0}'
def cleanup(self, timestamp: Optional[float] = None, exception_handlers: Optional[list] = None):
"""Remove expired jobs from registry.
Removes jobs with an expiry time earlier than timestamp, specified as
seconds since the Unix epoch. timestamp defaults to call time if
unspecified.
"""
score = timestamp if timestamp is not None else current_timestamp()
self.connection.zremrangebyscore(self.key, 0, score)
def add( # type: ignore[override]
self,
job: 'Job',
ttl=None,
exc_string: str = '',
pipeline: Optional['Pipeline'] = None,
):
"""
Adds a job to a registry with expiry time of now + ttl.
`ttl` defaults to DEFAULT_FAILURE_TTL if not specified.
"""
if ttl is None:
ttl = DEFAULT_FAILURE_TTL
score = ttl if ttl < 0 else current_timestamp() + ttl
if pipeline:
p = pipeline
else:
p = self.connection.pipeline()
job._exc_info = exc_string
job.save(pipeline=p, include_meta=False, include_result=False)
job.cleanup(ttl=ttl, pipeline=p)
p.zadd(self.key, {job.id: score})
if not pipeline:
p.execute()
class DeferredJobRegistry(BaseRegistry):
"""
Registry of deferred jobs (waiting for another job to finish).
"""
key_template = 'rq:deferred:{0}'
def cleanup(self, timestamp: Optional[float] = None, exception_handlers: Optional[list] = None):
"""Remove expired jobs from registry and add them to FailedJobRegistry.
Removes jobs with an expiry time earlier than timestamp, specified as
seconds since the Unix epoch. timestamp defaults to call time if
unspecified. Removed jobs are added to the failed job registry.
"""
score = timestamp if timestamp is not None else current_timestamp()
job_ids = self.get_expired_job_ids(score)
if job_ids:
with self.connection.pipeline() as pipeline:
for job_id in job_ids:
try:
job = self.job_class.fetch(job_id, connection=self.connection, serializer=self.serializer)
except NoSuchJobError:
continue
job.set_status(JobStatus.FAILED, pipeline=pipeline)
exc_info = f'Expired in DeferredJobRegistry, moved to FailedJobRegistry at {now}'
job._handle_failure(exc_string=exc_info, pipeline=pipeline, worker_name='')
pipeline.zremrangebyscore(self.key, 0, score)
pipeline.execute()
def add(self, job: Job, ttl: Optional[int] = None, pipeline: Optional['Pipeline'] = None, xx: bool = False) -> int:
"""
Adds a job to a registry with expiry time of now + ttl.
Defaults to -1 (never expire).
"""
if ttl is None:
ttl = -1
return super(DeferredJobRegistry, self).add(job, ttl, pipeline, xx)
class ScheduledJobRegistry(BaseRegistry):
"""
Registry of scheduled jobs.
"""
key_template = 'rq:scheduled:{0}'
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# The underlying implementation of get_jobs_to_enqueue() is
# the same as get_expired_job_ids, but get_expired_job_ids() doesn't
# make sense in this context
self.get_jobs_to_enqueue = self.get_expired_job_ids
def schedule(self, job: 'Job', scheduled_datetime, pipeline: Optional['Pipeline'] = None):
"""
Adds job to registry, scored by its execution time (in UTC).
If datetime has no tzinfo, it will assume local timezone.
"""
# If datetime has no timezone, assume server's local timezone
if not scheduled_datetime.tzinfo:
tz = timezone(timedelta(seconds=-(time.timezone if time.daylight == 0 else time.altzone)))
scheduled_datetime = scheduled_datetime.replace(tzinfo=tz)
timestamp = calendar.timegm(scheduled_datetime.utctimetuple())
return self.connection.zadd(self.key, {job.id: timestamp})
def remove_jobs(self, timestamp: Optional[int] = None, pipeline: Optional['Pipeline'] = None):
"""Remove jobs whose timestamp is in the past from registry.
Args:
timestamp (Optional[int], optional): The timestamp. Defaults to None.
pipeline (Optional['Pipeline'], optional): The Redis pipeline. Defaults to None.
"""
warnings.warn(
'ScheduledJobRegistry.remove_jobs() is deprecated and will be removed in the future.', DeprecationWarning
)
connection = pipeline if pipeline is not None else self.connection
score: int = timestamp if timestamp is not None else current_timestamp()
return connection.zremrangebyscore(self.key, 0, score)
def get_jobs_to_schedule(self, timestamp: Optional[int] = None, chunk_size: int = 1000) -> list[str]:
"""Get's a list of job IDs that should be scheduled.
Args:
timestamp (Optional[int]): _description_. Defaults to None.
chunk_size (int, optional): _description_. Defaults to 1000.
Returns:
jobs (List[str]): A list of Job ids
"""
score: int = timestamp if timestamp is not None else current_timestamp()
jobs_to_schedule = self.connection.zrangebyscore(self.key, 0, score, start=0, num=chunk_size)
return [as_text(job_id) for job_id in jobs_to_schedule]
def get_scheduled_time(self, job_or_id: Union['Job', str]) -> datetime:
"""Returns datetime (UTC) at which job is scheduled to be enqueued
Args:
job_or_id (Union[Job, str]): The Job instance or Job ID
Raises:
NoSuchJobError: If the job was not found
Returns:
datetime (datetime): The scheduled time as datetime object
"""
if isinstance(job_or_id, Job):
job_id = job_or_id.id
else:
job_id = job_or_id
score = self.connection.zscore(self.key, job_id)
if not score:
raise NoSuchJobError
return datetime.fromtimestamp(score, tz=timezone.utc)
class CanceledJobRegistry(BaseRegistry):
key_template = 'rq:canceled:{0}'
def get_expired_job_ids(self, timestamp: Optional[float] = None):
raise NotImplementedError
def clean_registries(queue: 'Queue', exception_handlers: Optional[list] = None):
"""Cleans StartedJobRegistry, FinishedJobRegistry and FailedJobRegistry, and DeferredJobRegistry of a queue.
Args:
queue (Queue): The queue to clean
"""
FinishedJobRegistry(
name=queue.name, connection=queue.connection, job_class=queue.job_class, serializer=queue.serializer
).cleanup()
StartedJobRegistry(
name=queue.name, connection=queue.connection, job_class=queue.job_class, serializer=queue.serializer
).cleanup(exception_handlers=exception_handlers)
FailedJobRegistry(
name=queue.name, connection=queue.connection, job_class=queue.job_class, serializer=queue.serializer
).cleanup()
DeferredJobRegistry(
name=queue.name, connection=queue.connection, job_class=queue.job_class, serializer=queue.serializer
).cleanup()
|