Add readied tenants

Add config for readied tenants
Add `create` and `clear` command
Add Readied scope and static functions
Add tests

src/Commands/ClearReadiedTenants.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Builder;
+
+class ClearReadiedTenants extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'tenants:readied-clear
+                            {--all : Override the default settings and deletes all readied tenants}
+                            {--older-days= : Deletes all readied older than the amount of days}
+                            {--older-hours= : Deletes all readied older than the amount of hours}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Removes any readied tenants';
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        $this->info('Cleaning readied tenants.');
+
+        $expireDate = now();
+        // At the end, we will check if the value has been changed by comparing the two dates
+        $savedExpiredDate = $expireDate->copy()->toImmutable();
+
+        // If the all option is given, skip the expiry date configuration
+        if (! $this->option('all')) {
+            if ($olderThanDays = $this->option('older-days') ?? config('tenancy.readied.older_than_days')) {
+                $expireDate->subDays($olderThanDays);
+            }
+
+            if ($olderThanHours = $this->option('older-hours') ?? config('tenancy.readied.older_than_hours')) {
+                $expireDate->subHours($olderThanHours);
+            }
+        }
+
+
+        $readiedTenantsDeletedCount = tenancy()
+            ->query()
+            ->onlyReadied()
+            ->when($savedExpiredDate->notEqualTo($expireDate), function (Builder $query) use ($expireDate) {
+                $query->where('data->readied', '<', $expireDate->timestamp);
+            })
+            ->get()
+            ->each // This makes sure the events or triggered on the model
+            ->delete()
+            ->count();
+
+        $this->info("$readiedTenantsDeletedCount readied tenant(s) deleted.");
+    }
+}

src/Commands/CreateReadiedTenants.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Commands;
+
+use Illuminate\Console\Command;
+
+class CreateReadiedTenants extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'tenants:readied {--count= The number of tenant to be in a readied state}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Deploy tenants until the readied count is achieved.';
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        $this->info('Deploying readied tenants.');
+
+        $readiedCountObjectif = (int)config('tenancy.readied.count');
+
+        $readiedTenantCount = $this->getReadiedTenantCount();
+
+        $deployedCount = 0;
+        while ($readiedTenantCount < $readiedCountObjectif) {
+            tenancy()->model()::createReadied();
+            // We update the number of readied tenant every time with a query to get a live count.
+            // this prevents to deploy too many tenants if readied tenants have been deployed
+            // while this command is running.
+            $readiedTenantCount = $this->getReadiedTenantCount();
+            $deployedCount++;
+        }
+
+        $this->info("$deployedCount tenants deployed, $readiedCountObjectif tenant(s) are ready to be used.");
+    }
+
+    /**
+     * Calculates the number of readied tenants currently deployed
+     * @return int
+     */
+    private function getReadiedTenantCount(): int
+    {
+        return tenancy()
+            ->query()
+            ->onlyReadied()
+            ->count();
+    }
+}

src/Database/Concerns/ReadiedScope.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Concerns;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Scope;
+
+class ReadiedScope implements Scope
+{
+
+    /**
+     * All of the extensions to be added to the builder.
+     *
+     * @var string[]
+     */
+    protected $extensions = ['WithReadied', 'WithoutReadied', 'OnlyReadied'];
+
+    /**
+     * Apply the scope to a given Eloquent query builder.
+     *
+     * @param  Builder  $builder
+     * @param  Model  $model
+     * @return void
+     */
+    public function apply(Builder $builder, Model $model)
+    {
+        $builder->when(!config('tenancy.readied.include_in_scope'), function (Builder $builder){
+            $builder->whereNull('data->readied');
+        });
+    }
+
+    /**
+     * Extend the query builder with the needed functions.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    public function extend(Builder $builder)
+    {
+        foreach ($this->extensions as $extension) {
+            $this->{"add{$extension}"}($builder);
+        }
+    }
+    /**
+     * Add the with-readied extension to the builder.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    protected function addWithReadied(Builder $builder)
+    {
+        $builder->macro('withReadied', function (Builder $builder, $withReadied = true) {
+            if (! $withReadied) {
+                return $builder->withoutReadied();
+            }
+
+            return $builder->withoutGlobalScope($this);
+        });
+    }
+
+    /**
+     * Add the without-readied extension to the builder.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    protected function addWithoutReadied(Builder $builder)
+    {
+        $builder->macro('withoutReadied', function (Builder $builder) {
+
+            $builder->withoutGlobalScope($this)->whereNull('data->readied');
+
+            return $builder;
+        });
+    }
+
+    /**
+     * Add the only-readied extension to the builder.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     * @return void
+     */
+    protected function addOnlyReadied(Builder $builder)
+    {
+        $builder->macro('onlyReadied', function (Builder $builder) {
+
+            $builder->withoutGlobalScope($this)->whereNotNull('data->readied');
+
+            return $builder;
+        });
+    }
+}

