Merge branch 'master' into pr/874

.github/workflows/ci.yml

@@ -1,31 +1,104 @@
 name: CI
 
 env:
-  COMPOSE_INTERACTIVE_NO_CLI: 1
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
 on:
   push:
-    branches: [ 3.x, 2.x ]
   pull_request:
-    branches: [ 3.x, 2.x ]
+    branches: [ master ]
 
 jobs:
   tests:
     runs-on: ubuntu-latest
+    container: archtechx/tenancy:latest
 
     strategy:
       matrix:
-        php: ["7.3", "8.0"]
+        laravel: ['^9.0']
-        laravel: ["^6.0", "^8.0", "^9.0"]
-        exclude:
-          - laravel: "^9.0"
-            php: "7.3"
 
     steps:
-    - uses: actions/checkout@v2
+      - name: Checkout
-    - name: Start docker containers
+        uses: actions/checkout@v2
-      run: PHP_VERSION=${{ matrix.php }} docker-compose up -d
+
-    - name: Install dependencies
+      - name: Install Composer dependencies
-      run: docker-compose exec -T test composer require --no-interaction "laravel/framework:${{ matrix.laravel }}"
+        run: |
+          composer require "laravel/framework:${{ matrix.laravel }}" --no-interaction --no-update
+          composer update --prefer-dist --no-interaction
       - name: Run tests
-      run: ./test
+        run: ./vendor/bin/pest
+        env:
+          DB_PASSWORD: password
+          DB_USERNAME: root
+          DB_DATABASE: main
+          TENANCY_TEST_MYSQL_HOST: mysql
+          TENANCY_TEST_PGSQL_HOST: postgres
+          TENANCY_TEST_REDIS_HOST: redis
+          TENANCY_TEST_SQLSRV_HOST: mssql
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          token: 24382d15-84e7-4a55-bea4-c4df96a24a9b
+
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_USER: root
+          POSTGRES_DB: main
+        ports:
+          - 5432/tcp
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
+
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: false
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_DATABASE: main
+        ports:
+          - 3306/tcp
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+      mysql2:
+        image: mysql:5.7
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: false
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_DATABASE: main
+        ports:
+          - 3306/tcp
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+      mssql:
+        image: mcr.microsoft.com/mssql/server:2019-latest
+        ports:
+          - 1433/tcp
+        env:
+          ACCEPT_EULA: Y
+          SA_PASSWORD: P@ssword
+        options: --health-cmd "echo quit | /opt/mssql-tools/bin/sqlcmd -S 127.0.0.1 -l 1 -U sa -P P@ssword"
+
+      redis:
+        image: redis
+        ports:
+          - 6379/tcp
+        options: --health-cmd="redis-cli ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+  php-cs-fixer:
+    name: Code style (php-cs-fixer)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install php-cs-fixer
+        run: composer global require friendsofphp/php-cs-fixer
+      - name: Run php-cs-fixer
+        run: $HOME/.composer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php
+      - name: Commit changes from php-cs-fixer
+        uses: EndBug/add-and-commit@v5
+        with:
+          author_name: "PHP CS Fixer"
+          author_email: "phpcsfixer@example.com"
+          message: Fix code style (php-cs-fixer)

.gitignore

@@ -8,5 +8,7 @@ psysh
 phpunit_var_*.xml
 coverage/
 clover.xml
