Job: getName()

orisai · Mar 9, 2023 · e3cd096 · e3cd096
1 parent 03ddac2
commit e3cd096
Show file tree

Hide file tree

Showing 9 changed files with 62 additions and 9 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -127,7 +127,8 @@ $scheduler->addBeforeJobCallback(
 	function(JobInfo $info): void {
 		// Executes before job start
 
-		$info->getStart(); // DateTimeImmutable
+		$name = $info->getName(); // string
+		$start = $info->getStart(); // DateTimeImmutable
 	},
 );
 
@@ -196,6 +197,12 @@ use Orisai\Scheduler\Job\Job;
 final class CustomJob implements Job
 {
 
+	public function getName(): string
+	{
+		// Provide (preferably unique) name of the job. It will be used in jobs overview
+		return static::class;
+	}
+
 	public function run(): void
 	{
  		// Do whatever you need to

diff --git a/src/Job/CallbackJob.php b/src/Job/CallbackJob.php
@@ -3,6 +3,8 @@
 namespace Orisai\Scheduler\Job;
 
 use Closure;
+use ReflectionFunction;
+use function str_ends_with;
 
 final class CallbackJob implements Job
 {
@@ -18,6 +20,19 @@ public function __construct(Closure $callback)
 		$this->callback = $callback;
 	}
 
+	public function getName(): string
+	{
+		$ref = new ReflectionFunction($this->callback);
+		$refName = $ref->getName();
+
+		$class = $ref->getClosureScopeClass();
+		if ($class !== null && !str_ends_with($refName, '{closure}')) {
+			return "{$class->getName()}::$refName()";
+		}
+
+		return $refName;
+	}
+
 	public function run(): void
 	{
 		($this->callback)();

diff --git a/src/Job/Job.php b/src/Job/Job.php
@@ -5,6 +5,8 @@
 interface Job
 {
 
+	public function getName(): string;
+
 	public function run(): void;
 
 }
diff --git a/src/Scheduler.php b/src/Scheduler.php
@@ -47,6 +47,7 @@ public function run(): void
 
 		foreach ($jobs as [$job, $expression]) {
 			$info = new JobInfo(
+				$job->getName(),
 				$expression->getExpression(),
 				$this->clock->now(),
 			);

diff --git a/src/Status/JobInfo.php b/src/Status/JobInfo.php
@@ -7,16 +7,24 @@
 final class JobInfo
 {
 
+	private string $name;
+
 	private string $expression;
 
 	private DateTimeImmutable $start;
 
-	public function __construct(string $expression, DateTimeImmutable $start)
+	public function __construct(string $name, string $expression, DateTimeImmutable $start)
 	{
+		$this->name = $name;
 		$this->expression = $expression;
 		$this->start = $start;
 	}
 
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
 	public function getExpression(): string
 	{
 		return $this->expression;

diff --git a/tests/Unit/Job/CallbackJobTest.php b/tests/Unit/Job/CallbackJobTest.php
@@ -2,6 +2,7 @@
 
 namespace Tests\Orisai\Scheduler\Unit\Job;
 
+use Closure;
 use Orisai\Scheduler\Job\CallbackJob;
 use PHPUnit\Framework\TestCase;
 
@@ -18,11 +19,26 @@ static function () use (&$i): void {
 			},
 		);
 
+		self::assertSame(
+			'Tests\Orisai\Scheduler\Unit\Job\{closure}',
+			$job->getName(),
+		);
+
 		$job->run();
 		self::assertSame(1, $i);
 
 		$job->run();
 		self::assertSame(2, $i);
 	}
 
+	public function testStaticName(): void
+	{
+		$job = new CallbackJob(Closure::fromCallable([$this, 'testStaticName']));
+
+		self::assertSame(
+			'Tests\Orisai\Scheduler\Unit\Job\CallbackJobTest::testStaticName()',
+			$job->getName(),
+		);
+	}
+
 }
diff --git a/tests/Unit/SchedulerTest.php b/tests/Unit/SchedulerTest.php
@@ -101,19 +101,19 @@ static function (): void {
 
 		self::assertEquals(
 			[
-				new JobInfo('* * * * *', $now),
-				new JobInfo('* * * * *', $now),
+				new JobInfo('Tests\Orisai\Scheduler\Unit\{closure}', '* * * * *', $now),
+				new JobInfo('Tests\Orisai\Scheduler\Unit\{closure}', '* * * * *', $now),
 			],
 			$beforeCollected,
 		);
 		self::assertEquals(
 			[
 				[
-					new JobInfo('* * * * *', $now),
+					new JobInfo('Tests\Orisai\Scheduler\Unit\{closure}', '* * * * *', $now),
 					new JobResult($now, new Exception('test')),
 				],
 				[
-					new JobInfo('* * * * *', $now),
+					new JobInfo('Tests\Orisai\Scheduler\Unit\{closure}', '* * * * *', $now),
 					new JobResult($now, null),
 				],
 			],
@@ -151,6 +151,7 @@ static function (): void {
 		self::assertEquals(
 			[
 				new JobInfo(
+					'Tests\Orisai\Scheduler\Unit\{closure}',
 					'* * * * *',
 					DateTimeImmutable::createFromFormat('U', '1'),
 				),
@@ -161,6 +162,7 @@ static function (): void {
 			[
 				[
 					new JobInfo(
+						'Tests\Orisai\Scheduler\Unit\{closure}',
 						'* * * * *',
 						DateTimeImmutable::createFromFormat('U', '1'),
 					),

diff --git a/tests/Unit/Status/JobInfoTest.php b/tests/Unit/Status/JobInfoTest.php
@@ -11,10 +11,12 @@ final class JobInfoTest extends TestCase
 
 	public function test(): void
 	{
+		$name = 'name';
 		$expression = '* * * * *';
 		$start = new DateTimeImmutable();
 
-		$info = new JobInfo($expression, $start);
+		$info = new JobInfo($name, $expression, $start);
+		self::assertSame($name, $info->getName());
 		self::assertSame($expression, $info->getExpression());
 		self::assertSame($start, $info->getStart());
 	}

diff --git a/tools/phpstan.baseline.neon b/tools/phpstan.baseline.neon
@@ -1,7 +1,7 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Parameter \\#1 \\$expression of class Orisai\\\\Scheduler\\\\Status\\\\JobInfo constructor expects string, string\\|null given\\.$#"
+			message: "#^Parameter \\#2 \\$expression of class Orisai\\\\Scheduler\\\\Status\\\\JobInfo constructor expects string, string\\|null given\\.$#"
 			count: 1
 			path: ../src/Scheduler.php
 
@@ -36,6 +36,6 @@ parameters:
 			path: ../tests/Unit/SchedulerTest.php
 
 		-
-			message: "#^Parameter \\#2 \\$start of class Orisai\\\\Scheduler\\\\Status\\\\JobInfo constructor expects DateTimeImmutable, DateTimeImmutable\\|false given\\.$#"
+			message: "#^Parameter \\#3 \\$start of class Orisai\\\\Scheduler\\\\Status\\\\JobInfo constructor expects DateTimeImmutable, DateTimeImmutable\\|false given\\.$#"
 			count: 2
 			path: ../tests/Unit/SchedulerTest.php