Auto-invalidate manifest per build

Author: jasonmccreary

src/Support/TaskManifest.php

@@ -2,9 +2,11 @@
 
 namespace Shift\Cli\Support;
 
+use Illuminate\Support\Str;
+
 class TaskManifest
 {
-    private array $manifest = [];
+    private array $tasks = [];
 
     private string $manifestPath;
 
@@ -21,16 +23,24 @@ public function __construct(string $vendorPath, array $defaultTasks)
 
     public function list(): array
     {
-        if (! empty($this->manifest)) {
-            return $this->manifest;
+        if (! empty($this->tasks)) {
+            return $this->tasks;
         }
 
         if (! is_file($this->manifestPath)) {
             $this->build();
         }
 
-        return $this->manifest = is_file($this->manifestPath) ?
-            require $this->manifestPath : [];
+        $manifest = require $this->manifestPath;
+        if (! $this->isStale($manifest)) {
+            return $this->tasks = $manifest['tasks'];
+        }
+
+        $this->build();
+        $manifest = require $this->manifestPath;
+        $this->tasks = $manifest['tasks'];
+
+        return $this->tasks;
     }
 
     public function build(): void
@@ -53,12 +63,27 @@ public function build(): void
             ->all());
     }
 
-    protected function write(array $manifest): void
+    private static function currentNamespace(): string
+    {
+        return Str::before(__NAMESPACE__, '\\');
+    }
+
+    private function isStale(array $manifest): bool
+    {
+        return $manifest['namespace'] !== self::currentNamespace();
+    }
+
+    protected function write(array $tasks): void
     {
         if (! is_writable($dirname = dirname($this->manifestPath))) {
             throw new \Exception("The {$dirname} directory must be present and writable.");
         }
 
+        $manifest = [
+            'namespace' => self::currentNamespace(),
+            'tasks' => $tasks,
+        ];
+
         file_put_contents(
             $this->manifestPath, '<?php return ' . var_export($manifest, true) . ';'
         );

tests/Feature/Support/TaskManifestTest.php

@@ -15,7 +15,7 @@ class TaskManifestTest extends TestCase
     public function list_returns_existing_manifest()
     {
         $this->fakeProject([
-            'shift-tasks.php' => '<?php return ["task-name" => "fqcn"];',
+            'shift-tasks.php' => '<?php return ["namespace" => "Shift", "tasks" => ["task-name" => "fqcn"]];',
         ]);
 
         $taskManifest = new TaskManifest($this->currentSnapshotPath(), []);
@@ -32,6 +32,42 @@ public function list_returns_default_tasks_for_no_manifest()
 
         $this->assertSame(['task-name' => 'Fully\\Qualified\\Class\\Name'], $taskManifest->list());
         $this->assertFileExists($this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php');
+
+        $manifest = require $this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php';
+        $this->assertSame('Shift', $manifest['namespace']);
+        $this->assertArrayHasKey('tasks', $manifest);
+    }
+
+    #[Test]
+    public function list_rebuilds_stale_manifest()
+    {
+        $this->fakeProject([
+            'shift-tasks.php' => '<?php return ["namespace" => "Stale", "tasks" => ["task-name" => "foo"]];',
+            'composer/installed.json' => json_encode([
+                'packages' => [
+                    [
+                        'extra' => [
+                            'shift' => [
+                                'tasks' => ['task1' => '\\Package\\Task1', 'task2' => '\\Package\\Task2'],
+                            ],
+                        ],
+                    ],
+                ],
+            ]),
+        ]);
+
+        $taskManifest = new TaskManifest($this->currentSnapshotPath(), ['task-name' => 'Fully\\Qualified\\Class\\Name']);
+
+        $this->assertEqualsCanonicalizing(
+            ['task-name' => 'Fully\\Qualified\\Class\\Name', 'task1' => '\\Package\\Task1', 'task2' => '\\Package\\Task2'],
+            $taskManifest->list()
+        );
+
+        $this->assertFileExists($this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php');
+
+        $manifest = require $this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php';
+        $this->assertSame('Shift', $manifest['namespace']);
+        $this->assertArrayHasKey('tasks', $manifest);
     }
 
     #[Test]
@@ -66,5 +102,9 @@ public function build_returns_merged_tasks_from_packages()
         );
 
         $this->assertFileExists($this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php');
+
+        $manifest = require $this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php';
+        $this->assertSame('Shift', $manifest['namespace']);
+        $this->assertArrayHasKey('tasks', $manifest);
     }
 }