+tenant-schema-test.dump
 tests/Etc/tmp/queuetest.json
 docker-compose.override.yml
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,141 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$rules = [
+    'array_syntax' => ['syntax' => 'short'],
+    'binary_operator_spaces' => [
+        'default' => 'single_space',
+        'operators' => [
+            '=>' => null,
+            '|' => 'no_space',
+        ]
+    ],
+    'blank_line_after_namespace' => true,
+    'blank_line_after_opening_tag' => true,
+    'no_superfluous_phpdoc_tags' => true,
+    'blank_line_before_statement' => [
+        'statements' => ['return']
+    ],
+    'braces' => true,
+    'cast_spaces' => true,
+    'class_definition' => true,
+    'concat_space' => [
+        'spacing' => 'one'
+    ],
+    'declare_equal_normalize' => true,
+    'elseif' => true,
+    'encoding' => true,
+    'full_opening_tag' => true,
+    'declare_strict_types' => true,
+    'fully_qualified_strict_types' => true, // added by Shift
+    'function_declaration' => true,
+    'function_typehint_space' => true,
+    'heredoc_to_nowdoc' => true,
+    'include' => true,
+    'increment_style' => ['style' => 'post'],
+    'indentation_type' => true,
+    'linebreak_after_opening_tag' => true,
+    'line_ending' => true,
+    'lowercase_cast' => true,
+    'constant_case' => true,
+    'lowercase_keywords' => true,
+    'lowercase_static_reference' => true, // added from Symfony
+    'magic_method_casing' => true, // added from Symfony
+    'magic_constant_casing' => true,
+    'method_argument_space' => true,
+    'native_function_casing' => true,
+    'no_alias_functions' => true,
+    'no_extra_blank_lines' => [
+        'tokens' => [
+            'extra',
+            'throw',
+            'use',
+            'use_trait',
+        ]
+    ],
+    'no_blank_lines_after_class_opening' => true,
+    'no_blank_lines_after_phpdoc' => true,
+    'no_closing_tag' => true,
+    'no_empty_phpdoc' => true,
+    'no_empty_statement' => true,
+    'no_leading_import_slash' => true,
+    'no_leading_namespace_whitespace' => true,
+    'no_mixed_echo_print' => [
+        'use' => 'echo'
+    ],
+    'no_multiline_whitespace_around_double_arrow' => true,
+    'multiline_whitespace_before_semicolons' => [
+        'strategy' => 'no_multi_line'
+    ],
+    'no_short_bool_cast' => true,
+    'no_singleline_whitespace_before_semicolons' => true,
+    'no_spaces_after_function_name' => true,
+    'no_spaces_around_offset' => true,
+    'no_spaces_inside_parenthesis' => true,
+    'no_trailing_comma_in_list_call' => true,
+    'no_trailing_comma_in_singleline_array' => true,
+    'no_trailing_whitespace' => true,
+    'no_trailing_whitespace_in_comment' => true,
+    'no_unneeded_control_parentheses' => true,
+    'no_unreachable_default_argument_value' => true,
+    'no_useless_return' => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line' => true,
+    'normalize_index_brace' => true,
+    'not_operator_with_successor_space' => true,
+    'object_operator_without_whitespace' => true,
+    'ordered_imports' => ['sort_algorithm' => 'alpha'],
+    'phpdoc_indent' => true,
+    'general_phpdoc_tag_rename' => true,
+    'phpdoc_no_access' => true,
+    'phpdoc_no_package' => true,
+    'phpdoc_no_useless_inheritdoc' => true,
+    'phpdoc_scalar' => true,
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_summary' => true,
+    'phpdoc_to_comment' => false,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+    'phpdoc_var_without_name' => true,
+    'psr_autoloading' => true,
+    'self_accessor' => true,
+    'short_scalar_cast' => true,
+    'simplified_null_return' => false, // disabled by Shift
+    'single_blank_line_at_eof' => true,
+    'single_blank_line_before_namespace' => true,
+    'single_class_element_per_statement' => true,
+    'single_import_per_statement' => true,
+    'single_line_after_imports' => true,
+    'no_unused_imports' => true,
+    'single_line_comment_style' => [
+        'comment_types' => ['hash']
+    ],
+    'single_quote' => true,
+    'space_after_semicolon' => true,
+    'standardize_not_equals' => true,
+    'switch_case_semicolon_to_colon' => true,
+    'switch_case_space' => true,
+    'ternary_operator_spaces' => true,
+    'trailing_comma_in_multiline' => true,
+    'trim_array_spaces' => true,
+    'unary_operator_spaces' => true,
+    'whitespace_after_comma_in_array' => true,
+];
+
+$project_path = getcwd();
+$finder = Finder::create()
+    ->in([
+        $project_path . '/src',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new Config())
+    ->setFinder($finder)
+    ->setRules($rules)
+    ->setRiskyAllowed(true)
+    ->setUsingCache(true);

.styleci.yml

@@ -1,7 +0,0 @@
-risky: true
-preset: laravel
-enabled:
-- declare_strict_types
-disabled:
-- concat_without_spaces
-- ternary_operator_spaces

CONTRIBUTING.md

@@ -2,23 +2,30 @@
 
 ## Code style
 
-StyleCI will flag code style violations in your pull requests.
+php-cs-fixer will fix code style violations in your pull requests.
 
 ## Running tests
 
-Run `docker-compose up -d` to start the containers. Then run `./test` to run the tests.
+Run `composer docker-up` to start the containers. Then run `composer test` to run the tests.
 
-When you're done testing, run `docker-compose down` to shut down the containers.
+If you need to pass additional flags to phpunit, use `./test --foo` instead of `composer test --foo`. Composer scripts unfortunately don't pass CLI arguments.
+
+When you're done testing, run `composer docker-down` to shut down the containers.
 
 ### Docker on M1
 
-You can add:
+Run `composer docker-m1` to symlink `docker-compose-m1.override.yml` to `docker-compose.override.yml`. This will reconfigure a few services in the docker compose config to be compatible with M1.
-```yaml
-services:
-  mysql:
-    platform: linux/amd64
-  mysql2:
-    platform: linux/amd64
-```
 
-to `docker-compose.override.yml` to make `docker-compose up-d` work on M1.
+### Coverage reports
+
+To run tests and generate coverage reports, use `composer test-full`.
+
+To view the coverage reports in your browser, use `composer coverage` (works on macOS; on other operating systems you can manually open `coverage/phpunit/html/index.html` in your browser).
+
+### Rebuilding containers
+
+If you need to rebuild the container for any reason (e.g. a change in `Dockerfile`), you can use `composer docker-rebuild`.
+
+## PHPStan
+
+Use `composer phpstan` to run our phpstan suite.

Dockerfile

@@ -1,50 +1,42 @@
-ARG PHP_VERSION=7.4
+# add amd64 platform to support Mac M1
-ARG PHP_TARGET=php:${PHP_VERSION}-cli
+FROM --platform=linux/amd64 shivammathur/node:latest-amd64
 
-FROM ${PHP_TARGET}
+ARG PHP_VERSION=8.1
-
-ARG COMPOSER_TARGET=2.0.3
 
 WORKDIR /var/www/html
 
-LABEL org.opencontainers.image.source=https://github.com/stancl/tenancy \
-    org.opencontainers.image.vendor="Samuel Štancl" \
-    org.opencontainers.image.licenses="MIT" \
-    org.opencontainers.image.title="PHP ${PHP_VERSION} with modules for laravel support" \
-    org.opencontainers.image.description="PHP ${PHP_VERSION} with a set of php/os packages suitable for running Laravel apps"
-
 # our default timezone and langauge
 ENV TZ=Europe/London
 ENV LANG=en_GB.UTF-8
 
-# Note: we only install reliable/core 1st-party php extensions here.
+# install MYSSQL ODBC Driver
-#       If your app needs custom ones install them in the apps own
+RUN apt-get update \
-#       Dockerfile _and pin the versions_! Eg:
+    && apt-get install -y gnupg2 \
-#       RUN pecl install memcached-2.2.0 && docker-php-ext-enable memcached
+    && curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add - \
+    && curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list > /etc/apt/sources.list.d/mssql-release.list \
+    && apt-get update \
+    && ACCEPT_EULA=Y apt-get install -y unixodbc-dev msodbcsql17
+
+# set PHP version
+RUN update-alternatives --set php /usr/bin/php$PHP_VERSION \
+    && update-alternatives --set phar /usr/bin/phar$PHP_VERSION \
+    && update-alternatives --set phar.phar /usr/bin/phar.phar$PHP_VERSION \
+    && update-alternatives --set phpize /usr/bin/phpize$PHP_VERSION \
+    && update-alternatives --set php-config /usr/bin/php-config$PHP_VERSION
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends libhiredis0.14 libjemalloc2 liblua5.1-0 lua-bitop lua-cjson redis redis-server redis-tools
+
+RUN pecl install redis-5.3.7 sqlsrv pdo_sqlsrv pcov \
+    && printf "; priority=20\nextension=redis.so\n" > /etc/php/$PHP_VERSION/mods-available/redis.ini \
+    && printf "; priority=20\nextension=sqlsrv.so\n" > /etc/php/$PHP_VERSION/mods-available/sqlsrv.ini \
+    && printf "; priority=30\nextension=pdo_sqlsrv.so\n" > /etc/php/$PHP_VERSION/mods-available/pdo_sqlsrv.ini \
+    && printf "; priority=40\nextension=pcov.so\n" > /etc/php/$PHP_VERSION/mods-available/pcov.ini \
+    && phpenmod -v $PHP_VERSION redis sqlsrv pdo_sqlsrv pcov
+
+# install composer
+COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
 
-# install some OS packages we need
-RUN apt-get update
-RUN apt-get install -y --no-install-recommends libfreetype6-dev libjpeg62-turbo-dev libpng-dev libgmp-dev libldap2-dev netcat curl sqlite3 libsqlite3-dev libpq-dev libzip-dev unzip vim-tiny gosu git
-    # install php extensions
-RUN docker-php-ext-configure pgsql -with-pgsql=/usr/local/pgsql \
-    # && if [ "${PHP_VERSION}" = "7.4" ]; then docker-php-ext-configure gd --with-freetype --with-jpeg; else docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/; fi \
-    && docker-php-ext-install -j$(nproc) gd pdo pdo_mysql pdo_pgsql pdo_sqlite pgsql zip gmp bcmath pcntl ldap sysvmsg exif \
-    # install the redis php extension
-    && pecl install redis-5.3.7 \
-    && docker-php-ext-enable redis \
-    # install the pcov extention
-    && pecl install pcov \
-    && docker-php-ext-enable pcov \
-    && echo "pcov.enabled = 1" > /usr/local/etc/php/conf.d/pcov.ini
-# clear the apt cache
-RUN rm -rf /var/lib/apt/lists/* \
-    && rm -rf /var/lib/apt/lists/* \
-    # install composer
-    && curl -o /tmp/composer-setup.php https://getcomposer.org/installer \
-    && curl -o /tmp/composer-setup.sig https://composer.github.io/installer.sig \
-    && php -r "if (hash('SHA384', file_get_contents('/tmp/composer-setup.php')) !== trim(file_get_contents('/tmp/composer-setup.sig'))) { unlink('/tmp/composer-setup.php'); echo 'Invalid installer' . PHP_EOL; exit(1); }" \
-    && php /tmp/composer-setup.php --version=${COMPOSER_TARGET} --no-ansi --install-dir=/usr/local/bin --filename=composer --snapshot \
-    && rm -f /tmp/composer-setup.*
 # set the system timezone
 RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime \
     && echo $TZ > /etc/timezone

SUPPORT.md

@@ -1,5 +1,5 @@
 # Get Support
 
-If you need help with implementing the package, you can join our community [Discord server](https://discord.gg/7cpgPxv) and ask in `#help`.
+If you need help with implementing the package, you can join our community [Discord server](https://archte.ch/discord) and ask in `#help`.
 
 If you're interested in paid consulting from the maintainer, see the [contact page](https://tenancyforlaravel.com/contact/) on our website.

assets/TenancyServiceProvider.stub.php

@@ -40,7 +40,13 @@ class TenancyServiceProvider extends ServiceProvider
             Events\TenantSaved::class => [],
             Events\UpdatingTenant::class => [],
             Events\TenantUpdated::class => [],
-            Events\DeletingTenant::class => [],
+            Events\DeletingTenant::class => [
+                JobPipeline::make([
+                    Jobs\DeleteDomains::class,
+                ])->send(function (Events\DeletingTenant $event) {
+                    return $event->tenant;
+                })->shouldBeQueued(false),
+            ],
             Events\TenantDeleted::class => [
                 JobPipeline::make([
                     Jobs\DeleteDatabase::class,

assets/config.php

@@ -59,21 +59,22 @@ return [
          * TenantDatabaseManagers are classes that handle the creation & deletion of tenant databases.
          */
         'managers' => [
-            'sqlite' => Stancl\Tenancy\TenantDatabaseManagers\SQLiteDatabaseManager::class,
+            'sqlite' => Stancl\Tenancy\Database\TenantDatabaseManagers\SQLiteDatabaseManager::class,
-            'mysql' => Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager::class,
+            'mysql' => Stancl\Tenancy\Database\TenantDatabaseManagers\MySQLDatabaseManager::class,
-            'pgsql' => Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager::class,
+            'pgsql' => Stancl\Tenancy\Database\TenantDatabaseManagers\PostgreSQLDatabaseManager::class,
+            'sqlsrv' => Stancl\Tenancy\Database\TenantDatabaseManagers\MicrosoftSQLDatabaseManager::class,
 
         /**
          * Use this database manager for MySQL to have a DB user created for each tenant database.
          * You can customize the grants given to these users by changing the $grants property.
          */
-            // 'mysql' => Stancl\Tenancy\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager::class,
+            // 'mysql' => Stancl\Tenancy\Database\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager::class,
 
         /**
          * Disable the pgsql manager above, and enable the one below if you
          * want to separate tenant DBs by schemas rather than databases.
          */
-            // 'pgsql' => Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLSchemaManager::class, // Separate by schema instead of database
+            // 'pgsql' => Stancl\Tenancy\Database\TenantDatabaseManagers\PostgreSQLSchemaManager::class, // Separate by schema instead of database
         ],
     ],
 

assets/migrations/2019_09_15_000020_create_domains_table.php

@@ -21,7 +21,7 @@ class CreateDomainsTable extends Migration
             $table->string('tenant_id');
 
             $table->timestamps();
-            $table->foreign('tenant_id')->references('id')->on('tenants')->onUpdate('cascade')->onDelete('cascade');
+            $table->foreign('tenant_id')->references('id')->on('tenants')->onUpdate('cascade');
         });
     }
 

composer.json

@@ -1,28 +1,36 @@
 {
     "name": "stancl/tenancy",
     "description": "Automatic multi-tenancy for your Laravel application.",
-    "keywords": ["laravel", "multi-tenancy", "multi-database", "tenancy"],
+    "keywords": [
+        "laravel",
+        "multi-tenancy",
+        "multi-database",
+        "tenancy"
+    ],
     "license": "MIT",
     "authors": [
         {
             "name": "Samuel Štancl",
-            "email": "samuel.stancl@gmail.com"
+            "email": "samuel@archte.ch"
         }
     ],
     "require": {
+        "php": "^8.1",
         "ext-json": "*",
-        "illuminate/support": "^6.0|^7.0|^8.0|^9.0",
+        "illuminate/support": "^9.0",
-        "facade/ignition-contracts": "^1.0",
+        "spatie/ignition": "^1.4",
-        "ramsey/uuid": "^3.7|^4.0",
+        "ramsey/uuid": "^4.0",
         "stancl/jobpipeline": "^1.0",
         "stancl/virtualcolumn": "^1.0"
     },
     "require-dev": {
-        "laravel/framework": "^6.0|^7.0|^8.0|^9.0",
+        "laravel/framework": "^9.0",
-        "orchestra/testbench": "^4.0|^5.0|^6.0|^7.0",
+        "orchestra/testbench": "^7.0",
-        "league/flysystem-aws-s3-v3": "^1.0|^3.0",
+        "league/flysystem-aws-s3-v3": "^3.0",
         "doctrine/dbal": "^2.10",
-        "spatie/valuestore": "^1.2.5"
+        "spatie/valuestore": "^1.2.5",
+        "pestphp/pest": "^1.21",
+        "nunomaduro/larastan": "^1.0"
     },
     "autoload": {
         "psr-4": {
@@ -48,6 +56,21 @@
             }
         }
     },
+    "scripts": {
+        "docker-up": "PHP_VERSION=8.1 docker-compose up -d",
+        "docker-down": "PHP_VERSION=8.1 docker-compose down",
+        "docker-rebuild": "PHP_VERSION=8.1 docker-compose up -d --no-deps --build",
+        "docker-m1": "ln -s docker-compose-m1.override.yml docker-compose.override.yml",
+        "coverage": "open coverage/phpunit/html/index.html",
+        "phpstan": "vendor/bin/phpstan",
+        "test": "PHP_VERSION=8.1 ./test --no-coverage",
+        "test-full": "PHP_VERSION=8.1 ./test"
+    },
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    }
 }

docker-compose-m1.override.yml

@@ -0,0 +1,7 @@
+services:
+  mysql:
+    platform: linux/amd64
+  mysql2:
+    platform: linux/amd64
+  mssql:
+    image: mcr.microsoft.com/azure-sql-edge

