Prevent migrations being published multiple times (#253)

duncanmcclean · web-flow · commit 3fb33e5d1879 · 2024-03-07T17:42:21.000Z
* Use fixed timestamps in migration filenames

* Adjust migrations in TestCase

* Publish migrations using artisan commands

* wip

* Move entry migrations into subdirectory

This allows them to be split a little easier in the tests.

* Refactor how migrations are defined in our test suite

* 🍺
diff --git a/database/migrations/2024_03_07_100000_create_asset_containers_table.php b/database/migrations/2024_03_07_100000_create_asset_containers_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('asset_containers'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_asset_table.php b/database/migrations/2024_03_07_100000_create_asset_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('assets_meta'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_blueprints_table.php b/database/migrations/2024_03_07_100000_create_blueprints_table.php
@@ -5,7 +5,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('blueprints'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_collections_table.php b/database/migrations/2024_03_07_100000_create_collections_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('collections'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_fieldsets_table.php b/database/migrations/2024_03_07_100000_create_fieldsets_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('fieldsets'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_form_submissions_table.php b/database/migrations/2024_03_07_100000_create_form_submissions_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('form_submissions'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_forms_table.php b/database/migrations/2024_03_07_100000_create_forms_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('forms'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_global_variables_table.php b/database/migrations/2024_03_07_100000_create_global_variables_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('global_set_variables'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_globals_table.php b/database/migrations/2024_03_07_100000_create_globals_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('global_sets'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_navigation_trees_table.php b/database/migrations/2024_03_07_100000_create_navigation_trees_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('trees'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_navigations_table.php b/database/migrations/2024_03_07_100000_create_navigations_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('navigations'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_revisions_table.php b/database/migrations/2024_03_07_100000_create_revisions_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('revisions'), function (Blueprint $table) {
@@ -20,7 +21,6 @@ public function up()
         });
     }
 
-
     public function down()
     {
         Schema::dropIfExists($this->prefix('revisions'));
diff --git a/database/migrations/2024_03_07_100000_create_taxonomies_table.php b/database/migrations/2024_03_07_100000_create_taxonomies_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('taxonomies'), function (Blueprint $table) {
diff --git a/database/migrations/2024_03_07_100000_create_terms_table.php b/database/migrations/2024_03_07_100000_create_terms_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('taxonomy_terms'), function (Blueprint $table) {
diff --git a/database/migrations/entries/2024_03_07_100000_create_entries_table.php b/database/migrations/entries/2024_03_07_100000_create_entries_table.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('entries'), function (Blueprint $table) {
diff --git a/database/migrations/entries/2024_03_07_100000_create_entries_table_with_string_ids.php b/database/migrations/entries/2024_03_07_100000_create_entries_table_with_string_ids.php
@@ -4,7 +4,8 @@
 use Illuminate\Support\Facades\Schema;
 use Statamic\Eloquent\Database\BaseMigration as Migration;
 
-return new class extends Migration {
+return new class extends Migration
+{
     public function up()
     {
         Schema::create($this->prefix('entries'), function (Blueprint $table) {
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -43,8 +43,6 @@ class ServiceProvider extends AddonServiceProvider
 {
     protected $config = false;
 
-    protected $migrationCount = 0;
-
     protected $updateScripts = [
         \Statamic\Eloquent\Updates\AddMetaAndIndexesToAssetsTable::class,
         \Statamic\Eloquent\Updates\AddOrderToEntriesTable::class,
@@ -75,42 +73,71 @@ public function boot()
 
         $this->publishes([$config => config_path('statamic/eloquent-driver.php')], 'statamic-eloquent-config');
 
+        $this->publishMigrations();
+
+        $this->commands([
+            Commands\ExportAssets::class,
+            Commands\ExportBlueprints::class,
+            Commands\ExportCollections::class,
+            Commands\ExportEntries::class,
+            Commands\ExportForms::class,
+            Commands\ExportGlobals::class,
+            Commands\ExportNavs::class,
+            Commands\ExportRevisions::class,
+            Commands\ExportTaxonomies::class,
+            Commands\ImportAssets::class,
+            Commands\ImportBlueprints::class,
+            Commands\ImportCollections::class,
+            Commands\ImportEntries::class,
+            Commands\ImportForms::class,
+            Commands\ImportGlobals::class,
+            Commands\ImportNavs::class,
+            Commands\ImportRevisions::class,
+            Commands\ImportTaxonomies::class,
+            Commands\SyncAssets::class,
+        ]);
+
+        $this->addAboutCommandInfo();
+    }
+
+    private function publishMigrations(): void
+    {
         $this->publishes($taxonomyMigrations = [
-            __DIR__.'/../database/migrations/create_taxonomies_table.php.stub' => $this->migrationsPath('create_taxonomies_table.php'),
-            __DIR__.'/../database/migrations/create_terms_table.php.stub' => $this->migrationsPath('create_terms_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_taxonomies_table.php' => database_path('migrations/2024_03_07_100000_create_taxonomies_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_terms_table.php' => database_path('migrations/2024_03_07_100000_create_terms_table.php'),
         ], 'statamic-eloquent-taxonomy-migrations');
 
         $this->publishes($globalMigrations = [
-            __DIR__.'/../database/migrations/create_globals_table.php.stub' => $this->migrationsPath('create_globals_table.php'),
-            __DIR__.'/../database/migrations/create_global_variables_table.php.stub' => $this->migrationsPath('create_global_variables_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_globals_table.php' => database_path('migrations/2024_03_07_100000_create_globals_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_global_variables_table.php' => database_path('migrations/2024_03_07_100000_create_global_variables_table.php'),
         ], 'statamic-eloquent-global-migrations');
 
         $this->publishes($navigationMigrations = [
-            __DIR__.'/../database/migrations/create_navigations_table.php.stub' => $this->migrationsPath('create_navigations_table.php'),
-            __DIR__.'/../database/migrations/create_navigation_trees_table.php.stub' => $this->migrationsPath('create_navigation_trees_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_navigations_table.php' => database_path('migrations/2024_03_07_100000_create_navigations_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_navigation_trees_table.php' => database_path('migrations/2024_03_07_100000_create_navigation_trees_table.php'),
         ], 'statamic-eloquent-navigation-migrations');
 
         $this->publishes($collectionMigrations = [
-            __DIR__.'/../database/migrations/create_collections_table.php.stub' => $this->migrationsPath('create_collections_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_collections_table.php' => database_path('migrations/2024_03_07_100000_create_collections_table.php'),
         ], 'statamic-eloquent-collection-migrations');
 
         $this->publishes($blueprintMigrations = [
-            __DIR__.'/../database/migrations/create_blueprints_table.php.stub' => $this->migrationsPath('create_blueprints_table.php'),
-            __DIR__.'/../database/migrations/create_fieldsets_table.php.stub' => $this->migrationsPath('create_fieldsets_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_blueprints_table.php' => database_path('migrations/2024_03_07_100000_create_blueprints_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_fieldsets_table.php' => database_path('migrations/2024_03_07_100000_create_fieldsets_table.php'),
         ], 'statamic-eloquent-blueprint-migrations');
 
         $this->publishes($formMigrations = [
-            __DIR__.'/../database/migrations/create_forms_table.php.stub' => $this->migrationsPath('create_forms_table.php'),
-            __DIR__.'/../database/migrations/create_form_submissions_table.php.stub' => $this->migrationsPath('create_form_submissions_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_forms_table.php' => database_path('migrations/2024_03_07_100000_create_forms_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_form_submissions_table.php' => database_path('migrations/2024_03_07_100000_create_form_submissions_table.php'),
         ], 'statamic-eloquent-form-migrations');
 
         $this->publishes($assetMigrations = [
-            __DIR__.'/../database/migrations/create_asset_containers_table.php.stub' => $this->migrationsPath('create_asset_containers_table.php'),
-            __DIR__.'/../database/migrations/create_asset_table.php.stub' => $this->migrationsPath('create_asset_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_asset_containers_table.php' => database_path('migrations/2024_03_07_100000_create_asset_containers_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_asset_table.php' => database_path('migrations/2024_03_07_100000_create_asset_table.php'),
         ], 'statamic-eloquent-asset-migrations');
 
         $this->publishes($revisionMigrations = [
-            __DIR__.'/../database/migrations/create_revisions_table.php.stub' => $this->migrationsPath('create_revisions_table.php'),
+            __DIR__.'/../database/migrations/2024_03_07_100000_create_revisions_table.php' => database_path('migrations/2024_03_07_100000_create_revisions_table.php'),
         ], 'statamic-eloquent-revision-migrations');
 
         $this->publishes(
@@ -128,36 +155,12 @@ public function boot()
         );
 
         $this->publishes([
-            __DIR__.'/../database/migrations/create_entries_table.php.stub' => $this->migrationsPath('create_entries_table'),
+            __DIR__.'/../database/migrations/entries/2024_03_07_100000_create_entries_table.php' => database_path('migrations/2024_03_07_100000_create_entries_table.php'),
         ], 'statamic-eloquent-entries-table');
 
         $this->publishes([
-            __DIR__.'/../database/migrations/create_entries_table_with_string_ids.php.stub' => $this->migrationsPath('create_entries_table_with_string_ids'),
+            __DIR__.'/../database/migrations/entries/2024_03_07_100000_create_entries_table_with_string_ids.php' => database_path('migrations/2024_03_07_100000_create_entries_table_with_string_ids.php'),
         ], 'statamic-eloquent-entries-table-with-string-ids');
-
-        $this->commands([
-            Commands\ExportAssets::class,
-            Commands\ExportBlueprints::class,
-            Commands\ExportCollections::class,
-            Commands\ExportEntries::class,
-            Commands\ExportForms::class,
-            Commands\ExportGlobals::class,
-            Commands\ExportNavs::class,
-            Commands\ExportRevisions::class,
-            Commands\ExportTaxonomies::class,
-            Commands\ImportAssets::class,
-            Commands\ImportBlueprints::class,
-            Commands\ImportCollections::class,
-            Commands\ImportEntries::class,
-            Commands\ImportForms::class,
-            Commands\ImportGlobals::class,
-            Commands\ImportNavs::class,
-            Commands\ImportRevisions::class,
-            Commands\ImportTaxonomies::class,
-            Commands\SyncAssets::class,
-        ]);
-
-        $this->addAboutCommandInfo();
     }
 
     public function register()
@@ -434,11 +437,6 @@ public function registerTerms()
         Statamic::repository(TermRepositoryContract::class, TermRepository::class);
     }
 
-    protected function migrationsPath($filename)
-    {
-        return database_path('migrations/'.date('Y_m_d_His', time() + (++$this->migrationCount + 60))."_{$filename}.php");
-    }
-
     protected function addAboutCommandInfo()
     {
         if (! class_exists(AboutCommand::class)) {
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,8 @@`
`4`	`4`	`use Illuminate\Support\Facades\Schema;`
`5`	`5`	`use Statamic\Eloquent\Database\BaseMigration as Migration;`
`6`	`6`
`7`		`-return new class extends Migration {`
	`7`	`+return new class extends Migration`
	`8`	`+{`
`8`	`9`	`public function up()`
`9`	`10`	`{`
`10`	`11`	`Schema::create($this->prefix('asset_containers'), function (Blueprint $table) {`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@`
`5`	`5`	`use Illuminate\Support\Facades\Schema;`
`6`	`6`	`use Statamic\Eloquent\Database\BaseMigration as Migration;`
`7`	`7`
`8`		`-return new class extends Migration {`
	`8`	`+return new class extends Migration`
	`9`	`+{`
`9`	`10`	`public function up()`
`10`	`11`	`{`
`11`	`12`	`Schema::create($this->prefix('blueprints'), function (Blueprint $table) {`