From 679682c186ee99c98fe795721b5e620e03d96d6b Mon Sep 17 00:00:00 2001
From: Côme Chilliet <come.chilliet@nextcloud.com>
Date: Tue, 10 Jan 2023 18:20:31 +0100
Subject: Use a Generator for job list to fix background-job:list command
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
---
 lib/private/BackgroundJob/JobList.php | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

(limited to 'lib/private/BackgroundJob')

diff --git a/lib/private/BackgroundJob/JobList.php b/lib/private/BackgroundJob/JobList.php
index 20176e45125..3886ff13bc6 100644
--- a/lib/private/BackgroundJob/JobList.php
+++ b/lib/private/BackgroundJob/JobList.php
@@ -160,19 +160,19 @@ class JobList implements IJobList {
 	/**
 	 * get all jobs in the list
 	 *
-	 * @return IJob[]
+	 * @return iterable<IJob>
 	 * @deprecated 9.0.0 - This method is dangerous since it can cause load and
 	 * memory problems when creating too many instances. Use getJobs instead.
 	 */
-	public function getAll(): array {
+	public function getAll(): iterable {
 		return $this->getJobs(null, null, 0);
 	}
 
 	/**
 	 * @param IJob|class-string<IJob>|null $job
-	 * @return IJob[]
+	 * @return iterable<IJob> Avoid to store these objects as they may share a Singleton instance. You should instead use these IJobs instances while looping on the iterable.
 	 */
-	public function getJobs($job, ?int $limit, int $offset): array {
+	public function getJobs($job, ?int $limit, int $offset): iterable {
 		$query = $this->connection->getQueryBuilder();
 		$query->select('*')
 			->from('jobs')
@@ -190,20 +190,18 @@ class JobList implements IJobList {
 
 		$result = $query->executeQuery();
 
-		$jobs = [];
 		while ($row = $result->fetch()) {
 			$job = $this->buildJob($row);
 			if ($job) {
-				$jobs[] = $job;
+				yield $job;
 			}
 		}
 		$result->closeCursor();
-
-		return $jobs;
 	}
 
 	/**
-	 * get the next job in the list
+	 * Get the next job in the list
+	 * @return ?IJob the next job to run. Beware that this object may be a singleton and may be modified by the next call to buildJob.
 	 */
 	public function getNext(bool $onlyTimeSensitive = false): ?IJob {
 		$query = $this->connection->getQueryBuilder();
@@ -261,6 +259,9 @@ class JobList implements IJobList {
 		}
 	}
 
+	/**
+	 * @return ?IJob The job matching the id. Beware that this object may be a singleton and may be modified by the next call to buildJob.
+	 */
 	public function getById(int $id): ?IJob {
 		$row = $this->getDetailsById($id);
 
@@ -291,6 +292,7 @@ class JobList implements IJobList {
 	 * get the job object from a row in the db
 	 *
 	 * @param array{class:class-string<IJob>, id:mixed, last_run:mixed, argument:string} $row
+	 * @return ?IJob the next job to run. Beware that this object may be a singleton and may be modified by the next call to buildJob.
 	 */
 	private function buildJob(array $row): ?IJob {
 		try {
-- 
cgit v1.2.3