docker-compose.yml

@@ -22,6 +22,9 @@ services:
             TENANCY_TEST_REDIS_HOST: redis
             TENANCY_TEST_MYSQL_HOST: mysql
             TENANCY_TEST_PGSQL_HOST: postgres
+            TENANCY_TEST_SQLSRV_HOST: mssql
+            TENANCY_TEST_SQLSRV_USERNAME: sa
+            TENANCY_TEST_SQLSRV_PASSWORD: P@ssword
         stdin_open: true
         tty: true
     mysql:
@@ -64,3 +67,11 @@ services:
             interval: 1s
             timeout: 3s
             retries: 30
+    mssql:
+        image: mcr.microsoft.com/mssql/server:2019-latest
+        ports:
+            - 1433:1433
+        environment:
+          - ACCEPT_EULA=Y
+          - SA_PASSWORD=P@ssword # todo reuse values from env above
+        # todo missing health check

phpstan.neon

@@ -0,0 +1,25 @@
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+
+parameters:
+    paths:
+        - src
+        # - tests
+
+    level: 8
+
+    universalObjectCratesClasses:
+        - Illuminate\Routing\Route
+
+    ignoreErrors:
+        -
+            message: '#Cannot access offset (.*?) on Illuminate\\Contracts\\Foundation\\Application#'
+            paths:
+                - src/TenancyServiceProvider.php
+        -
+            message: '#invalid type Laravel\\Telescope\\IncomingEntry#'
+            paths:
+                - src/Features/TelescopeTags.php
+
+    checkMissingIterableValueType: false
+    treatPhpDocTypesAsCertain: false

src/Bootstrappers/DatabaseTenancyBootstrapper.php

@@ -6,7 +6,7 @@ namespace Stancl\Tenancy\Bootstrappers;
 
 use Stancl\Tenancy\Contracts\TenancyBootstrapper;
 use Stancl\Tenancy\Contracts\Tenant;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Database\DatabaseManager;
 use Stancl\Tenancy\Exceptions\TenantDatabaseDoesNotExistException;
 

src/Bootstrappers/FilesystemTenancyBootstrapper.php

@@ -56,6 +56,8 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper
         Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']);
 
         foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
+            // todo@v4 \League\Flysystem\PathPrefixer is making this a lot more painful in flysystem v2
+
             $originalRoot = $this->app['config']["filesystems.disks.{$disk}.root"];
             $this->originalPaths['disks'][$disk] = $originalRoot;
 
@@ -67,7 +69,7 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper
 
             if (! $finalPrefix) {
                 $finalPrefix = $originalRoot
-                    ? rtrim($originalRoot, '/') . '/'. $suffix
+                    ? rtrim($originalRoot, '/') . '/' . $suffix
                     : $suffix;
             }
 

src/Bootstrappers/QueueTenancyBootstrapper.php

@@ -4,18 +4,17 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Bootstrappers;
 
-use Illuminate\Support\Str;
 use Illuminate\Config\Repository;
-use Illuminate\Queue\QueueManager;
+use Illuminate\Contracts\Events\Dispatcher;
-use Stancl\Tenancy\Contracts\Tenant;
+use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Queue\Events\JobFailed;
 use Illuminate\Queue\Events\JobProcessed;
 use Illuminate\Queue\Events\JobProcessing;
-use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Queue\Events\JobRetryRequested;
+use Illuminate\Queue\QueueManager;
 use Illuminate\Support\Testing\Fakes\QueueFake;
