Update script

Author: duncanmcclean

src/Providers/ExtensionServiceProvider.php

@@ -248,6 +248,7 @@ class ExtensionServiceProvider extends ServiceProvider
         Updates\MigrateSitesConfigToYaml::class,
         Updates\AddTimezoneConfigOptions::class,
         Updates\RemoveParentField::class,
+        Updates\UpdateGlobalVariables::class,
     ];
 
     public function register()

src/UpdateScripts/UpdateGlobalVariables.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace Statamic\UpdateScripts;
+
+use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\File;
+use Statamic\Facades\GlobalSet;
+use Statamic\Facades\GlobalVariables;
+use Statamic\Facades\Site;
+use Statamic\Facades\Stache;
+use Statamic\Facades\YAML;
+
+class UpdateGlobalVariables extends UpdateScript
+{
+    public function shouldUpdate($newVersion, $oldVersion)
+    {
+        return $this->isUpdatingTo('6.0.0');
+    }
+
+    public function update()
+    {
+        // This update script deals with reading & writing YAML files from the filesystem.
+        // There's an equivalent update script for the Eloquent driver that deals with
+        // reading & writing to the database.
+        if (config('statamic.eloquent-driver.global_set_variables.driver') === 'eloquent') {
+            return;
+        }
+
+        match (Site::multiEnabled()) {
+            true => $this->buildSitesArray(),
+            false => $this->migrateFileStructure(),
+        };
+    }
+
+    /**
+     * Adds the `sites` array to the global set based on the global variables that exist.
+     * It also removes the `origin` key from global variables.
+     */
+    private function buildSitesArray(): void
+    {
+        GlobalSet::all()->each(function ($globalSet) {
+            $variables = GlobalVariables::whereSet($globalSet->handle());
+
+            $sites = $variables->mapWithKeys(function ($variable) {
+                $contents = YAML::file($variable->path())->parse();
+                $origin = Arr::get($contents, 'origin');
+
+                return [$variable->locale() => $origin];
+            });
+
+            $globalSet->sites($sites)->save();
+
+            $variables->each(function ($variable) {
+                $data = YAML::file($variable->path())->parse();
+
+                File::put($variable->path(), YAML::dump(Arr::except($data, 'origin')));
+            });
+        });
+    }
+
+    /**
+     * Migrates global variables in a single-site install to the new directory structure.
+     */
+    private function migrateFileStructure(): void
+    {
+        GlobalSet::all()->each(function ($globalSet) {
+            $variablesDirectory = Stache::store('global-variables')->directory().Site::default()->handle().'/';
+            $variablesPath = $variablesDirectory.$globalSet->handle().'.yaml';
+
+            if (File::exists($variablesPath)) {
+                return;
+            }
+
+            $contents = YAML::file($globalSet->path())->parse();
+            $data = Arr::get($contents, 'data', []);
+
+            File::ensureDirectoryExists($variablesDirectory);
+            File::put($variablesPath, YAML::dump($data));
+
+            $globalSet->save();
+        });
+    }
+}

tests/UpdateScripts/UpdateGlobalVariablesTest.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace Tests\UpdateScripts;
+
+use Illuminate\Support\Facades\File;
+use PHPUnit\Framework\Attributes\Test;
+use Statamic\Facades\YAML;
+use Statamic\UpdateScripts\UpdateGlobalVariables;
+use Tests\PreventSavingStacheItemsToDisk;
+use Tests\TestCase;
+use Tests\UpdateScripts\Concerns\RunsUpdateScripts;
+
+class UpdateGlobalVariablesTest extends TestCase
+{
+    use PreventSavingStacheItemsToDisk, RunsUpdateScripts;
+
+    protected $globalsPath;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->globalsPath = $this->fakeStacheDirectory.'/content/globals';
+
+        File::ensureDirectoryExists($this->globalsPath);
+    }
+
+    #[Test]
+    public function it_is_registered()
+    {
+        $this->assertUpdateScriptRegistered(UpdateGlobalVariables::class);
+    }
+
+    #[Test]
+    public function it_migrates_global_variables_in_a_single_site_install()
+    {
+        File::put($this->globalsPath.'/test.yaml', Yaml::dump([
+            'title' => 'Test',
+            'data' => [
+                'foo' => 'Bar',
+            ],
+        ]));
+
+        $this->runUpdateScript(UpdateGlobalVariables::class);
+
+        $expected = <<<'YAML'
+title: Test
+
+YAML;
+        $this->assertEquals($expected, File::get($this->globalsPath.'/test.yaml'));
+
+        $expected = <<<'YAML'
+foo: Bar
+
+YAML;
+        $this->assertEquals($expected, File::get($this->globalsPath.'/en/test.yaml'));
+
+        unlink($this->globalsPath.'/test.yaml');
+        unlink($this->globalsPath.'/en/test.yaml');
+    }
+
+    #[Test]
+    public function it_builds_the_sites_array_in_a_multi_site_install()
+    {
+        $this->setSites([
+            'en' => ['url' => '/', 'locale' => 'en_US', 'name' => 'English'],
+            'fr' => ['url' => '/', 'locale' => 'fr_FR', 'name' => 'French'],
+            'de' => ['url' => '/', 'locale' => 'de_DE', 'name' => 'German'],
+        ]);
+
+        File::ensureDirectoryExists($this->globalsPath.'/en');
+        File::ensureDirectoryExists($this->globalsPath.'/fr');
+        File::ensureDirectoryExists($this->globalsPath.'/de');
+
+        File::put($this->globalsPath.'/test.yaml', Yaml::dump(['title' => 'Test']));
+        File::put($this->globalsPath.'/en/test.yaml', Yaml::dump(['foo' => 'Bar', 'baz' => 'Qux']));
+        File::put($this->globalsPath.'/fr/test.yaml', Yaml::dump(['origin' => 'en', 'foo' => 'Bar']));
+        File::put($this->globalsPath.'/de/test.yaml', Yaml::dump(['origin' => 'fr']));
+
+        $this->runUpdateScript(UpdateGlobalVariables::class);
+
+        // Ensures that the sites array is built correctly.
+        $expected = <<<'YAML'
+title: Test
+sites:
+  de: fr
+  en: null
+  fr: en
+
+YAML;
+
+        $this->assertEquals($expected, File::get($this->globalsPath.'/test.yaml'));
+
+        // Ensure the origin key has been removed from the global variables.
+        $this->assertEquals(['foo' => 'Bar', 'baz' => 'Qux'], YAML::parse(File::get($this->globalsPath.'/en/test.yaml')));
+        $this->assertEquals(['foo' => 'Bar'], YAML::parse(File::get($this->globalsPath.'/fr/test.yaml')));
+        $this->assertEquals([], YAML::parse(File::get($this->globalsPath.'/de/test.yaml')));
+    }
+}