Merge remote-tracking branch 'origin/august' into tenant-param-before-route-prefix

Author: lukinovec

.github/workflows/validate.yml

@@ -8,14 +8,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Check for todo0
-      run: '! grep -r "todo0" --exclude-dir=workflows .'
-      if: always()
-    - name: Check for todo1
-      run: '! grep -r "todo1" --exclude-dir=workflows .'
-      if: always()
-    - name: Check for todo2
-      run: '! grep -r "todo2" --exclude-dir=workflows .'
+    - name: Check for priority todos
+      run: '! grep -r "todo[0-9]" --exclude-dir=workflows .'
       if: always()
     - name: Check for non-todo skip()s in tests
       run: '! grep -r "skip(" --exclude-dir=workflows tests/ | grep -v "todo"'

assets/TenancyServiceProvider.stub.php

@@ -21,6 +21,21 @@
 use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
 use Stancl\Tenancy\Bootstrappers\Integrations\FortifyRouteBootstrapper;
 
+/**
+ * Tenancy for Laravel.
+ *
+ * Documentation: https://tenancyforlaravel.com
+ *
+ * We can sustainably develop Tenancy for Laravel thanks to our sponsors.
+ * Big thanks to everyone listed here: https://github.com/sponsors/stancl
+ *
+ * You can also support us, and save time, by purchasing these products:
+ *   Exclusive content for sponsors: https://sponsors.tenancyforlaravel.com
+ *   Multi-Tenant SaaS boilerplate: https://portal.archte.ch/boilerplate
+ *   Multi-Tenant Laravel in Production e-book: https://portal.archte.ch/book
+ *
+ * All of these products can also be accessed at https://portal.archte.ch
+ */
 class TenancyServiceProvider extends ServiceProvider
 {
     // By default, no namespace is used to support the callable array syntax.

assets/config.php

@@ -8,6 +8,21 @@
 use Stancl\Tenancy\Enums\RouteMode;
 use Stancl\Tenancy\UniqueIdentifierGenerators;
 
+/**
+ * Tenancy for Laravel.
+ *
+ * Documentation: https://tenancyforlaravel.com
+ *
+ * We can sustainably develop Tenancy for Laravel thanks to our sponsors.
+ * Big thanks to everyone listed here: https://github.com/sponsors/stancl
+ *
+ * You can also support us, and save time, by purchasing these products:
+ *   Exclusive content for sponsors: https://sponsors.tenancyforlaravel.com
+ *   Multi-Tenant SaaS boilerplate: https://portal.archte.ch/boilerplate
+ *   Multi-Tenant Laravel in Production e-book: https://portal.archte.ch/book
+ *
+ * All of these products can also be accessed at https://portal.archte.ch
+ */
 return [
     /**
      * Configuration for the models used by Tenancy.

docker-compose.yml

@@ -80,7 +80,7 @@ services:
         image: mcr.microsoft.com/mssql/server:2022-latest
         environment:
           - ACCEPT_EULA=Y
-          - SA_PASSWORD=P@ssword # todo reuse env from above
+          - SA_PASSWORD=P@ssword # must be the same as TENANCY_TEST_SQLSRV_PASSWORD
         healthcheck: # https://github.com/Microsoft/mssql-docker/issues/133#issuecomment-1995615432
             test: timeout 2 bash -c 'cat < /dev/null > /dev/tcp/127.0.0.1/1433'
             interval: 10s

src/Bootstrappers/DatabaseTenancyBootstrapper.php

@@ -32,10 +32,10 @@ public function bootstrap(Tenant $tenant): void
             throw new Exception('The template connection must NOT have URL defined. Specify the connection using individual parts instead of a database URL.');
         }
 
-        // Better debugging, but breaks cached lookup in prod
-        if (app()->environment('local') || app()->environment('testing')) { // todo@docs mention this change in v4 upgrade guide https://github.com/archtechx/tenancy/pull/945#issuecomment-1268206149
+        // Better debugging, but breaks cached lookup, so we disable this in prod
+        if (app()->environment('local') || app()->environment('testing')) {
             $database = $tenant->database()->getName();
-            if (! $tenant->database()->manager()->databaseExists($database)) { // todo@samuel does this call correctly use the host connection?
+            if (! $tenant->database()->manager()->databaseExists($database)) { // todo@dbRefactor does this call correctly use the host connection?
                 throw new TenantDatabaseDoesNotExistException($database);
             }
         }

src/Commands/CreatePendingTenants.php

@@ -8,7 +8,7 @@
 
 class CreatePendingTenants extends Command
 {
-    protected $signature = 'tenants:pending-create {--count= : The number of pending tenants to be created}';
+    protected $signature = 'tenants:pending-create {--count= : The number of pending tenants to maintain}';
 
     protected $description = 'Create pending tenants.';
 

src/Commands/Migrate.php

@@ -51,13 +51,24 @@ public function handle(): int
             return 1;
         }
 
+        $originalTemplateConnection = config('tenancy.database.template_tenant_connection');
+
+        if ($database = $this->input->getOption('database')) {
+            config(['tenancy.database.template_tenant_connection' => $database]);
+        }
+
         if ($this->getProcesses() > 1) {
-            return $this->runConcurrently($this->getTenantChunks()->map(function ($chunk) {
+            $code = $this->runConcurrently($this->getTenantChunks()->map(function ($chunk) {
                 return $this->getTenants($chunk);
             }));
+        } else {
+            $code = $this->migrateTenants($this->getTenants()) ? 0 : 1;
         }
 
-        return $this->migrateTenants($this->getTenants()) ? 0 : 1;
+        // Reset the template tenant connection to the original one
+        config(['tenancy.database.template_tenant_connection' => $originalTemplateConnection]);
+
+        return $code;
     }
 
     protected function childHandle(mixed ...$args): bool

src/Commands/MigrateFresh.php

@@ -4,6 +4,7 @@
 
 namespace Stancl\Tenancy\Commands;
 
+use Illuminate\Console\ConfirmableTrait;
 use Illuminate\Database\Console\Migrations\BaseCommand;
 use Illuminate\Database\QueryException;
 use Illuminate\Support\LazyCollection;
@@ -17,7 +18,7 @@
 
 class MigrateFresh extends BaseCommand
 {
-    use HasTenantOptions, DealsWithMigrations, ParallelCommand;
+    use HasTenantOptions, DealsWithMigrations, ParallelCommand, ConfirmableTrait;
 
     protected $description = 'Drop all tables and re-run all migrations for tenant(s)';
 
@@ -27,13 +28,18 @@ public function __construct()
 
         $this->addOption('drop-views', null, InputOption::VALUE_NONE, 'Drop views along with tenant tables.', null);
         $this->addOption('step', null, InputOption::VALUE_NONE, 'Force the migrations to be run so they can be rolled back individually.');
+        $this->addOption('force', null, InputOption::VALUE_NONE, 'Force the command to run when in production.', null);
         $this->addProcessesOption();
 
         $this->setName('tenants:migrate-fresh');
     }
 
     public function handle(): int
     {
+        if (! $this->confirmToProceed()) {
+            return 1;
+        }
+
         $success = true;
 
         if ($this->getProcesses() > 1) {

src/Contracts/Feature.php

@@ -4,10 +4,8 @@
 
 namespace Stancl\Tenancy\Contracts;
 
-use Stancl\Tenancy\Tenancy;
-
 /** Additional features, like Telescope tags and tenant redirects. */
 interface Feature
 {
-    public function bootstrap(Tenancy $tenancy): void;
+    public function bootstrap(): void;
 }

src/Database/Concerns/HasPending.php

@@ -6,14 +6,13 @@
 
 use Carbon\Carbon;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\DB;
 use Stancl\Tenancy\Contracts\Tenant;
 use Stancl\Tenancy\Events\CreatingPendingTenant;
 use Stancl\Tenancy\Events\PendingTenantCreated;
 use Stancl\Tenancy\Events\PendingTenantPulled;
 use Stancl\Tenancy\Events\PullingPendingTenant;
 
-// todo consider adding a method that sets pending_since to null — to flag tenants as not-pending
-
 /**
  * @property ?Carbon $pending_since
  *
@@ -50,46 +49,62 @@ public function pending(): bool
      */
     public static function createPending(array $attributes = []): Model&Tenant
     {
-        $tenant = static::create($attributes);
-
-        event(new CreatingPendingTenant($tenant));
-
-        // Update the pending_since value only after the tenant is created so it's
-        // Not marked as pending until finishing running the migrations, seeders, etc.
-        $tenant->update([
-            'pending_since' => now()->timestamp,
-        ]);
+        try {
+            $tenant = static::create($attributes);
+            event(new CreatingPendingTenant($tenant));
+        } finally {
+            // Update the pending_since value only after the tenant is created so it's
+            // not marked as pending until after migrations, seeders, etc are run.
+            $tenant->update([
+                'pending_since' => now()->timestamp,
+            ]);
+        }
 
         event(new PendingTenantCreated($tenant));
 
         return $tenant;
     }
 
-    /** Pull a pending tenant. */
-    public static function pullPending(): Model&Tenant
+    /**
+     * Pull a pending tenant from the pool or create a new one if the pool is empty.
+     *
+     * @param array $attributes The attributes to set on the tenant.
+     */
+    public static function pullPending(array $attributes = []): Model&Tenant
     {
         /** @var Model&Tenant $pendingTenant */
-        $pendingTenant = static::pullPendingFromPool(true);
+        $pendingTenant = static::pullPendingFromPool(true, $attributes);
 
         return $pendingTenant;
     }
 
-    /** Try to pull a tenant from the pool of pending tenants. */
-    public static function pullPendingFromPool(bool $firstOrCreate = true, array $attributes = []): ?Tenant
+    /**
+     * Try to pull a tenant from the pool of pending tenants.
+     *
+     * @param bool $firstOrCreate If true, a tenant will be *created* if the pool is empty. Otherwise null is returned.
+     * @param array $attributes The attributes to set on the tenant.
+     */
+    public static function pullPendingFromPool(bool $firstOrCreate = false, array $attributes = []): ?Tenant
     {
-        /** @var (Model&Tenant)|null $tenant */
-        $tenant = static::onlyPending()->first();
+        $tenant = DB::transaction(function () use ($attributes): ?Tenant {
+            /** @var (Model&Tenant)|null $tenant */
+            $tenant = static::onlyPending()->first();
+
+            if ($tenant !== null) {
+                event(new PullingPendingTenant($tenant));
+                $tenant->update(array_merge($attributes, [
+                    'pending_since' => null,
+                ]));
+            }
+
+            return $tenant;
+        });
 
         if ($tenant === null) {
             return $firstOrCreate ? static::create($attributes) : null;
         }
 
-        event(new PullingPendingTenant($tenant));
-
-        $tenant->update(array_merge($attributes, [
-            'pending_since' => null,
-        ]));
-
+        // Only triggered if a tenant that was pulled from the pool is returned
         event(new PendingTenantPulled($tenant));
 
         return $tenant;