-use Illuminate\Contracts\Foundation\Application;
 use Stancl\Tenancy\Contracts\TenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Tenant;
 
 class QueueTenancyBootstrapper implements TenancyBootstrapper
 {

src/CacheManager.php

@@ -6,6 +6,8 @@ namespace Stancl\Tenancy;
 
 use Illuminate\Cache\CacheManager as BaseCacheManager;
 
+// todo move to Cache namespace?
+
 class CacheManager extends BaseCacheManager
 {
     /**
@@ -13,7 +15,6 @@ class CacheManager extends BaseCacheManager
      *
      * @param string $method
      * @param array $parameters
-     * @return mixed
      */
     public function __call($method, $parameters)
     {
@@ -27,7 +28,7 @@ class CacheManager extends BaseCacheManager
             }
 
             $names = $parameters[0];
-            $names = (array) $names; // cache()->tags('foo') https://laravel.com/docs/5.7/cache#removing-tagged-cache-items
+            $names = (array) $names; // cache()->tags('foo') https://laravel.com/docs/9.x/cache#removing-tagged-cache-items
 
             return $this->store()->tags(array_merge($tags, $names));
         }

src/Commands/Install.php

@@ -24,8 +24,6 @@ class Install extends Command
 
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
     public function handle()
     {

src/Commands/Migrate.php

@@ -33,8 +33,6 @@ class Migrate extends MigrateCommand
 
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
     public function handle()
     {

src/Commands/MigrateFresh.php

@@ -31,8 +31,6 @@ final class MigrateFresh extends Command
 
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
     public function handle()
     {

src/Commands/Rollback.php

@@ -42,8 +42,6 @@ class Rollback extends RollbackCommand
 
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
     public function handle()
     {

src/Commands/Run.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Commands;
 
 use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Artisan;
 
 class Run extends Command
 {
@@ -20,38 +21,20 @@ class Run extends Command
      *
      * @var string
      */
-    protected $signature = "tenants:run {commandname : The command's name.}
+    protected $signature = 'tenants:run {commandname : The artisan command.}
-                            {--tenants=* : The tenant(s) to run the command for. Default: all}
+                            {--tenants=* : The tenant(s) to run the command for. Default: all}';
-                            {--argument=* : The arguments to pass to the command. Default: none}
-                            {--option=* : The options to pass to the command. Default: none}";
 
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
     public function handle()
     {
         tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
             $this->line("Tenant: {$tenant->getTenantKey()}");
 
-            $callback = function ($prefix = '') {
+            Artisan::call($this->argument('commandname'));
-                return function ($arguments, $argument) use ($prefix) {
+            $this->comment('Command output:');
-                    [$key, $value] = explode('=', $argument, 2);
+            $this->info(Artisan::output());
-                    $arguments[$prefix . $key] = $value;
-
-                    return $arguments;
-                };
-            };
-
-            // Turns ['foo=bar', 'abc=xyz=zzz'] into ['foo' => 'bar', 'abc' => 'xyz=zzz']
-            $arguments = array_reduce($this->option('argument'), $callback(), []);
-
-            // Turns ['foo=bar', 'abc=xyz=zzz'] into ['--foo' => 'bar', '--abc' => 'xyz=zzz']
-            $options = array_reduce($this->option('option'), $callback('--'), []);
-
-            // Run command
-            $this->call($this->argument('commandname'), array_merge($arguments, $options));
         });
     }
 }

src/Commands/Seed.php

@@ -35,8 +35,6 @@ class Seed extends SeedCommand
 
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
     public function handle()
     {

src/Commands/TenantDump.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Database\ConnectionResolverInterface;
+use Illuminate\Database\Console\DumpCommand;
+use Stancl\Tenancy\Contracts\Tenant;
+use Symfony\Component\Console\Input\InputOption;
+
+class TenantDump extends DumpCommand
+{
+    public function __construct()
+    {
+        parent::__construct();
+
+        $this->setName('tenants:dump');
+        $this->specifyParameters();
+    }
+
+    public function handle(ConnectionResolverInterface $connections, Dispatcher $dispatcher): int
+    {
+        $this->tenant()->run(fn () => parent::handle($connections, $dispatcher));
+
+        return Command::SUCCESS;
+    }
+
+    public function tenant(): Tenant
+    {
+        $tenant = $this->option('tenant')
+            ?? tenant()
+            ?? $this->ask('What tenant do you want to dump the schema for?')
+            ?? tenancy()->query()->first();
+
+        if (! $tenant instanceof Tenant) {
+            $tenant = tenancy()->find($tenant);
+        }
+
+        throw_if(! $tenant, 'Could not identify the tenant to use for dumping the schema.');
+
+        return $tenant;
+    }
+
+    protected function getOptions(): array
+    {
+        return array_merge([
+            ['tenant', null, InputOption::VALUE_OPTIONAL, '', null],
+        ], parent::getOptions());
+    }
+}

src/Commands/TenantList.php

@@ -25,8 +25,6 @@ class TenantList extends Command
 
     /**
      * Execute the console command.
-     *
-     * @return mixed
      */
     public function handle()
     {

src/Concerns/Debuggable.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Concerns;
+
+use Closure;
+use Stancl\Tenancy\Enums\LogMode;
+use Stancl\Tenancy\Events\Contracts\TenancyEvent;
+use Stancl\Tenancy\Tenancy;
+
+// todo finish this feature
+
+/**
+ * @mixin Tenancy
+ */
+trait Debuggable
+{
+    protected LogMode $logMode = LogMode::NONE;
+    protected array $eventLog = [];
+
+    public function log(LogMode $mode = LogMode::SILENT): static
+    {
+        $this->eventLog = [];
+        $this->logMode = $mode;
+
+        return $this;
+    }
+
+    public function logMode(): LogMode
+    {
+        return $this->logMode;
+    }
+
+    public function getLog(): array
+    {
+        return $this->eventLog;
+    }
+
+    public function logEvent(TenancyEvent $event): static
+    {
+        $this->eventLog[] = ['time' => now(), 'event' => $event::class, 'tenant' => $this->tenant];
+
+        return $this;
+    }
+
+    public function dump(Closure $dump = null): static
+    {
+        $dump ??= dd(...);
+
+        // Dump the log if we were already logging in silent mode
+        // Otherwise start logging in instant mode
+        match ($this->logMode) {
+            LogMode::NONE => $this->log(LogMode::INSTANT),
+            LogMode::SILENT => $dump($this->eventLog),
+            LogMode::INSTANT => null,
+        };
+
+        return $this;
+    }
+
+    public function dd(Closure $dump = null): void
+    {
+        $dump ??= dd(...);
+
+        if ($this->logMode === LogMode::SILENT) {
+            $dump($this->eventLog);
+        } else {
+            $dump($this);
+        }
+    }
+}

src/Concerns/ExtendsLaravelCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Stancl\Tenancy\Concerns;
 
 trait ExtendsLaravelCommand

src/Concerns/HasATenantsOption.php

@@ -12,7 +12,7 @@ trait HasATenantsOption
     protected function getOptions()
     {
         return array_merge([
-            ['tenants', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL, '', null],
+            ['tenants', null, InputOption::VALUE_IS_ARRAY|InputOption::VALUE_OPTIONAL, '', null],
         ], parent::getOptions());
     }
 

src/Contracts/SyncMaster.php

@@ -7,6 +7,8 @@ namespace Stancl\Tenancy\Contracts;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
+// todo move all resource syncing-related things to a separate namespace?
+
 /**
  * @property-read Tenant[]|Collection $tenants
  */

src/Contracts/Syncable.php

@@ -8,11 +8,11 @@ interface Syncable
 {
     public function getGlobalIdentifierKeyName(): string;
 
-    public function getGlobalIdentifierKey();
+    public function getGlobalIdentifierKey(): string|int;
 
     public function getCentralModelName(): string;
 
     public function getSyncedAttributeNames(): array;
 
-    public function triggerSyncEvent();
+    public function triggerSyncEvent(): void;
 }

src/Contracts/Tenant.php

@@ -4,11 +4,11 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Contracts;
 
+use Closure;
+
 /**
  * @see \Stancl\Tenancy\Database\Models\Tenant
  *
- * @method __call(string $method, array $parameters) IDE support. This will be a model.
- * @method static __callStatic(string $method, array $parameters) IDE support. This will be a model.
  * @mixin \Illuminate\Database\Eloquent\Model
  */
 interface Tenant
@@ -17,14 +17,14 @@ interface Tenant
     public function getTenantKeyName(): string;
 
     /** Get the value of the key used for identifying the tenant. */
-    public function getTenantKey();
+    public function getTenantKey(): int|string;
 
     /** Get the value of an internal key. */
-    public function getInternal(string $key);
+    public function getInternal(string $key): mixed;
 
     /** Set the value of an internal key. */
-    public function setInternal(string $key, $value);
+    public function setInternal(string $key, mixed $value): static;
 
     /** Run a callback in this tenant's environment. */
-    public function run(callable $callback);
+    public function run(Closure $callback): mixed;
 }

src/Contracts/TenantCouldNotBeIdentifiedException.php

@@ -5,7 +5,49 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Contracts;
 
 use Exception;
+use Spatie\Ignition\Contracts\BaseSolution;
+use Spatie\Ignition\Contracts\ProvidesSolution;
 
-abstract class TenantCouldNotBeIdentifiedException extends Exception
+abstract class TenantCouldNotBeIdentifiedException extends Exception implements ProvidesSolution
 {
+    /** Default solution title. */
+    protected string $solutionTitle = 'Tenant could not be identified';
+
+    /** Default solution description. */
+    protected string $solutionDescription = 'Are you sure this tenant exists?';
+
+    /** Set the message. */
+    protected function tenantCouldNotBeIdentified(string $how): static
+    {
+        $this->message = 'Tenant could not be identified ' . $how;
+
+        return $this;
+    }
+
+    /** Set the solution title. */
+    protected function title(string $solutionTitle): static
+    {
+        $this->solutionTitle = $solutionTitle;
+
+        return $this;
+    }
+
+    /** Set the solution description. */
+    protected function description(string $solutionDescription): static
+    {
+        $this->solutionDescription = $solutionDescription;
+
+        return $this;
+    }
+
+    /** Get the Ignition description. */
+    public function getSolution(): BaseSolution
+    {
+        return BaseSolution::create($this->solutionTitle)
+            ->setSolutionDescription($this->solutionDescription)
+            ->setDocumentationLinks([
+                'Tenants' => 'https://tenancyforlaravel.com/docs/v3/tenants',
+                'Tenant Identification' => 'https://tenancyforlaravel.com/docs/v3/tenant-identification',
+            ]);
+    }
 }

src/Contracts/TenantResolver.php

@@ -11,5 +11,5 @@ interface TenantResolver
      *
      * @throws TenantCouldNotBeIdentifiedException
      */
-    public function resolve(...$args): Tenant;
+    public function resolve(mixed ...$args): Tenant;
 }

src/Contracts/TenantWithDatabase.php

@@ -1,15 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Stancl\Tenancy\Contracts;
-
-use Stancl\Tenancy\DatabaseConfig;
-
-interface TenantWithDatabase extends Tenant
-{
-    public function database(): DatabaseConfig;
-
-    /** Get an internal key. */
-    public function getInternal(string $key);
-}

src/Controllers/TenantAssetsController.php

@@ -4,22 +4,26 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Controllers;
 
+use Closure;
 use Illuminate\Routing\Controller;
+use Throwable;
 
 class TenantAssetsController extends Controller
 {
-    public static $tenancyMiddleware = 'Stancl\Tenancy\Middleware\InitializeTenancyByDomain';
+    public static string|array|Closure $tenancyMiddleware = Stancl\Tenancy\Middleware\InitializeTenancyByDomain::class;
 
     public function __construct()
     {
         $this->middleware(static::$tenancyMiddleware);
     }
 
-    public function asset($path)
+    public function asset(string $path = null)
     {
+        abort_if($path === null, 404);
+
         try {
             return response()->file(storage_path("app/public/$path"));
-        } catch (\Throwable $th) {
+        } catch (Throwable) {
             abort(404);
         }
     }

src/Database/Concerns/BelongsToPrimaryModel.php

@@ -10,7 +10,7 @@ trait BelongsToPrimaryModel
 {
     abstract public function getRelationshipToPrimaryModel(): string;
 
-    public static function bootBelongsToPrimaryModel()
+    public static function bootBelongsToPrimaryModel(): void
     {
         static::addGlobalScope(new ParentModelScope);
     }

src/Database/Concerns/BelongsToTenant.php

@@ -19,7 +19,7 @@ trait BelongsToTenant
         return $this->belongsTo(config('tenancy.tenant_model'), BelongsToTenant::$tenantIdColumn);
     }
 
-    public static function bootBelongsToTenant()
+    public static function bootBelongsToTenant(): void
     {
         static::addGlobalScope(new TenantScope);
 

src/Database/Concerns/ConvertsDomainsToLowercase.php

@@ -6,7 +6,7 @@ namespace Stancl\Tenancy\Database\Concerns;
 
 trait ConvertsDomainsToLowercase
 {
-    public static function bootConvertsDomainsToLowercase()
+    public static function bootConvertsDomainsToLowercase(): void
     {
         static::saving(function ($model) {
             $model->domain = strtolower($model->domain);

src/Database/Concerns/CreatesDatabaseUsers.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Concerns;
+namespace Stancl\Tenancy\Database\Concerns;
 
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 trait CreatesDatabaseUsers
 {

src/Database/Concerns/EnsuresDomainIsNotOccupied.php

@@ -8,7 +8,7 @@ use Stancl\Tenancy\Exceptions\DomainOccupiedByOtherTenantException;
 
 trait EnsuresDomainIsNotOccupied
 {
-    public static function bootEnsuresDomainIsNotOccupied()
+    public static function bootEnsuresDomainIsNotOccupied(): void
     {
         static::saving(function ($self) {
             if ($domain = $self->newQuery()->where('domain', $self->domain)->first()) {

src/Database/Concerns/GeneratesIds.php

@@ -8,7 +8,7 @@ use Stancl\Tenancy\Contracts\UniqueIdentifierGenerator;
 
 trait GeneratesIds
 {
-    public static function bootGeneratesIds()
+    public static function bootGeneratesIds(): void
     {
         static::creating(function (self $model) {
             if (! $model->getKey() && $model->shouldGenerateId()) {

src/Database/Concerns/HasDatabase.php

@@ -4,8 +4,8 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Database\Concerns;
 
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\DatabaseConfig;
+use Stancl\Tenancy\Database\DatabaseConfig;
 
 trait HasDatabase
 {

src/Database/Concerns/HasDomains.php

@@ -2,6 +2,8 @@
 
 declare(strict_types=1);
 
+// todo not sure if this should be in Database\
+
 namespace Stancl\Tenancy\Database\Concerns;
 
 use Stancl\Tenancy\Contracts\Domain;

src/Database/Concerns/HasInternalKeys.php

@@ -6,26 +6,20 @@ namespace Stancl\Tenancy\Database\Concerns;
 
 trait HasInternalKeys
 {
-    /**
+    /** Get the internal prefix. */
-     * Get the internal prefix.
-     */
     public static function internalPrefix(): string
     {
         return 'tenancy_';
     }
 
-    /**
+    /** Get an internal key. */
-     * Get an internal key.
+    public function getInternal(string $key): mixed
-     */
-    public function getInternal(string $key)
     {
         return $this->getAttribute(static::internalPrefix() . $key);
     }
 
-    /**
+    /** Set internal key. */
-     * Set internal key.
+    public function setInternal(string $key, mixed $value): static
-     */
-    public function setInternal(string $key, $value)
     {
         $this->setAttribute(static::internalPrefix() . $key, $value);
 

src/Database/Concerns/InvalidatesResolverCache.php

@@ -16,7 +16,7 @@ trait InvalidatesResolverCache
         Resolvers\RequestDataTenantResolver::class,
     ];
 
-    public static function bootInvalidatesResolverCache()
+    public static function bootInvalidatesResolverCache(): void
     {
         static::saved(function (Tenant $tenant) {
             foreach (static::$resolvers as $resolver) {

src/Database/Concerns/InvalidatesTenantsResolverCache.php

@@ -19,7 +19,7 @@ trait InvalidatesTenantsResolverCache
         Resolvers\RequestDataTenantResolver::class,
     ];
 
-    public static function bootInvalidatesTenantsResolverCache()
+    public static function bootInvalidatesTenantsResolverCache(): void
     {
         static::saved(function (Model $model) {
             foreach (static::$resolvers as $resolver) {

src/Database/Concerns/ResourceSyncing.php

@@ -10,7 +10,7 @@ use Stancl\Tenancy\Events\SyncedResourceSaved;
 
 trait ResourceSyncing
 {
-    public static function bootResourceSyncing()
+    public static function bootResourceSyncing(): void
     {
         static::saved(function (Syncable $model) {
             /** @var ResourceSyncing $model */
@@ -27,7 +27,7 @@ trait ResourceSyncing
         });
     }
 
-    public function triggerSyncEvent()
+    public function triggerSyncEvent(): void
     {
         /** @var Syncable $this */
         event(new SyncedResourceSaved($this, tenant()));

src/Database/Concerns/TenantRun.php

@@ -4,18 +4,17 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Database\Concerns;
 
+use Closure;
 use Stancl\Tenancy\Contracts\Tenant;
 
 trait TenantRun
 {
     /**
      * Run a callback in this tenant's context.
-     * Atomic, safely reverts to previous context.
      *
-     * @param callable $callback
+     * This method is atomic and safely reverts to the previous context.
-     * @return mixed
      */
-    public function run(callable $callback)
+    public function run(Closure $callback): mixed
     {
         /** @var Tenant $this */
         $originalTenant = tenant();

src/Database/Contracts/ManagesDatabaseUsers.php

@@ -2,15 +2,18 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Contracts;
+namespace Stancl\Tenancy\Database\Contracts;
 
-use Stancl\Tenancy\DatabaseConfig;
+use Stancl\Tenancy\Database\DatabaseConfig;
 
 interface ManagesDatabaseUsers extends TenantDatabaseManager
 {
+    /** Create a database user. */
     public function createUser(DatabaseConfig $databaseConfig): bool;
 
+    /** Delete a database user. */
     public function deleteUser(DatabaseConfig $databaseConfig): bool;
 
+    /** Does a database user exist? */
     public function userExists(string $username): bool;
 }

src/Database/Contracts/TenantDatabaseManager.php

@@ -2,46 +2,28 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Contracts;
+namespace Stancl\Tenancy\Database\Contracts;
 
-use Stancl\Tenancy\Exceptions\NoConnectionSetException;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
 
 interface TenantDatabaseManager
 {
-    /**
+    /** Create a database. */
-     * Create a database.
-     */
     public function createDatabase(TenantWithDatabase $tenant): bool;
 
-    /**
+    /** Delete a database. */
-     * Delete a database.
-     */
     public function deleteDatabase(TenantWithDatabase $tenant): bool;
 
-    /**
+    /** Does a database exist? */
-     * Does a database exist.
-     *
-     * @param string $name
-     * @return bool
-     */
     public function databaseExists(string $name): bool;
 
-    /**
+    /** Construct a DB connection config array. */
-     * Make a DB connection config array.
-     *
-     * @param array $baseConfig
-     * @param string $databaseName
-     * @return array
-     */
     public function makeConnectionConfig(array $baseConfig, string $databaseName): array;
 
     /**
      * Set the DB connection that should be used by the tenant database manager.
      *
      * @throws NoConnectionSetException
-     *
-     * @param string $connection
-     * @return void
      */
     public function setConnection(string $connection): void;
 }

src/Database/Contracts/TenantWithDatabase.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Contracts;
+
+use Stancl\Tenancy\Contracts\Tenant;
+use Stancl\Tenancy\Database\DatabaseConfig;
+
+interface TenantWithDatabase extends Tenant
+{
+    public function database(): DatabaseConfig;
+}

src/Database/DatabaseConfig.php

@@ -2,29 +2,27 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy;
+namespace Stancl\Tenancy\Database;
 
+use Closure;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Str;
-use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase as Tenant;
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase as Tenant;
-use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
 
 class DatabaseConfig
 {
-    /** @var Tenant|Model */
+    /** The tenant whose database we're dealing with. */
-    public $tenant;
+    public Tenant&Model $tenant;
 
-    /** @var callable */
+    /** Database username generator (can be set by the developer.) */
-    public static $usernameGenerator;
+    public static Closure|null $usernameGenerator = null;
 
-    /** @var callable */
+    /** Database password generator (can be set by the developer.) */
-    public static $passwordGenerator;
+    public static Closure|null $passwordGenerator = null;
 
-    /** @var callable */
+    /** Database name generator (can be set by the developer.) */
-    public static $databaseNameGenerator;
+    public static Closure|null $databaseNameGenerator = null;
 
     public static function __constructStatic(): void
     {
@@ -48,17 +46,17 @@ class DatabaseConfig
         $this->tenant = $tenant;
     }
 
-    public static function generateDatabaseNamesUsing(callable $databaseNameGenerator): void
+    public static function generateDatabaseNamesUsing(Closure $databaseNameGenerator): void
     {
         static::$databaseNameGenerator = $databaseNameGenerator;
     }
 
-    public static function generateUsernamesUsing(callable $usernameGenerator): void
+    public static function generateUsernamesUsing(Closure $usernameGenerator): void
     {
         static::$usernameGenerator = $usernameGenerator;
     }
 
-    public static function generatePasswordsUsing(callable $passwordGenerator): void
+    public static function generatePasswordsUsing(Closure $passwordGenerator): void
     {
         static::$passwordGenerator = $passwordGenerator;
     }
@@ -80,14 +78,12 @@ class DatabaseConfig
 
     /**
      * Generate DB name, username & password and write them to the tenant model.
-     *
-     * @return void
      */
     public function makeCredentials(): void
     {
         $this->tenant->setInternal('db_name', $this->getName() ?? (static::$databaseNameGenerator)($this->tenant));
 
-        if ($this->manager() instanceof ManagesDatabaseUsers) {
+        if ($this->manager() instanceof Contracts\ManagesDatabaseUsers) {
             $this->tenant->setInternal('db_username', $this->getUsername() ?? (static::$usernameGenerator)($this->tenant));
             $this->tenant->setInternal('db_password', $this->getPassword() ?? (static::$passwordGenerator)($this->tenant));
         }
@@ -113,7 +109,8 @@ class DatabaseConfig
         $templateConnection = config("database.connections.{$template}");
 
         return $this->manager()->makeConnectionConfig(
-            array_merge($templateConnection, $this->tenantConfig()), $this->getName()
+            array_merge($templateConnection, $this->tenantConfig()),
+            $this->getName()
         );
     }
 
@@ -143,20 +140,18 @@ class DatabaseConfig
         }, []);
     }
 
-    /**
+    /** Get the TenantDatabaseManager for this tenant's connection. */
-     * Get the TenantDatabaseManager for this tenant's connection.
+    public function manager(): Contracts\TenantDatabaseManager
-     */
-    public function manager(): TenantDatabaseManager
     {
         $driver = config("database.connections.{$this->getTemplateConnectionName()}.driver");
 
         $databaseManagers = config('tenancy.database.managers');
 
         if (! array_key_exists($driver, $databaseManagers)) {
-            throw new DatabaseManagerNotRegisteredException($driver);
+            throw new Exceptions\DatabaseManagerNotRegisteredException($driver);
         }
 
-        /** @var TenantDatabaseManager $databaseManager */
+        /** @var Contracts\TenantDatabaseManager $databaseManager */
         $databaseManager = app($databaseManagers[$driver]);
 
         $databaseManager->setConnection($this->getTemplateConnectionName());

src/Database/DatabaseManager.php

@@ -7,12 +7,8 @@ namespace Stancl\Tenancy\Database;
 use Illuminate\Config\Repository;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\DatabaseManager as BaseDatabaseManager;
-use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
-use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
-use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
 
 /**
  * @internal Class is subject to breaking changes in minor and patch versions.
@@ -38,7 +34,7 @@ class DatabaseManager
     /**
      * Connect to a tenant's database.
      */
-    public function connectToTenant(TenantWithDatabase $tenant)
+    public function connectToTenant(TenantWithDatabase $tenant): void
     {
         $this->purgeTenantConnection();
         $this->createTenantConnection($tenant);
@@ -48,7 +44,7 @@ class DatabaseManager
     /**
      * Reconnect to the default non-tenant connection.
      */
-    public function reconnectToCentral()
+    public function reconnectToCentral(): void
     {
         $this->purgeTenantConnection();
         $this->setDefaultConnection($this->config->get('tenancy.database.central_connection'));
@@ -57,7 +53,7 @@ class DatabaseManager
     /**
      * Change the default database connection config.
      */
-    public function setDefaultConnection(string $connection)
+    public function setDefaultConnection(string $connection): void
     {
         $this->config['database.default'] = $connection;
         $this->database->setDefaultConnection($connection);
@@ -66,7 +62,7 @@ class DatabaseManager
     /**
      * Create the tenant database connection.
      */
-    public function createTenantConnection(TenantWithDatabase $tenant)
+    public function createTenantConnection(TenantWithDatabase $tenant): void
     {
         $this->config['database.connections.tenant'] = $tenant->database()->connection();
     }
@@ -74,7 +70,7 @@ class DatabaseManager
     /**
      * Purge the tenant database connection.
      */
-    public function purgeTenantConnection()
+    public function purgeTenantConnection(): void
     {
         if (array_key_exists('tenant', $this->database->getConnections())) {
             $this->database->purge('tenant');
@@ -95,11 +91,11 @@ class DatabaseManager
         $manager = $tenant->database()->manager();
 
         if ($manager->databaseExists($database = $tenant->database()->getName())) {
-            throw new TenantDatabaseAlreadyExistsException($database);
+            throw new Exceptions\TenantDatabaseAlreadyExistsException($database);
         }
 
-        if ($manager instanceof ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
+        if ($manager instanceof Contracts\ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
-            throw new TenantDatabaseUserAlreadyExistsException($username);
+            throw new Exceptions\TenantDatabaseUserAlreadyExistsException($username);
         }
     }
 }

src/Database/Exceptions/DatabaseManagerNotRegisteredException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Exceptions;
+
+use Exception;
+
+class DatabaseManagerNotRegisteredException extends Exception
+{
+    public function __construct(string $driver)
+    {
+        parent::__construct("Database manager for driver $driver is not registered.");
+    }
+}

src/Database/Exceptions/NoConnectionSetException.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Exception;
 
 class NoConnectionSetException extends Exception
 {
-    public function __construct($manager)
+    public function __construct(string $manager)
     {
         parent::__construct("No connection was set on this $manager instance.");
     }

src/Database/Exceptions/TenantDatabaseAlreadyExistsException.php

@@ -2,24 +2,20 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
 
 class TenantDatabaseAlreadyExistsException extends TenantCannotBeCreatedException
 {
-    /** @var string */
+    public function __construct(
-    protected $database;
+        protected string $database,
+    ) {
+        parent::__construct();
+    }
 
     public function reason(): string
     {
         return "Database {$this->database} already exists.";
     }
-
-    public function __construct(string $database)
-    {
-        $this->database = $database;
-
-        parent::__construct();
-    }
 }

src/Database/Exceptions/TenantDatabaseDoesNotExistException.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Exception;
 
 class TenantDatabaseDoesNotExistException extends Exception
 {
-    public function __construct($database)
+    public function __construct(string $database)
     {
         parent::__construct("Database $database does not exist.");
     }

src/Database/Exceptions/TenantDatabaseUserAlreadyExistsException.php

@@ -2,24 +2,20 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\Exceptions;
+namespace Stancl\Tenancy\Database\Exceptions;
 
 use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
 
 class TenantDatabaseUserAlreadyExistsException extends TenantCannotBeCreatedException
 {
-    /** @var string */
+    public function __construct(
-    protected $user;
+        protected string $user,
+    ) {
+        parent::__construct();
+    }
 
     public function reason(): string
     {
         return "Database user {$this->user} already exists.";
     }
-
-    public function __construct(string $user)
-    {
-        parent::__construct();
-
-        $this->user = $user;
-    }
 }

src/Database/Models/Domain.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Database\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Stancl\Tenancy\Contracts;
 use Stancl\Tenancy\Contracts\Tenant;
 use Stancl\Tenancy\Database\Concerns;
@@ -25,7 +26,7 @@ class Domain extends Model implements Contracts\Domain
 
     protected $guarded = [];
 
-    public function tenant()
+    public function tenant(): BelongsTo
     {
         return $this->belongsTo(config('tenancy.tenant_model'));
     }

src/Database/Models/ImpersonationToken.php

@@ -10,30 +10,33 @@ use Illuminate\Support\Str;
 use Stancl\Tenancy\Database\Concerns\CentralConnection;
 
 /**
- * @param string $token
+ * @property string $token
- * @param string $tenant_id
+ * @property string $tenant_id
- * @param string $user_id
+ * @property string $user_id
- * @param string $auth_guard
+ * @property string $auth_guard
- * @param string $redirect_url
+ * @property string $redirect_url
- * @param Carbon $created_at
+ * @property Carbon $created_at
  */
 class ImpersonationToken extends Model
 {
     use CentralConnection;
 
     protected $guarded = [];
+
     public $timestamps = false;
+
     protected $primaryKey = 'token';
+
     public $incrementing = false;
+
     protected $table = 'tenant_user_impersonation_tokens';
+
     protected $dates = [
         'created_at',
     ];
 
-    public static function boot()
+    public static function booted(): void
     {
-        parent::boot();
-
         static::creating(function ($model) {
             $model->created_at = $model->created_at ?? $model->freshTimestamp();
             $model->token = $model->token ?? Str::random(128);

src/Database/Models/Tenant.php

@@ -29,7 +29,9 @@ class Tenant extends Model implements Contracts\Tenant
         Concerns\InvalidatesResolverCache;
 
     protected $table = 'tenants';
+
     protected $primaryKey = 'id';
+
     protected $guarded = [];
 
     public function getTenantKeyName(): string
@@ -37,7 +39,7 @@ class Tenant extends Model implements Contracts\Tenant
         return 'id';
     }
 
-    public function getTenantKey()
+    public function getTenantKey(): int|string
     {
         return $this->getAttribute($this->getTenantKeyName());
     }

src/Database/Models/TenantPivot.php

@@ -9,10 +9,8 @@ use Stancl\Tenancy\Contracts\Syncable;
 
 class TenantPivot extends Pivot
 {
-    public static function boot()
+    public static function booted(): void
     {
-        parent::boot();
-
         static::saved(function (self $pivot) {
             $parent = $pivot->pivotParent;
 

src/Database/ParentModelScope.php

@@ -10,7 +10,7 @@ use Illuminate\Database\Eloquent\Scope;
 
 class ParentModelScope implements Scope
 {
-    public function apply(Builder $builder, Model $model)
+    public function apply(Builder $builder, Model $model): void
     {
         if (! tenancy()->initialized) {
             return;

src/Database/TenantCollection.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Database;
 
+use Closure;
 use Illuminate\Database\Eloquent\Collection;
 use Stancl\Tenancy\Contracts\Tenant;
 
@@ -16,7 +17,7 @@ use Stancl\Tenancy\Contracts\Tenant;
  */
 class TenantCollection extends Collection
 {
-    public function runForEach(callable $callable): self
+    public function runForEach(Closure $callable): self
     {
         tenancy()->runForMultiple($this->items, $callable);
 

src/Database/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+
+class MicrosoftSQLDatabaseManager extends TenantDatabaseManager
+{
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        $database = $tenant->database()->getName();
+        $charset = $this->database()->getConfig('charset');
+        $collation = $this->database()->getConfig('collation'); // todo check why these are not used
+
+        return $this->database()->statement("CREATE DATABASE [{$database}]");
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("DROP DATABASE [{$tenant->database()->getName()}]");
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return (bool) $this->database()->select("SELECT name FROM master.sys.databases WHERE name = '$name'");
+    }
+}

src/Database/TenantDatabaseManagers/MySQLDatabaseManager.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+
+class MySQLDatabaseManager extends TenantDatabaseManager
+{
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        $database = $tenant->database()->getName();
+        $charset = $this->database()->getConfig('charset');
+        $collation = $this->database()->getConfig('collation');
+
+        return $this->database()->statement("CREATE DATABASE `{$database}` CHARACTER SET `$charset` COLLATE `$collation`");
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("DROP DATABASE `{$tenant->database()->getName()}`");
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return (bool) $this->database()->select("SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = '$name'");
+    }
+}

src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
-use Stancl\Tenancy\Concerns\CreatesDatabaseUsers;
+use Stancl\Tenancy\Database\Concerns\CreatesDatabaseUsers;
-use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
+use Stancl\Tenancy\Database\Contracts\ManagesDatabaseUsers;
-use Stancl\Tenancy\DatabaseConfig;
+use Stancl\Tenancy\Database\DatabaseConfig;
 
 class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager implements ManagesDatabaseUsers
 {
@@ -54,11 +54,4 @@ class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager impl
     {
         return (bool) $this->database()->select("SELECT count(*) FROM mysql.user WHERE user = '$username'")[0]->{'count(*)'};
     }
-
-    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
-    {
-        $baseConfig['database'] = $databaseName;
-
-        return $baseConfig;
-    }
 }

src/Database/TenantDatabaseManagers/PostgreSQLDatabaseManager.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+
+class PostgreSQLDatabaseManager extends TenantDatabaseManager
+{
+    public function createDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("CREATE DATABASE \"{$tenant->database()->getName()}\" WITH TEMPLATE=template0");
+    }
+
+    public function deleteDatabase(TenantWithDatabase $tenant): bool
+    {
+        return $this->database()->statement("DROP DATABASE \"{$tenant->database()->getName()}\"");
+    }
+
+    public function databaseExists(string $name): bool
+    {
+        return (bool) $this->database()->select("SELECT datname FROM pg_database WHERE datname = '$name'");
+    }
+}

src/Database/TenantDatabaseManagers/PostgreSQLSchemaManager.php

@@ -2,33 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
-use Illuminate\Database\Connection;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
-use Illuminate\Support\Facades\DB;
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
-use Stancl\Tenancy\Exceptions\NoConnectionSetException;
 
-class PostgreSQLSchemaManager implements TenantDatabaseManager
+class PostgreSQLSchemaManager extends TenantDatabaseManager
 {
-    /** @var string */
-    protected $connection;
-
-    protected function database(): Connection
-    {
-        if ($this->connection === null) {
-            throw new NoConnectionSetException(static::class);
-        }
-
-        return DB::connection($this->connection);
-    }
-
-    public function setConnection(string $connection): void
-    {
-        $this->connection = $connection;
-    }
-
     public function createDatabase(TenantWithDatabase $tenant): bool
     {
         return $this->database()->statement("CREATE SCHEMA \"{$tenant->database()->getName()}\"");

src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php

@@ -2,10 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Stancl\Tenancy\TenantDatabaseManagers;
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
 
-use Stancl\Tenancy\Contracts\TenantDatabaseManager;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+use Throwable;
 
 class SQLiteDatabaseManager implements TenantDatabaseManager
 {
@@ -13,7 +14,7 @@ class SQLiteDatabaseManager implements TenantDatabaseManager
     {
         try {
             return file_put_contents(database_path($tenant->database()->getName()), '');
-        } catch (\Throwable $th) {
+        } catch (Throwable) {
             return false;
         }
     }
@@ -22,7 +23,7 @@ class SQLiteDatabaseManager implements TenantDatabaseManager
     {
         try {
             return unlink(database_path($tenant->database()->getName()));
-        } catch (\Throwable $th) {
+        } catch (Throwable) {
             return false;
         }
     }

src/Database/TenantDatabaseManagers/TenantDatabaseManager.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\TenantDatabaseManagers;
+
+use Illuminate\Database\Connection;
+use Illuminate\Support\Facades\DB;
+use Stancl\Tenancy\Database\Contracts\TenantDatabaseManager as Contract;
+use Stancl\Tenancy\Database\Exceptions\NoConnectionSetException;
+
+abstract class TenantDatabaseManager implements Contract // todo better naming?
+{
+    /** The database connection to the server. */
+    protected string $connection;
+
+    protected function database(): Connection
+    {
+        if (! isset($this->connection)) {
+            throw new NoConnectionSetException(static::class);
+        }
+
+        return DB::connection($this->connection);
+    }
+
+    public function setConnection(string $connection): void
+    {
+        $this->connection = $connection;
+    }
+
+    public function makeConnectionConfig(array $baseConfig, string $databaseName): array
+    {
+        $baseConfig['database'] = $databaseName;
+
+        return $baseConfig;
+    }
+}

src/Enums/LogMode.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Enums;
+
+enum LogMode
+{
+    case NONE;
+    case SILENT;
+    case INSTANT;
+}

src/Events/SyncedResourceChangedInForeignDatabase.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Events;
 
 use Stancl\Tenancy\Contracts\Syncable;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class SyncedResourceChangedInForeignDatabase
 {

src/Events/SyncedResourceSaved.php

@@ -6,17 +6,16 @@ namespace Stancl\Tenancy\Events;
 
 use Illuminate\Database\Eloquent\Model;
 use Stancl\Tenancy\Contracts\Syncable;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class SyncedResourceSaved
 {
-    /** @var Syncable|Model */
+    public Syncable&Model $model;
-    public $model;
 
-    /** @var TenantWithDatabase|Model|null */
+    /** @var (TenantWithDatabase&Model)|null */
-    public $tenant;
+    public TenantWithDatabase|null $tenant;
 
-    public function __construct(Syncable $model, ?TenantWithDatabase $tenant)
+    public function __construct(Syncable $model, TenantWithDatabase|null $tenant)
     {
         $this->model = $model;
         $this->tenant = $tenant;

src/Exceptions/DatabaseManagerNotRegisteredException.php

@@ -1,13 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Stancl\Tenancy\Exceptions;
-
-class DatabaseManagerNotRegisteredException extends \Exception
-{
-    public function __construct($driver)
-    {
-        parent::__construct("Database manager for driver $driver is not registered.");
-    }
-}

src/Exceptions/TenantCouldNotBeIdentifiedById.php

@@ -1,28 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Stancl\Tenancy\Exceptions;
-
-use Facade\IgnitionContracts\BaseSolution;
-use Facade\IgnitionContracts\ProvidesSolution;
-use Facade\IgnitionContracts\Solution;
-use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
-
-// todo: in v4 this should be suffixed with Exception
-class TenantCouldNotBeIdentifiedById extends TenantCouldNotBeIdentifiedException implements ProvidesSolution
-{
-    public function __construct($tenant_id)
-    {
-        parent::__construct("Tenant could not be identified with tenant_id: $tenant_id");
-    }
-
-    public function getSolution(): Solution
-    {
-        return BaseSolution::create('Tenant could not be identified with that ID')
-            ->setSolutionDescription('Are you sure the ID is correct and the tenant exists?')
-            ->setDocumentationLinks([
-                'Initializing Tenants' => 'https://tenancyforlaravel.com/docs/v3/tenants',
-            ]);
-    }
-}

src/Exceptions/TenantCouldNotBeIdentifiedByIdException.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+// todo perhaps create Identification namespace
+
+namespace Stancl\Tenancy\Exceptions;
+
+use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
+
+class TenantCouldNotBeIdentifiedByIdException extends TenantCouldNotBeIdentifiedException
+{
+    public function __construct(int|string $tenant_id)
+    {
+        $this
+            ->tenantCouldNotBeIdentified("by tenant id: $tenant_id")
+            ->title('Tenant could not be identified with that ID')
+            ->description('Are you sure the ID is correct and the tenant exists?');
+    }
+}

src/Exceptions/TenantCouldNotBeIdentifiedByPathException.php

@@ -4,24 +4,15 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Exceptions;
 
-use Facade\IgnitionContracts\BaseSolution;
-use Facade\IgnitionContracts\ProvidesSolution;
-use Facade\IgnitionContracts\Solution;
 use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
 
-class TenantCouldNotBeIdentifiedByPathException extends TenantCouldNotBeIdentifiedException implements ProvidesSolution
+class TenantCouldNotBeIdentifiedByPathException extends TenantCouldNotBeIdentifiedException
 {
-    public function __construct($tenant_id)
+    public function __construct(int|string $tenant_id)
     {
-        parent::__construct("Tenant could not be identified on path with tenant_id: $tenant_id");
+        $this
-    }
+            ->tenantCouldNotBeIdentified("on path with tenant id: $tenant_id")
-
+            ->title('Tenant could not be identified on this path')
-    public function getSolution(): Solution
+            ->description('Did you forget to create a tenant for this path?');
-    {
-        return BaseSolution::create('Tenant could not be identified on this path')
-            ->setSolutionDescription('Did you forget to create a tenant for this path?')
-            ->setDocumentationLinks([
-                'Creating Tenants' => 'https://tenancyforlaravel.com/docs/v3/tenants/',
-            ]);
     }
 }

src/Exceptions/TenantCouldNotBeIdentifiedByRequestDataException.php

@@ -4,24 +4,15 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Exceptions;
 
-use Facade\IgnitionContracts\BaseSolution;
-use Facade\IgnitionContracts\ProvidesSolution;
-use Facade\IgnitionContracts\Solution;
 use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
 
-class TenantCouldNotBeIdentifiedByRequestDataException extends TenantCouldNotBeIdentifiedException implements ProvidesSolution
+class TenantCouldNotBeIdentifiedByRequestDataException extends TenantCouldNotBeIdentifiedException
 {
-    public function __construct($tenant_id)
+    public function __construct(mixed $payload)
     {
-        parent::__construct("Tenant could not be identified by request data with payload: $tenant_id");
+        $this
-    }
+            ->tenantCouldNotBeIdentified("by request data with payload: $payload")
-
+            ->title('Tenant could not be identified using this request data')
-    public function getSolution(): Solution
+            ->description('Did you forget to create a tenant with this id?');
-    {
-        return BaseSolution::create('Tenant could not be identified with this request data')
-            ->setSolutionDescription('Did you forget to create a tenant with this id?')
-            ->setDocumentationLinks([
-                'Creating Tenants' => 'https://tenancyforlaravel.com/docs/v3/tenants/',
-            ]);
     }
 }

src/Exceptions/TenantCouldNotBeIdentifiedOnDomainException.php

@@ -4,24 +4,15 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Exceptions;
 
-use Facade\IgnitionContracts\BaseSolution;
-use Facade\IgnitionContracts\ProvidesSolution;
-use Facade\IgnitionContracts\Solution;
 use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
 
-class TenantCouldNotBeIdentifiedOnDomainException extends TenantCouldNotBeIdentifiedException implements ProvidesSolution
+class TenantCouldNotBeIdentifiedOnDomainException extends TenantCouldNotBeIdentifiedException
 {
-    public function __construct($domain)
+    public function __construct(string $domain)
     {
-        parent::__construct("Tenant could not be identified on domain $domain");
+        $this
-    }
+            ->tenantCouldNotBeIdentified("on domain $domain")
-
+            ->title('Tenant could not be identified on this domain')
-    public function getSolution(): Solution
+            ->description('Did you forget to create a tenant for this domain?');
-    {
-        return BaseSolution::create('Tenant could not be identified on this domain')
-            ->setSolutionDescription('Did you forget to create a tenant for this domain?')
-            ->setDocumentationLinks([
-                'Creating Tenants' => 'https://tenancyforlaravel.com/docs/v3/tenants/',
-            ]);
     }
 }

src/Features/CrossDomainRedirect.php

@@ -15,7 +15,7 @@ class CrossDomainRedirect implements Feature
         RedirectResponse::macro('domain', function (string $domain) {
             /** @var RedirectResponse $this */
 
-            // replace first occurance of hostname fragment with $domain
+            // Replace first occurrence of the hostname fragment with $domain
             $url = $this->getTargetUrl();
             $hostname = parse_url($url, PHP_URL_HOST);
             $position = strpos($url, $hostname);

src/Features/TenantConfig.php

@@ -6,6 +6,7 @@ namespace Stancl\Tenancy\Features;
 
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Event;
 use Stancl\Tenancy\Contracts\Feature;
 use Stancl\Tenancy\Contracts\Tenant;
@@ -18,8 +19,7 @@ class TenantConfig implements Feature
     /** @var Repository */
     protected $config;
 
-    /** @var array */
+    public array $originalConfig = [];
-    public $originalConfig = [];
 
     public static $storageToConfigMap = [
         // 'paypal_api_key' => 'services.paypal.api_key',
@@ -45,19 +45,19 @@ class TenantConfig implements Feature
     {
         /** @var Tenant|Model $tenant */
         foreach (static::$storageToConfigMap as $storageKey => $configKey) {
-            $override = $tenant->getAttribute($storageKey);
+            $override = Arr::get($tenant, $storageKey);
 
             if (! is_null($override)) {
                 if (is_array($configKey)) {
                     foreach ($configKey as $key) {
-                        $this->originalConfig[$key] = $this->originalConfig[$key] ?? $this->config[$key];
+                        $this->originalConfig[$key] = $this->originalConfig[$key] ?? $this->config->get($key);
 
-                        $this->config[$key] = $override;
+                        $this->config->set($key, $override);
                     }
                 } else {
-                    $this->originalConfig[$configKey] = $this->originalConfig[$configKey] ?? $this->config[$configKey];
+                    $this->originalConfig[$configKey] = $this->originalConfig[$configKey] ?? $this->config->get($configKey);
 
-                    $this->config[$configKey] = $override;
+                    $this->config->set($configKey, $override);
                 }
             }
         }
@@ -66,7 +66,7 @@ class TenantConfig implements Feature
     public function unsetTenantConfig(): void
     {
         foreach ($this->originalConfig as $key => $value) {
-            $this->config[$key] = $value;
+            $this->config->set($key, $value);
         }
     }
 }

src/Features/UniversalRoutes.php

@@ -13,9 +13,10 @@ use Stancl\Tenancy\Tenancy;
 
 class UniversalRoutes implements Feature
 {
-    public static $middlewareGroup = 'universal';
+    public static string $middlewareGroup = 'universal';
 
-    public static $identificationMiddlewares = [
+    // todo docblock
+    public static array $identificationMiddlewares = [
         Middleware\InitializeTenancyByDomain::class,
         Middleware\InitializeTenancyBySubdomain::class,
     ];
@@ -23,17 +24,23 @@ class UniversalRoutes implements Feature
     public function bootstrap(Tenancy $tenancy): void
     {
         foreach (static::$identificationMiddlewares as $middleware) {
-            $middleware::$onFail = function ($exception, $request, $next) {
+            $originalOnFail = $middleware::$onFail;
+
+            $middleware::$onFail = function ($exception, $request, $next) use ($originalOnFail) {
                 if (static::routeHasMiddleware($request->route(), static::$middlewareGroup)) {
                     return $next($request);
                 }
 
+                if ($originalOnFail) {
+                    return $originalOnFail($exception, $request, $next);
+                }
+
                 throw $exception;
             };
         }
     }
 
-    public static function routeHasMiddleware(Route $route, $middleware): bool
+    public static function routeHasMiddleware(Route $route, string $middleware): bool
     {
         if (in_array($middleware, $route->middleware(), true)) {
             return true;

src/Features/UserImpersonation.php

@@ -4,7 +4,6 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Features;
 
-use Carbon\Carbon;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Facades\Auth;
 use Stancl\Tenancy\Contracts\Feature;
@@ -14,7 +13,8 @@ use Stancl\Tenancy\Tenancy;
 
 class UserImpersonation implements Feature
 {
-    public static $ttl = 60; // seconds
+    /** The lifespan of impersonation tokens (in seconds). */
+    public static int $ttl = 60;
 
     public function bootstrap(Tenancy $tenancy): void
     {
@@ -28,26 +28,21 @@ class UserImpersonation implements Feature
         });
     }
 
-    /**
+    /** Impersonate a user and get an HTTP redirect response. */
-     * Impersonate a user and get an HTTP redirect response.
+    public static function makeResponse(string|ImpersonationToken $token, int $ttl = null): RedirectResponse
-     *
-     * @param string|ImpersonationToken $token
-     * @param int $ttl
-     * @return RedirectResponse
-     */
-    public static function makeResponse($token, int $ttl = null): RedirectResponse
     {
+        /** @var ImpersonationToken $token */
         $token = $token instanceof ImpersonationToken ? $token : ImpersonationToken::findOrFail($token);
+        $ttl ??= static::$ttl;
 
-        if (((string) $token->tenant_id) !== ((string) tenant()->getTenantKey())) {
+        $tokenExpired = $token->created_at->diffInSeconds(now()) > $ttl;
-            abort(403);
-        }
 
-        $ttl = $ttl ?? static::$ttl;
+        abort_if($tokenExpired, 403);
 
-        if ($token->created_at->diffInSeconds(Carbon::now()) > $ttl) {
+        $tokenTenantId = (string) $token->tenant_id;
-            abort(403);
+        $currentTenantId = (string) tenant()->getTenantKey();
-        }
+
+        abort_unless($tokenTenantId === $currentTenantId, 403);
 
         Auth::guard($token->auth_guard)->loginUsingId($token->user_id);
 

src/Jobs/CreateDatabase.php

@@ -10,7 +10,7 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Database\DatabaseManager;
 use Stancl\Tenancy\Events\CreatingDatabase;
 use Stancl\Tenancy\Events\DatabaseCreated;
@@ -19,12 +19,9 @@ class CreateDatabase implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    /** @var TenantWithDatabase|Model */
+    public function __construct(
-    protected $tenant;
+        protected TenantWithDatabase&Model $tenant,
-
+    ) {
-    public function __construct(TenantWithDatabase $tenant)
-    {
-        $this->tenant = $tenant;
     }
 
     public function handle(DatabaseManager $databaseManager)

src/Jobs/DeleteDatabase.php

@@ -6,10 +6,11 @@ namespace Stancl\Tenancy\Jobs;
 
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 use Stancl\Tenancy\Events\DatabaseDeleted;
 use Stancl\Tenancy\Events\DeletingDatabase;
 
@@ -17,15 +18,12 @@ class DeleteDatabase implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    /** @var TenantWithDatabase */
+    public function __construct(
-    protected $tenant;
+        protected TenantWithDatabase&Model $tenant,
-
+    ) {
-    public function __construct(TenantWithDatabase $tenant)
-    {
-        $this->tenant = $tenant;
     }
 
-    public function handle()
+    public function handle(): void
     {
         event(new DeletingDatabase($this->tenant));
 

src/Jobs/DeleteDomains.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Stancl\Tenancy\Database\Concerns\HasDomains;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
+
+class DeleteDomains
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /** @var TenantWithDatabase&Model&HasDomains */ // todo unresolvable type for phpstan
+    protected TenantWithDatabase&Model $tenant;
+
+    public function __construct(TenantWithDatabase&Model $tenant)
+    {
+        $this->tenant = $tenant;
+    }
+
+    public function handle(): void
+    {
+        $this->tenant->domains->each->delete();
+    }
+}

src/Jobs/MigrateDatabase.php

@@ -6,30 +6,23 @@ namespace Stancl\Tenancy\Jobs;
 
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Facades\Artisan;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class MigrateDatabase implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    /** @var TenantWithDatabase */
+    public function __construct(
-    protected $tenant;
+        protected TenantWithDatabase&Model $tenant,
-
+    ) {
-    public function __construct(TenantWithDatabase $tenant)
-    {
-        $this->tenant = $tenant;
     }
 
-    /**
+    public function handle(): void
-     * Execute the job.
-     *
-     * @return void
-     */
-    public function handle()
     {
         Artisan::call('tenants:migrate', [
             '--tenants' => [$this->tenant->getTenantKey()],

src/Jobs/SeedDatabase.php

@@ -6,30 +6,23 @@ namespace Stancl\Tenancy\Jobs;
 
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Facades\Artisan;
-use Stancl\Tenancy\Contracts\TenantWithDatabase;
+use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
 
 class SeedDatabase implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    /** @var TenantWithDatabase */
+    public function __construct(
-    protected $tenant;
+        protected TenantWithDatabase&Model $tenant,
-
+    ) {
-    public function __construct(TenantWithDatabase $tenant)
-    {
-        $this->tenant = $tenant;
     }
 
-    /**
+    public function handle(): void
-     * Execute the job.
-     *
-     * @return void
-     */
-    public function handle()
     {
         Artisan::call('tenants:seed', [
             '--tenants' => [$this->tenant->getTenantKey()],

src/Listeners/BootstrapTenancy.php

@@ -10,7 +10,7 @@ use Stancl\Tenancy\Events\TenancyInitialized;
 
 class BootstrapTenancy
 {
-    public function handle(TenancyInitialized $event)
+    public function handle(TenancyInitialized $event): void
     {
         event(new BootstrappingTenancy($event->tenancy));
 

src/Listeners/CreateTenantConnection.php

@@ -17,7 +17,7 @@ class CreateTenantConnection
         $this->database = $database;
     }
 
-    public function handle(TenantEvent $event)
+    public function handle(TenantEvent $event): void
     {
         $this->database->createTenantConnection($event->tenant);
     }

src/Listeners/QueueableListener.php

@@ -11,9 +11,9 @@ use Illuminate\Contracts\Queue\ShouldQueue;
  */
 abstract class QueueableListener implements ShouldQueue
 {
-    public static $shouldQueue = false;
+    public static bool $shouldQueue = false;
 
-    public function shouldQueue($event)
+    public function shouldQueue($event): bool
     {
         if (static::$shouldQueue) {
             return true;

src/Listeners/RevertToCentralContext.php

@@ -10,11 +10,11 @@ use Stancl\Tenancy\Events\TenancyEnded;
 
 class RevertToCentralContext
 {
-    public function handle(TenancyEnded $event)
+    public function handle(TenancyEnded $event): void
     {
         event(new RevertingToCentralContext($event->tenancy));
 
-        foreach ($event->tenancy->getBootstrappers() as $bootstrapper) {
+        foreach (array_reverse($event->tenancy->getBootstrappers()) as $bootstrapper) {
             $bootstrapper->revert();
         }
 

src/Listeners/UpdateSyncedResource.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Listeners;
 
+use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Pivot;
 use Stancl\Tenancy\Contracts\SyncMaster;
@@ -13,9 +14,9 @@ use Stancl\Tenancy\Exceptions\ModelNotSyncMasterException;
 
 class UpdateSyncedResource extends QueueableListener
 {
-    public static $shouldQueue = false;
+    public static bool $shouldQueue = false;
 
-    public function handle(SyncedResourceSaved $event)
+    public function handle(SyncedResourceSaved $event): void
     {
         $syncedAttributes = $event->model->only($event->model->getSyncedAttributeNames());
 
@@ -29,7 +30,7 @@ class UpdateSyncedResource extends QueueableListener
         $this->updateResourceInTenantDatabases($tenants, $event, $syncedAttributes);
     }
 
-    protected function getTenantsForCentralModel($centralModel)
+    protected function getTenantsForCentralModel($centralModel): EloquentCollection
     {
         if (! $centralModel instanceof SyncMaster) {
             // If we're trying to use a tenant User model instead of the central User model, for example.
@@ -45,11 +46,10 @@ class UpdateSyncedResource extends QueueableListener
         return $centralModel->tenants;
     }
 
-    protected function updateResourceInCentralDatabaseAndGetTenants($event, $syncedAttributes)
+    protected function updateResourceInCentralDatabaseAndGetTenants($event, $syncedAttributes): EloquentCollection
     {
         /** @var Model|SyncMaster $centralModel */
-        $centralModel = $event->model->getCentralModelName()
+        $centralModel = $event->model->getCentralModelName()::where($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey())
-            ::where($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey())
             ->first();
 
         // We disable events for this call, to avoid triggering this event & listener again.
@@ -86,7 +86,7 @@ class UpdateSyncedResource extends QueueableListener
         });
     }
 
-    protected function updateResourceInTenantDatabases($tenants, $event, $syncedAttributes)
+    protected function updateResourceInTenantDatabases($tenants, $event, $syncedAttributes): void
     {
         tenancy()->runForMultiple($tenants, function ($tenant) use ($event, $syncedAttributes) {
             // Forget instance state and find the model,

src/Middleware/CheckTenantForMaintenanceMode.php

@@ -5,10 +5,10 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Middleware;
 
 use Closure;
-use Symfony\Component\HttpKernel\Exception\HttpException;
 use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode;
 use Stancl\Tenancy\Exceptions\TenancyNotInitializedException;
 use Symfony\Component\HttpFoundation\IpUtils;
+use Symfony\Component\HttpKernel\Exception\HttpException;
 
 class CheckTenantForMaintenanceMode extends CheckForMaintenanceMode
 {

src/Middleware/InitializeTenancyByDomain.php

@@ -29,13 +29,13 @@ class InitializeTenancyByDomain extends IdentificationMiddleware
      * Handle an incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
      */
     public function handle($request, Closure $next)
     {
         return $this->initializeTenancy(
-            $request, $next, $request->getHost()
+            $request,
+            $next,
+            $request->getHost()
         );
     }
 }

src/Middleware/InitializeTenancyByDomainOrSubdomain.php

@@ -13,8 +13,6 @@ class InitializeTenancyByDomainOrSubdomain
      * Handle an incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
      */
     public function handle($request, Closure $next)
     {

src/Middleware/InitializeTenancyByPath.php

@@ -38,7 +38,9 @@ class InitializeTenancyByPath extends IdentificationMiddleware
         // simply injected into some route controller action.
         if ($route->parameterNames()[0] === PathTenantResolver::$tenantParameterName) {
             return $this->initializeTenancy(
-                $request, $next, $route
+                $request,
+                $next,
+                $route
             );
         } else {
             throw new RouteIsMissingTenantParameterException;

src/Middleware/InitializeTenancyByRequestData.php

@@ -36,8 +36,6 @@ class InitializeTenancyByRequestData extends IdentificationMiddleware
      * Handle an incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
      */
     public function handle($request, Closure $next)
     {