diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f0fe927a..db2b0ffc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,32 +1,91 @@ name: CI env: - COMPOSE_INTERACTIVE_NO_CLI: 1 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} on: push: - branches: [ master ] pull_request: branches: [ master ] jobs: tests: runs-on: ubuntu-latest + container: archtechx/tenancy:latest strategy: matrix: - php: ["8.1"] - laravel: ["^9.0"] + laravel: ['^9.0'] steps: - - uses: actions/checkout@v2 - - name: Start docker containers - run: PHP_VERSION=${{ matrix.php }} docker-compose up -d - - name: Install dependencies - run: docker-compose exec -T test composer require --no-interaction "laravel/framework:${{ matrix.laravel }}" - - name: Run tests - run: ./test + - name: Checkout + uses: actions/checkout@v2 + + - name: Install Composer dependencies + run: | + composer require "laravel/framework:${{ matrix.laravel }}" --no-interaction --no-update + composer update --prefer-dist --no-interaction + - name: Run tests + 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) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12e5e55b..d76a686a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,24 @@ php-cs-fixer will fix code style violations in your pull requests. Run `composer docker-up` to start the containers. Then run `composer test` to run the tests. +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 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. + +### 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. diff --git a/Dockerfile b/Dockerfile index fb63afe3..0ced8009 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,59 +1,42 @@ -ARG PHP_VERSION=7.4 -ARG PHP_TARGET=php:${PHP_VERSION}-cli +# add amd64 platform to support Mac M1 +FROM --platform=linux/amd64 shivammathur/node:latest-amd64 -FROM --platform=linux/amd64 ${PHP_TARGET} - -ARG COMPOSER_TARGET=2.0.3 +ARG PHP_VERSION=8.1 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. -# If your app needs custom ones install them in the apps own -# Dockerfile _and pin the versions_! Eg: -# RUN pecl install memcached-2.2.0 && docker-php-ext-enable memcached - - +# install MYSSQL ODBC Driver RUN apt-get update \ && apt-get install -y gnupg2 \ && curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add - \ - && curl https://packages.microsoft.com/config/debian/11/prod.list > /etc/apt/sources.list.d/mssql-release.list \ + && 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 -RUN apt-get install -y --no-install-recommends locales apt-transport-https libfreetype6-dev libjpeg62-turbo-dev libpng-dev libgmp-dev libldap2-dev netcat curl mariadb-client sqlite3 libsqlite3-dev libpq-dev libzip-dev unzip vim-tiny gosu git +# 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 -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 \ - # install sqlsrv - && pecl install sqlsrv pdo_sqlsrv \ - && docker-php-ext-enable sqlsrv pdo_sqlsrv -# 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 diff --git a/assets/TenancyServiceProvider.stub.php b/assets/TenancyServiceProvider.stub.php index 865bb93d..a3626225 100644 --- a/assets/TenancyServiceProvider.stub.php +++ b/assets/TenancyServiceProvider.stub.php @@ -28,6 +28,7 @@ class TenancyServiceProvider extends ServiceProvider Jobs\CreateDatabase::class, Jobs\MigrateDatabase::class, // Jobs\SeedDatabase::class, + Jobs\CreateStorageSymlinks::class, // Your own jobs to prepare the tenant. // Provision API keys, create S3 buckets, anything you want! @@ -46,10 +47,13 @@ class TenancyServiceProvider extends ServiceProvider ])->send(function (Events\DeletingTenant $event) { return $event->tenant; })->shouldBeQueued(false), + + // Listeners\DeleteTenantStorage::class, ], Events\TenantDeleted::class => [ JobPipeline::make([ Jobs\DeleteDatabase::class, + Jobs\RemoveStorageSymlinks::class, ])->send(function (Events\TenantDeleted $event) { return $event->tenant; })->shouldBeQueued(false), // `false` by default, but you probably want to make this `true` for production. @@ -93,6 +97,12 @@ class TenancyServiceProvider extends ServiceProvider Listeners\UpdateSyncedResource::class, ], + // Storage symlinks + Events\CreatingStorageSymlink::class => [], + Events\StorageSymlinkCreated::class => [], + Events\RemovingStorageSymlink::class => [], + Events\StorageSymlinkRemoved::class => [], + // Fired only when a synced resource is changed in a different DB than the origin DB (to avoid infinite loops) Events\SyncedResourceChangedInForeignDatabase::class => [], ]; diff --git a/assets/config.php b/assets/config.php index e1c82e6b..7aff2b65 100644 --- a/assets/config.php +++ b/assets/config.php @@ -32,6 +32,7 @@ return [ Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper::class, Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper::class, Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper::class, + Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper::class, // Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper::class, // Note: phpredis is needed ], @@ -58,22 +59,22 @@ return [ * TenantDatabaseManagers are classes that handle the creation & deletion of tenant databases. */ 'managers' => [ - 'sqlite' => Stancl\Tenancy\TenantDatabaseManagers\SQLiteDatabaseManager::class, - 'mysql' => Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager::class, - 'pgsql' => Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager::class, - 'sqlsrv' => Stancl\Tenancy\TenantDatabaseManagers\MicrosoftSQLDatabaseManager::class, + 'sqlite' => Stancl\Tenancy\Database\TenantDatabaseManagers\SQLiteDatabaseManager::class, + 'mysql' => Stancl\Tenancy\Database\TenantDatabaseManagers\MySQLDatabaseManager::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 ], ], @@ -118,6 +119,24 @@ return [ 'public' => '%storage_path%/app/public/', ], + /* + * Tenant-aware Storage::disk()->url() can be enabled for specific local disks here + * by mapping the disk's name to a name with '%tenant_id%' (this will be used as the public name of the disk). + * Doing that will override the disk's default URL with a URL containing the current tenant's key. + * + * For example, Storage::disk('public')->url('') will return https://your-app.test/storage/ by default. + * After adding 'public' => 'public-%tenant_id%' to 'url_override', + * the returned URL will be https://your-app.test/public-1/ (%tenant_id% gets substitued by the current tenant's ID). + * + * Use `php artisan tenants:link` to create a symbolic link from the tenant's storage to its public directory. + */ + 'url_override' => [ + // Note that the local disk you add must exist in the tenancy.filesystem.root_override config + // todo@v4 Rename %tenant_id% to %tenant_key% + // todo@v4 Rename url_override to something that describes the config key better + 'public' => 'public-%tenant_id%', + ], + /** * Should storage_path() be suffixed. * diff --git a/composer.json b/composer.json index 8aca9ded..cc213add 100644 --- a/composer.json +++ b/composer.json @@ -18,10 +18,10 @@ "php": "^8.1", "ext-json": "*", "illuminate/support": "^9.0", - "facade/ignition-contracts": "^1.0", + "spatie/ignition": "^1.4", "ramsey/uuid": "^4.0", - "stancl/jobpipeline": "^1.6", - "stancl/virtualcolumn": "^1.2" + "stancl/jobpipeline": "^1.0", + "stancl/virtualcolumn": "^1.0" }, "require-dev": { "laravel/framework": "^9.0", @@ -29,7 +29,8 @@ "league/flysystem-aws-s3-v3": "^3.0", "doctrine/dbal": "^2.10", "spatie/valuestore": "^1.2.5", - "pestphp/pest": "^1.21" + "pestphp/pest": "^1.21", + "nunomaduro/larastan": "^1.0" }, "autoload": { "psr-4": { @@ -60,7 +61,10 @@ "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", - "test": "PHP_VERSION=8.1 ./test" + "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, diff --git a/docker-compose.yml b/docker-compose.yml index 7b635637..116b48f1 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -12,6 +12,8 @@ services: condition: service_healthy redis: condition: service_healthy + # mssql: + # condition: service_healthy volumes: - .:/var/www/html:delegated environment: @@ -74,4 +76,8 @@ services: environment: - ACCEPT_EULA=Y - SA_PASSWORD=P@ssword # todo reuse values from env above - # todo missing health check + healthcheck: + test: /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P P@ssword -Q "SELECT 1" -b -o /dev/null + interval: 10s + timeout: 10s + retries: 10 diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 00000000..f325f3ec --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,34 @@ +includes: + - ./vendor/nunomaduro/larastan/extension.neon + +parameters: + paths: + - src + # - tests + + level: 8 + + universalObjectCratesClasses: + - Illuminate\Routing\Route + - Illuminate\Database\Eloquent\Model + + 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 + - + message: '#Parameter \#1 \$key of method Illuminate\\Contracts\\Cache\\Repository::put\(\) expects string#' + paths: + - src/helpers.php + - + message: '#PHPDoc tag \@param has invalid value \(dynamic#' + paths: + - src/helpers.php + + checkMissingIterableValueType: false + treatPhpDocTypesAsCertain: false diff --git a/src/Actions/CreateStorageSymlinksAction.php b/src/Actions/CreateStorageSymlinksAction.php new file mode 100644 index 00000000..eac5d933 --- /dev/null +++ b/src/Actions/CreateStorageSymlinksAction.php @@ -0,0 +1,55 @@ + $storagePath) { + static::createLink($publicPath, $storagePath, $tenant, $relativeLink, $force); + } + } + } + + protected static function createLink(string $publicPath, string $storagePath, Tenant $tenant, bool $relativeLink, bool $force): void + { + event(new CreatingStorageSymlink($tenant)); + + if (static::symlinkExists($publicPath)) { + // If $force isn't passed, don't overwrite the existing symlink + throw_if(! $force, new Exception("The [$publicPath] link already exists.")); + + app()->make('files')->delete($publicPath); + } + + // Make sure the storage path exists before we create a symlink + if (! is_dir($storagePath)) { + mkdir($storagePath, 0777, true); + } + + if ($relativeLink) { + app()->make('files')->relativeLink($storagePath, $publicPath); + } else { + app()->make('files')->link($storagePath, $publicPath); + } + + event((new StorageSymlinkCreated($tenant))); + } +} diff --git a/src/Actions/RemoveStorageSymlinksAction.php b/src/Actions/RemoveStorageSymlinksAction.php new file mode 100644 index 00000000..a3660e7a --- /dev/null +++ b/src/Actions/RemoveStorageSymlinksAction.php @@ -0,0 +1,40 @@ + $storagePath) { + static::removeLink($publicPath, $tenant); + } + } + } + + protected static function removeLink(string $publicPath, Tenant $tenant): void + { + if (static::symlinkExists($publicPath)) { + event(new RemovingStorageSymlink($tenant)); + + app()->make('files')->delete($publicPath); + + event(new StorageSymlinkRemoved($tenant)); + } + } +} diff --git a/src/Bootstrappers/BatchTenancyBootstrapper.php b/src/Bootstrappers/BatchTenancyBootstrapper.php new file mode 100644 index 00000000..ccd1c00a --- /dev/null +++ b/src/Bootstrappers/BatchTenancyBootstrapper.php @@ -0,0 +1,41 @@ +previousConnection = $this->batchRepository->getConnection(); + $this->batchRepository->setConnection($this->databaseManager->connection('tenant')); + } + + public function revert() + { + if ($this->previousConnection) { + // Replace batch repository connection with the previously replaced one + $this->batchRepository->setConnection($this->previousConnection); + $this->previousConnection = null; + } + } +} diff --git a/src/Bootstrappers/DatabaseTenancyBootstrapper.php b/src/Bootstrappers/DatabaseTenancyBootstrapper.php index 59ee0aec..dd94bfd4 100644 --- a/src/Bootstrappers/DatabaseTenancyBootstrapper.php +++ b/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; diff --git a/src/Bootstrappers/FilesystemTenancyBootstrapper.php b/src/Bootstrappers/FilesystemTenancyBootstrapper.php index 6f720e7c..d90d36d0 100644 --- a/src/Bootstrappers/FilesystemTenancyBootstrapper.php +++ b/src/Bootstrappers/FilesystemTenancyBootstrapper.php @@ -57,9 +57,10 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) { // todo@v4 \League\Flysystem\PathPrefixer is making this a lot more painful in flysystem v2 + $diskConfig = $this->app['config']["filesystems.disks.{$disk}"]; + $originalRoot = $diskConfig['root'] ?? null; - $originalRoot = $this->app['config']["filesystems.disks.{$disk}.root"]; - $this->originalPaths['disks'][$disk] = $originalRoot; + $this->originalPaths['disks']['path'][$disk] = $originalRoot; $finalPrefix = str_replace( ['%storage_path%', '%tenant%'], @@ -74,6 +75,19 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper } $this->app['config']["filesystems.disks.{$disk}.root"] = $finalPrefix; + + // Storage Url + if ($diskConfig['driver'] === 'local') { + $this->originalPaths['disks']['url'][$disk] = $diskConfig['url'] ?? null; + + if ($url = str_replace( + '%tenant_id%', + $tenant->getTenantKey(), + $this->app['config']["tenancy.filesystem.url_override.{$disk}"] ?? '' + )) { + $this->app['config']["filesystems.disks.{$disk}.url"] = url($url); + } + } } } @@ -88,8 +102,16 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper // Storage facade Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']); - foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) { - $this->app['config']["filesystems.disks.{$disk}.root"] = $this->originalPaths['disks'][$disk]; + foreach ($this->app['config']['tenancy.filesystem.disks'] as $diskName) { + $this->app['config']["filesystems.disks.$diskName.root"] = $this->originalPaths['disks']['path'][$diskName]; + $diskConfig = $this->app['config']['filesystems.disks.' . $diskName]; + + // Storage Url + $url = $this->originalPaths['disks.url.' . $diskName] ?? null; + + if ($diskConfig['driver'] === 'local' && ! is_null($url)) { + $$this->app['config']["filesystems.disks.$diskName.url"] = $url; + } } } } diff --git a/src/Bootstrappers/Integrations/ScoutTenancyBootstrapper.php b/src/Bootstrappers/Integrations/ScoutTenancyBootstrapper.php new file mode 100644 index 00000000..49869bb5 --- /dev/null +++ b/src/Bootstrappers/Integrations/ScoutTenancyBootstrapper.php @@ -0,0 +1,42 @@ +config = $config; + } + + public function bootstrap(Tenant $tenant) + { + if (! isset($this->originalScoutPrefix)) { + $this->originalScoutPrefix = $this->config->get('scout.prefix'); + } + + $this->config->set('scout.prefix', $this->getTenantPrefix($tenant)); + } + + public function revert() + { + $this->config->set('scout.prefix', $this->originalScoutPrefix); + } + + protected function getTenantPrefix(Tenant $tenant): string + { + return (string) $tenant->getTenantKey(); + } +} diff --git a/src/CacheManager.php b/src/CacheManager.php index 09581201..f28134b8 100644 --- a/src/CacheManager.php +++ b/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 { /** @@ -26,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)); } diff --git a/src/Commands/Install.php b/src/Commands/Install.php index 41492b26..12a2c2c9 100644 --- a/src/Commands/Install.php +++ b/src/Commands/Install.php @@ -8,24 +8,11 @@ use Illuminate\Console\Command; class Install extends Command { - /** - * The name and signature of the console command. - * - * @var string - */ protected $signature = 'tenancy:install'; - /** - * The console command description. - * - * @var string - */ protected $description = 'Install stancl/tenancy.'; - /** - * Execute the console command. - */ - public function handle() + public function handle(): void { $this->comment('Installing stancl/tenancy...'); $this->callSilent('vendor:publish', [ diff --git a/src/Commands/Link.php b/src/Commands/Link.php new file mode 100644 index 00000000..2b9ee4cf --- /dev/null +++ b/src/Commands/Link.php @@ -0,0 +1,58 @@ +getTenants(); + + try { + if ($this->option('remove')) { + $this->removeLinks($tenants); + } else { + $this->createLinks($tenants); + } + } catch (Exception $exception) { + $this->error($exception->getMessage()); + } + } + + protected function removeLinks(LazyCollection $tenants): void + { + RemoveStorageSymlinksAction::handle($tenants); + + $this->info('The links have been removed.'); + } + + protected function createLinks(LazyCollection $tenants): void + { + CreateStorageSymlinksAction::handle( + $tenants, + $this->option('relative') ?? false, + $this->option('force') ?? false, + ); + + $this->info('The links have been created.'); + } +} diff --git a/src/Commands/Migrate.php b/src/Commands/Migrate.php index 52ecd47f..739b56de 100644 --- a/src/Commands/Migrate.php +++ b/src/Commands/Migrate.php @@ -7,7 +7,6 @@ namespace Stancl\Tenancy\Commands; use Illuminate\Contracts\Events\Dispatcher; use Illuminate\Database\Console\Migrations\MigrateCommand; use Illuminate\Database\Migrations\Migrator; -use Stancl\Tenancy\Concerns\DealsWithMigrations; use Stancl\Tenancy\Concerns\ExtendsLaravelCommand; use Stancl\Tenancy\Concerns\HasATenantsOption; use Stancl\Tenancy\Events\DatabaseMigrated; @@ -15,7 +14,7 @@ use Stancl\Tenancy\Events\MigratingDatabase; class Migrate extends MigrateCommand { - use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand; + use HasATenantsOption, ExtendsLaravelCommand; protected $description = 'Run migrations for tenant(s)'; @@ -31,10 +30,7 @@ class Migrate extends MigrateCommand $this->specifyParameters(); } - /** - * Execute the console command. - */ - public function handle() + public function handle(): int { foreach (config('tenancy.migration_parameters') as $parameter => $value) { if (! $this->input->hasParameterOption($parameter)) { @@ -43,10 +39,10 @@ class Migrate extends MigrateCommand } if (! $this->confirmToProceed()) { - return; + return 1; } - tenancy()->runForMultiple($this->option('tenants'), function ($tenant) { + tenancy()->runForMultiple($this->getTenants(), function ($tenant) { $this->line("Tenant: {$tenant->getTenantKey()}"); event(new MigratingDatabase($tenant)); @@ -56,5 +52,7 @@ class Migrate extends MigrateCommand event(new DatabaseMigrated($tenant)); }); + + return 0; } } diff --git a/src/Commands/MigrateFresh.php b/src/Commands/MigrateFresh.php index 63860153..56a6047f 100644 --- a/src/Commands/MigrateFresh.php +++ b/src/Commands/MigrateFresh.php @@ -5,19 +5,13 @@ declare(strict_types=1); namespace Stancl\Tenancy\Commands; use Illuminate\Console\Command; -use Stancl\Tenancy\Concerns\DealsWithMigrations; use Stancl\Tenancy\Concerns\HasATenantsOption; use Symfony\Component\Console\Input\InputOption; final class MigrateFresh extends Command { - use HasATenantsOption, DealsWithMigrations; + use HasATenantsOption; - /** - * The console command description. - * - * @var string - */ protected $description = 'Drop all tables and re-run all migrations for tenant(s)'; public function __construct() @@ -29,12 +23,9 @@ final class MigrateFresh extends Command $this->setName('tenants:migrate-fresh'); } - /** - * Execute the console command. - */ - public function handle() + public function handle(): void { - tenancy()->runForMultiple($this->option('tenants'), function ($tenant) { + tenancy()->runForMultiple($this->getTenants(), function ($tenant) { $this->info('Dropping tables.'); $this->call('db:wipe', array_filter([ '--database' => 'tenant', diff --git a/src/Commands/Rollback.php b/src/Commands/Rollback.php index 1c434189..d61083d4 100644 --- a/src/Commands/Rollback.php +++ b/src/Commands/Rollback.php @@ -6,7 +6,6 @@ namespace Stancl\Tenancy\Commands; use Illuminate\Database\Console\Migrations\RollbackCommand; use Illuminate\Database\Migrations\Migrator; -use Stancl\Tenancy\Concerns\DealsWithMigrations; use Stancl\Tenancy\Concerns\ExtendsLaravelCommand; use Stancl\Tenancy\Concerns\HasATenantsOption; use Stancl\Tenancy\Events\DatabaseRolledBack; @@ -14,25 +13,10 @@ use Stancl\Tenancy\Events\RollingBackDatabase; class Rollback extends RollbackCommand { - use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand; + use HasATenantsOption, ExtendsLaravelCommand; - protected static function getTenantCommandName(): string - { - return 'tenants:rollback'; - } - - /** - * The console command description. - * - * @var string - */ protected $description = 'Rollback migrations for tenant(s).'; - /** - * Create a new command instance. - * - * @return void - */ public function __construct(Migrator $migrator) { parent::__construct($migrator); @@ -40,10 +24,7 @@ class Rollback extends RollbackCommand $this->specifyTenantSignature(); } - /** - * Execute the console command. - */ - public function handle() + public function handle(): int { foreach (config('tenancy.migration_parameters') as $parameter => $value) { if (! $this->input->hasParameterOption($parameter)) { @@ -52,7 +33,7 @@ class Rollback extends RollbackCommand } if (! $this->confirmToProceed()) { - return; + return 1; } tenancy()->runForMultiple($this->option('tenants'), function ($tenant) { @@ -65,5 +46,12 @@ class Rollback extends RollbackCommand event(new DatabaseRolledBack($tenant)); }); + + return 0; + } + + protected static function getTenantCommandName(): string + { + return 'tenants:rollback'; } } diff --git a/src/Commands/Run.php b/src/Commands/Run.php index 2b20d9c3..403ffd1b 100644 --- a/src/Commands/Run.php +++ b/src/Commands/Run.php @@ -5,51 +5,37 @@ declare(strict_types=1); namespace Stancl\Tenancy\Commands; use Illuminate\Console\Command; +use Illuminate\Contracts\Console\Kernel; +use Symfony\Component\Console\Input\ArgvInput; +use Symfony\Component\Console\Output\ConsoleOutput; class Run extends Command { - /** - * The console command description. - * - * @var string - */ protected $description = 'Run a command for tenant(s)'; - /** - * The name and signature of the console command. - * - * @var string - */ - protected $signature = "tenants:run {commandname : The command's name.} - {--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}"; + protected $signature = 'tenants:run {commandname : The artisan command.} + {--tenants=* : The tenant(s) to run the command for. Default: all}'; - /** - * Execute the console command. - */ - public function handle() + public function handle(): void { - tenancy()->runForMultiple($this->option('tenants'), function ($tenant) { + $argvInput = $this->argvInput(); + tenancy()->runForMultiple($this->option('tenants'), function ($tenant) use ($argvInput) { $this->line("Tenant: {$tenant->getTenantKey()}"); - $callback = function ($prefix = '') { - return function ($arguments, $argument) use ($prefix) { - [$key, $value] = explode('=', $argument, 2); - $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)); + $this->getLaravel() + ->make(Kernel::class) + ->handle($argvInput, new ConsoleOutput); }); } + + protected function argvInput(): ArgvInput + { + // Convert string command to array + $subCommand = explode(' ', $this->argument('commandname')); + + // Add "artisan" as first parameter because ArgvInput expects "artisan" as first parameter and later removes it + array_unshift($subCommand, 'artisan'); + + return new ArgvInput($subCommand); + } } diff --git a/src/Commands/Seed.php b/src/Commands/Seed.php index 8c525208..b59e0062 100644 --- a/src/Commands/Seed.php +++ b/src/Commands/Seed.php @@ -14,29 +14,16 @@ class Seed extends SeedCommand { use HasATenantsOption; - /** - * The console command description. - * - * @var string - */ protected $description = 'Seed tenant database(s).'; protected $name = 'tenants:seed'; - /** - * Create a new command instance. - * - * @return void - */ public function __construct(ConnectionResolverInterface $resolver) { parent::__construct($resolver); } - /** - * Execute the console command. - */ - public function handle() + public function handle(): int { foreach (config('tenancy.seeder_parameters') as $parameter => $value) { if (! $this->input->hasParameterOption($parameter)) { @@ -45,7 +32,7 @@ class Seed extends SeedCommand } if (! $this->confirmToProceed()) { - return; + return 1; } tenancy()->runForMultiple($this->option('tenants'), function ($tenant) { @@ -58,5 +45,7 @@ class Seed extends SeedCommand event(new DatabaseSeeded($tenant)); }); + + return 0; } } diff --git a/src/Commands/TenantList.php b/src/Commands/TenantList.php index 13775676..ce8dfcec 100644 --- a/src/Commands/TenantList.php +++ b/src/Commands/TenantList.php @@ -9,24 +9,11 @@ use Stancl\Tenancy\Contracts\Tenant; class TenantList extends Command { - /** - * The name and signature of the console command. - * - * @var string - */ protected $signature = 'tenants:list'; - /** - * The console command description. - * - * @var string - */ protected $description = 'List tenants.'; - /** - * Execute the console command. - */ - public function handle() + public function handle(): void { $this->info('Listing all tenants.'); tenancy() diff --git a/src/Concerns/DealsWithMigrations.php b/src/Concerns/DealsWithMigrations.php index 4bb6b44c..3129c68d 100644 --- a/src/Concerns/DealsWithMigrations.php +++ b/src/Concerns/DealsWithMigrations.php @@ -6,12 +6,12 @@ namespace Stancl\Tenancy\Concerns; trait DealsWithMigrations { - protected function getMigrationPaths() + protected function getMigrationPaths(): array { if ($this->input->hasOption('path') && $this->input->getOption('path')) { return parent::getMigrationPaths(); } - return database_path('migrations/tenant'); + return [database_path('migrations/tenant')]; } } diff --git a/src/Concerns/DealsWithTenantSymlinks.php b/src/Concerns/DealsWithTenantSymlinks.php new file mode 100644 index 00000000..d6d6f5f2 --- /dev/null +++ b/src/Concerns/DealsWithTenantSymlinks.php @@ -0,0 +1,46 @@ + 'storage path']). + * + * Tenants can have a symlink for each disk registered in the tenancy.filesystem.url_override config. + * + * This is used for creating all possible tenant symlinks and removing all existing tenant symlinks. + * + * @return Collection + */ + protected static function possibleTenantSymlinks(Tenant $tenant): Collection + { + $diskUrls = config('tenancy.filesystem.url_override'); + $disks = config('tenancy.filesystem.root_override'); + $suffixBase = config('tenancy.filesystem.suffix_base'); + $symlinks = collect(); + $tenantKey = $tenant->getTenantKey(); + + foreach ($diskUrls as $disk => $publicPath) { + $storagePath = str_replace('%storage_path%', $suffixBase . $tenantKey, $disks[$disk]); + $publicPath = str_replace('%tenant_id%', $tenantKey, $publicPath); + + tenancy()->central(function () use ($symlinks, $publicPath, $storagePath) { + $symlinks->push([public_path($publicPath) => storage_path($storagePath)]); + }); + } + + return $symlinks->mapWithKeys(fn ($item) => $item); // [[a => b], [c => d]] -> [a => b, c => d] + } + + /** Determine if the provided path is an existing symlink. */ + protected static function symlinkExists(string $link): bool + { + return file_exists($link) && is_link($link); + } +} diff --git a/src/Concerns/Debuggable.php b/src/Concerns/Debuggable.php index 98697f1d..ff781f89 100644 --- a/src/Concerns/Debuggable.php +++ b/src/Concerns/Debuggable.php @@ -9,6 +9,8 @@ use Stancl\Tenancy\Enums\LogMode; use Stancl\Tenancy\Events\Contracts\TenancyEvent; use Stancl\Tenancy\Tenancy; +// todo finish this feature + /** * @mixin Tenancy */ diff --git a/src/Contracts/SyncMaster.php b/src/Contracts/SyncMaster.php index e1b34149..28fafa91 100644 --- a/src/Contracts/SyncMaster.php +++ b/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 */ diff --git a/src/Contracts/Syncable.php b/src/Contracts/Syncable.php index 1f6e36e7..e09f4f7e 100644 --- a/src/Contracts/Syncable.php +++ b/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; } diff --git a/src/Contracts/Tenant.php b/src/Contracts/Tenant.php index 770e862e..c01cd7d5 100644 --- a/src/Contracts/Tenant.php +++ b/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; } diff --git a/src/Contracts/TenantCouldNotBeIdentifiedException.php b/src/Contracts/TenantCouldNotBeIdentifiedException.php index ac767e5e..011d974b 100644 --- a/src/Contracts/TenantCouldNotBeIdentifiedException.php +++ b/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', + ]); + } } diff --git a/src/Contracts/TenantResolver.php b/src/Contracts/TenantResolver.php index bba72f34..b4b45f4b 100644 --- a/src/Contracts/TenantResolver.php +++ b/src/Contracts/TenantResolver.php @@ -11,5 +11,5 @@ interface TenantResolver * * @throws TenantCouldNotBeIdentifiedException */ - public function resolve(...$args): Tenant; + public function resolve(mixed ...$args): Tenant; } diff --git a/src/Contracts/TenantWithDatabase.php b/src/Contracts/TenantWithDatabase.php deleted file mode 100644 index c3f51628..00000000 --- a/src/Contracts/TenantWithDatabase.php +++ /dev/null @@ -1,15 +0,0 @@ -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); } } diff --git a/src/Database/Concerns/BelongsToPrimaryModel.php b/src/Database/Concerns/BelongsToPrimaryModel.php index 72101d6a..a50f9d9e 100644 --- a/src/Database/Concerns/BelongsToPrimaryModel.php +++ b/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); } diff --git a/src/Database/Concerns/BelongsToTenant.php b/src/Database/Concerns/BelongsToTenant.php index 5410758d..ade966a8 100644 --- a/src/Database/Concerns/BelongsToTenant.php +++ b/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); diff --git a/src/Database/Concerns/ConvertsDomainsToLowercase.php b/src/Database/Concerns/ConvertsDomainsToLowercase.php index e3f0c6ac..8068902d 100644 --- a/src/Database/Concerns/ConvertsDomainsToLowercase.php +++ b/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); diff --git a/src/Concerns/CreatesDatabaseUsers.php b/src/Database/Concerns/CreatesDatabaseUsers.php similarity index 80% rename from src/Concerns/CreatesDatabaseUsers.php rename to src/Database/Concerns/CreatesDatabaseUsers.php index 863dd4a7..f329f071 100644 --- a/src/Concerns/CreatesDatabaseUsers.php +++ b/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 { diff --git a/src/Database/Concerns/EnsuresDomainIsNotOccupied.php b/src/Database/Concerns/EnsuresDomainIsNotOccupied.php index 2b1c56ee..a853c437 100644 --- a/src/Database/Concerns/EnsuresDomainIsNotOccupied.php +++ b/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()) { diff --git a/src/Database/Concerns/GeneratesIds.php b/src/Database/Concerns/GeneratesIds.php index d2796ba4..301ea385 100644 --- a/src/Database/Concerns/GeneratesIds.php +++ b/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()) { diff --git a/src/Database/Concerns/HasDatabase.php b/src/Database/Concerns/HasDatabase.php index aab381bd..42e6555a 100644 --- a/src/Database/Concerns/HasDatabase.php +++ b/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\DatabaseConfig; +use Stancl\Tenancy\Database\Contracts\TenantWithDatabase; +use Stancl\Tenancy\Database\DatabaseConfig; trait HasDatabase { diff --git a/src/Database/Concerns/HasDomains.php b/src/Database/Concerns/HasDomains.php index 39411fea..bd512e23 100644 --- a/src/Database/Concerns/HasDomains.php +++ b/src/Database/Concerns/HasDomains.php @@ -2,12 +2,16 @@ declare(strict_types=1); +// todo not sure if this should be in Database\ + namespace Stancl\Tenancy\Database\Concerns; use Stancl\Tenancy\Contracts\Domain; /** * @property-read Domain[]|\Illuminate\Database\Eloquent\Collection $domains + * @mixin \Illuminate\Database\Eloquent\Model + * @mixin \Stancl\Tenancy\Contracts\Tenant */ trait HasDomains { diff --git a/src/Database/Concerns/HasInternalKeys.php b/src/Database/Concerns/HasInternalKeys.php index b4e175c3..ea70d6ed 100644 --- a/src/Database/Concerns/HasInternalKeys.php +++ b/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. - */ - public function getInternal(string $key) + /** Get an internal key. */ + public function getInternal(string $key): mixed { return $this->getAttribute(static::internalPrefix() . $key); } - /** - * Set internal key. - */ - public function setInternal(string $key, $value) + /** Set internal key. */ + public function setInternal(string $key, mixed $value): static { $this->setAttribute(static::internalPrefix() . $key, $value); diff --git a/src/Database/Concerns/InitializationHelpers.php b/src/Database/Concerns/InitializationHelpers.php new file mode 100644 index 00000000..46802df1 --- /dev/null +++ b/src/Database/Concerns/InitializationHelpers.php @@ -0,0 +1,21 @@ +initialize($this); + } + + public function leave(): void + { + tenancy()->end(); + } +} diff --git a/src/Database/Concerns/InvalidatesResolverCache.php b/src/Database/Concerns/InvalidatesResolverCache.php index 7dff35ad..3b864789 100644 --- a/src/Database/Concerns/InvalidatesResolverCache.php +++ b/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) { diff --git a/src/Database/Concerns/InvalidatesTenantsResolverCache.php b/src/Database/Concerns/InvalidatesTenantsResolverCache.php index 555aceeb..8d7c2845 100644 --- a/src/Database/Concerns/InvalidatesTenantsResolverCache.php +++ b/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) { diff --git a/src/Database/Concerns/ResourceSyncing.php b/src/Database/Concerns/ResourceSyncing.php index f1026f7a..df5b0766 100644 --- a/src/Database/Concerns/ResourceSyncing.php +++ b/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())); diff --git a/src/Database/Concerns/TenantRun.php b/src/Database/Concerns/TenantRun.php index 29bbedac..01d5b9d8 100644 --- a/src/Database/Concerns/TenantRun.php +++ b/src/Database/Concerns/TenantRun.php @@ -4,15 +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. + * + * This method is atomic and safely reverts to the previous context. */ - public function run(callable $callback) + public function run(Closure $callback): mixed { /** @var Tenant $this */ $originalTenant = tenant(); diff --git a/src/Contracts/ManagesDatabaseUsers.php b/src/Database/Contracts/ManagesDatabaseUsers.php similarity index 60% rename from src/Contracts/ManagesDatabaseUsers.php rename to src/Database/Contracts/ManagesDatabaseUsers.php index 6de28a80..83b9fad5 100644 --- a/src/Contracts/ManagesDatabaseUsers.php +++ b/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; } diff --git a/src/Contracts/TenantDatabaseManager.php b/src/Database/Contracts/TenantDatabaseManager.php similarity index 66% rename from src/Contracts/TenantDatabaseManager.php rename to src/Database/Contracts/TenantDatabaseManager.php index 92801d75..474ee016 100644 --- a/src/Contracts/TenantDatabaseManager.php +++ b/src/Database/Contracts/TenantDatabaseManager.php @@ -2,30 +2,22 @@ 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? */ public function databaseExists(string $name): bool; - /** - * Make a DB connection config array. - */ + /** Construct a DB connection config array. */ public function makeConnectionConfig(array $baseConfig, string $databaseName): array; /** diff --git a/src/Database/Contracts/TenantWithDatabase.php b/src/Database/Contracts/TenantWithDatabase.php new file mode 100644 index 00000000..c9247d94 --- /dev/null +++ b/src/Database/Contracts/TenantWithDatabase.php @@ -0,0 +1,13 @@ +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; } @@ -85,7 +83,7 @@ class DatabaseConfig { $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)); } @@ -142,20 +140,18 @@ class DatabaseConfig }, []); } - /** - * Get the TenantDatabaseManager for this tenant's connection. - */ - public function manager(): TenantDatabaseManager + /** Get the TenantDatabaseManager for this tenant's connection. */ + public function manager(): Contracts\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()); diff --git a/src/Database/DatabaseManager.php b/src/Database/DatabaseManager.php index 6242ffa9..a92ccb7b 100644 --- a/src/Database/DatabaseManager.php +++ b/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\Exceptions\DatabaseManagerNotRegisteredException; -use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException; -use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException; +use Stancl\Tenancy\Database\Contracts\TenantWithDatabase; /** * @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())) { - throw new TenantDatabaseUserAlreadyExistsException($username); + if ($manager instanceof Contracts\ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) { + throw new Exceptions\TenantDatabaseUserAlreadyExistsException($username); } } } diff --git a/src/Database/Exceptions/DatabaseManagerNotRegisteredException.php b/src/Database/Exceptions/DatabaseManagerNotRegisteredException.php new file mode 100644 index 00000000..d499df5d --- /dev/null +++ b/src/Database/Exceptions/DatabaseManagerNotRegisteredException.php @@ -0,0 +1,15 @@ +database} already exists."; } - - public function __construct(string $database) - { - $this->database = $database; - - parent::__construct(); - } } diff --git a/src/Exceptions/TenantDatabaseDoesNotExistException.php b/src/Database/Exceptions/TenantDatabaseDoesNotExistException.php similarity index 66% rename from src/Exceptions/TenantDatabaseDoesNotExistException.php rename to src/Database/Exceptions/TenantDatabaseDoesNotExistException.php index 2f6df0f9..cbbf3edb 100644 --- a/src/Exceptions/TenantDatabaseDoesNotExistException.php +++ b/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."); } diff --git a/src/Exceptions/TenantDatabaseUserAlreadyExistsException.php b/src/Database/Exceptions/TenantDatabaseUserAlreadyExistsException.php similarity index 67% rename from src/Exceptions/TenantDatabaseUserAlreadyExistsException.php rename to src/Database/Exceptions/TenantDatabaseUserAlreadyExistsException.php index f84e39ec..073f0387 100644 --- a/src/Exceptions/TenantDatabaseUserAlreadyExistsException.php +++ b/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 */ - protected $user; + public function __construct( + 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; - } } diff --git a/src/Database/Models/Domain.php b/src/Database/Models/Domain.php index 261918c4..16695711 100644 --- a/src/Database/Models/Domain.php +++ b/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')); } diff --git a/src/Database/Models/ImpersonationToken.php b/src/Database/Models/ImpersonationToken.php index 43c536fb..05d17ad4 100644 --- a/src/Database/Models/ImpersonationToken.php +++ b/src/Database/Models/ImpersonationToken.php @@ -5,17 +5,20 @@ declare(strict_types=1); namespace Stancl\Tenancy\Database\Models; use Carbon\Carbon; +use Illuminate\Contracts\Auth\StatefulGuard; use Illuminate\Database\Eloquent\Model; +use Illuminate\Support\Facades\Auth; use Illuminate\Support\Str; use Stancl\Tenancy\Database\Concerns\CentralConnection; +use Stancl\Tenancy\Exceptions\StatefulGuardRequiredException; /** - * @param string $token - * @param string $tenant_id - * @param string $user_id - * @param string $auth_guard - * @param string $redirect_url - * @param Carbon $created_at + * @property string $token + * @property string $tenant_id + * @property string $user_id + * @property string $auth_guard + * @property string $redirect_url + * @property Carbon $created_at */ class ImpersonationToken extends Model { @@ -35,14 +38,18 @@ class ImpersonationToken extends Model 'created_at', ]; - public static function boot() + public static function booted(): void { - parent::boot(); - static::creating(function ($model) { + $authGuard = $model->auth_guard ?? config('auth.defaults.guard'); + + if (! Auth::guard($authGuard) instanceof StatefulGuard) { + throw new StatefulGuardRequiredException($authGuard); + } + $model->created_at = $model->created_at ?? $model->freshTimestamp(); $model->token = $model->token ?? Str::random(128); - $model->auth_guard = $model->auth_guard ?? config('auth.defaults.guard'); + $model->auth_guard = $authGuard; }); } } diff --git a/src/Database/Models/Tenant.php b/src/Database/Models/Tenant.php index f88297be..88c34146 100644 --- a/src/Database/Models/Tenant.php +++ b/src/Database/Models/Tenant.php @@ -26,6 +26,7 @@ class Tenant extends Model implements Contracts\Tenant Concerns\HasDataColumn, Concerns\HasInternalKeys, Concerns\TenantRun, + Concerns\InitializationHelpers, Concerns\InvalidatesResolverCache; protected $table = 'tenants'; @@ -39,7 +40,7 @@ class Tenant extends Model implements Contracts\Tenant return 'id'; } - public function getTenantKey() + public function getTenantKey(): int|string { return $this->getAttribute($this->getTenantKeyName()); } diff --git a/src/Database/Models/TenantPivot.php b/src/Database/Models/TenantPivot.php index f745b45a..2c7583c1 100644 --- a/src/Database/Models/TenantPivot.php +++ b/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; diff --git a/src/Database/ParentModelScope.php b/src/Database/ParentModelScope.php index 387b1d19..78f5de20 100644 --- a/src/Database/ParentModelScope.php +++ b/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; diff --git a/src/Database/TenantCollection.php b/src/Database/TenantCollection.php index ba3a8fab..45a137fe 100644 --- a/src/Database/TenantCollection.php +++ b/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); diff --git a/src/Database/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php b/src/Database/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php new file mode 100644 index 00000000..65950baa --- /dev/null +++ b/src/Database/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php @@ -0,0 +1,29 @@ +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'"); + } +} diff --git a/src/Database/TenantDatabaseManagers/MySQLDatabaseManager.php b/src/Database/TenantDatabaseManagers/MySQLDatabaseManager.php new file mode 100644 index 00000000..c96c162b --- /dev/null +++ b/src/Database/TenantDatabaseManagers/MySQLDatabaseManager.php @@ -0,0 +1,29 @@ +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'"); + } +} diff --git a/src/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php b/src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php similarity index 83% rename from src/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php rename to src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php index 918601a8..337864dc 100644 --- a/src/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php +++ b/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\Contracts\ManagesDatabaseUsers; -use Stancl\Tenancy\DatabaseConfig; +use Stancl\Tenancy\Database\Concerns\CreatesDatabaseUsers; +use Stancl\Tenancy\Database\Contracts\ManagesDatabaseUsers; +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; - } } diff --git a/src/Database/TenantDatabaseManagers/PostgreSQLDatabaseManager.php b/src/Database/TenantDatabaseManagers/PostgreSQLDatabaseManager.php new file mode 100644 index 00000000..6a3aee2e --- /dev/null +++ b/src/Database/TenantDatabaseManagers/PostgreSQLDatabaseManager.php @@ -0,0 +1,25 @@ +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'"); + } +} diff --git a/src/TenantDatabaseManagers/PostgreSQLSchemaManager.php b/src/Database/TenantDatabaseManagers/PostgreSQLSchemaManager.php similarity index 56% rename from src/TenantDatabaseManagers/PostgreSQLSchemaManager.php rename to src/Database/TenantDatabaseManagers/PostgreSQLSchemaManager.php index 55f049d0..fa5aa593 100644 --- a/src/TenantDatabaseManagers/PostgreSQLSchemaManager.php +++ b/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 Illuminate\Support\Facades\DB; -use Stancl\Tenancy\Contracts\TenantDatabaseManager; -use Stancl\Tenancy\Contracts\TenantWithDatabase; -use Stancl\Tenancy\Exceptions\NoConnectionSetException; +use Stancl\Tenancy\Database\Contracts\TenantWithDatabase; -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()}\""); diff --git a/src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php b/src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php new file mode 100644 index 00000000..ada5d642 --- /dev/null +++ b/src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php @@ -0,0 +1,61 @@ +getPath($tenant->database()->getName()), ''); + } catch (Throwable) { + return false; + } + } + + public function deleteDatabase(TenantWithDatabase $tenant): bool + { + try { + return unlink($this->getPath($tenant->database()->getName())); + } catch (Throwable) { + return false; + } + } + + public function databaseExists(string $name): bool + { + return file_exists($this->getPath($name)); + } + + public function makeConnectionConfig(array $baseConfig, string $databaseName): array + { + $baseConfig['database'] = database_path($databaseName); + + return $baseConfig; + } + + public function setConnection(string $connection): void + { + // + } + + public function getPath(string $name): string + { + if (static::$path) { + return static::$path . DIRECTORY_SEPARATOR . $name; + } + + return database_path($name); + } +} diff --git a/src/Database/TenantDatabaseManagers/TenantDatabaseManager.php b/src/Database/TenantDatabaseManagers/TenantDatabaseManager.php new file mode 100644 index 00000000..b7dd15fa --- /dev/null +++ b/src/Database/TenantDatabaseManagers/TenantDatabaseManager.php @@ -0,0 +1,37 @@ +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; + } +} diff --git a/src/Events/Contracts/TenancyEvent.php b/src/Events/Contracts/TenancyEvent.php index f292049d..85b793f5 100644 --- a/src/Events/Contracts/TenancyEvent.php +++ b/src/Events/Contracts/TenancyEvent.php @@ -8,11 +8,8 @@ use Stancl\Tenancy\Tenancy; abstract class TenancyEvent { - /** @var Tenancy */ - public $tenancy; - - public function __construct(Tenancy $tenancy) - { - $this->tenancy = $tenancy; + public function __construct( + public Tenancy $tenancy, + ) { } } diff --git a/src/Events/CreatingStorageSymlink.php b/src/Events/CreatingStorageSymlink.php new file mode 100644 index 00000000..13937174 --- /dev/null +++ b/src/Events/CreatingStorageSymlink.php @@ -0,0 +1,9 @@ +model = $model; $this->tenant = $tenant; diff --git a/src/Exceptions/DatabaseManagerNotRegisteredException.php b/src/Exceptions/DatabaseManagerNotRegisteredException.php deleted file mode 100644 index e93c31a1..00000000 --- a/src/Exceptions/DatabaseManagerNotRegisteredException.php +++ /dev/null @@ -1,13 +0,0 @@ -setSolutionDescription('Are you sure the ID is correct and the tenant exists?') - ->setDocumentationLinks([ - 'Initializing Tenants' => 'https://tenancyforlaravel.com/docs/v3/tenants', - ]); - } -} diff --git a/src/Exceptions/TenantCouldNotBeIdentifiedByIdException.php b/src/Exceptions/TenantCouldNotBeIdentifiedByIdException.php new file mode 100644 index 00000000..ffd3dbdc --- /dev/null +++ b/src/Exceptions/TenantCouldNotBeIdentifiedByIdException.php @@ -0,0 +1,20 @@ +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?'); + } +} diff --git a/src/Exceptions/TenantCouldNotBeIdentifiedByPathException.php b/src/Exceptions/TenantCouldNotBeIdentifiedByPathException.php index 896c9323..5a494d90 100644 --- a/src/Exceptions/TenantCouldNotBeIdentifiedByPathException.php +++ b/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"); - } - - public function getSolution(): Solution - { - 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/', - ]); + $this + ->tenantCouldNotBeIdentified("on path with tenant id: $tenant_id") + ->title('Tenant could not be identified on this path') + ->description('Did you forget to create a tenant for this path?'); } } diff --git a/src/Exceptions/TenantCouldNotBeIdentifiedByRequestDataException.php b/src/Exceptions/TenantCouldNotBeIdentifiedByRequestDataException.php index f0447d96..1f1c98a1 100644 --- a/src/Exceptions/TenantCouldNotBeIdentifiedByRequestDataException.php +++ b/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"); - } - - public function getSolution(): Solution - { - 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/', - ]); + $this + ->tenantCouldNotBeIdentified("by request data with payload: $payload") + ->title('Tenant could not be identified using this request data') + ->description('Did you forget to create a tenant with this id?'); } } diff --git a/src/Exceptions/TenantCouldNotBeIdentifiedOnDomainException.php b/src/Exceptions/TenantCouldNotBeIdentifiedOnDomainException.php index 66bc1db8..0421fe1b 100644 --- a/src/Exceptions/TenantCouldNotBeIdentifiedOnDomainException.php +++ b/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"); - } - - public function getSolution(): Solution - { - 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/', - ]); + $this + ->tenantCouldNotBeIdentified("on domain $domain") + ->title('Tenant could not be identified on this domain') + ->description('Did you forget to create a tenant for this domain?'); } } diff --git a/src/Features/CrossDomainRedirect.php b/src/Features/CrossDomainRedirect.php index 6ebd15fc..a48be6ea 100644 --- a/src/Features/CrossDomainRedirect.php +++ b/src/Features/CrossDomainRedirect.php @@ -14,12 +14,16 @@ class CrossDomainRedirect implements Feature { RedirectResponse::macro('domain', function (string $domain) { /** @var RedirectResponse $this */ - - // replace first occurance of hostname fragment with $domain $url = $this->getTargetUrl(); + + /** + * The original hostname in the redirect response. + * + * @var string $hostname + */ $hostname = parse_url($url, PHP_URL_HOST); - $position = strpos($url, $hostname); - $this->setTargetUrl(substr_replace($url, $domain, $position, strlen($hostname))); + + $this->setTargetUrl((string) str($url)->replace($hostname, $domain)); return $this; }); diff --git a/src/Features/TenantConfig.php b/src/Features/TenantConfig.php index fb09a871..50756b2c 100644 --- a/src/Features/TenantConfig.php +++ b/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 $originalConfig = []; + public array $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); } } } diff --git a/src/Features/UniversalRoutes.php b/src/Features/UniversalRoutes.php index c73a5304..e327b5d3 100644 --- a/src/Features/UniversalRoutes.php +++ b/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, ]; @@ -39,7 +40,7 @@ class UniversalRoutes implements Feature } } - 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; diff --git a/src/Features/UserImpersonation.php b/src/Features/UserImpersonation.php index f96465ff..41bf774b 100644 --- a/src/Features/UserImpersonation.php +++ b/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,25 +28,21 @@ class UserImpersonation implements Feature }); } - /** - * Impersonate a user and get an HTTP redirect response. - * - * @param string|ImpersonationToken $token - * @param int $ttl - */ - public static function makeResponse($token, int $ttl = null): RedirectResponse + /** Impersonate a user and get an HTTP redirect response. */ + public static function makeResponse(string|ImpersonationToken $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())) { - abort(403); - } + $tokenExpired = $token->created_at->diffInSeconds(now()) > $ttl; - $ttl = $ttl ?? static::$ttl; + abort_if($tokenExpired, 403); - if ($token->created_at->diffInSeconds(Carbon::now()) > $ttl) { - abort(403); - } + $tokenTenantId = (string) $token->tenant_id; + $currentTenantId = (string) tenant()->getTenantKey(); + + abort_unless($tokenTenantId === $currentTenantId, 403); Auth::guard($token->auth_guard)->loginUsingId($token->user_id); diff --git a/src/Jobs/CreateDatabase.php b/src/Jobs/CreateDatabase.php index 3cb2a6b4..dbc4b097 100644 --- a/src/Jobs/CreateDatabase.php +++ b/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,15 +19,12 @@ class CreateDatabase implements ShouldQueue { use Dispatchable, InteractsWithQueue, Queueable, SerializesModels; - /** @var TenantWithDatabase|Model */ - protected $tenant; - - public function __construct(TenantWithDatabase $tenant) - { - $this->tenant = $tenant; + public function __construct( + protected TenantWithDatabase&Model $tenant, + ) { } - public function handle(DatabaseManager $databaseManager) + public function handle(DatabaseManager $databaseManager): bool { event(new CreatingDatabase($this->tenant)); @@ -41,5 +38,7 @@ class CreateDatabase implements ShouldQueue $this->tenant->database()->manager()->createDatabase($this->tenant); event(new DatabaseCreated($this->tenant)); + + return true; } } diff --git a/src/Jobs/CreateStorageSymlinks.php b/src/Jobs/CreateStorageSymlinks.php new file mode 100644 index 00000000..2e1db88a --- /dev/null +++ b/src/Jobs/CreateStorageSymlinks.php @@ -0,0 +1,27 @@ +tenant); + } +} diff --git a/src/Jobs/DeleteDatabase.php b/src/Jobs/DeleteDatabase.php index 589741cf..71358f74 100644 --- a/src/Jobs/DeleteDatabase.php +++ b/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 */ - protected $tenant; - - public function __construct(TenantWithDatabase $tenant) - { - $this->tenant = $tenant; + public function __construct( + protected TenantWithDatabase&Model $tenant, + ) { } - public function handle() + public function handle(): void { event(new DeletingDatabase($this->tenant)); diff --git a/src/Jobs/DeleteDomains.php b/src/Jobs/DeleteDomains.php index 4ea92b7f..15fff779 100644 --- a/src/Jobs/DeleteDomains.php +++ b/src/Jobs/DeleteDomains.php @@ -5,24 +5,24 @@ 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\Contracts\TenantWithDatabase; +use Stancl\Tenancy\Database\Contracts\TenantWithDatabase; class DeleteDomains { use Dispatchable, InteractsWithQueue, Queueable, SerializesModels; - /** @var TenantWithDatabase */ - protected $tenant; + protected TenantWithDatabase&Model $tenant; - public function __construct(TenantWithDatabase $tenant) + public function __construct(TenantWithDatabase&Model $tenant) { $this->tenant = $tenant; } - public function handle() + public function handle(): void { $this->tenant->domains->each->delete(); } diff --git a/src/Jobs/MigrateDatabase.php b/src/Jobs/MigrateDatabase.php index ad590062..4624f212 100644 --- a/src/Jobs/MigrateDatabase.php +++ b/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 */ - protected $tenant; - - public function __construct(TenantWithDatabase $tenant) - { - $this->tenant = $tenant; + public function __construct( + protected TenantWithDatabase&Model $tenant, + ) { } - /** - * Execute the job. - * - * @return void - */ - public function handle() + public function handle(): void { Artisan::call('tenants:migrate', [ '--tenants' => [$this->tenant->getTenantKey()], diff --git a/src/Jobs/RemoveStorageSymlinks.php b/src/Jobs/RemoveStorageSymlinks.php new file mode 100644 index 00000000..3022da79 --- /dev/null +++ b/src/Jobs/RemoveStorageSymlinks.php @@ -0,0 +1,40 @@ +tenant = $tenant; + } + + /** + * Execute the job. + * + * @return void + */ + public function handle() + { + RemoveStorageSymlinksAction::handle($this->tenant); + } +} diff --git a/src/Jobs/SeedDatabase.php b/src/Jobs/SeedDatabase.php index 9c1a95f6..e1bae0c7 100644 --- a/src/Jobs/SeedDatabase.php +++ b/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 */ - protected $tenant; - - public function __construct(TenantWithDatabase $tenant) - { - $this->tenant = $tenant; + public function __construct( + protected TenantWithDatabase&Model $tenant, + ) { } - /** - * Execute the job. - * - * @return void - */ - public function handle() + public function handle(): void { Artisan::call('tenants:seed', [ '--tenants' => [$this->tenant->getTenantKey()], diff --git a/src/Listeners/BootstrapTenancy.php b/src/Listeners/BootstrapTenancy.php index d03da698..205efc5f 100644 --- a/src/Listeners/BootstrapTenancy.php +++ b/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)); diff --git a/src/Listeners/CreateTenantConnection.php b/src/Listeners/CreateTenantConnection.php index 987a8804..01351c08 100644 --- a/src/Listeners/CreateTenantConnection.php +++ b/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); } diff --git a/src/Listeners/DeleteTenantStorage.php b/src/Listeners/DeleteTenantStorage.php new file mode 100644 index 00000000..ce1a4203 --- /dev/null +++ b/src/Listeners/DeleteTenantStorage.php @@ -0,0 +1,16 @@ +tenant->run(fn () => storage_path())); + } +} diff --git a/src/Listeners/QueueableListener.php b/src/Listeners/QueueableListener.php index b3afba0b..e10c1e7a 100644 --- a/src/Listeners/QueueableListener.php +++ b/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; diff --git a/src/Listeners/RevertToCentralContext.php b/src/Listeners/RevertToCentralContext.php index 788e3876..0a680532 100644 --- a/src/Listeners/RevertToCentralContext.php +++ b/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(); } diff --git a/src/Listeners/UpdateSyncedResource.php b/src/Listeners/UpdateSyncedResource.php index 9be290f0..45f73516 100644 --- a/src/Listeners/UpdateSyncedResource.php +++ b/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,7 +46,7 @@ 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()::where($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey()) @@ -85,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, diff --git a/src/Middleware/IdentificationMiddleware.php b/src/Middleware/IdentificationMiddleware.php index 38f4684d..12aa4a16 100644 --- a/src/Middleware/IdentificationMiddleware.php +++ b/src/Middleware/IdentificationMiddleware.php @@ -4,22 +4,22 @@ declare(strict_types=1); namespace Stancl\Tenancy\Middleware; +use Closure; +use Illuminate\Http\Request; use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException; use Stancl\Tenancy\Contracts\TenantResolver; use Stancl\Tenancy\Tenancy; +/** + * @property Tenancy $tenancy + * @property TenantResolver $resolver + */ abstract class IdentificationMiddleware { - /** @var callable */ - public static $onFail; + public static ?Closure $onFail = null; - /** @var Tenancy */ - protected $tenancy; - - /** @var TenantResolver */ - protected $resolver; - - public function initializeTenancy($request, $next, ...$resolverArguments) + /** @return \Illuminate\Http\Response|mixed */ + public function initializeTenancy(Request $request, Closure $next, mixed ...$resolverArguments): mixed { try { $this->tenancy->initialize( diff --git a/src/Middleware/InitializeTenancyByDomain.php b/src/Middleware/InitializeTenancyByDomain.php index 5a07112d..add5597d 100644 --- a/src/Middleware/InitializeTenancyByDomain.php +++ b/src/Middleware/InitializeTenancyByDomain.php @@ -5,32 +5,22 @@ declare(strict_types=1); namespace Stancl\Tenancy\Middleware; use Closure; +use Illuminate\Http\Request; use Stancl\Tenancy\Resolvers\DomainTenantResolver; use Stancl\Tenancy\Tenancy; class InitializeTenancyByDomain extends IdentificationMiddleware { - /** @var callable|null */ - public static $onFail; + public static ?Closure $onFail = null; - /** @var Tenancy */ - protected $tenancy; - - /** @var DomainTenantResolver */ - protected $resolver; - - public function __construct(Tenancy $tenancy, DomainTenantResolver $resolver) - { - $this->tenancy = $tenancy; - $this->resolver = $resolver; + public function __construct( + protected Tenancy $tenancy, + protected DomainTenantResolver $resolver, + ) { } - /** - * Handle an incoming request. - * - * @param \Illuminate\Http\Request $request - */ - public function handle($request, Closure $next) + /** @return \Illuminate\Http\Response|mixed */ + public function handle(Request $request, Closure $next): mixed { return $this->initializeTenancy( $request, diff --git a/src/Middleware/InitializeTenancyByDomainOrSubdomain.php b/src/Middleware/InitializeTenancyByDomainOrSubdomain.php index 9b153db3..1a30001a 100644 --- a/src/Middleware/InitializeTenancyByDomainOrSubdomain.php +++ b/src/Middleware/InitializeTenancyByDomainOrSubdomain.php @@ -5,16 +5,13 @@ declare(strict_types=1); namespace Stancl\Tenancy\Middleware; use Closure; +use Illuminate\Http\Request; use Illuminate\Support\Str; class InitializeTenancyByDomainOrSubdomain { - /** - * Handle an incoming request. - * - * @param \Illuminate\Http\Request $request - */ - public function handle($request, Closure $next) + /** @return \Illuminate\Http\Response|mixed */ + public function handle(Request $request, Closure $next): mixed { if ($this->isSubdomain($request->getHost())) { return app(InitializeTenancyBySubdomain::class)->handle($request, $next); diff --git a/src/Middleware/InitializeTenancyByPath.php b/src/Middleware/InitializeTenancyByPath.php index e66400c5..e88a1950 100644 --- a/src/Middleware/InitializeTenancyByPath.php +++ b/src/Middleware/InitializeTenancyByPath.php @@ -7,28 +7,25 @@ namespace Stancl\Tenancy\Middleware; use Closure; use Illuminate\Http\Request; use Illuminate\Routing\Route; +use Illuminate\Support\Facades\Event; +use Illuminate\Support\Facades\URL; +use Stancl\Tenancy\Events\InitializingTenancy; use Stancl\Tenancy\Exceptions\RouteIsMissingTenantParameterException; use Stancl\Tenancy\Resolvers\PathTenantResolver; use Stancl\Tenancy\Tenancy; class InitializeTenancyByPath extends IdentificationMiddleware { - /** @var callable|null */ - public static $onFail; + public static ?Closure $onFail = null; - /** @var Tenancy */ - protected $tenancy; - - /** @var PathTenantResolver */ - protected $resolver; - - public function __construct(Tenancy $tenancy, PathTenantResolver $resolver) - { - $this->tenancy = $tenancy; - $this->resolver = $resolver; + public function __construct( + protected Tenancy $tenancy, + protected PathTenantResolver $resolver, + ) { } - public function handle(Request $request, Closure $next) + /** @return \Illuminate\Http\Response|mixed */ + public function handle(Request $request, Closure $next): mixed { /** @var Route $route */ $route = $request->route(); @@ -37,6 +34,11 @@ class InitializeTenancyByPath extends IdentificationMiddleware // We don't want to initialize tenancy if the tenant is // simply injected into some route controller action. if ($route->parameterNames()[0] === PathTenantResolver::$tenantParameterName) { + // Set tenant as a default parameter for the URLs in the current request + Event::listen(InitializingTenancy::class, function (InitializingTenancy $event) { + URL::defaults([PathTenantResolver::$tenantParameterName => $event->tenancy->tenant->getTenantKey()]); + }); + return $this->initializeTenancy( $request, $next, diff --git a/src/Middleware/InitializeTenancyByRequestData.php b/src/Middleware/InitializeTenancyByRequestData.php index 4e1d33ff..ba587d9a 100644 --- a/src/Middleware/InitializeTenancyByRequestData.php +++ b/src/Middleware/InitializeTenancyByRequestData.php @@ -11,33 +11,18 @@ use Stancl\Tenancy\Tenancy; class InitializeTenancyByRequestData extends IdentificationMiddleware { - /** @var string|null */ - public static $header = 'X-Tenant'; + public static string $header = 'X-Tenant'; + public static string $queryParameter = 'tenant'; + public static ?Closure $onFail = null; - /** @var string|null */ - public static $queryParameter = 'tenant'; - - /** @var callable|null */ - public static $onFail; - - /** @var Tenancy */ - protected $tenancy; - - /** @var TenantResolver */ - protected $resolver; - - public function __construct(Tenancy $tenancy, RequestDataTenantResolver $resolver) - { - $this->tenancy = $tenancy; - $this->resolver = $resolver; + public function __construct( + protected Tenancy $tenancy, + protected RequestDataTenantResolver $resolver, + ) { } - /** - * Handle an incoming request. - * - * @param \Illuminate\Http\Request $request - */ - public function handle($request, Closure $next) + /** @return \Illuminate\Http\Response|mixed */ + public function handle(Request $request, Closure $next): mixed { if ($request->method() !== 'OPTIONS') { return $this->initializeTenancy($request, $next, $this->getPayload($request)); diff --git a/src/Middleware/InitializeTenancyBySubdomain.php b/src/Middleware/InitializeTenancyBySubdomain.php index 76389df7..1bf083f3 100644 --- a/src/Middleware/InitializeTenancyBySubdomain.php +++ b/src/Middleware/InitializeTenancyBySubdomain.php @@ -6,6 +6,7 @@ namespace Stancl\Tenancy\Middleware; use Closure; use Exception; +use Illuminate\Http\Request; use Illuminate\Http\Response; use Illuminate\Support\Str; use Stancl\Tenancy\Exceptions\NotASubdomainException; @@ -21,15 +22,10 @@ class InitializeTenancyBySubdomain extends InitializeTenancyByDomain */ public static $subdomainIndex = 0; - /** @var callable|null */ - public static $onFail; + public static ?Closure $onFail = null; - /** - * Handle an incoming request. - * - * @param \Illuminate\Http\Request $request - */ - public function handle($request, Closure $next) + /** @return Response|mixed */ + public function handle(Request $request, Closure $next): mixed { $subdomain = $this->makeSubdomain($request->getHost()); diff --git a/src/Middleware/PreventAccessFromCentralDomains.php b/src/Middleware/PreventAccessFromCentralDomains.php index 14b2306d..40718730 100644 --- a/src/Middleware/PreventAccessFromCentralDomains.php +++ b/src/Middleware/PreventAccessFromCentralDomains.php @@ -11,12 +11,11 @@ class PreventAccessFromCentralDomains { /** * Set this property if you want to customize the on-fail behavior. - * - * @var callable|null */ - public static $abortRequest; + public static ?Closure $abortRequest; - public function handle(Request $request, Closure $next) + /** @return \Illuminate\Http\Response|mixed */ + public function handle(Request $request, Closure $next): mixed { if (in_array($request->getHost(), config('tenancy.central_domains'))) { $abortRequest = static::$abortRequest ?? function () { diff --git a/src/Middleware/ScopeSessions.php b/src/Middleware/ScopeSessions.php index 8abfcfe8..dc302ee5 100644 --- a/src/Middleware/ScopeSessions.php +++ b/src/Middleware/ScopeSessions.php @@ -10,9 +10,10 @@ use Stancl\Tenancy\Exceptions\TenancyNotInitializedException; class ScopeSessions { - public static $tenantIdKey = '_tenant_id'; + public static string $tenantIdKey = '_tenant_id'; - public function handle(Request $request, Closure $next) + /** @return \Illuminate\Http\Response|mixed */ + public function handle(Request $request, Closure $next): mixed { if (! tenancy()->initialized) { throw new TenancyNotInitializedException('Tenancy needs to be initialized before the session scoping middleware is executed'); diff --git a/src/Resolvers/Contracts/CachedTenantResolver.php b/src/Resolvers/Contracts/CachedTenantResolver.php index e84f1fb1..d4d5ba6e 100644 --- a/src/Resolvers/Contracts/CachedTenantResolver.php +++ b/src/Resolvers/Contracts/CachedTenantResolver.php @@ -11,14 +11,11 @@ use Stancl\Tenancy\Contracts\TenantResolver; abstract class CachedTenantResolver implements TenantResolver { - /** @var bool */ - public static $shouldCache = false; + public static bool $shouldCache = false; // todo docblocks for these - /** @var int */ - public static $cacheTTL = 3600; // seconds + public static int $cacheTTL = 3600; // seconds - /** @var string|null */ - public static $cacheStore = null; // default + public static string|null $cacheStore = null; // default /** @var Repository */ protected $cache; @@ -28,7 +25,7 @@ abstract class CachedTenantResolver implements TenantResolver $this->cache = $cache->store(static::$cacheStore); } - public function resolve(...$args): Tenant + public function resolve(mixed ...$args): Tenant { if (! static::$shouldCache) { return $this->resolveWithoutCache(...$args); @@ -61,14 +58,14 @@ abstract class CachedTenantResolver implements TenantResolver } } - public function getCacheKey(...$args): string + public function getCacheKey(mixed ...$args): string { return '_tenancy_resolver:' . static::class . ':' . json_encode($args); } - abstract public function resolveWithoutCache(...$args): Tenant; + abstract public function resolveWithoutCache(mixed ...$args): Tenant; - public function resolved(Tenant $tenant, ...$args): void + public function resolved(Tenant $tenant, mixed ...$args): void { } diff --git a/src/Resolvers/DomainTenantResolver.php b/src/Resolvers/DomainTenantResolver.php index 13eeb448..d2970bb5 100644 --- a/src/Resolvers/DomainTenantResolver.php +++ b/src/Resolvers/DomainTenantResolver.php @@ -11,31 +11,21 @@ use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedOnDomainException; class DomainTenantResolver extends Contracts\CachedTenantResolver { - /** - * The model representing the domain that the tenant was identified on. - * - * @var Domain - */ - public static $currentDomain; + /** The model representing the domain that the tenant was identified on. */ + public static Domain $currentDomain; // todo |null? - /** @var bool */ - public static $shouldCache = false; + public static bool $shouldCache = false; - /** @var int */ - public static $cacheTTL = 3600; // seconds + public static int $cacheTTL = 3600; // seconds - /** @var string|null */ - public static $cacheStore = null; // default + public static string|null $cacheStore = null; // default - public function resolveWithoutCache(...$args): Tenant + public function resolveWithoutCache(mixed ...$args): Tenant { $domain = $args[0]; - /** @var Tenant|null $tenant */ $tenant = config('tenancy.tenant_model')::query() - ->whereHas('domains', function (Builder $query) use ($domain) { - $query->where('domain', $domain); - }) + ->whereHas('domains', fn (Builder $query) => $query->where('domain', $domain)) ->with('domains') ->first(); @@ -48,7 +38,7 @@ class DomainTenantResolver extends Contracts\CachedTenantResolver throw new TenantCouldNotBeIdentifiedOnDomainException($args[0]); } - public function resolved(Tenant $tenant, ...$args): void + public function resolved(Tenant $tenant, mixed ...$args): void { $this->setCurrentDomain($tenant, $args[0]); } diff --git a/src/Resolvers/PathTenantResolver.php b/src/Resolvers/PathTenantResolver.php index 0b79626f..c98ac37e 100644 --- a/src/Resolvers/PathTenantResolver.php +++ b/src/Resolvers/PathTenantResolver.php @@ -10,23 +10,20 @@ use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByPathException; class PathTenantResolver extends Contracts\CachedTenantResolver { - public static $tenantParameterName = 'tenant'; + public static string $tenantParameterName = 'tenant'; - /** @var bool */ - public static $shouldCache = false; + public static bool $shouldCache = false; - /** @var int */ - public static $cacheTTL = 3600; // seconds + public static int $cacheTTL = 3600; // seconds - /** @var string|null */ - public static $cacheStore = null; // default + public static string|null $cacheStore = null; // default - public function resolveWithoutCache(...$args): Tenant + public function resolveWithoutCache(mixed ...$args): Tenant { /** @var Route $route */ $route = $args[0]; - if ($id = $route->parameter(static::$tenantParameterName)) { + if ($id = (string) $route->parameter(static::$tenantParameterName)) { $route->forgetParameter(static::$tenantParameterName); if ($tenant = tenancy()->find($id)) { @@ -40,7 +37,7 @@ class PathTenantResolver extends Contracts\CachedTenantResolver public function getArgsForTenant(Tenant $tenant): array { return [ - [$tenant->id], + [$tenant->getTenantKey()], ]; } } diff --git a/src/Resolvers/RequestDataTenantResolver.php b/src/Resolvers/RequestDataTenantResolver.php index d9f2ebac..8a5bbc53 100644 --- a/src/Resolvers/RequestDataTenantResolver.php +++ b/src/Resolvers/RequestDataTenantResolver.php @@ -9,18 +9,15 @@ use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByRequestDataException; class RequestDataTenantResolver extends Contracts\CachedTenantResolver { - /** @var bool */ - public static $shouldCache = false; + public static bool $shouldCache = false; - /** @var int */ - public static $cacheTTL = 3600; // seconds + public static int $cacheTTL = 3600; // seconds - /** @var string|null */ - public static $cacheStore = null; // default + public static string|null $cacheStore = null; // default - public function resolveWithoutCache(...$args): Tenant + public function resolveWithoutCache(mixed ...$args): Tenant { - $payload = $args[0]; + $payload = (string) $args[0]; if ($payload && $tenant = tenancy()->find($payload)) { return $tenant; @@ -32,7 +29,7 @@ class RequestDataTenantResolver extends Contracts\CachedTenantResolver public function getArgsForTenant(Tenant $tenant): array { return [ - [$tenant->id], + [$tenant->getTenantKey()], ]; } } diff --git a/src/Tenancy.php b/src/Tenancy.php index 439c34cb..0a8d4542 100644 --- a/src/Tenancy.php +++ b/src/Tenancy.php @@ -4,42 +4,45 @@ declare(strict_types=1); namespace Stancl\Tenancy; +use Closure; use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Traits\Macroable; use Stancl\Tenancy\Concerns\Debuggable; use Stancl\Tenancy\Contracts\TenancyBootstrapper; use Stancl\Tenancy\Contracts\Tenant; -use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedById; +use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedByIdException; class Tenancy { use Macroable, Debuggable; - /** @var Tenant|Model|null */ - public $tenant; - - /** @var callable|null */ - public $getBootstrappersUsing = null; - - /** @var bool */ - public $initialized = false; - /** - * Initializes the tenant. - * @param Tenant|int|string $tenant + * The current tenant. + * + * @var (Tenant&Model)|null */ - public function initialize($tenant): void + public ?Tenant $tenant = null; + + // todo docblock + public ?Closure $getBootstrappersUsing = null; + + /** Is tenancy fully initialized? */ + public bool $initialized = false; // todo document the difference between $tenant being set and $initialized being true (e.g. end of initialize() method) + + /** Initialize tenancy for the passed tenant. */ + public function initialize(Tenant|int|string $tenant): void { if (! is_object($tenant)) { $tenantId = $tenant; $tenant = $this->find($tenantId); if (! $tenant) { - throw new TenantCouldNotBeIdentifiedById($tenantId); + throw new TenantCouldNotBeIdentifiedByIdException($tenantId); } } + // todo0 for phpstan this should be $this->tenant?, but first I want to clean up the $initialized logic and explore removing the property if ($this->initialized && $this->tenant->getTenantKey() === $tenant->getTenantKey()) { return; } @@ -60,17 +63,19 @@ class Tenancy public function end(): void { - event(new Events\EndingTenancy($this)); - if (! $this->initialized) { return; } + event(new Events\EndingTenancy($this)); + + // todo find a way to refactor these two methods + event(new Events\TenancyEnded($this)); - $this->initialized = false; - $this->tenant = null; + + $this->initialized = false; } /** @return TenancyBootstrapper[] */ @@ -85,29 +90,28 @@ class Tenancy return array_map('app', $resolve($this->tenant)); } - public function query(): Builder + public static function query(): Builder { - return $this->model()->query(); + return static::model()->query(); } - /** @return Tenant|Model */ - public function model() + public static function model(): Tenant&Model { $class = config('tenancy.tenant_model'); return new $class; } - public function find($id): ?Tenant + public static function find(int|string $id): Tenant|null { - return $this->model()->where($this->model()->getTenantKeyName(), $id)->first(); + return static::model()->where(static::model()->getTenantKeyName(), $id)->first(); } /** * Run a callback in the central context. * Atomic, safely reverts to previous context. */ - public function central(callable $callback) + public function central(Closure $callback) { $previousTenant = $this->tenant; @@ -129,9 +133,8 @@ class Tenancy * More performant than running $tenant->run() one by one. * * @param Tenant[]|\Traversable|string[]|null $tenants - * @return void */ - public function runForMultiple($tenants, callable $callback) + public function runForMultiple($tenants, Closure $callback): void { // Convert null to all tenants $tenants = is_null($tenants) ? $this->model()->cursor() : $tenants; @@ -143,7 +146,7 @@ class Tenancy $tenants = is_string($tenants) ? [$tenants] : $tenants; // Use all tenants if $tenants is falsey - $tenants = $tenants ?: $this->model()->cursor(); + $tenants = $tenants ?: $this->model()->cursor(); // todo0 phpstan thinks this isn't needed, but tests fail without it $originalTenant = $this->tenant; diff --git a/src/TenancyServiceProvider.php b/src/TenancyServiceProvider.php index 0d065dbc..d9556283 100644 --- a/src/TenancyServiceProvider.php +++ b/src/TenancyServiceProvider.php @@ -16,9 +16,7 @@ use Stancl\Tenancy\Resolvers\DomainTenantResolver; class TenancyServiceProvider extends ServiceProvider { - /** - * Register services. - */ + /* Register services. */ public function register(): void { $this->mergeConfigFrom(__DIR__ . '/../assets/config.php', 'tenancy'); @@ -75,13 +73,12 @@ class TenancyServiceProvider extends ServiceProvider }); } - /** - * Bootstrap services. - */ + /* Bootstrap services. */ public function boot(): void { $this->commands([ Commands\Run::class, + Commands\Link::class, Commands\Seed::class, Commands\Install::class, Commands\Migrate::class, diff --git a/src/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php b/src/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php deleted file mode 100644 index 0bc34623..00000000 --- a/src/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php +++ /dev/null @@ -1,57 +0,0 @@ -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 - { - $database = $tenant->database()->getName(); - $charset = $this->database()->getConfig('charset'); - $collation = $this->database()->getConfig('collation'); - - 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'"); - } - - public function makeConnectionConfig(array $baseConfig, string $databaseName): array - { - $baseConfig['database'] = $databaseName; - - return $baseConfig; - } -} diff --git a/src/TenantDatabaseManagers/MySQLDatabaseManager.php b/src/TenantDatabaseManagers/MySQLDatabaseManager.php deleted file mode 100644 index 9d860fd3..00000000 --- a/src/TenantDatabaseManagers/MySQLDatabaseManager.php +++ /dev/null @@ -1,57 +0,0 @@ -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 - { - $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'"); - } - - public function makeConnectionConfig(array $baseConfig, string $databaseName): array - { - $baseConfig['database'] = $databaseName; - - return $baseConfig; - } -} diff --git a/src/TenantDatabaseManagers/PostgreSQLDatabaseManager.php b/src/TenantDatabaseManagers/PostgreSQLDatabaseManager.php deleted file mode 100644 index 680fcdc7..00000000 --- a/src/TenantDatabaseManagers/PostgreSQLDatabaseManager.php +++ /dev/null @@ -1,53 +0,0 @@ -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 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'"); - } - - public function makeConnectionConfig(array $baseConfig, string $databaseName): array - { - $baseConfig['database'] = $databaseName; - - return $baseConfig; - } -} diff --git a/src/TenantDatabaseManagers/SQLiteDatabaseManager.php b/src/TenantDatabaseManagers/SQLiteDatabaseManager.php deleted file mode 100644 index 1b73f250..00000000 --- a/src/TenantDatabaseManagers/SQLiteDatabaseManager.php +++ /dev/null @@ -1,46 +0,0 @@ -database()->getName()), ''); - } catch (\Throwable $th) { - return false; - } - } - - public function deleteDatabase(TenantWithDatabase $tenant): bool - { - try { - return unlink(database_path($tenant->database()->getName())); - } catch (\Throwable $th) { - return false; - } - } - - public function databaseExists(string $name): bool - { - return file_exists(database_path($name)); - } - - public function makeConnectionConfig(array $baseConfig, string $databaseName): array - { - $baseConfig['database'] = database_path($databaseName); - - return $baseConfig; - } - - public function setConnection(string $connection): void - { - // - } -} diff --git a/src/UUIDGenerator.php b/src/UUIDGenerator.php index 1b15dfa5..a0974862 100644 --- a/src/UUIDGenerator.php +++ b/src/UUIDGenerator.php @@ -4,12 +4,15 @@ declare(strict_types=1); namespace Stancl\Tenancy; +use Illuminate\Database\Eloquent\Model; use Ramsey\Uuid\Uuid; use Stancl\Tenancy\Contracts\UniqueIdentifierGenerator; +// todo move to separate namespace + class UUIDGenerator implements UniqueIdentifierGenerator { - public static function generate($resource): string + public static function generate(Model $model): string { return Uuid::uuid4()->toString(); } diff --git a/src/helpers.php b/src/helpers.php index 9c3b75cd..c50da940 100644 --- a/src/helpers.php +++ b/src/helpers.php @@ -15,15 +15,14 @@ if (! function_exists('tenancy')) { if (! function_exists('tenant')) { /** - * Get a key from the current tenant's storage. + * Get the current tenant or a key from the current tenant's properties. * - * @param string|null $key * @return Tenant|null|mixed */ - function tenant($key = null) + function tenant(string $key = null): mixed { if (! app()->bound(Tenant::class)) { - return; + return null; } if (is_null($key)) { @@ -35,35 +34,66 @@ if (! function_exists('tenant')) { } if (! function_exists('tenant_asset')) { - /** @return string */ - function tenant_asset($asset) + // todo docblock + // todo add an option to generate paths respecting the ASSET_URL + function tenant_asset(string|null $asset): string { return route('stancl.tenancy.asset', ['path' => $asset]); } } if (! function_exists('global_asset')) { - function global_asset($asset) + function global_asset(string $asset): string { return app('globalUrl')->asset($asset); } } if (! function_exists('global_cache')) { - function global_cache() + /** + * Get / set the specified cache value in the global cache store. + * + * If an array is passed, we'll assume you want to put to the cache. + * + * @param dynamic key|key,default|data,expiration|null + * @return mixed|\Illuminate\Cache\CacheManager + * + * @throws \InvalidArgumentException + */ + function global_cache(): mixed { - return app('globalCache'); + $arguments = func_get_args(); + + if (empty($arguments)) { + return app('globalCache'); + } + + if (is_string($arguments[0])) { + return app('globalCache')->get(...$arguments); + } + + if (! is_array($arguments[0])) { + throw new InvalidArgumentException( + 'When setting a value in the cache, you must pass an array of key / value pairs.' + ); + } + + return app('globalCache')->put(key($arguments[0]), reset($arguments[0]), $arguments[1] ?? null); } } if (! function_exists('tenant_route')) { - function tenant_route(string $domain, $route, $parameters = [], $absolute = true) + function tenant_route(string $domain, string $route, array $parameters = [], bool $absolute = true): string { - // replace first occurance of hostname fragment with $domain $url = route($route, $parameters, $absolute); - $hostname = parse_url($url, PHP_URL_HOST); - $position = strpos($url, $hostname); - return substr_replace($url, $domain, $position, strlen($hostname)); + /** + * The original hostname in the generated route. + * + * @var string $hostname + */ + $hostname = parse_url($url, PHP_URL_HOST); + + return (string) str($url)->replace($hostname, $domain); } } diff --git a/tests/ActionTest.php b/tests/ActionTest.php new file mode 100644 index 00000000..cc0950ea --- /dev/null +++ b/tests/ActionTest.php @@ -0,0 +1,69 @@ + [ + FilesystemTenancyBootstrapper::class, + ], + 'tenancy.filesystem.suffix_base' => 'tenant-', + 'tenancy.filesystem.root_override.public' => '%storage_path%/app/public/', + 'tenancy.filesystem.url_override.public' => 'public-%tenant_id%' + ]); + + /** @var Tenant $tenant */ + $tenant = Tenant::create(); + $tenantKey = $tenant->getTenantKey(); + + tenancy()->initialize($tenant); + + $this->assertDirectoryDoesNotExist($publicPath = public_path("public-$tenantKey")); + + CreateStorageSymlinksAction::handle($tenant); + + $this->assertDirectoryExists($publicPath); + $this->assertEquals(storage_path("app/public/"), readlink($publicPath)); +}); + +test('remove storage symlinks action works', function() { + config([ + 'tenancy.bootstrappers' => [ + FilesystemTenancyBootstrapper::class, + ], + 'tenancy.filesystem.suffix_base' => 'tenant-', + 'tenancy.filesystem.root_override.public' => '%storage_path%/app/public/', + 'tenancy.filesystem.url_override.public' => 'public-%tenant_id%' + ]); + + /** @var Tenant $tenant */ + $tenant = Tenant::create(); + $tenantKey = $tenant->getTenantKey(); + + tenancy()->initialize($tenant); + + CreateStorageSymlinksAction::handle($tenant); + + $this->assertDirectoryExists($publicPath = public_path("public-$tenantKey")); + + RemoveStorageSymlinksAction::handle($tenant); + + $this->assertDirectoryDoesNotExist($publicPath); +}); diff --git a/tests/BatchTest.php b/tests/BatchTest.php new file mode 100644 index 00000000..a168deb2 --- /dev/null +++ b/tests/BatchTest.php @@ -0,0 +1,44 @@ + [ + DatabaseTenancyBootstrapper::class, + BatchTenancyBootstrapper::class, + ], + ]); + + Event::listen(TenancyInitialized::class, BootstrapTenancy::class); + Event::listen(TenancyEnded::class, RevertToCentralContext::class); +}); + +test('batch repository is set to tenant connection and reverted', function () { + $tenant = Tenant::create(); + $tenant2 = Tenant::create(); + + expect(getBatchRepositoryConnectionName())->toBe('central'); + + tenancy()->initialize($tenant); + expect(getBatchRepositoryConnectionName())->toBe('tenant'); + + tenancy()->initialize($tenant2); + expect(getBatchRepositoryConnectionName())->toBe('tenant'); + + tenancy()->end(); + expect(getBatchRepositoryConnectionName())->toBe('central'); +})->skip(fn() => version_compare(app()->version(), '8.0', '<'), 'Job batches are only supported in Laravel 8+'); + +function getBatchRepositoryConnectionName() +{ + return app(BatchRepository::class)->getConnection()->getName(); +} diff --git a/tests/BootstrapperTest.php b/tests/BootstrapperTest.php index 96afbc83..a610fbd2 100644 --- a/tests/BootstrapperTest.php +++ b/tests/BootstrapperTest.php @@ -2,10 +2,10 @@ declare(strict_types=1); -use Illuminate\Filesystem\FilesystemAdapter; use Illuminate\Support\Str; use Illuminate\Support\Facades\DB; use Stancl\JobPipeline\JobPipeline; +use Illuminate\Support\Facades\File; use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Support\Facades\Cache; use Illuminate\Support\Facades\Event; @@ -14,8 +14,14 @@ use Illuminate\Support\Facades\Storage; use Stancl\Tenancy\Events\TenancyEnded; use Stancl\Tenancy\Jobs\CreateDatabase; use Stancl\Tenancy\Events\TenantCreated; +use Stancl\Tenancy\Events\TenantDeleted; +use Stancl\Tenancy\Events\DeletingTenant; +use Illuminate\Filesystem\FilesystemAdapter; use Stancl\Tenancy\Events\TenancyInitialized; +use Stancl\Tenancy\Jobs\CreateStorageSymlinks; +use Stancl\Tenancy\Jobs\RemoveStorageSymlinks; use Stancl\Tenancy\Listeners\BootstrapTenancy; +use Stancl\Tenancy\Listeners\DeleteTenantStorage; use Stancl\Tenancy\Listeners\RevertToCentralContext; use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper; use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper; @@ -184,6 +190,142 @@ test('filesystem data is separated', function () { expect($new_storage_path)->toEqual($expected_storage_path); }); +test('tenant storage can get deleted after the tenant when DeletingTenant listens to DeleteTenantStorage', function () { + config([ + 'tenancy.bootstrappers' => [ + FilesystemTenancyBootstrapper::class, + ], + 'tenancy.filesystem.root_override.public' => '%storage_path%/app/public/', + 'tenancy.filesystem.url_override.public' => 'public-%tenant_id%' + ]); + + $tenant1 = Tenant::create(); + $tenant2 = Tenant::create(); + $tenant1StorageUrl = 'http://localhost/public-' . $tenant1->getKey().'/'; + $tenant2StorageUrl = 'http://localhost/public-' . $tenant2->getKey().'/'; + + tenancy()->initialize($tenant1); + + $this->assertEquals( + $tenant1StorageUrl, + Storage::disk('public')->url('') + ); + + Storage::disk('public')->put($tenant1FileName = 'tenant1.txt', 'text'); + + $this->assertEquals( + $tenant1StorageUrl . $tenant1FileName, + Storage::disk('public')->url($tenant1FileName) + ); + + tenancy()->initialize($tenant2); + + $this->assertEquals( + $tenant2StorageUrl, + Storage::disk('public')->url('') + ); + + Storage::disk('public')->put($tenant2FileName = 'tenant2.txt', 'text'); + + $this->assertEquals( + $tenant2StorageUrl . $tenant2FileName, + Storage::disk('public')->url($tenant2FileName) + ); +}); + +test('files can get fetched using the storage url', function() { + config([ + 'tenancy.bootstrappers' => [ + FilesystemTenancyBootstrapper::class, + ], + 'tenancy.filesystem.root_override.public' => '%storage_path%/app/public/', + 'tenancy.filesystem.url_override.public' => 'public-%tenant_id%' + ]); + + $tenant1 = Tenant::create(); + $tenant2 = Tenant::create(); + + pest()->artisan('tenants:link'); + + // First tenant + tenancy()->initialize($tenant1); + Storage::disk('public')->put($tenantFileName = 'tenant1.txt', $tenantKey = $tenant1->getTenantKey()); + + $url = Storage::disk('public')->url($tenantFileName); + $tenantDiskName = Str::of(config('tenancy.filesystem.url_override.public'))->replace('%tenant_id%', $tenantKey); + $hostname = Str::of($url)->before($tenantDiskName); + $parsedUrl = Str::of($url)->after($hostname); + + expect(file_get_contents(public_path($parsedUrl)))->toBe($tenantKey); + + // Second tenant + tenancy()->initialize($tenant2); + Storage::disk('public')->put($tenantFileName = 'tenant2.txt', $tenantKey = $tenant2->getTenantKey()); + + $url = Storage::disk('public')->url($tenantFileName); + $tenantDiskName = Str::of(config('tenancy.filesystem.url_override.public'))->replace('%tenant_id%', $tenantKey); + $hostname = Str::of($url)->before($tenantDiskName); + $parsedUrl = Str::of($url)->after($hostname); + + expect(file_get_contents(public_path($parsedUrl)))->toBe($tenantKey); +}); + +test('create and delete storage symlinks jobs work', function() { + Event::listen( + TenantCreated::class, + JobPipeline::make([CreateStorageSymlinks::class])->send(function (TenantCreated $event) { + return $event->tenant; + })->toListener() + ); + + Event::listen( + TenantDeleted::class, + JobPipeline::make([RemoveStorageSymlinks::class])->send(function (TenantDeleted $event) { + return $event->tenant; + })->toListener() + ); + + config([ + 'tenancy.bootstrappers' => [ + FilesystemTenancyBootstrapper::class, + ], + 'tenancy.filesystem.suffix_base' => 'tenant-', + 'tenancy.filesystem.root_override.public' => '%storage_path%/app/public/', + 'tenancy.filesystem.url_override.public' => 'public-%tenant_id%' + ]); + + /** @var Tenant $tenant */ + $tenant = Tenant::create(); + + tenancy()->initialize($tenant); + + $tenantKey = $tenant->getTenantKey(); + + $this->assertDirectoryExists(storage_path("app/public")); + $this->assertEquals(storage_path("app/public/"), readlink(public_path("public-$tenantKey"))); + + $tenant->delete(); + + $this->assertDirectoryDoesNotExist(public_path("public-$tenantKey")); +}); + +test('local storage public urls are generated correctly', function() { + Event::listen(DeletingTenant::class, DeleteTenantStorage::class); + + tenancy()->initialize(Tenant::create()); + $tenantStoragePath = storage_path(); + + Storage::fake('test'); + + expect(File::isDirectory($tenantStoragePath))->toBeTrue(); + + Storage::put('test.txt', 'testing file'); + + tenant()->delete(); + + expect(File::isDirectory($tenantStoragePath))->toBeFalse(); +}); + function getDiskPrefix(string $disk): string { /** @var FilesystemAdapter $disk */ @@ -194,14 +336,14 @@ function getDiskPrefix(string $disk): string return $adapter->getPathPrefix(); } - $prefixer = (new ReflectionObject($adapter))->getProperty('prefixer'); - $prefixer->setAccessible(true); + $prefixer = (new ReflectionObject($adapter))->getProperty('prefixer'); + $prefixer->setAccessible(true); - // reflection -> instance - $prefixer = $prefixer->getValue($adapter); + // reflection -> instance + $prefixer = $prefixer->getValue($adapter); - $prefix = (new ReflectionProperty($prefixer, 'prefix')); - $prefix->setAccessible(true); + $prefix = (new ReflectionProperty($prefixer, 'prefix')); + $prefix->setAccessible(true); - return $prefix->getValue($prefixer); + return $prefix->getValue($prefixer); } diff --git a/tests/CommandsTest.php b/tests/CommandsTest.php index 5172d752..f7785bf2 100644 --- a/tests/CommandsTest.php +++ b/tests/CommandsTest.php @@ -2,6 +2,7 @@ declare(strict_types=1); +use Illuminate\Database\DatabaseManager; use Illuminate\Support\Facades\Artisan; use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\Event; @@ -16,6 +17,8 @@ use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Listeners\RevertToCentralContext; use Stancl\Tenancy\Tests\Etc\ExampleSeeder; use Stancl\Tenancy\Tests\Etc\Tenant; +use Stancl\Tenancy\Tests\Etc\TestSeeder; +use Stancl\Tenancy\Tests\Etc\User; beforeEach(function () { Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { @@ -26,6 +29,15 @@ beforeEach(function () { DatabaseTenancyBootstrapper::class, ]]); + config([ + 'tenancy.bootstrappers' => [ + DatabaseTenancyBootstrapper::class, + ], + 'tenancy.filesystem.suffix_base' => 'tenant-', + 'tenancy.filesystem.root_override.public' => '%storage_path%/app/public/', + 'tenancy.filesystem.url_override.public' => 'public-%tenant_id%' + ]); + Event::listen(TenancyInitialized::class, BootstrapTenancy::class); Event::listen(TenancyEnded::class, RevertToCentralContext::class); }); @@ -40,9 +52,9 @@ afterEach(function () { test('migrate command doesnt change the db connection', function () { expect(Schema::hasTable('users'))->toBeFalse(); - $old_connection_name = app(\Illuminate\Database\DatabaseManager::class)->connection()->getName(); + $old_connection_name = app(DatabaseManager::class)->connection()->getName(); Artisan::call('tenants:migrate'); - $new_connection_name = app(\Illuminate\Database\DatabaseManager::class)->connection()->getName(); + $new_connection_name = app(DatabaseManager::class)->connection()->getName(); expect(Schema::hasTable('users'))->toBeFalse(); expect($new_connection_name)->toEqual($old_connection_name); @@ -115,8 +127,22 @@ test('rollback command works', function () { expect(Schema::hasTable('users'))->toBeFalse(); }); -// Incomplete test -test('seed command works'); +test('seed command works', function (){ + $tenant = Tenant::create(); + Artisan::call('tenants:migrate'); + + $tenant->run(function (){ + expect(DB::table('users')->count())->toBe(0); + }); + + Artisan::call('tenants:seed', ['--class' => TestSeeder::class]); + + $tenant->run(function (){ + $user = DB::table('users'); + expect($user->count())->toBe(1) + ->and($user->first()->email)->toBe('seeded@user'); + }); +}); test('database connection is switched to default', function () { databaseConnectionSwitchedToDefault(); @@ -174,11 +200,71 @@ test('run command with array of tenants works', function () { $tenantId2 = Tenant::create()->getTenantKey(); Artisan::call('tenants:migrate-fresh'); - pest()->artisan("tenants:run foo --tenants=$tenantId1 --tenants=$tenantId2 --argument='a=foo' --option='b=bar' --option='c=xyz'") + pest()->artisan("tenants:run --tenants=$tenantId1 --tenants=$tenantId2 'foo foo --b=bar --c=xyz'") ->expectsOutput('Tenant: ' . $tenantId1) ->expectsOutput('Tenant: ' . $tenantId2); }); +test('link command works', function() { + $tenantId1 = Tenant::create()->getTenantKey(); + $tenantId2 = Tenant::create()->getTenantKey(); + pest()->artisan('tenants:link'); + + $this->assertDirectoryExists(storage_path("tenant-$tenantId1/app/public")); + $this->assertEquals(storage_path("tenant-$tenantId1/app/public/"), readlink(public_path("public-$tenantId1"))); + + $this->assertDirectoryExists(storage_path("tenant-$tenantId2/app/public")); + $this->assertEquals(storage_path("tenant-$tenantId2/app/public/"), readlink(public_path("public-$tenantId2"))); + + pest()->artisan('tenants:link', [ + '--remove' => true, + ]); + + $this->assertDirectoryDoesNotExist(public_path("public-$tenantId1")); + $this->assertDirectoryDoesNotExist(public_path("public-$tenantId2")); +}); + +test('link command works with a specified tenant', function() { + $tenantKey = Tenant::create()->getTenantKey(); + + pest()->artisan('tenants:link', [ + '--tenants' => [$tenantKey], + ]); + + $this->assertDirectoryExists(storage_path("tenant-$tenantKey/app/public")); + $this->assertEquals(storage_path("tenant-$tenantKey/app/public/"), readlink(public_path("public-$tenantKey"))); + + pest()->artisan('tenants:link', [ + '--remove' => true, + '--tenants' => [$tenantKey], + ]); + + $this->assertDirectoryDoesNotExist(public_path("public-$tenantKey")); +}); + +test('run command works when sub command asks questions and accepts arguments', function () { + $tenant = Tenant::create(); + $id = $tenant->getTenantKey(); + + Artisan::call('tenants:migrate'); + + pest()->artisan("tenants:run --tenants=$id 'user:addwithname Abrar' ") + ->expectsQuestion('What is your email?', 'email@localhost') + ->expectsOutput("Tenant: $id") + ->expectsOutput("User created: Abrar(email@localhost)"); + + // Assert we are in central context + expect(tenancy()->initialized)->toBeFalse(); + + // Assert user was created in tenant context + tenancy()->initialize($tenant); + $user = User::first(); + + // Assert user is same as provided using the command + expect($user->name)->toBe('Abrar'); + expect($user->email)->toBe('email@localhost'); +}); + // todo@tests function runCommandWorks(): void { @@ -186,7 +272,7 @@ function runCommandWorks(): void Artisan::call('tenants:migrate', ['--tenants' => [$id]]); - pest()->artisan("tenants:run foo --tenants=$id --argument='a=foo' --option='b=bar' --option='c=xyz'") + pest()->artisan("tenants:run --tenants=$id 'foo foo --b=bar --c=xyz' ") ->expectsOutput("User's name is Test command") ->expectsOutput('foo') ->expectsOutput('xyz'); diff --git a/tests/DatabasePreparationTest.php b/tests/DatabasePreparationTest.php index 64fa1e0f..e31fac9b 100644 --- a/tests/DatabasePreparationTest.php +++ b/tests/DatabasePreparationTest.php @@ -9,7 +9,7 @@ use Stancl\Tenancy\Events\TenantCreated; use Stancl\Tenancy\Jobs\CreateDatabase; use Stancl\Tenancy\Jobs\MigrateDatabase; use Stancl\Tenancy\Jobs\SeedDatabase; -use Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\MySQLDatabaseManager; use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Foundation\Auth\User as Authenticable; use Stancl\Tenancy\Tests\Etc\TestSeeder; diff --git a/tests/DatabaseUsersTest.php b/tests/DatabaseUsersTest.php index 2635c167..4f6ef723 100644 --- a/tests/DatabaseUsersTest.php +++ b/tests/DatabaseUsersTest.php @@ -11,11 +11,11 @@ use Stancl\Tenancy\Contracts\ManagesDatabaseUsers; use Stancl\Tenancy\Events\DatabaseCreated; use Stancl\Tenancy\Events\TenancyInitialized; use Stancl\Tenancy\Events\TenantCreated; -use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException; +use Stancl\Tenancy\Database\Exceptions\TenantDatabaseUserAlreadyExistsException; use Stancl\Tenancy\Jobs\CreateDatabase; use Stancl\Tenancy\Listeners\BootstrapTenancy; -use Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager; -use Stancl\Tenancy\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\MySQLDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager; use Stancl\Tenancy\Tests\Etc\Tenant; beforeEach(function () { diff --git a/tests/DomainTest.php b/tests/DomainTest.php index 594270e1..6995da24 100644 --- a/tests/DomainTest.php +++ b/tests/DomainTest.php @@ -81,7 +81,7 @@ test('tenant can be identified by domain', function () { test('onfail logic can be customized', function () { InitializeTenancyByDomain::$onFail = function () { - return 'foo'; + return response('foo'); }; pest() diff --git a/tests/Etc/AddUserCommand.php b/tests/Etc/Console/AddUserCommand.php similarity index 91% rename from tests/Etc/AddUserCommand.php rename to tests/Etc/Console/AddUserCommand.php index 46e1fcbb..f102bae6 100644 --- a/tests/Etc/AddUserCommand.php +++ b/tests/Etc/Console/AddUserCommand.php @@ -2,12 +2,13 @@ declare(strict_types=1); -namespace Stancl\Tenancy\Tests\Etc; +namespace Stancl\Tenancy\Tests\Etc\Console; use Illuminate\Console\Command; use Illuminate\Support\Str; use Stancl\Tenancy\Concerns\HasATenantsOption; use Stancl\Tenancy\Concerns\TenantAwareCommand; +use Stancl\Tenancy\Tests\Etc\User; class AddUserCommand extends Command { diff --git a/tests/Etc/ConsoleKernel.php b/tests/Etc/Console/ConsoleKernel.php similarity index 72% rename from tests/Etc/ConsoleKernel.php rename to tests/Etc/Console/ConsoleKernel.php index a548f113..c5e5ee85 100644 --- a/tests/Etc/ConsoleKernel.php +++ b/tests/Etc/Console/ConsoleKernel.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Stancl\Tenancy\Tests\Etc; +namespace Stancl\Tenancy\Tests\Etc\Console; use Orchestra\Testbench\Foundation\Console\Kernel; @@ -10,6 +10,7 @@ class ConsoleKernel extends Kernel { protected $commands = [ ExampleCommand::class, + ExampleQuestionCommand::class, AddUserCommand::class, ]; } diff --git a/tests/Etc/ExampleCommand.php b/tests/Etc/Console/ExampleCommand.php similarity index 94% rename from tests/Etc/ExampleCommand.php rename to tests/Etc/Console/ExampleCommand.php index 49e7189b..72263b37 100644 --- a/tests/Etc/ExampleCommand.php +++ b/tests/Etc/Console/ExampleCommand.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Stancl\Tenancy\Tests\Etc; +namespace Stancl\Tenancy\Tests\Etc\Console; use Illuminate\Console\Command; diff --git a/tests/Etc/Console/ExampleQuestionCommand.php b/tests/Etc/Console/ExampleQuestionCommand.php new file mode 100644 index 00000000..9a967054 --- /dev/null +++ b/tests/Etc/Console/ExampleQuestionCommand.php @@ -0,0 +1,46 @@ +ask('What is your email?'); + + User::create([ + 'name' => $this->argument('name'), + 'email' => $email, + 'email_verified_at' => now(), + 'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password + 'remember_token' => Str::random(10), + ]); + + $this->line("User created: ". $this->argument('name') . "($email)"); + + return 0; + } +} diff --git a/tests/Etc/Tenant.php b/tests/Etc/Tenant.php index fc41adde..9b59dedb 100644 --- a/tests/Etc/Tenant.php +++ b/tests/Etc/Tenant.php @@ -4,12 +4,15 @@ declare(strict_types=1); namespace Stancl\Tenancy\Tests\Etc; -use Stancl\Tenancy\Contracts\TenantWithDatabase; +use Stancl\Tenancy\Database\Contracts\TenantWithDatabase; use Stancl\Tenancy\Database\Concerns\HasDatabase; use Stancl\Tenancy\Database\Concerns\HasDomains; use Stancl\Tenancy\Database\Concerns\MaintenanceMode; use Stancl\Tenancy\Database\Models; +/** + * @method static static create(array $attributes = []) + */ class Tenant extends Models\Tenant implements TenantWithDatabase { use HasDatabase, HasDomains, MaintenanceMode; diff --git a/tests/EventListenerTest.php b/tests/EventListenerTest.php index 85203f07..454c86ed 100644 --- a/tests/EventListenerTest.php +++ b/tests/EventListenerTest.php @@ -181,7 +181,7 @@ test('database is not migrated if creation is disabled', function () { class FooListener extends QueueableListener { - public static $shouldQueue = false; + public static bool $shouldQueue = false; public function handle() { diff --git a/tests/Features/TenantConfigTest.php b/tests/Features/TenantConfigTest.php index 35df35ed..5c12c5f0 100644 --- a/tests/Features/TenantConfigTest.php +++ b/tests/Features/TenantConfigTest.php @@ -14,6 +14,28 @@ afterEach(function () { TenantConfig::$storageToConfigMap = []; }); +test('nested tenant values are merged', function () { + expect(config('whitelabel.theme'))->toBeNull(); + config([ + 'tenancy.features' => [TenantConfig::class], + 'tenancy.bootstrappers' => [], + ]); + Event::listen(TenancyInitialized::class, BootstrapTenancy::class); + Event::listen(TenancyEnded::class, RevertToCentralContext::class); + + TenantConfig::$storageToConfigMap = [ + 'whitelabel.config.theme' => 'whitelabel.theme', + ]; + + $tenant = Tenant::create([ + 'whitelabel' => ['config' => ['theme' => 'dark']], + ]); + + tenancy()->initialize($tenant); + expect(config('whitelabel.theme'))->toBe('dark'); + tenancy()->end(); +}); + test('config is merged and removed', function () { expect(config('services.paypal'))->toBe(null); config([ diff --git a/tests/GlobalCacheTest.php b/tests/GlobalCacheTest.php index 8a13395c..ea38341b 100644 --- a/tests/GlobalCacheTest.php +++ b/tests/GlobalCacheTest.php @@ -50,3 +50,17 @@ test('global cache manager stores data in global cache', function () { expect(cache('def'))->toBe('ghi'); }); +test('the global_cache helper supports the same syntax as the cache helper', function () { + $tenant = Tenant::create(); + $tenant->enter(); + + expect(cache('foo'))->toBe(null); // tenant cache is empty + + global_cache(['foo' => 'bar']); + expect(global_cache('foo'))->toBe('bar'); + + global_cache()->set('foo', 'baz'); + expect(global_cache()->get('foo'))->toBe('baz'); + + expect(cache('foo'))->toBe(null); // tenant cache is not affected +}); diff --git a/tests/PathIdentificationTest.php b/tests/PathIdentificationTest.php index bda0cfcb..517fa396 100644 --- a/tests/PathIdentificationTest.php +++ b/tests/PathIdentificationTest.php @@ -18,7 +18,11 @@ beforeEach(function () { ], function () { Route::get('/foo/{a}/{b}', function ($a, $b) { return "$a + $b"; - }); + })->name('foo'); + + Route::get('/baz/{a}/{b}', function ($a, $b) { + return "$a - $b"; + })->name('baz'); }); }); @@ -67,7 +71,7 @@ test('exception is thrown when tenant cannot be identified by path', function () test('onfail logic can be customized', function () { InitializeTenancyByPath::$onFail = function () { - return 'foo'; + return response('foo'); }; pest() @@ -123,3 +127,23 @@ test('tenant parameter name can be customized', function () { ->withoutExceptionHandling() ->get('/acme/foo/abc/xyz'); }); + +test('tenant parameter is set for all routes as the default parameter once the tenancy initialized', function () { + Tenant::create([ + 'id' => 'acme', + ]); + + expect(tenancy()->initialized)->toBeFalse(); + + // make a request that will initialize tenancy + pest()->get(route('foo', ['tenant' => 'acme', 'a' => 1, 'b' => 2])); + + expect(tenancy()->initialized)->toBeTrue(); + expect(tenant('id'))->toBe('acme'); + + // assert that the route WITHOUT the tenant parameter matches the route WITH the tenant parameter + expect(route('baz', ['a' => 1, 'b' => 2]))->toBe(route('baz', ['tenant' => 'acme', 'a' => 1, 'b' => 2])); + + expect(route('baz', ['a' => 1, 'b' => 2]))->toBe('http://localhost/acme/baz/1/2'); // assert the full route string + pest()->get(route('baz', ['a' => 1, 'b' => 2]))->assertOk(); // Assert route don't need tenant parameter +}); diff --git a/tests/RequestDataIdentificationTest.php b/tests/RequestDataIdentificationTest.php index 81bdda53..e5a05f65 100644 --- a/tests/RequestDataIdentificationTest.php +++ b/tests/RequestDataIdentificationTest.php @@ -37,7 +37,6 @@ test('header identification works', function () { }); test('query parameter identification works', function () { - InitializeTenancyByRequestData::$header = null; InitializeTenancyByRequestData::$queryParameter = 'tenant'; $tenant = Tenant::create(); diff --git a/tests/ResourceSyncingTest.php b/tests/ResourceSyncingTest.php index 806e8706..214a9f47 100644 --- a/tests/ResourceSyncingTest.php +++ b/tests/ResourceSyncingTest.php @@ -15,7 +15,7 @@ use Stancl\Tenancy\Contracts\SyncMaster; use Stancl\Tenancy\Database\Concerns\CentralConnection; use Stancl\Tenancy\Database\Concerns\ResourceSyncing; use Stancl\Tenancy\Database\Models\TenantPivot; -use Stancl\Tenancy\DatabaseConfig; +use Stancl\Tenancy\Database\DatabaseConfig; use Stancl\Tenancy\Events\SyncedResourceChangedInForeignDatabase; use Stancl\Tenancy\Events\SyncedResourceSaved; use Stancl\Tenancy\Events\TenancyEnded; @@ -575,7 +575,7 @@ class CentralUser extends Model implements SyncMaster return ResourceUser::class; } - public function getGlobalIdentifierKey() + public function getGlobalIdentifierKey(): string|int { return $this->getAttribute($this->getGlobalIdentifierKeyName()); } @@ -610,7 +610,7 @@ class ResourceUser extends Model implements Syncable public $timestamps = false; - public function getGlobalIdentifierKey() + public function getGlobalIdentifierKey(): string|int { return $this->getAttribute($this->getGlobalIdentifierKeyName()); } diff --git a/tests/SingleDatabaseTenancyTest.php b/tests/SingleDatabaseTenancyTest.php index 34b12383..8914a6d7 100644 --- a/tests/SingleDatabaseTenancyTest.php +++ b/tests/SingleDatabaseTenancyTest.php @@ -61,7 +61,7 @@ test('secondary models are not scoped to the current tenant when accessed direct expect(Comment::count())->toBe(2); }); -test('secondary models a r e scoped to the current tenant when accessed directly and parent relationship traitis used', function () { +test('secondary models ARE scoped to the current tenant when accessed directly and parent relationship trait is used', function () { $acme = Tenant::create([ 'id' => 'acme', ]); @@ -207,13 +207,13 @@ test('the model returned by the tenant helper has unique and exists validation r $uniqueFails = Validator::make($data, [ 'slug' => 'unique:posts', ])->fails(); - $existsFails = Validator::make($data, [ + $existsPass = Validator::make($data, [ 'slug' => 'exists:posts', - ])->fails(); + ])->passes(); // Assert that 'unique' and 'exists' aren't scoped by default - // pest()->assertFalse($uniqueFails); // todo get these two assertions to pass. for some reason, the validator is passing for both 'unique' and 'exists' - // pest()->assertTrue($existsFails); // todo get these two assertions to pass. for some reason, the validator is passing for both 'unique' and 'exists' + expect($uniqueFails)->toBeTrue(); // Expect unique rule failed to pass because slug 'foo' already exists + expect($existsPass)->toBeTrue(); // Expect exists rule pass because slug 'foo' exists $uniqueFails = Validator::make($data, [ 'slug' => tenant()->unique('posts'), diff --git a/tests/SubdomainTest.php b/tests/SubdomainTest.php index 00096d8c..0ff52bc0 100644 --- a/tests/SubdomainTest.php +++ b/tests/SubdomainTest.php @@ -44,7 +44,7 @@ test('tenant can be identified by subdomain', function () { test('onfail logic can be customized', function () { InitializeTenancyBySubdomain::$onFail = function () { - return 'foo'; + return response('foo'); }; pest() diff --git a/tests/TenantAssetTest.php b/tests/TenantAssetTest.php index 2c5000f1..d43b7989 100644 --- a/tests/TenantAssetTest.php +++ b/tests/TenantAssetTest.php @@ -94,6 +94,18 @@ test('asset helper tenancy can be disabled', function () { expect(asset('foo'))->toBe($original); }); +test('test asset controller returns a 404 when no path is provided', function () { + TenantAssetsController::$tenancyMiddleware = InitializeTenancyByRequestData::class; + + $tenant = Tenant::create(); + + tenancy()->initialize($tenant); + + pest()->get(tenant_asset(null), [ + 'X-Tenant' => $tenant->id, + ])->assertNotFound(); +}); + function getEnvironmentSetUp($app) { $app->booted(function () { diff --git a/tests/TenantDatabaseManagerTest.php b/tests/TenantDatabaseManagerTest.php index bc09e888..d6a5b369 100644 --- a/tests/TenantDatabaseManagerTest.php +++ b/tests/TenantDatabaseManagerTest.php @@ -12,16 +12,16 @@ use Stancl\Tenancy\Database\DatabaseManager; use Stancl\Tenancy\Events\TenancyEnded; use Stancl\Tenancy\Events\TenancyInitialized; use Stancl\Tenancy\Events\TenantCreated; -use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException; +use Stancl\Tenancy\Database\Exceptions\TenantDatabaseAlreadyExistsException; use Stancl\Tenancy\Jobs\CreateDatabase; use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Listeners\RevertToCentralContext; -use Stancl\Tenancy\TenantDatabaseManagers\MicrosoftSQLDatabaseManager; -use Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager; -use Stancl\Tenancy\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager; -use Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager; -use Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLSchemaManager; -use Stancl\Tenancy\TenantDatabaseManagers\SQLiteDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\MicrosoftSQLDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\MySQLDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\PostgreSQLDatabaseManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\PostgreSQLSchemaManager; +use Stancl\Tenancy\Database\TenantDatabaseManagers\SQLiteDatabaseManager; use Stancl\Tenancy\Tests\Etc\Tenant; test('databases can be created and deleted', function ($driver, $databaseManager) { @@ -135,7 +135,7 @@ test('db name is prefixed with db path when sqlite is used', function () { test('schema manager uses schema to separate tenant dbs', function () { config([ - 'tenancy.database.managers.pgsql' => \Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLSchemaManager::class, + 'tenancy.database.managers.pgsql' => \Stancl\Tenancy\Database\TenantDatabaseManagers\PostgreSQLSchemaManager::class, 'tenancy.boostrappers' => [ DatabaseTenancyBootstrapper::class, ], @@ -225,7 +225,25 @@ test('tenant database can be created on a foreign server', function () { }); test('path used by sqlite manager can be customized', function () { - pest()->markTestIncomplete(); + Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) { + return $event->tenant; + })->toListener()); + + // Set custom path for SQLite file + SQLiteDatabaseManager::$path = $customPath = database_path('custom_' . Str::random(8)); + + if (! is_dir($customPath)) { + // Create custom directory + mkdir($customPath); + } + + $name = Str::random(8). '.sqlite'; + Tenant::create([ + 'tenancy_db_name' => $name, + 'tenancy_db_connection' => 'sqlite', + ]); + + expect(file_exists( $customPath . '/' . $name))->toBeTrue(); }); // Datasets diff --git a/tests/TenantModelTest.php b/tests/TenantModelTest.php index d50c9b6b..b4fd38f6 100644 --- a/tests/TenantModelTest.php +++ b/tests/TenantModelTest.php @@ -157,23 +157,25 @@ class AnotherTenant extends Model implements Contracts\Tenant return 'id'; } - public function getTenantKey() + public function getTenantKey(): int|string { return $this->getAttribute('id'); } - public function run(callable $callback) + public function run(Closure $callback): mixed { $callback(); } - public function getInternal(string $key) + public function getInternal(string $key): mixed { return $this->$key; } - public function setInternal(string $key, $value) + public function setInternal(string $key, mixed $value): static { $this->$key = $value; + + return $this; } } diff --git a/tests/TenantUserImpersonationTest.php b/tests/TenantUserImpersonationTest.php index 65aa380d..0fcb9022 100644 --- a/tests/TenantUserImpersonationTest.php +++ b/tests/TenantUserImpersonationTest.php @@ -4,25 +4,27 @@ declare(strict_types=1); use Carbon\Carbon; use Carbon\CarbonInterval; +use Illuminate\Support\Str; +use Illuminate\Auth\TokenGuard; use Illuminate\Auth\SessionGuard; +use Stancl\JobPipeline\JobPipeline; use Illuminate\Support\Facades\Auth; +use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Support\Facades\Event; use Illuminate\Support\Facades\Route; -use Illuminate\Support\Str; -use Stancl\JobPipeline\JobPipeline; -use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper; -use Stancl\Tenancy\Database\Models\ImpersonationToken; use Stancl\Tenancy\Events\TenancyEnded; -use Stancl\Tenancy\Events\TenancyInitialized; -use Stancl\Tenancy\Events\TenantCreated; -use Stancl\Tenancy\Features\UserImpersonation; use Stancl\Tenancy\Jobs\CreateDatabase; +use Stancl\Tenancy\Events\TenantCreated; +use Stancl\Tenancy\Events\TenancyInitialized; +use Stancl\Tenancy\Features\UserImpersonation; use Stancl\Tenancy\Listeners\BootstrapTenancy; use Stancl\Tenancy\Listeners\RevertToCentralContext; -use Stancl\Tenancy\Middleware\InitializeTenancyByDomain; -use Stancl\Tenancy\Middleware\InitializeTenancyByPath; -use Stancl\Tenancy\Tests\Etc\Tenant; use Illuminate\Foundation\Auth\User as Authenticable; +use Stancl\Tenancy\Database\Models\ImpersonationToken; +use Stancl\Tenancy\Middleware\InitializeTenancyByPath; +use Stancl\Tenancy\Middleware\InitializeTenancyByDomain; +use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper; +use Stancl\Tenancy\Exceptions\StatefulGuardRequiredException; beforeEach(function () { pest()->artisan('migrate', [ @@ -223,6 +225,46 @@ test('impersonation works with multiple models and guards', function () { }); }); +test('impersonation tokens can be created only with stateful guards', function () { + config([ + 'auth.guards' => [ + 'nonstateful' => [ + 'driver' => 'nonstateful', + 'provider' => 'provider', + ], + 'stateful' => [ + 'driver' => 'session', + 'provider' => 'provider', + ], + ], + 'auth.providers.provider' => [ + 'driver' => 'eloquent', + 'model' => ImpersonationUser::class, + ], + ]); + + $tenant = Tenant::create(); + migrateTenants(); + + $user = $tenant->run(function () { + return ImpersonationUser::create([ + 'name' => 'Joe', + 'email' => 'joe@local', + 'password' => bcrypt('secret'), + ]); + }); + + Auth::extend('nonstateful', fn($app, $name, array $config) => new TokenGuard(Auth::createUserProvider($config['provider']), request())); + + expect(fn() => tenancy()->impersonate($tenant, $user->id, '/dashboard', 'nonstateful')) + ->toThrow(StatefulGuardRequiredException::class); + + Auth::extend('stateful', fn ($app, $name, array $config) => new SessionGuard($name, Auth::createUserProvider($config['provider']), session())); + + expect(tenancy()->impersonate($tenant, $user->id, '/dashboard', 'stateful')) + ->toBeInstanceOf(ImpersonationToken::class); +}); + function migrateTenants() { pest()->artisan('tenants:migrate')->assertExitCode(0); diff --git a/tests/TestCase.php b/tests/TestCase.php index 554aeb8d..f7f8b9ad 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -4,8 +4,15 @@ declare(strict_types=1); namespace Stancl\Tenancy\Tests; +use Dotenv\Dotenv; +use Illuminate\Foundation\Application; use Illuminate\Support\Facades\Redis; use PDO; +use Stancl\Tenancy\Bootstrappers\BatchTenancyBootstrapper; +use Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper; +use Stancl\Tenancy\Facades\GlobalCache; +use Stancl\Tenancy\Facades\Tenancy; +use Stancl\Tenancy\TenancyServiceProvider; use Stancl\Tenancy\Tests\Etc\Tenant; abstract class TestCase extends \Orchestra\Testbench\TestCase @@ -42,17 +49,13 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase /** * Define environment setup. * - * @param \Illuminate\Foundation\Application $app + * @param Application $app * @return void */ protected function getEnvironmentSetUp($app) { if (file_exists(__DIR__ . '/../.env')) { - if (method_exists(\Dotenv\Dotenv::class, 'createImmutable')) { - \Dotenv\Dotenv::createImmutable(__DIR__ . '/..')->load(); - } else { - \Dotenv\Dotenv::create(__DIR__ . '/..')->load(); - } + Dotenv::createImmutable(__DIR__ . '/..')->load(); } $app['config']->set([ @@ -100,7 +103,7 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase '--realpath' => true, '--force' => true, ], - 'tenancy.bootstrappers.redis' => \Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper::class, + 'tenancy.bootstrappers.redis' => RedisTenancyBootstrapper::class, // todo0 change this to []? two tests in TenantDatabaseManagerTest are failing with that 'queue.connections.central' => [ 'driver' => 'sync', 'central' => true, @@ -109,28 +112,28 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase 'tenancy.tenant_model' => Tenant::class, // Use test tenant w/ DBs & domains ]); - $app->singleton(\Stancl\Tenancy\Bootstrappers\RedisTenancyBootstrapper::class); + $app->singleton(RedisTenancyBootstrapper::class); // todo (Samuel) use proper approach eg config for singleton registration } protected function getPackageProviders($app) { return [ - \Stancl\Tenancy\TenancyServiceProvider::class, + TenancyServiceProvider::class, ]; } protected function getPackageAliases($app) { return [ - 'Tenancy' => \Stancl\Tenancy\Facades\Tenancy::class, - 'GlobalCache' => \Stancl\Tenancy\Facades\GlobalCache::class, + 'Tenancy' => Tenancy::class, + 'GlobalCache' => GlobalCache::class, ]; } /** * Resolve application HTTP Kernel implementation. * - * @param \Illuminate\Foundation\Application $app + * @param Application $app * @return void */ protected function resolveApplicationHttpKernel($app) @@ -141,12 +144,12 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase /** * Resolve application Console Kernel implementation. * - * @param \Illuminate\Foundation\Application $app + * @param Application $app * @return void */ protected function resolveApplicationConsoleKernel($app) { - $app->singleton('Illuminate\Contracts\Console\Kernel', Etc\ConsoleKernel::class); + $app->singleton('Illuminate\Contracts\Console\Kernel', Etc\Console\ConsoleKernel::class); } public function randomString(int $length = 10)