Document using --skip-failing on tenants:migrate

[xdimension]

Hi,

First, thank you for creating this awesome package!

Describe the bug

In our case when a tenant is created a record will be added to the Tenant table but we need to postpone the creation of the tenant database as it requires approval (we have managed this behavior using additional event instead of TenantCreated, thanks for the flexibility of this package). Thus, there will be any tenant records which the databases haven't been created yet, this causes an issue if we have additional migration for tenants, when running artisan tenants:migrate it will raise TenantDatabaseDoesNotExistException.

 at \vendor\stancl\tenancy\src\Bootstrappers\DatabaseTenancyBootstrapper.php:30
    27|         if (app()->environment('local')) {
    28|             $database = $tenant->database()->getName();
    29|             if (! $tenant->database()->manager()->databaseExists($database)) {
  > 30|                 throw new TenantDatabaseDoesNotExistException($database);
    31|             }
    32|         }

Steps to reproduce

Specifically for my case above, running artisan tenants:migrate will raise TenantDatabaseDoesNotExistException.

Expected behavior

It may show just a message that the database doesn't exist and continue the migration for the rest of the other tenants.

Your setup

• Laravel version: 7.0
• stancl/tenancy version: 3.0
• Storage driver: mysql

[tfilho]

This could be configurable

[stancl]

Hi.

This is not a bug. The standard behavior works as it should.

If you have tenants that don't have a database yet, don't run tenants:migrate for all tenants. You can specify the tenants for which you want the command to run.

Ideally, you'd run it for each tenant separately from the app.

I can see this being an issue with deployments. Tenants existing without a DB but tenants:migrate running.

I think the best thing to do here would be adding a flag to tenants:migrate like --skip-failing. It could catch the exception from DatabaseTenancyBootstrapper and simply do nothing.

But, note that the TenantDatabaseDoesNotExistException is only thrown in local environment. In production, you get a QueryException.

Feel free to send a PR.

[xdimension]

Thanks for your response. Sorry for filing this issue as a bug, was not sure where to put in.

Yes, I think it's a good idea to add --skip-failing flag to tenant migration command. Let's see if we can explore the package and make the PR.