src/Database/Concerns/WithReadied.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Concerns;
+
+use Carbon\Carbon;
+use Stancl\Tenancy\Contracts\Tenant;
+
+/**
+ * @property null|Carbon $readied
+ *
+ * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder withReadied(bool $withReadied = true)
+ * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder onlyReadied()
+ * @method static static|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder withoutReadied()
+ */
+trait WithReadied
+{
+    /**
+     * Boot the readied trait for a model.
+     *
+     * @return void
+     */
+    public static function bootWithReadied()
+    {
+        static::addGlobalScope(new ReadiedScope());
+    }
+
+    /**
+     * Initialize the readied trait for an instance.
+     *
+     * @return void
+     */
+    public function initializeSoftDeletes()
+    {
+        $this->casts['readied'] = 'datetime';
+    }
+
+
+    /**
+     * Determine if the model instance is in a readied state.
+     *
+     * @return bool
+     */
+    public function readied()
+    {
+        return !is_null($this->readied);
+    }
+
+    public static function createReadied($attributes = []): void
+    {
+        $tenant = static::create($attributes);
+
+        // We add the readied value only after the model has then been created.
+        // this ensures the model is not marked as readied until the migrations, seeders, etc. are done
+        $tenant->update([
+            'readied' => now()->timestamp
+        ]);
+    }
+
+    public static function pullReadiedTenant(bool $firstOrCreate = false): ?Tenant
+    {
+        if (!static::onlyReadied()->exists()) {
+            if (!$firstOrCreate) {
+                return null;
+            }
+            static::createReadied();
+        }
+
+        // At this point we can guarantee a readied tenant is free and can be called
+        $tenant = static::onlyReadied()->first();
+
+        $tenant->update([
+            'readied' => null
+        ]);
+
+        return $tenant;
+    }
+}

src/Database/Models/Tenant.php

@@ -26,7 +26,8 @@ class Tenant extends Model implements Contracts\Tenant
         Concerns\HasDataColumn,
         Concerns\HasInternalKeys,
         Concerns\TenantRun,
-        Concerns\InvalidatesResolverCache;
+        Concerns\InvalidatesResolverCache,
+        Concerns\WithReadied;
 
     protected $table = 'tenants';
     protected $primaryKey = 'id';

src/Jobs/ClearReadiedTenants.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Artisan;
+use Stancl\Tenancy\Contracts\TenantWithDatabase;
+
+class ClearReadiedTenants implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * Execute the job.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        Artisan::call('tenants:readied-clear');
+    }
+}

src/Jobs/CreateReadiedTenants.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Artisan;
+use Stancl\Tenancy\Contracts\TenantWithDatabase;
+
+class CreateReadiedTenants implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * Execute the job.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        Artisan::call('tenants:readied');
+    }
+}

src/TenancyServiceProvider.php

@@ -89,6 +89,8 @@ class TenancyServiceProvider extends ServiceProvider
             Commands\Rollback::class,
             Commands\TenantList::class,
             Commands\MigrateFresh::class,
+            Commands\CreateReadiedTenants::class,
+            Commands\ClearReadiedTenants::class,
         ]);
 
         $this->publishes([