mirror of
https://github.com/archtechx/tenancy.git
synced 2026-02-05 16:54:05 +00:00
Merge branch 'master' into pr/679
This commit is contained in:
commit
7b69b8f5d2
71 changed files with 1082 additions and 240 deletions
21
.github/ISSUE_TEMPLATE/bug-report.md
vendored
21
.github/ISSUE_TEMPLATE/bug-report.md
vendored
|
|
@ -1,21 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F41B Bug Report"
|
|
||||||
about: Report unexpected behavior with stancl/tenancy.
|
|
||||||
title: ''
|
|
||||||
labels: bug
|
|
||||||
assignees: stancl
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Describe the bug
|
|
||||||
<!-- A clear and concise description of what the bug is. -->
|
|
||||||
|
|
||||||
#### Steps to reproduce
|
|
||||||
|
|
||||||
|
|
||||||
#### Expected behavior
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
#### Your setup
|
|
||||||
- Laravel version: [e.g. 8.2.0]
|
|
||||||
- stancl/tenancy version: [e.g. 3.1.0]
|
|
||||||
48
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
48
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
name: 🐛 Bug Report
|
||||||
|
description: Report unexpected behavior with stancl/tenancy.
|
||||||
|
labels: ["bug"]
|
||||||
|
assignees:
|
||||||
|
- stancl
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Before opening a bug report, please search for the behaviour in the existing issues.
|
||||||
|
---
|
||||||
|
Thank you for taking the time to file a bug report. To address this bug as fast as possible, we need some information.
|
||||||
|
- type: textarea
|
||||||
|
id: bug-description
|
||||||
|
attributes:
|
||||||
|
label: Bug description
|
||||||
|
description: A clear and concise description of what the bug is.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Step-by-step guide for reproducing the bug in a fresh Laravel application.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: A clear and concise description of what you expected to happen.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: laravel-version
|
||||||
|
attributes:
|
||||||
|
label: Laravel version
|
||||||
|
placeholder: "e.g. 8.2.0"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: tenancy-version
|
||||||
|
attributes:
|
||||||
|
label: stancl/tenancy version
|
||||||
|
placeholder: "e.g. 3.1.0"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
30
.github/workflows/ci.yml
vendored
30
.github/workflows/ci.yml
vendored
|
|
@ -2,12 +2,14 @@ name: CI
|
||||||
|
|
||||||
env:
|
env:
|
||||||
COMPOSE_INTERACTIVE_NO_CLI: 1
|
COMPOSE_INTERACTIVE_NO_CLI: 1
|
||||||
|
PHP_CS_FIXER_IGNORE_ENV: 1
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [ 3.x, 2.x, master ]
|
branches: [ master ]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [ 3.x, 2.x, master ]
|
branches: [ master ]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
tests:
|
tests:
|
||||||
|
|
@ -15,8 +17,8 @@ jobs:
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
php: ["7.4", "8.0"]
|
php: ["8.1"]
|
||||||
laravel: ["^6.0", "^8.0"]
|
laravel: ["^9.0"]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|
@ -26,7 +28,19 @@ jobs:
|
||||||
run: docker-compose exec -T test composer require --no-interaction "laravel/framework:${{ matrix.laravel }}"
|
run: docker-compose exec -T test composer require --no-interaction "laravel/framework:${{ matrix.laravel }}"
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: ./test
|
run: ./test
|
||||||
- name: Send code coverage to codecov
|
|
||||||
env:
|
php-cs-fixer:
|
||||||
CODECOV_TOKEN: 24382d15-84e7-4a55-bea4-c4df96a24a9b
|
name: Code style (php-cs-fixer)
|
||||||
run: bash <(curl -s https://codecov.io/bash)
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Install php-cs-fixer
|
||||||
|
run: composer global require friendsofphp/php-cs-fixer
|
||||||
|
- name: Run php-cs-fixer
|
||||||
|
run: $HOME/.composer/vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php
|
||||||
|
- name: Commit changes from php-cs-fixer
|
||||||
|
uses: EndBug/add-and-commit@v5
|
||||||
|
with:
|
||||||
|
author_name: "PHP CS Fixer"
|
||||||
|
author_email: "phpcsfixer@example.com"
|
||||||
|
message: Fix code style (php-cs-fixer)
|
||||||
|
|
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -8,3 +8,7 @@ psysh
|
||||||
phpunit_var_*.xml
|
phpunit_var_*.xml
|
||||||
coverage/
|
coverage/
|
||||||
clover.xml
|
clover.xml
|
||||||
|
tenant-schema-test.dump
|
||||||
|
tests/Etc/tmp/queuetest.json
|
||||||
|
docker-compose.override.yml
|
||||||
|
.php-cs-fixer.cache
|
||||||
|
|
|
||||||
141
.php-cs-fixer.php
Normal file
141
.php-cs-fixer.php
Normal file
|
|
@ -0,0 +1,141 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
use PhpCsFixer\Config;
|
||||||
|
use PhpCsFixer\Finder;
|
||||||
|
|
||||||
|
$rules = [
|
||||||
|
'array_syntax' => ['syntax' => 'short'],
|
||||||
|
'binary_operator_spaces' => [
|
||||||
|
'default' => 'single_space',
|
||||||
|
'operators' => [
|
||||||
|
'=>' => null,
|
||||||
|
'|' => 'no_space',
|
||||||
|
]
|
||||||
|
],
|
||||||
|
'blank_line_after_namespace' => true,
|
||||||
|
'blank_line_after_opening_tag' => true,
|
||||||
|
'no_superfluous_phpdoc_tags' => true,
|
||||||
|
'blank_line_before_statement' => [
|
||||||
|
'statements' => ['return']
|
||||||
|
],
|
||||||
|
'braces' => true,
|
||||||
|
'cast_spaces' => true,
|
||||||
|
'class_definition' => true,
|
||||||
|
'concat_space' => [
|
||||||
|
'spacing' => 'one'
|
||||||
|
],
|
||||||
|
'declare_equal_normalize' => true,
|
||||||
|
'elseif' => true,
|
||||||
|
'encoding' => true,
|
||||||
|
'full_opening_tag' => true,
|
||||||
|
'declare_strict_types' => true,
|
||||||
|
'fully_qualified_strict_types' => true, // added by Shift
|
||||||
|
'function_declaration' => true,
|
||||||
|
'function_typehint_space' => true,
|
||||||
|
'heredoc_to_nowdoc' => true,
|
||||||
|
'include' => true,
|
||||||
|
'increment_style' => ['style' => 'post'],
|
||||||
|
'indentation_type' => true,
|
||||||
|
'linebreak_after_opening_tag' => true,
|
||||||
|
'line_ending' => true,
|
||||||
|
'lowercase_cast' => true,
|
||||||
|
'constant_case' => true,
|
||||||
|
'lowercase_keywords' => true,
|
||||||
|
'lowercase_static_reference' => true, // added from Symfony
|
||||||
|
'magic_method_casing' => true, // added from Symfony
|
||||||
|
'magic_constant_casing' => true,
|
||||||
|
'method_argument_space' => true,
|
||||||
|
'native_function_casing' => true,
|
||||||
|
'no_alias_functions' => true,
|
||||||
|
'no_extra_blank_lines' => [
|
||||||
|
'tokens' => [
|
||||||
|
'extra',
|
||||||
|
'throw',
|
||||||
|
'use',
|
||||||
|
'use_trait',
|
||||||
|
]
|
||||||
|
],
|
||||||
|
'no_blank_lines_after_class_opening' => true,
|
||||||
|
'no_blank_lines_after_phpdoc' => true,
|
||||||
|
'no_closing_tag' => true,
|
||||||
|
'no_empty_phpdoc' => true,
|
||||||
|
'no_empty_statement' => true,
|
||||||
|
'no_leading_import_slash' => true,
|
||||||
|
'no_leading_namespace_whitespace' => true,
|
||||||
|
'no_mixed_echo_print' => [
|
||||||
|
'use' => 'echo'
|
||||||
|
],
|
||||||
|
'no_multiline_whitespace_around_double_arrow' => true,
|
||||||
|
'multiline_whitespace_before_semicolons' => [
|
||||||
|
'strategy' => 'no_multi_line'
|
||||||
|
],
|
||||||
|
'no_short_bool_cast' => true,
|
||||||
|
'no_singleline_whitespace_before_semicolons' => true,
|
||||||
|
'no_spaces_after_function_name' => true,
|
||||||
|
'no_spaces_around_offset' => true,
|
||||||
|
'no_spaces_inside_parenthesis' => true,
|
||||||
|
'no_trailing_comma_in_list_call' => true,
|
||||||
|
'no_trailing_comma_in_singleline_array' => true,
|
||||||
|
'no_trailing_whitespace' => true,
|
||||||
|
'no_trailing_whitespace_in_comment' => true,
|
||||||
|
'no_unneeded_control_parentheses' => true,
|
||||||
|
'no_unreachable_default_argument_value' => true,
|
||||||
|
'no_useless_return' => true,
|
||||||
|
'no_whitespace_before_comma_in_array' => true,
|
||||||
|
'no_whitespace_in_blank_line' => true,
|
||||||
|
'normalize_index_brace' => true,
|
||||||
|
'not_operator_with_successor_space' => true,
|
||||||
|
'object_operator_without_whitespace' => true,
|
||||||
|
'ordered_imports' => ['sort_algorithm' => 'alpha'],
|
||||||
|
'phpdoc_indent' => true,
|
||||||
|
'general_phpdoc_tag_rename' => true,
|
||||||
|
'phpdoc_no_access' => true,
|
||||||
|
'phpdoc_no_package' => true,
|
||||||
|
'phpdoc_no_useless_inheritdoc' => true,
|
||||||
|
'phpdoc_scalar' => true,
|
||||||
|
'phpdoc_single_line_var_spacing' => true,
|
||||||
|
'phpdoc_summary' => true,
|
||||||
|
'phpdoc_to_comment' => false,
|
||||||
|
'phpdoc_trim' => true,
|
||||||
|
'phpdoc_types' => true,
|
||||||
|
'phpdoc_var_without_name' => true,
|
||||||
|
'psr_autoloading' => true,
|
||||||
|
'self_accessor' => true,
|
||||||
|
'short_scalar_cast' => true,
|
||||||
|
'simplified_null_return' => false, // disabled by Shift
|
||||||
|
'single_blank_line_at_eof' => true,
|
||||||
|
'single_blank_line_before_namespace' => true,
|
||||||
|
'single_class_element_per_statement' => true,
|
||||||
|
'single_import_per_statement' => true,
|
||||||
|
'single_line_after_imports' => true,
|
||||||
|
'no_unused_imports' => true,
|
||||||
|
'single_line_comment_style' => [
|
||||||
|
'comment_types' => ['hash']
|
||||||
|
],
|
||||||
|
'single_quote' => true,
|
||||||
|
'space_after_semicolon' => true,
|
||||||
|
'standardize_not_equals' => true,
|
||||||
|
'switch_case_semicolon_to_colon' => true,
|
||||||
|
'switch_case_space' => true,
|
||||||
|
'ternary_operator_spaces' => true,
|
||||||
|
'trailing_comma_in_multiline' => true,
|
||||||
|
'trim_array_spaces' => true,
|
||||||
|
'unary_operator_spaces' => true,
|
||||||
|
'whitespace_after_comma_in_array' => true,
|
||||||
|
];
|
||||||
|
|
||||||
|
$project_path = getcwd();
|
||||||
|
$finder = Finder::create()
|
||||||
|
->in([
|
||||||
|
$project_path . '/src',
|
||||||
|
])
|
||||||
|
->name('*.php')
|
||||||
|
->notName('*.blade.php')
|
||||||
|
->ignoreDotFiles(true)
|
||||||
|
->ignoreVCS(true);
|
||||||
|
|
||||||
|
return (new Config())
|
||||||
|
->setFinder($finder)
|
||||||
|
->setRules($rules)
|
||||||
|
->setRiskyAllowed(true)
|
||||||
|
->setUsingCache(true);
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
risky: true
|
|
||||||
preset: laravel
|
|
||||||
enabled:
|
|
||||||
- declare_strict_types
|
|
||||||
disabled:
|
|
||||||
- concat_without_spaces
|
|
||||||
- ternary_operator_spaces
|
|
||||||
|
|
@ -9,3 +9,16 @@ StyleCI will flag code style violations in your pull requests.
|
||||||
Run `docker-compose up -d` to start the containers. Then run `./test` to run the tests.
|
Run `docker-compose up -d` to start the containers. Then run `./test` to run the tests.
|
||||||
|
|
||||||
When you're done testing, run `docker-compose down` to shut down the containers.
|
When you're done testing, run `docker-compose down` to shut down the containers.
|
||||||
|
|
||||||
|
### Docker on M1
|
||||||
|
|
||||||
|
You can add:
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
mysql:
|
||||||
|
platform: linux/amd64
|
||||||
|
mysql2:
|
||||||
|
platform: linux/amd64
|
||||||
|
```
|
||||||
|
|
||||||
|
to `docker-compose.override.yml` to make `docker-compose up-d` work on M1.
|
||||||
|
|
|
||||||
23
Dockerfile
23
Dockerfile
|
|
@ -1,7 +1,7 @@
|
||||||
ARG PHP_VERSION=7.4
|
ARG PHP_VERSION=7.4
|
||||||
ARG PHP_TARGET=php:${PHP_VERSION}-cli
|
ARG PHP_TARGET=php:${PHP_VERSION}-cli
|
||||||
|
|
||||||
FROM ${PHP_TARGET}
|
FROM --platform=linux/amd64 ${PHP_TARGET}
|
||||||
|
|
||||||
ARG COMPOSER_TARGET=2.0.3
|
ARG COMPOSER_TARGET=2.0.3
|
||||||
|
|
||||||
|
|
@ -22,20 +22,29 @@ ENV LANG=en_GB.UTF-8
|
||||||
# Dockerfile _and pin the versions_! Eg:
|
# Dockerfile _and pin the versions_! Eg:
|
||||||
# RUN pecl install memcached-2.2.0 && docker-php-ext-enable memcached
|
# RUN pecl install memcached-2.2.0 && docker-php-ext-enable memcached
|
||||||
|
|
||||||
# install some OS packages we need
|
|
||||||
RUN apt-get update
|
RUN apt-get update \
|
||||||
RUN apt-get install -y --no-install-recommends libfreetype6-dev libjpeg62-turbo-dev libpng-dev libgmp-dev libldap2-dev netcat curl sqlite3 libsqlite3-dev libpq-dev libzip-dev unzip vim-tiny gosu git
|
&& apt-get install -y gnupg2 \
|
||||||
# install php extensions
|
&& 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 \
|
||||||
|
&& 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
|
||||||
|
|
||||||
RUN docker-php-ext-configure pgsql -with-pgsql=/usr/local/pgsql \
|
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 \
|
# && 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 \
|
&& 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
|
# install the redis php extension
|
||||||
&& pecl install redis-5.3.2 \
|
&& pecl install redis-5.3.7 \
|
||||||
&& docker-php-ext-enable redis \
|
&& docker-php-ext-enable redis \
|
||||||
# install the pcov extention
|
# install the pcov extention
|
||||||
&& pecl install pcov \
|
&& pecl install pcov \
|
||||||
&& docker-php-ext-enable pcov \
|
&& docker-php-ext-enable pcov \
|
||||||
&& echo "pcov.enabled = 1" > /usr/local/etc/php/conf.d/pcov.ini
|
&& 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
|
# clear the apt cache
|
||||||
RUN rm -rf /var/lib/apt/lists/* \
|
RUN rm -rf /var/lib/apt/lists/* \
|
||||||
&& rm -rf /var/lib/apt/lists/* \
|
&& rm -rf /var/lib/apt/lists/* \
|
||||||
|
|
|
||||||
|
|
@ -3,10 +3,9 @@
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://laravel.com"><img alt="Laravel 6.x/7.x/8.x" src="https://img.shields.io/badge/laravel-6.x/7.x/8.x-red.svg"></a>
|
<a href="https://laravel.com"><img alt="Laravel 9.x" src="https://img.shields.io/badge/laravel-9.x-red.svg"></a>
|
||||||
<a href="https://packagist.org/packages/stancl/tenancy"><img alt="Latest Stable Version" src="https://poser.pugx.org/stancl/tenancy/version"></a>
|
<a href="https://packagist.org/packages/stancl/tenancy"><img alt="Latest Stable Version" src="https://poser.pugx.org/stancl/tenancy/version"></a>
|
||||||
<a href="https://github.com/stancl/tenancy/actions"><img alt="GitHub Actions CI status" src="https://github.com/stancl/tenancy/workflows/CI/badge.svg"></a>
|
<a href="https://github.com/stancl/tenancy/actions"><img alt="GitHub Actions CI status" src="https://github.com/stancl/tenancy/workflows/CI/badge.svg"></a>
|
||||||
<a href="https://codecov.io/gh/stancl/tenancy"><img alt="codecov" src="https://codecov.io/gh/stancl/tenancy/branch/3.x/graph/badge.svg"></a>
|
|
||||||
<a href="https://github.com/stancl/tenancy/blob/3.x/DONATIONS.md"><img alt="Donate" src="https://img.shields.io/badge/Donate-%3C3-red"></a>
|
<a href="https://github.com/stancl/tenancy/blob/3.x/DONATIONS.md"><img alt="Donate" src="https://img.shields.io/badge/Donate-%3C3-red"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
# Get Support
|
# Get Support
|
||||||
|
|
||||||
If you need help with implementing the package, you can join our community [Discord server](https://discord.gg/7cpgPxv) and ask in `#help`.
|
If you need help with implementing the package, you can join our community [Discord server](https://archte.ch/discord) and ask in `#help`.
|
||||||
|
|
||||||
If you're interested in paid consulting from the maintainer, see the [contact page](https://tenancyforlaravel.com/contact/) on our website.
|
If you're interested in paid consulting from the maintainer, see the [contact page](https://tenancyforlaravel.com/contact/) on our website.
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,13 @@ class TenancyServiceProvider extends ServiceProvider
|
||||||
Events\TenantSaved::class => [],
|
Events\TenantSaved::class => [],
|
||||||
Events\UpdatingTenant::class => [],
|
Events\UpdatingTenant::class => [],
|
||||||
Events\TenantUpdated::class => [],
|
Events\TenantUpdated::class => [],
|
||||||
Events\DeletingTenant::class => [],
|
Events\DeletingTenant::class => [
|
||||||
|
JobPipeline::make([
|
||||||
|
Jobs\DeleteDomains::class,
|
||||||
|
])->send(function (Events\DeletingTenant $event) {
|
||||||
|
return $event->tenant;
|
||||||
|
})->shouldBeQueued(false),
|
||||||
|
],
|
||||||
Events\TenantDeleted::class => [
|
Events\TenantDeleted::class => [
|
||||||
JobPipeline::make([
|
JobPipeline::make([
|
||||||
Jobs\DeleteDatabase::class,
|
Jobs\DeleteDatabase::class,
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,8 @@ return [
|
||||||
'central_connection' => env('DB_CONNECTION', 'central'),
|
'central_connection' => env('DB_CONNECTION', 'central'),
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Connection used as a "template" for the tenant database connection.
|
* Connection used as a "template" for the dynamically created tenant database connection.
|
||||||
|
* Note: don't name your template connection tenant. That name is reserved by package.
|
||||||
*/
|
*/
|
||||||
'template_tenant_connection' => null,
|
'template_tenant_connection' => null,
|
||||||
|
|
||||||
|
|
@ -60,6 +61,7 @@ return [
|
||||||
'sqlite' => Stancl\Tenancy\TenantDatabaseManagers\SQLiteDatabaseManager::class,
|
'sqlite' => Stancl\Tenancy\TenantDatabaseManagers\SQLiteDatabaseManager::class,
|
||||||
'mysql' => Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager::class,
|
'mysql' => Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager::class,
|
||||||
'pgsql' => Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager::class,
|
'pgsql' => Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager::class,
|
||||||
|
'sqlsrv' => Stancl\Tenancy\TenantDatabaseManagers\MicrosoftSQLDatabaseManager::class,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Use this database manager for MySQL to have a DB user created for each tenant database.
|
* Use this database manager for MySQL to have a DB user created for each tenant database.
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@ class CreateDomainsTable extends Migration
|
||||||
$table->string('tenant_id');
|
$table->string('tenant_id');
|
||||||
|
|
||||||
$table->timestamps();
|
$table->timestamps();
|
||||||
$table->foreign('tenant_id')->references('id')->on('tenants')->onUpdate('cascade')->onDelete('cascade');
|
$table->foreign('tenant_id')->references('id')->on('tenants')->onUpdate('cascade');
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,17 +11,17 @@
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"ext-json": "*",
|
"ext-json": "*",
|
||||||
"illuminate/support": "^6.0|^7.0|^8.0",
|
"illuminate/support": "^6.0|^7.0|^8.0|^9.0",
|
||||||
"facade/ignition-contracts": "^1.0",
|
"facade/ignition-contracts": "^1.0",
|
||||||
"ramsey/uuid": "^3.7|^4.0",
|
"ramsey/uuid": "^3.7|^4.0",
|
||||||
"stancl/jobpipeline": "^1.0",
|
"stancl/jobpipeline": "dev-master",
|
||||||
"stancl/virtualcolumn": "^1.0"
|
"stancl/virtualcolumn": "dev-master"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"vlucas/phpdotenv": "^3.3|^4.0|^5.0",
|
"laravel/framework": "^6.0|^7.0|^8.0|^9.0",
|
||||||
"laravel/framework": "^6.0|^7.0|^8.0",
|
"orchestra/testbench": "^4.0|^5.0|^6.0|^7.0",
|
||||||
"orchestra/testbench-browser-kit": "^4.0|^5.0|^6.0",
|
"phpunit/phpunit": "*",
|
||||||
"league/flysystem-aws-s3-v3": "~1.0",
|
"league/flysystem-aws-s3-v3": "^1.0|^3.0",
|
||||||
"doctrine/dbal": "^2.10",
|
"doctrine/dbal": "^2.10",
|
||||||
"spatie/valuestore": "^1.2.5"
|
"spatie/valuestore": "^1.2.5"
|
||||||
},
|
},
|
||||||
|
|
@ -49,6 +49,12 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"scripts": {
|
||||||
|
"docker-up": "PHP_VERSION=8.0.11 docker-compose up -d",
|
||||||
|
"docker-down": "PHP_VERSION=8.0.11 docker-compose down",
|
||||||
|
"docker-rebuild": "PHP_VERSION=8.0.11 docker-compose up -d --no-deps --build",
|
||||||
|
"test": "PHP_VERSION=8.0.11 ./test"
|
||||||
|
},
|
||||||
"minimum-stability": "dev",
|
"minimum-stability": "dev",
|
||||||
"prefer-stable": true
|
"prefer-stable": true
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ services:
|
||||||
build:
|
build:
|
||||||
context: .
|
context: .
|
||||||
args:
|
args:
|
||||||
PHP_VERSION: ${PHP_VERSION}
|
PHP_VERSION: ${PHP_VERSION:-8.1}
|
||||||
depends_on:
|
depends_on:
|
||||||
mysql:
|
mysql:
|
||||||
condition: service_healthy
|
condition: service_healthy
|
||||||
|
|
@ -22,6 +22,9 @@ services:
|
||||||
TENANCY_TEST_REDIS_HOST: redis
|
TENANCY_TEST_REDIS_HOST: redis
|
||||||
TENANCY_TEST_MYSQL_HOST: mysql
|
TENANCY_TEST_MYSQL_HOST: mysql
|
||||||
TENANCY_TEST_PGSQL_HOST: postgres
|
TENANCY_TEST_PGSQL_HOST: postgres
|
||||||
|
TENANCY_TEST_SQLSRV_HOST: mssql
|
||||||
|
TENANCY_TEST_SQLSRV_USERNAME: sa
|
||||||
|
TENANCY_TEST_SQLSRV_PASSWORD: P@ssword
|
||||||
stdin_open: true
|
stdin_open: true
|
||||||
tty: true
|
tty: true
|
||||||
mysql:
|
mysql:
|
||||||
|
|
@ -64,3 +67,11 @@ services:
|
||||||
interval: 1s
|
interval: 1s
|
||||||
timeout: 3s
|
timeout: 3s
|
||||||
retries: 30
|
retries: 30
|
||||||
|
mssql:
|
||||||
|
image: mcr.microsoft.com/mssql/server:2019-latest
|
||||||
|
ports:
|
||||||
|
- 1433:1433
|
||||||
|
environment:
|
||||||
|
- ACCEPT_EULA=Y
|
||||||
|
- SA_PASSWORD=P@ssword # todo reuse values from env above
|
||||||
|
# todo missing health check
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,7 @@ namespace Stancl\Tenancy\Bootstrappers;
|
||||||
|
|
||||||
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
||||||
use Stancl\Tenancy\Contracts\Tenant;
|
use Stancl\Tenancy\Contracts\Tenant;
|
||||||
|
use Stancl\Tenancy\Contracts\TenantWithDatabase;
|
||||||
use Stancl\Tenancy\Database\DatabaseManager;
|
use Stancl\Tenancy\Database\DatabaseManager;
|
||||||
use Stancl\Tenancy\Exceptions\TenantDatabaseDoesNotExistException;
|
use Stancl\Tenancy\Exceptions\TenantDatabaseDoesNotExistException;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,6 @@ declare(strict_types=1);
|
||||||
namespace Stancl\Tenancy\Bootstrappers;
|
namespace Stancl\Tenancy\Bootstrappers;
|
||||||
|
|
||||||
use Illuminate\Contracts\Foundation\Application;
|
use Illuminate\Contracts\Foundation\Application;
|
||||||
use Illuminate\Filesystem\FilesystemAdapter;
|
|
||||||
use Illuminate\Support\Facades\Storage;
|
use Illuminate\Support\Facades\Storage;
|
||||||
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
||||||
use Stancl\Tenancy\Contracts\Tenant;
|
use Stancl\Tenancy\Contracts\Tenant;
|
||||||
|
|
@ -54,20 +53,24 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper
|
||||||
}
|
}
|
||||||
|
|
||||||
// Storage facade
|
// Storage facade
|
||||||
foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
|
Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']);
|
||||||
/** @var FilesystemAdapter $filesystemDisk */
|
|
||||||
$filesystemDisk = Storage::disk($disk);
|
|
||||||
$this->originalPaths['disks'][$disk] = $filesystemDisk->getAdapter()->getPathPrefix();
|
|
||||||
|
|
||||||
if ($root = str_replace(
|
foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
|
||||||
'%storage_path%',
|
// todo@v4 \League\Flysystem\PathPrefixer is making this a lot more painful in flysystem v2
|
||||||
storage_path(),
|
|
||||||
$this->app['config']["tenancy.filesystem.root_override.{$disk}"] ?? ''
|
$originalRoot = $this->app['config']["filesystems.disks.{$disk}.root"];
|
||||||
)) {
|
$this->originalPaths['disks'][$disk] = $originalRoot;
|
||||||
$filesystemDisk->getAdapter()->setPathPrefix($finalPrefix = $root);
|
|
||||||
} else {
|
$finalPrefix = str_replace(
|
||||||
$root = $this->app['config']["filesystems.disks.{$disk}.root"];
|
['%storage_path%', '%tenant%'],
|
||||||
$filesystemDisk->getAdapter()->setPathPrefix($finalPrefix = $root . "/{$suffix}");
|
[storage_path(), $tenant->getTenantKey()],
|
||||||
|
$this->app['config']["tenancy.filesystem.root_override.{$disk}"] ?? '',
|
||||||
|
);
|
||||||
|
|
||||||
|
if (! $finalPrefix) {
|
||||||
|
$finalPrefix = $originalRoot
|
||||||
|
? rtrim($originalRoot, '/') . '/' . $suffix
|
||||||
|
: $suffix;
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->app['config']["filesystems.disks.{$disk}.root"] = $finalPrefix;
|
$this->app['config']["filesystems.disks.{$disk}.root"] = $finalPrefix;
|
||||||
|
|
@ -84,14 +87,9 @@ class FilesystemTenancyBootstrapper implements TenancyBootstrapper
|
||||||
$this->app['url']->setAssetRoot($this->app['config']['app.asset_url']);
|
$this->app['url']->setAssetRoot($this->app['config']['app.asset_url']);
|
||||||
|
|
||||||
// Storage facade
|
// Storage facade
|
||||||
|
Storage::forgetDisk($this->app['config']['tenancy.filesystem.disks']);
|
||||||
foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
|
foreach ($this->app['config']['tenancy.filesystem.disks'] as $disk) {
|
||||||
/** @var FilesystemAdapter $filesystemDisk */
|
$this->app['config']["filesystems.disks.{$disk}.root"] = $this->originalPaths['disks'][$disk];
|
||||||
$filesystemDisk = Storage::disk($disk);
|
|
||||||
|
|
||||||
$root = $this->originalPaths['disks'][$disk];
|
|
||||||
|
|
||||||
$filesystemDisk->getAdapter()->setPathPrefix($root);
|
|
||||||
$this->app['config']["filesystems.disks.{$disk}.root"] = $root;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,10 @@ namespace Stancl\Tenancy\Bootstrappers;
|
||||||
use Illuminate\Config\Repository;
|
use Illuminate\Config\Repository;
|
||||||
use Illuminate\Contracts\Events\Dispatcher;
|
use Illuminate\Contracts\Events\Dispatcher;
|
||||||
use Illuminate\Contracts\Foundation\Application;
|
use Illuminate\Contracts\Foundation\Application;
|
||||||
|
use Illuminate\Queue\Events\JobFailed;
|
||||||
|
use Illuminate\Queue\Events\JobProcessed;
|
||||||
use Illuminate\Queue\Events\JobProcessing;
|
use Illuminate\Queue\Events\JobProcessing;
|
||||||
|
use Illuminate\Queue\Events\JobRetryRequested;
|
||||||
use Illuminate\Queue\QueueManager;
|
use Illuminate\Queue\QueueManager;
|
||||||
use Illuminate\Support\Testing\Fakes\QueueFake;
|
use Illuminate\Support\Testing\Fakes\QueueFake;
|
||||||
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
use Stancl\Tenancy\Contracts\TenancyBootstrapper;
|
||||||
|
|
@ -21,6 +24,16 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper
|
||||||
/** @var QueueManager */
|
/** @var QueueManager */
|
||||||
protected $queue;
|
protected $queue;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Don't persist the same tenant across multiple jobs even if they have the same tenant ID.
|
||||||
|
*
|
||||||
|
* This is useful when you're changing the tenant's state (e.g. properties in the `data` column) and want the next job to initialize tenancy again
|
||||||
|
* with the new data. Features like the Tenant Config are only executed when tenancy is initialized, so the re-initialization is needed in some cases.
|
||||||
|
*
|
||||||
|
* @var bool
|
||||||
|
*/
|
||||||
|
public static $forceRefresh = false;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The normal constructor is only executed after tenancy is bootstrapped.
|
* The normal constructor is only executed after tenancy is bootstrapped.
|
||||||
* However, we're registering a hook to initialize tenancy. Therefore,
|
* However, we're registering a hook to initialize tenancy. Therefore,
|
||||||
|
|
@ -28,7 +41,7 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper
|
||||||
*/
|
*/
|
||||||
public static function __constructStatic(Application $app)
|
public static function __constructStatic(Application $app)
|
||||||
{
|
{
|
||||||
static::setUpJobListener($app->make(Dispatcher::class));
|
static::setUpJobListener($app->make(Dispatcher::class), $app->runningUnitTests());
|
||||||
}
|
}
|
||||||
|
|
||||||
public function __construct(Repository $config, QueueManager $queue)
|
public function __construct(Repository $config, QueueManager $queue)
|
||||||
|
|
@ -39,25 +52,90 @@ class QueueTenancyBootstrapper implements TenancyBootstrapper
|
||||||
$this->setUpPayloadGenerator();
|
$this->setUpPayloadGenerator();
|
||||||
}
|
}
|
||||||
|
|
||||||
protected static function setUpJobListener($dispatcher)
|
protected static function setUpJobListener($dispatcher, $runningTests)
|
||||||
{
|
{
|
||||||
$dispatcher->listen(JobProcessing::class, function ($event) {
|
$previousTenant = null;
|
||||||
$tenantId = $event->job->payload()['tenant_id'] ?? null;
|
|
||||||
|
|
||||||
// The job is not tenant-aware
|
$dispatcher->listen(JobProcessing::class, function ($event) use (&$previousTenant) {
|
||||||
|
$previousTenant = tenant();
|
||||||
|
|
||||||
|
static::initializeTenancyForQueue($event->job->payload()['tenant_id'] ?? null);
|
||||||
|
});
|
||||||
|
|
||||||
|
if (version_compare(app()->version(), '8.64', '>=')) {
|
||||||
|
// JobRetryRequested only exists since Laravel 8.64
|
||||||
|
$dispatcher->listen(JobRetryRequested::class, function ($event) use (&$previousTenant) {
|
||||||
|
$previousTenant = tenant();
|
||||||
|
|
||||||
|
static::initializeTenancyForQueue($event->payload()['tenant_id'] ?? null);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we're running tests, we make sure to clean up after any artisan('queue:work') calls
|
||||||
|
$revertToPreviousState = function ($event) use (&$previousTenant, $runningTests) {
|
||||||
|
if ($runningTests) {
|
||||||
|
static::revertToPreviousState($event, $previousTenant);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
$dispatcher->listen(JobProcessed::class, $revertToPreviousState); // artisan('queue:work') which succeeds
|
||||||
|
$dispatcher->listen(JobFailed::class, $revertToPreviousState); // artisan('queue:work') which fails
|
||||||
|
}
|
||||||
|
|
||||||
|
protected static function initializeTenancyForQueue($tenantId)
|
||||||
|
{
|
||||||
if (! $tenantId) {
|
if (! $tenantId) {
|
||||||
|
// The job is not tenant-aware
|
||||||
|
if (tenancy()->initialized) {
|
||||||
|
// Tenancy was initialized, so we revert back to the central context
|
||||||
|
tenancy()->end();
|
||||||
|
}
|
||||||
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Tenancy is already initialized for the tenant (e.g. dispatchNow was used)
|
if (static::$forceRefresh) {
|
||||||
if (tenancy()->initialized && tenant()->getTenantKey() === $tenantId) {
|
// Re-initialize tenancy between all jobs
|
||||||
|
if (tenancy()->initialized) {
|
||||||
|
tenancy()->end();
|
||||||
|
}
|
||||||
|
|
||||||
|
tenancy()->initialize(tenancy()->find($tenantId));
|
||||||
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (tenancy()->initialized) {
|
||||||
|
// Tenancy is already initialized
|
||||||
|
if (tenant()->getTenantKey() === $tenantId) {
|
||||||
|
// It's initialized for the same tenant (e.g. dispatchNow was used, or the previous job also ran for this tenant)
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Tenancy was either not initialized, or initialized for a different tenant.
|
// Tenancy was either not initialized, or initialized for a different tenant.
|
||||||
// Therefore, we initialize it for the correct tenant.
|
// Therefore, we initialize it for the correct tenant.
|
||||||
tenancy()->initialize(tenancy()->find($tenantId));
|
tenancy()->initialize(tenancy()->find($tenantId));
|
||||||
});
|
}
|
||||||
|
|
||||||
|
protected static function revertToPreviousState($event, &$previousTenant)
|
||||||
|
{
|
||||||
|
$tenantId = $event->job->payload()['tenant_id'] ?? null;
|
||||||
|
|
||||||
|
// The job was not tenant-aware
|
||||||
|
if (! $tenantId) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Revert back to the previous tenant
|
||||||
|
if (tenant() && $previousTenant && $previousTenant->isNot(tenant())) {
|
||||||
|
tenancy()->initialize($previousTenant);
|
||||||
|
}
|
||||||
|
|
||||||
|
// End tenancy
|
||||||
|
if (tenant() && (! $previousTenant)) {
|
||||||
|
tenancy()->end();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function setUpPayloadGenerator()
|
protected function setUpPayloadGenerator()
|
||||||
|
|
|
||||||
|
|
@ -13,15 +13,16 @@ class CacheManager extends BaseCacheManager
|
||||||
*
|
*
|
||||||
* @param string $method
|
* @param string $method
|
||||||
* @param array $parameters
|
* @param array $parameters
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function __call($method, $parameters)
|
public function __call($method, $parameters)
|
||||||
{
|
{
|
||||||
$tags = [config('tenancy.cache.tag_base') . tenant()->getTenantKey()];
|
$tags = [config('tenancy.cache.tag_base') . tenant()->getTenantKey()];
|
||||||
|
|
||||||
if ($method === 'tags') {
|
if ($method === 'tags') {
|
||||||
if (count($parameters) !== 1) {
|
$count = count($parameters);
|
||||||
throw new \Exception("Method tags() takes exactly 1 argument. {count($parameters)} passed.");
|
|
||||||
|
if ($count !== 1) {
|
||||||
|
throw new \Exception("Method tags() takes exactly 1 argument. $count passed.");
|
||||||
}
|
}
|
||||||
|
|
||||||
$names = $parameters[0];
|
$names = $parameters[0];
|
||||||
|
|
|
||||||
|
|
@ -24,8 +24,6 @@ class Install extends Command
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -8,39 +8,31 @@ use Illuminate\Contracts\Events\Dispatcher;
|
||||||
use Illuminate\Database\Console\Migrations\MigrateCommand;
|
use Illuminate\Database\Console\Migrations\MigrateCommand;
|
||||||
use Illuminate\Database\Migrations\Migrator;
|
use Illuminate\Database\Migrations\Migrator;
|
||||||
use Stancl\Tenancy\Concerns\DealsWithMigrations;
|
use Stancl\Tenancy\Concerns\DealsWithMigrations;
|
||||||
|
use Stancl\Tenancy\Concerns\ExtendsLaravelCommand;
|
||||||
use Stancl\Tenancy\Concerns\HasATenantsOption;
|
use Stancl\Tenancy\Concerns\HasATenantsOption;
|
||||||
use Stancl\Tenancy\Events\DatabaseMigrated;
|
use Stancl\Tenancy\Events\DatabaseMigrated;
|
||||||
use Stancl\Tenancy\Events\MigratingDatabase;
|
use Stancl\Tenancy\Events\MigratingDatabase;
|
||||||
|
|
||||||
class Migrate extends MigrateCommand
|
class Migrate extends MigrateCommand
|
||||||
{
|
{
|
||||||
use HasATenantsOption, DealsWithMigrations;
|
use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand;
|
||||||
|
|
||||||
/**
|
|
||||||
* The console command description.
|
|
||||||
*
|
|
||||||
* @var string
|
|
||||||
*/
|
|
||||||
protected $description = 'Run migrations for tenant(s)';
|
protected $description = 'Run migrations for tenant(s)';
|
||||||
|
|
||||||
/**
|
protected static function getTenantCommandName(): string
|
||||||
* Create a new command instance.
|
{
|
||||||
*
|
return 'tenants:migrate';
|
||||||
* @param Migrator $migrator
|
}
|
||||||
* @param Dispatcher $dispatcher
|
|
||||||
*/
|
|
||||||
public function __construct(Migrator $migrator, Dispatcher $dispatcher)
|
public function __construct(Migrator $migrator, Dispatcher $dispatcher)
|
||||||
{
|
{
|
||||||
parent::__construct($migrator, $dispatcher);
|
parent::__construct($migrator, $dispatcher);
|
||||||
|
|
||||||
$this->setName('tenants:migrate');
|
|
||||||
$this->specifyParameters();
|
$this->specifyParameters();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
|
|
@ -55,7 +47,7 @@ class Migrate extends MigrateCommand
|
||||||
}
|
}
|
||||||
|
|
||||||
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
||||||
$this->line("Tenant: {$tenant['id']}");
|
$this->line("Tenant: {$tenant->getTenantKey()}");
|
||||||
|
|
||||||
event(new MigratingDatabase($tenant));
|
event(new MigratingDatabase($tenant));
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@ namespace Stancl\Tenancy\Commands;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
use Stancl\Tenancy\Concerns\DealsWithMigrations;
|
use Stancl\Tenancy\Concerns\DealsWithMigrations;
|
||||||
use Stancl\Tenancy\Concerns\HasATenantsOption;
|
use Stancl\Tenancy\Concerns\HasATenantsOption;
|
||||||
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
|
|
||||||
final class MigrateFresh extends Command
|
final class MigrateFresh extends Command
|
||||||
{
|
{
|
||||||
|
|
@ -23,13 +24,13 @@ final class MigrateFresh extends Command
|
||||||
{
|
{
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
|
|
||||||
|
$this->addOption('--drop-views', null, InputOption::VALUE_NONE, 'Drop views along with tenant tables.', null);
|
||||||
|
|
||||||
$this->setName('tenants:migrate-fresh');
|
$this->setName('tenants:migrate-fresh');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
|
|
@ -37,6 +38,7 @@ final class MigrateFresh extends Command
|
||||||
$this->info('Dropping tables.');
|
$this->info('Dropping tables.');
|
||||||
$this->call('db:wipe', array_filter([
|
$this->call('db:wipe', array_filter([
|
||||||
'--database' => 'tenant',
|
'--database' => 'tenant',
|
||||||
|
'--drop-views' => $this->option('drop-views'),
|
||||||
'--force' => true,
|
'--force' => true,
|
||||||
]));
|
]));
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,13 +7,19 @@ namespace Stancl\Tenancy\Commands;
|
||||||
use Illuminate\Database\Console\Migrations\RollbackCommand;
|
use Illuminate\Database\Console\Migrations\RollbackCommand;
|
||||||
use Illuminate\Database\Migrations\Migrator;
|
use Illuminate\Database\Migrations\Migrator;
|
||||||
use Stancl\Tenancy\Concerns\DealsWithMigrations;
|
use Stancl\Tenancy\Concerns\DealsWithMigrations;
|
||||||
|
use Stancl\Tenancy\Concerns\ExtendsLaravelCommand;
|
||||||
use Stancl\Tenancy\Concerns\HasATenantsOption;
|
use Stancl\Tenancy\Concerns\HasATenantsOption;
|
||||||
use Stancl\Tenancy\Events\DatabaseRolledBack;
|
use Stancl\Tenancy\Events\DatabaseRolledBack;
|
||||||
use Stancl\Tenancy\Events\RollingBackDatabase;
|
use Stancl\Tenancy\Events\RollingBackDatabase;
|
||||||
|
|
||||||
class Rollback extends RollbackCommand
|
class Rollback extends RollbackCommand
|
||||||
{
|
{
|
||||||
use HasATenantsOption, DealsWithMigrations;
|
use HasATenantsOption, DealsWithMigrations, ExtendsLaravelCommand;
|
||||||
|
|
||||||
|
protected static function getTenantCommandName(): string
|
||||||
|
{
|
||||||
|
return 'tenants:rollback';
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command description.
|
* The console command description.
|
||||||
|
|
@ -31,14 +37,11 @@ class Rollback extends RollbackCommand
|
||||||
{
|
{
|
||||||
parent::__construct($migrator);
|
parent::__construct($migrator);
|
||||||
|
|
||||||
$this->setName('tenants:rollback');
|
$this->specifyTenantSignature();
|
||||||
$this->specifyParameters();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
|
|
@ -53,7 +56,7 @@ class Rollback extends RollbackCommand
|
||||||
}
|
}
|
||||||
|
|
||||||
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
||||||
$this->line("Tenant: {$tenant['id']}");
|
$this->line("Tenant: {$tenant->getTenantKey()}");
|
||||||
|
|
||||||
event(new RollingBackDatabase($tenant));
|
event(new RollingBackDatabase($tenant));
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -27,14 +27,11 @@ class Run extends Command
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
||||||
$this->line("Tenant: {$tenant['id']}");
|
$this->line("Tenant: {$tenant->getTenantKey()}");
|
||||||
tenancy()->initialize($tenant);
|
|
||||||
|
|
||||||
$callback = function ($prefix = '') {
|
$callback = function ($prefix = '') {
|
||||||
return function ($arguments, $argument) use ($prefix) {
|
return function ($arguments, $argument) use ($prefix) {
|
||||||
|
|
|
||||||
|
|
@ -35,8 +35,6 @@ class Seed extends SeedCommand
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
|
|
@ -51,7 +49,7 @@ class Seed extends SeedCommand
|
||||||
}
|
}
|
||||||
|
|
||||||
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
tenancy()->runForMultiple($this->option('tenants'), function ($tenant) {
|
||||||
$this->line("Tenant: {$tenant['id']}");
|
$this->line("Tenant: {$tenant->getTenantKey()}");
|
||||||
|
|
||||||
event(new SeedingDatabase($tenant));
|
event(new SeedingDatabase($tenant));
|
||||||
|
|
||||||
|
|
|
||||||
53
src/Commands/TenantDump.php
Normal file
53
src/Commands/TenantDump.php
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Stancl\Tenancy\Commands;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Events\Dispatcher;
|
||||||
|
use Illuminate\Database\ConnectionResolverInterface;
|
||||||
|
use Illuminate\Database\Console\DumpCommand;
|
||||||
|
use Stancl\Tenancy\Contracts\Tenant;
|
||||||
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
|
|
||||||
|
class TenantDump extends DumpCommand
|
||||||
|
{
|
||||||
|
public function __construct()
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
|
||||||
|
$this->setName('tenants:dump');
|
||||||
|
$this->specifyParameters();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function handle(ConnectionResolverInterface $connections, Dispatcher $dispatcher): int
|
||||||
|
{
|
||||||
|
$this->tenant()->run(fn () => parent::handle($connections, $dispatcher));
|
||||||
|
|
||||||
|
return Command::SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function tenant(): Tenant
|
||||||
|
{
|
||||||
|
$tenant = $this->option('tenant')
|
||||||
|
?? tenant()
|
||||||
|
?? $this->ask('What tenant do you want to dump the schema for?')
|
||||||
|
?? tenancy()->query()->first();
|
||||||
|
|
||||||
|
if (! $tenant instanceof Tenant) {
|
||||||
|
$tenant = tenancy()->find($tenant);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw_if(! $tenant, 'Could not identify the tenant to use for dumping the schema.');
|
||||||
|
|
||||||
|
return $tenant;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getOptions(): array
|
||||||
|
{
|
||||||
|
return array_merge([
|
||||||
|
['tenant', null, InputOption::VALUE_OPTIONAL, '', null],
|
||||||
|
], parent::getOptions());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -25,8 +25,6 @@ class TenantList extends Command
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Execute the console command.
|
* Execute the console command.
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
|
|
@ -36,9 +34,9 @@ class TenantList extends Command
|
||||||
->cursor()
|
->cursor()
|
||||||
->each(function (Tenant $tenant) {
|
->each(function (Tenant $tenant) {
|
||||||
if ($tenant->domains) {
|
if ($tenant->domains) {
|
||||||
$this->line("[Tenant] id: {$tenant['id']} @ " . implode('; ', $tenant->domains->pluck('domain')->toArray() ?? []));
|
$this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()} @ " . implode('; ', $tenant->domains->pluck('domain')->toArray() ?? []));
|
||||||
} else {
|
} else {
|
||||||
$this->line("[Tenant] id: {$tenant['id']}");
|
$this->line("[Tenant] {$tenant->getTenantKeyName()}: {$tenant->getTenantKey()}");
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
|
||||||
25
src/Concerns/ExtendsLaravelCommand.php
Normal file
25
src/Concerns/ExtendsLaravelCommand.php
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Stancl\Tenancy\Concerns;
|
||||||
|
|
||||||
|
trait ExtendsLaravelCommand
|
||||||
|
{
|
||||||
|
protected function specifyTenantSignature(): void
|
||||||
|
{
|
||||||
|
$this->specifyParameters();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getName(): ?string
|
||||||
|
{
|
||||||
|
return static::getTenantCommandName();
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getDefaultName(): ?string
|
||||||
|
{
|
||||||
|
return static::getTenantCommandName();
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract protected static function getTenantCommandName(): string;
|
||||||
|
}
|
||||||
|
|
@ -12,7 +12,7 @@ trait HasATenantsOption
|
||||||
protected function getOptions()
|
protected function getOptions()
|
||||||
{
|
{
|
||||||
return array_merge([
|
return array_merge([
|
||||||
['tenants', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL, '', null],
|
['tenants', null, InputOption::VALUE_IS_ARRAY|InputOption::VALUE_OPTIONAL, '', null],
|
||||||
], parent::getOptions());
|
], parent::getOptions());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,18 +20,11 @@ interface TenantDatabaseManager
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Does a database exist.
|
* Does a database exist.
|
||||||
*
|
|
||||||
* @param string $name
|
|
||||||
* @return bool
|
|
||||||
*/
|
*/
|
||||||
public function databaseExists(string $name): bool;
|
public function databaseExists(string $name): bool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Make a DB connection config array.
|
* Make a DB connection config array.
|
||||||
*
|
|
||||||
* @param array $baseConfig
|
|
||||||
* @param string $databaseName
|
|
||||||
* @return array
|
|
||||||
*/
|
*/
|
||||||
public function makeConnectionConfig(array $baseConfig, string $databaseName): array;
|
public function makeConnectionConfig(array $baseConfig, string $databaseName): array;
|
||||||
|
|
||||||
|
|
@ -39,9 +32,6 @@ interface TenantDatabaseManager
|
||||||
* Set the DB connection that should be used by the tenant database manager.
|
* Set the DB connection that should be used by the tenant database manager.
|
||||||
*
|
*
|
||||||
* @throws NoConnectionSetException
|
* @throws NoConnectionSetException
|
||||||
*
|
|
||||||
* @param string $connection
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function setConnection(string $connection): void;
|
public function setConnection(string $connection): void;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -11,9 +11,6 @@ trait TenantRun
|
||||||
/**
|
/**
|
||||||
* Run a callback in this tenant's context.
|
* Run a callback in this tenant's context.
|
||||||
* Atomic, safely reverts to previous context.
|
* Atomic, safely reverts to previous context.
|
||||||
*
|
|
||||||
* @param callable $callback
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function run(callable $callback)
|
public function run(callable $callback)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -7,10 +7,12 @@ namespace Stancl\Tenancy\Database;
|
||||||
use Illuminate\Config\Repository;
|
use Illuminate\Config\Repository;
|
||||||
use Illuminate\Contracts\Foundation\Application;
|
use Illuminate\Contracts\Foundation\Application;
|
||||||
use Illuminate\Database\DatabaseManager as BaseDatabaseManager;
|
use Illuminate\Database\DatabaseManager as BaseDatabaseManager;
|
||||||
|
use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
|
||||||
use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
|
use Stancl\Tenancy\Contracts\TenantCannotBeCreatedException;
|
||||||
use Stancl\Tenancy\Contracts\TenantWithDatabase;
|
use Stancl\Tenancy\Contracts\TenantWithDatabase;
|
||||||
use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
|
use Stancl\Tenancy\Exceptions\DatabaseManagerNotRegisteredException;
|
||||||
use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
|
use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
|
||||||
|
use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @internal Class is subject to breaking changes in minor and patch versions.
|
* @internal Class is subject to breaking changes in minor and patch versions.
|
||||||
|
|
@ -38,7 +40,7 @@ class DatabaseManager
|
||||||
*/
|
*/
|
||||||
public function connectToTenant(TenantWithDatabase $tenant)
|
public function connectToTenant(TenantWithDatabase $tenant)
|
||||||
{
|
{
|
||||||
$this->database->purge('tenant');
|
$this->purgeTenantConnection();
|
||||||
$this->createTenantConnection($tenant);
|
$this->createTenantConnection($tenant);
|
||||||
$this->setDefaultConnection('tenant');
|
$this->setDefaultConnection('tenant');
|
||||||
}
|
}
|
||||||
|
|
@ -48,10 +50,7 @@ class DatabaseManager
|
||||||
*/
|
*/
|
||||||
public function reconnectToCentral()
|
public function reconnectToCentral()
|
||||||
{
|
{
|
||||||
if (tenancy()->initialized) {
|
$this->purgeTenantConnection();
|
||||||
$this->database->purge('tenant');
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->setDefaultConnection($this->config->get('tenancy.database.central_connection'));
|
$this->setDefaultConnection($this->config->get('tenancy.database.central_connection'));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -60,7 +59,7 @@ class DatabaseManager
|
||||||
*/
|
*/
|
||||||
public function setDefaultConnection(string $connection)
|
public function setDefaultConnection(string $connection)
|
||||||
{
|
{
|
||||||
$this->app['config']['database.default'] = $connection;
|
$this->config['database.default'] = $connection;
|
||||||
$this->database->setDefaultConnection($connection);
|
$this->database->setDefaultConnection($connection);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -69,7 +68,19 @@ class DatabaseManager
|
||||||
*/
|
*/
|
||||||
public function createTenantConnection(TenantWithDatabase $tenant)
|
public function createTenantConnection(TenantWithDatabase $tenant)
|
||||||
{
|
{
|
||||||
$this->app['config']['database.connections.tenant'] = $tenant->database()->connection();
|
$this->config['database.connections.tenant'] = $tenant->database()->connection();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Purge the tenant database connection.
|
||||||
|
*/
|
||||||
|
public function purgeTenantConnection()
|
||||||
|
{
|
||||||
|
if (array_key_exists('tenant', $this->database->getConnections())) {
|
||||||
|
$this->database->purge('tenant');
|
||||||
|
}
|
||||||
|
|
||||||
|
unset($this->config['database.connections.tenant']);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -81,8 +92,14 @@ class DatabaseManager
|
||||||
*/
|
*/
|
||||||
public function ensureTenantCanBeCreated(TenantWithDatabase $tenant): void
|
public function ensureTenantCanBeCreated(TenantWithDatabase $tenant): void
|
||||||
{
|
{
|
||||||
if ($tenant->database()->manager()->databaseExists($database = $tenant->database()->getName())) {
|
$manager = $tenant->database()->manager();
|
||||||
|
|
||||||
|
if ($manager->databaseExists($database = $tenant->database()->getName())) {
|
||||||
throw new TenantDatabaseAlreadyExistsException($database);
|
throw new TenantDatabaseAlreadyExistsException($database);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ($manager instanceof ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
|
||||||
|
throw new TenantDatabaseUserAlreadyExistsException($username);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -22,10 +22,15 @@ class ImpersonationToken extends Model
|
||||||
use CentralConnection;
|
use CentralConnection;
|
||||||
|
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
public $timestamps = false;
|
public $timestamps = false;
|
||||||
|
|
||||||
protected $primaryKey = 'token';
|
protected $primaryKey = 'token';
|
||||||
|
|
||||||
public $incrementing = false;
|
public $incrementing = false;
|
||||||
|
|
||||||
protected $table = 'tenant_user_impersonation_tokens';
|
protected $table = 'tenant_user_impersonation_tokens';
|
||||||
|
|
||||||
protected $dates = [
|
protected $dates = [
|
||||||
'created_at',
|
'created_at',
|
||||||
];
|
];
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,9 @@ class Tenant extends Model implements Contracts\Tenant
|
||||||
Concerns\InvalidatesResolverCache;
|
Concerns\InvalidatesResolverCache;
|
||||||
|
|
||||||
protected $table = 'tenants';
|
protected $table = 'tenants';
|
||||||
|
|
||||||
protected $primaryKey = 'id';
|
protected $primaryKey = 'id';
|
||||||
|
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
public function getTenantKeyName(): string
|
public function getTenantKeyName(): string
|
||||||
|
|
|
||||||
|
|
@ -80,8 +80,6 @@ class DatabaseConfig
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generate DB name, username & password and write them to the tenant model.
|
* Generate DB name, username & password and write them to the tenant model.
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function makeCredentials(): void
|
public function makeCredentials(): void
|
||||||
{
|
{
|
||||||
|
|
@ -113,7 +111,8 @@ class DatabaseConfig
|
||||||
$templateConnection = config("database.connections.{$template}");
|
$templateConnection = config("database.connections.{$template}");
|
||||||
|
|
||||||
return $this->manager()->makeConnectionConfig(
|
return $this->manager()->makeConnectionConfig(
|
||||||
array_merge($templateConnection, $this->tenantConfig()), $this->getName()
|
array_merge($templateConnection, $this->tenantConfig()),
|
||||||
|
$this->getName()
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,6 @@ class ModelNotSyncMasterException extends Exception
|
||||||
{
|
{
|
||||||
public function __construct(string $class)
|
public function __construct(string $class)
|
||||||
{
|
{
|
||||||
parent::__construct("Model of $class class is not an SyncMaster model. Make sure you're using the central model to make changes to synced resouces when you're in the central context");
|
parent::__construct("Model of $class class is not an SyncMaster model. Make sure you're using the central model to make changes to synced resources when you're in the central context");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ use Facade\IgnitionContracts\ProvidesSolution;
|
||||||
use Facade\IgnitionContracts\Solution;
|
use Facade\IgnitionContracts\Solution;
|
||||||
use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
|
use Stancl\Tenancy\Contracts\TenantCouldNotBeIdentifiedException;
|
||||||
|
|
||||||
// todo: in v3 this should be suffixed with Exception
|
// todo: in v4 this should be suffixed with Exception
|
||||||
class TenantCouldNotBeIdentifiedById extends TenantCouldNotBeIdentifiedException implements ProvidesSolution
|
class TenantCouldNotBeIdentifiedById extends TenantCouldNotBeIdentifiedException implements ProvidesSolution
|
||||||
{
|
{
|
||||||
public function __construct($tenant_id)
|
public function __construct($tenant_id)
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,7 @@ class UniversalRoutes implements Feature
|
||||||
}
|
}
|
||||||
|
|
||||||
// Loop one level deep and check if the route's middleware
|
// Loop one level deep and check if the route's middleware
|
||||||
// groups have the searhced middleware group inside them
|
// groups have the searched middleware group inside them
|
||||||
$middlewareGroups = Router::getMiddlewareGroups();
|
$middlewareGroups = Router::getMiddlewareGroups();
|
||||||
foreach ($route->gatherMiddleware() as $inner) {
|
foreach ($route->gatherMiddleware() as $inner) {
|
||||||
if (! $inner instanceof Closure && isset($middlewareGroups[$inner]) && in_array($middleware, $middlewareGroups[$inner], true)) {
|
if (! $inner instanceof Closure && isset($middlewareGroups[$inner]) && in_array($middleware, $middlewareGroups[$inner], true)) {
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,6 @@ class UserImpersonation implements Feature
|
||||||
*
|
*
|
||||||
* @param string|ImpersonationToken $token
|
* @param string|ImpersonationToken $token
|
||||||
* @param int $ttl
|
* @param int $ttl
|
||||||
* @return RedirectResponse
|
|
||||||
*/
|
*/
|
||||||
public static function makeResponse($token, int $ttl = null): RedirectResponse
|
public static function makeResponse($token, int $ttl = null): RedirectResponse
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -36,8 +36,8 @@ class CreateDatabase implements ShouldQueue
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
$databaseManager->ensureTenantCanBeCreated($this->tenant);
|
|
||||||
$this->tenant->database()->makeCredentials();
|
$this->tenant->database()->makeCredentials();
|
||||||
|
$databaseManager->ensureTenantCanBeCreated($this->tenant);
|
||||||
$this->tenant->database()->manager()->createDatabase($this->tenant);
|
$this->tenant->database()->manager()->createDatabase($this->tenant);
|
||||||
|
|
||||||
event(new DatabaseCreated($this->tenant));
|
event(new DatabaseCreated($this->tenant));
|
||||||
|
|
|
||||||
29
src/Jobs/DeleteDomains.php
Normal file
29
src/Jobs/DeleteDomains.php
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Stancl\Tenancy\Jobs;
|
||||||
|
|
||||||
|
use Illuminate\Bus\Queueable;
|
||||||
|
use Illuminate\Foundation\Bus\Dispatchable;
|
||||||
|
use Illuminate\Queue\InteractsWithQueue;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
use Stancl\Tenancy\Contracts\TenantWithDatabase;
|
||||||
|
|
||||||
|
class DeleteDomains
|
||||||
|
{
|
||||||
|
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
|
||||||
|
|
||||||
|
/** @var TenantWithDatabase */
|
||||||
|
protected $tenant;
|
||||||
|
|
||||||
|
public function __construct(TenantWithDatabase $tenant)
|
||||||
|
{
|
||||||
|
$this->tenant = $tenant;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$this->tenant->domains->each->delete();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -48,8 +48,7 @@ class UpdateSyncedResource extends QueueableListener
|
||||||
protected function updateResourceInCentralDatabaseAndGetTenants($event, $syncedAttributes)
|
protected function updateResourceInCentralDatabaseAndGetTenants($event, $syncedAttributes)
|
||||||
{
|
{
|
||||||
/** @var Model|SyncMaster $centralModel */
|
/** @var Model|SyncMaster $centralModel */
|
||||||
$centralModel = $event->model->getCentralModelName()
|
$centralModel = $event->model->getCentralModelName()::where($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey())
|
||||||
::where($event->model->getGlobalIdentifierKeyName(), $event->model->getGlobalIdentifierKey())
|
|
||||||
->first();
|
->first();
|
||||||
|
|
||||||
// We disable events for this call, to avoid triggering this event & listener again.
|
// We disable events for this call, to avoid triggering this event & listener again.
|
||||||
|
|
|
||||||
|
|
@ -5,10 +5,10 @@ declare(strict_types=1);
|
||||||
namespace Stancl\Tenancy\Middleware;
|
namespace Stancl\Tenancy\Middleware;
|
||||||
|
|
||||||
use Closure;
|
use Closure;
|
||||||
use Illuminate\Foundation\Http\Exceptions\MaintenanceModeException;
|
|
||||||
use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode;
|
use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode;
|
||||||
use Stancl\Tenancy\Exceptions\TenancyNotInitializedException;
|
use Stancl\Tenancy\Exceptions\TenancyNotInitializedException;
|
||||||
use Symfony\Component\HttpFoundation\IpUtils;
|
use Symfony\Component\HttpFoundation\IpUtils;
|
||||||
|
use Symfony\Component\HttpKernel\Exception\HttpException;
|
||||||
|
|
||||||
class CheckTenantForMaintenanceMode extends CheckForMaintenanceMode
|
class CheckTenantForMaintenanceMode extends CheckForMaintenanceMode
|
||||||
{
|
{
|
||||||
|
|
@ -29,7 +29,12 @@ class CheckTenantForMaintenanceMode extends CheckForMaintenanceMode
|
||||||
return $next($request);
|
return $next($request);
|
||||||
}
|
}
|
||||||
|
|
||||||
throw new MaintenanceModeException($data['time'], $data['retry'], $data['message']);
|
throw new HttpException(
|
||||||
|
503,
|
||||||
|
'Service Unavailable',
|
||||||
|
null,
|
||||||
|
isset($data['retry']) ? ['Retry-After' => $data['retry']] : []
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
return $next($request);
|
return $next($request);
|
||||||
|
|
|
||||||
|
|
@ -29,13 +29,13 @@ class InitializeTenancyByDomain extends IdentificationMiddleware
|
||||||
* Handle an incoming request.
|
* Handle an incoming request.
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Http\Request $request
|
* @param \Illuminate\Http\Request $request
|
||||||
* @param \Closure $next
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle($request, Closure $next)
|
public function handle($request, Closure $next)
|
||||||
{
|
{
|
||||||
return $this->initializeTenancy(
|
return $this->initializeTenancy(
|
||||||
$request, $next, $request->getHost()
|
$request,
|
||||||
|
$next,
|
||||||
|
$request->getHost()
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -13,8 +13,6 @@ class InitializeTenancyByDomainOrSubdomain
|
||||||
* Handle an incoming request.
|
* Handle an incoming request.
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Http\Request $request
|
* @param \Illuminate\Http\Request $request
|
||||||
* @param \Closure $next
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle($request, Closure $next)
|
public function handle($request, Closure $next)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -38,7 +38,9 @@ class InitializeTenancyByPath extends IdentificationMiddleware
|
||||||
// simply injected into some route controller action.
|
// simply injected into some route controller action.
|
||||||
if ($route->parameterNames()[0] === PathTenantResolver::$tenantParameterName) {
|
if ($route->parameterNames()[0] === PathTenantResolver::$tenantParameterName) {
|
||||||
return $this->initializeTenancy(
|
return $this->initializeTenancy(
|
||||||
$request, $next, $route
|
$request,
|
||||||
|
$next,
|
||||||
|
$route
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
throw new RouteIsMissingTenantParameterException;
|
throw new RouteIsMissingTenantParameterException;
|
||||||
|
|
|
||||||
|
|
@ -36,8 +36,6 @@ class InitializeTenancyByRequestData extends IdentificationMiddleware
|
||||||
* Handle an incoming request.
|
* Handle an incoming request.
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Http\Request $request
|
* @param \Illuminate\Http\Request $request
|
||||||
* @param \Closure $next
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle($request, Closure $next)
|
public function handle($request, Closure $next)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -28,8 +28,6 @@ class InitializeTenancyBySubdomain extends InitializeTenancyByDomain
|
||||||
* Handle an incoming request.
|
* Handle an incoming request.
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Http\Request $request
|
* @param \Illuminate\Http\Request $request
|
||||||
* @param \Closure $next
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function handle($request, Closure $next)
|
public function handle($request, Closure $next)
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -75,7 +75,6 @@ abstract class CachedTenantResolver implements TenantResolver
|
||||||
/**
|
/**
|
||||||
* Get all the arg combinations for resolve() that can be used to find this tenant.
|
* Get all the arg combinations for resolve() that can be used to find this tenant.
|
||||||
*
|
*
|
||||||
* @param Tenant $tenant
|
|
||||||
* @return array[]
|
* @return array[]
|
||||||
*/
|
*/
|
||||||
abstract public function getArgsForTenant(Tenant $tenant): array;
|
abstract public function getArgsForTenant(Tenant $tenant): array;
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,6 @@ class Tenancy
|
||||||
/**
|
/**
|
||||||
* Initializes the tenant.
|
* Initializes the tenant.
|
||||||
* @param Tenant|int|string $tenant
|
* @param Tenant|int|string $tenant
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function initialize($tenant): void
|
public function initialize($tenant): void
|
||||||
{
|
{
|
||||||
|
|
@ -66,10 +65,10 @@ class Tenancy
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->initialized = false;
|
|
||||||
|
|
||||||
event(new Events\TenancyEnded($this));
|
event(new Events\TenancyEnded($this));
|
||||||
|
|
||||||
|
$this->initialized = false;
|
||||||
|
|
||||||
$this->tenant = null;
|
$this->tenant = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -106,9 +105,6 @@ class Tenancy
|
||||||
/**
|
/**
|
||||||
* Run a callback in the central context.
|
* Run a callback in the central context.
|
||||||
* Atomic, safely reverts to previous context.
|
* Atomic, safely reverts to previous context.
|
||||||
*
|
|
||||||
* @param callable $callback
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function central(callable $callback)
|
public function central(callable $callback)
|
||||||
{
|
{
|
||||||
|
|
@ -132,7 +128,6 @@ class Tenancy
|
||||||
* More performant than running $tenant->run() one by one.
|
* More performant than running $tenant->run() one by one.
|
||||||
*
|
*
|
||||||
* @param Tenant[]|\Traversable|string[]|null $tenants
|
* @param Tenant[]|\Traversable|string[]|null $tenants
|
||||||
* @param callable $callback
|
|
||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
public function runForMultiple($tenants, callable $callback)
|
public function runForMultiple($tenants, callable $callback)
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,7 @@ namespace Stancl\Tenancy;
|
||||||
use Illuminate\Cache\CacheManager;
|
use Illuminate\Cache\CacheManager;
|
||||||
use Illuminate\Support\ServiceProvider;
|
use Illuminate\Support\ServiceProvider;
|
||||||
use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
|
use Stancl\Tenancy\Bootstrappers\FilesystemTenancyBootstrapper;
|
||||||
|
use Stancl\Tenancy\Contracts\Domain;
|
||||||
use Stancl\Tenancy\Contracts\Tenant;
|
use Stancl\Tenancy\Contracts\Tenant;
|
||||||
use Stancl\Tenancy\Resolvers\DomainTenantResolver;
|
use Stancl\Tenancy\Resolvers\DomainTenantResolver;
|
||||||
|
|
||||||
|
|
@ -14,8 +15,6 @@ class TenancyServiceProvider extends ServiceProvider
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Register services.
|
* Register services.
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function register(): void
|
public function register(): void
|
||||||
{
|
{
|
||||||
|
|
@ -75,8 +74,6 @@ class TenancyServiceProvider extends ServiceProvider
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bootstrap services.
|
* Bootstrap services.
|
||||||
*
|
|
||||||
* @return void
|
|
||||||
*/
|
*/
|
||||||
public function boot(): void
|
public function boot(): void
|
||||||
{
|
{
|
||||||
|
|
@ -87,6 +84,7 @@ class TenancyServiceProvider extends ServiceProvider
|
||||||
Commands\Migrate::class,
|
Commands\Migrate::class,
|
||||||
Commands\Rollback::class,
|
Commands\Rollback::class,
|
||||||
Commands\TenantList::class,
|
Commands\TenantList::class,
|
||||||
|
Commands\TenantDump::class,
|
||||||
Commands\MigrateFresh::class,
|
Commands\MigrateFresh::class,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
|
|
||||||
57
src/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php
Normal file
57
src/TenantDatabaseManagers/MicrosoftSQLDatabaseManager.php
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Stancl\Tenancy\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;
|
||||||
|
|
||||||
|
class MicrosoftSQLDatabaseManager implements 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
|
||||||
|
{
|
||||||
|
$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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -7,7 +7,6 @@ namespace Stancl\Tenancy\TenantDatabaseManagers;
|
||||||
use Stancl\Tenancy\Concerns\CreatesDatabaseUsers;
|
use Stancl\Tenancy\Concerns\CreatesDatabaseUsers;
|
||||||
use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
|
use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
|
||||||
use Stancl\Tenancy\DatabaseConfig;
|
use Stancl\Tenancy\DatabaseConfig;
|
||||||
use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
|
|
||||||
|
|
||||||
class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager implements ManagesDatabaseUsers
|
class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager implements ManagesDatabaseUsers
|
||||||
{
|
{
|
||||||
|
|
@ -26,10 +25,6 @@ class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager impl
|
||||||
$hostname = $databaseConfig->connection()['host'];
|
$hostname = $databaseConfig->connection()['host'];
|
||||||
$password = $databaseConfig->getPassword();
|
$password = $databaseConfig->getPassword();
|
||||||
|
|
||||||
if ($this->userExists($username)) {
|
|
||||||
throw new TenantDatabaseUserAlreadyExistsException($username);
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->database()->statement("CREATE USER `{$username}`@`%` IDENTIFIED BY '{$password}'");
|
$this->database()->statement("CREATE USER `{$username}`@`%` IDENTIFIED BY '{$password}'");
|
||||||
|
|
||||||
$grants = implode(', ', static::$grants);
|
$grants = implode(', ', static::$grants);
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,11 @@ class PostgreSQLSchemaManager implements TenantDatabaseManager
|
||||||
|
|
||||||
public function makeConnectionConfig(array $baseConfig, string $databaseName): array
|
public function makeConnectionConfig(array $baseConfig, string $databaseName): array
|
||||||
{
|
{
|
||||||
|
if (version_compare(app()->version(), '9.0', '>=')) {
|
||||||
|
$baseConfig['search_path'] = $databaseName;
|
||||||
|
} else {
|
||||||
$baseConfig['schema'] = $databaseName;
|
$baseConfig['schema'] = $databaseName;
|
||||||
|
}
|
||||||
|
|
||||||
return $baseConfig;
|
return $baseConfig;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,11 +4,15 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace Stancl\Tenancy\Tests;
|
namespace Stancl\Tenancy\Tests;
|
||||||
|
|
||||||
|
use Illuminate\Filesystem\FilesystemAdapter;
|
||||||
use Illuminate\Support\Facades\Cache;
|
use Illuminate\Support\Facades\Cache;
|
||||||
use Illuminate\Support\Facades\DB;
|
use Illuminate\Support\Facades\DB;
|
||||||
use Illuminate\Support\Facades\Event;
|
use Illuminate\Support\Facades\Event;
|
||||||
use Illuminate\Support\Facades\Redis;
|
use Illuminate\Support\Facades\Redis;
|
||||||
use Illuminate\Support\Facades\Storage;
|
use Illuminate\Support\Facades\Storage;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
use ReflectionObject;
|
||||||
|
use ReflectionProperty;
|
||||||
use Stancl\JobPipeline\JobPipeline;
|
use Stancl\JobPipeline\JobPipeline;
|
||||||
use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper;
|
use Stancl\Tenancy\Bootstrappers\CacheTenancyBootstrapper;
|
||||||
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
||||||
|
|
@ -165,6 +169,7 @@ class BootstrapperTest extends TestCase
|
||||||
$tenant2 = Tenant::create();
|
$tenant2 = Tenant::create();
|
||||||
|
|
||||||
tenancy()->initialize($tenant1);
|
tenancy()->initialize($tenant1);
|
||||||
|
|
||||||
Storage::disk('public')->put('foo', 'bar');
|
Storage::disk('public')->put('foo', 'bar');
|
||||||
$this->assertSame('bar', Storage::disk('public')->get('foo'));
|
$this->assertSame('bar', Storage::disk('public')->get('foo'));
|
||||||
|
|
||||||
|
|
@ -184,30 +189,38 @@ class BootstrapperTest extends TestCase
|
||||||
$this->assertFalse(Storage::disk('public')->exists('foo'));
|
$this->assertFalse(Storage::disk('public')->exists('foo'));
|
||||||
$this->assertFalse(Storage::disk('public')->exists('abc'));
|
$this->assertFalse(Storage::disk('public')->exists('abc'));
|
||||||
|
|
||||||
|
$expected_storage_path = $old_storage_path . '/tenant' . tenant('id'); // /tenant = suffix base
|
||||||
|
|
||||||
|
// Check that disk prefixes respect the root_override logic
|
||||||
|
$this->assertSame($expected_storage_path . '/app/', $this->getDiskPrefix('local'));
|
||||||
|
$this->assertSame($expected_storage_path . '/app/public/', $this->getDiskPrefix('public'));
|
||||||
|
$this->assertSame('tenant' . tenant('id') . '/', $this->getDiskPrefix('s3'), '/');
|
||||||
|
|
||||||
// Check suffixing logic
|
// Check suffixing logic
|
||||||
$new_storage_path = storage_path();
|
$new_storage_path = storage_path();
|
||||||
$this->assertEquals($old_storage_path . '/' . config('tenancy.filesystem.suffix_base') . tenant('id'), $new_storage_path);
|
$this->assertEquals($expected_storage_path, $new_storage_path);
|
||||||
|
|
||||||
foreach (config('tenancy.filesystem.disks') as $disk) {
|
|
||||||
$suffix = config('tenancy.filesystem.suffix_base') . tenant('id');
|
|
||||||
|
|
||||||
/** @var FilesystemAdapter $filesystemDisk */
|
|
||||||
$filesystemDisk = Storage::disk($disk);
|
|
||||||
|
|
||||||
$current_path_prefix = $filesystemDisk->getAdapter()->getPathPrefix();
|
|
||||||
|
|
||||||
if ($override = config("tenancy.filesystem.root_override.{$disk}")) {
|
|
||||||
$correct_path_prefix = str_replace('%storage_path%', storage_path(), $override);
|
|
||||||
} else {
|
|
||||||
if ($base = $old_storage_facade_roots[$disk]) {
|
|
||||||
$correct_path_prefix = $base . "/$suffix/";
|
|
||||||
} else {
|
|
||||||
$correct_path_prefix = "$suffix/";
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->assertSame($correct_path_prefix, $current_path_prefix);
|
protected function getDiskPrefix(string $disk): string
|
||||||
|
{
|
||||||
|
/** @var FilesystemAdapter $disk */
|
||||||
|
$disk = Storage::disk($disk);
|
||||||
|
$adapter = $disk->getAdapter();
|
||||||
|
|
||||||
|
if (! Str::startsWith(app()->version(), '9.')) {
|
||||||
|
return $adapter->getPathPrefix();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$prefixer = (new ReflectionObject($adapter))->getProperty('prefixer');
|
||||||
|
$prefixer->setAccessible(true);
|
||||||
|
|
||||||
|
// reflection -> instance
|
||||||
|
$prefixer = $prefixer->getValue($adapter);
|
||||||
|
|
||||||
|
$prefix = (new ReflectionProperty($prefixer, 'prefix'));
|
||||||
|
$prefix->setAccessible(true);
|
||||||
|
|
||||||
|
return $prefix->getValue($prefixer);
|
||||||
}
|
}
|
||||||
|
|
||||||
// for queues see QueueTest
|
// for queues see QueueTest
|
||||||
|
|
|
||||||
|
|
@ -91,6 +91,38 @@ class CommandsTest extends TestCase
|
||||||
$this->assertTrue(Schema::hasTable('users'));
|
$this->assertTrue(Schema::hasTable('users'));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @test */
|
||||||
|
public function migrate_command_loads_schema_state()
|
||||||
|
{
|
||||||
|
$tenant = Tenant::create();
|
||||||
|
|
||||||
|
$this->assertFalse(Schema::hasTable('schema_users'));
|
||||||
|
$this->assertFalse(Schema::hasTable('users'));
|
||||||
|
|
||||||
|
Artisan::call('tenants:migrate --schema-path="tests/Etc/tenant-schema.dump"');
|
||||||
|
|
||||||
|
$this->assertFalse(Schema::hasTable('schema_users'));
|
||||||
|
$this->assertFalse(Schema::hasTable('users'));
|
||||||
|
|
||||||
|
tenancy()->initialize($tenant);
|
||||||
|
|
||||||
|
// Check for both tables to see if missing migrations also get executed
|
||||||
|
$this->assertTrue(Schema::hasTable('schema_users'));
|
||||||
|
$this->assertTrue(Schema::hasTable('users'));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @test */
|
||||||
|
public function dump_command_works()
|
||||||
|
{
|
||||||
|
$tenant = Tenant::create();
|
||||||
|
Artisan::call('tenants:migrate');
|
||||||
|
|
||||||
|
tenancy()->initialize($tenant);
|
||||||
|
|
||||||
|
Artisan::call('tenants:dump --path="tests/Etc/tenant-schema-test.dump"');
|
||||||
|
$this->assertFileExists('tests/Etc/tenant-schema-test.dump');
|
||||||
|
}
|
||||||
|
|
||||||
/** @test */
|
/** @test */
|
||||||
public function rollback_command_works()
|
public function rollback_command_works()
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,7 @@ use Illuminate\Support\Str;
|
||||||
use Stancl\JobPipeline\JobPipeline;
|
use Stancl\JobPipeline\JobPipeline;
|
||||||
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
||||||
use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
|
use Stancl\Tenancy\Contracts\ManagesDatabaseUsers;
|
||||||
|
use Stancl\Tenancy\Events\DatabaseCreated;
|
||||||
use Stancl\Tenancy\Events\TenancyInitialized;
|
use Stancl\Tenancy\Events\TenancyInitialized;
|
||||||
use Stancl\Tenancy\Events\TenantCreated;
|
use Stancl\Tenancy\Events\TenantCreated;
|
||||||
use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
|
use Stancl\Tenancy\Exceptions\TenantDatabaseUserAlreadyExistsException;
|
||||||
|
|
@ -67,14 +68,18 @@ class DatabaseUsersTest extends TestCase
|
||||||
$this->assertTrue($manager->databaseExists($tenant->database()->getName()));
|
$this->assertTrue($manager->databaseExists($tenant->database()->getName()));
|
||||||
|
|
||||||
$this->expectException(TenantDatabaseUserAlreadyExistsException::class);
|
$this->expectException(TenantDatabaseUserAlreadyExistsException::class);
|
||||||
|
Event::fake([DatabaseCreated::class]);
|
||||||
|
|
||||||
$tenant2 = Tenant::create([
|
$tenant2 = Tenant::create([
|
||||||
'tenancy_db_username' => $username,
|
'tenancy_db_username' => $username,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
/** @var ManagesDatabaseUsers $manager */
|
/** @var ManagesDatabaseUsers $manager */
|
||||||
$manager = $tenant2->database()->manager();
|
$manager2 = $tenant2->database()->manager();
|
||||||
|
|
||||||
// database was not created because of DB transaction
|
// database was not created because of DB transaction
|
||||||
$this->assertFalse($manager->databaseExists($tenant2->database()->getName()));
|
$this->assertFalse($manager2->databaseExists($tenant2->database()->getName()));
|
||||||
|
Event::assertNotDispatched(DatabaseCreated::class);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @test */
|
/** @test */
|
||||||
|
|
|
||||||
42
tests/DeleteDomainsJobTest.php
Normal file
42
tests/DeleteDomainsJobTest.php
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Stancl\Tenancy\Tests;
|
||||||
|
|
||||||
|
use Stancl\Tenancy\Database\Concerns\HasDomains;
|
||||||
|
use Stancl\Tenancy\Jobs\DeleteDomains;
|
||||||
|
|
||||||
|
class DeleteDomainsJobTest extends TestCase
|
||||||
|
{
|
||||||
|
public function setUp(): void
|
||||||
|
{
|
||||||
|
parent::setUp();
|
||||||
|
|
||||||
|
config(['tenancy.tenant_model' => DatabaseAndDomainTenant::class]);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @test */
|
||||||
|
public function job_delete_domains_successfully()
|
||||||
|
{
|
||||||
|
$tenant = DatabaseAndDomainTenant::create();
|
||||||
|
|
||||||
|
$tenant->domains()->create([
|
||||||
|
'domain' => 'foo.localhost',
|
||||||
|
]);
|
||||||
|
$tenant->domains()->create([
|
||||||
|
'domain' => 'bar.localhost',
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame($tenant->domains()->count(), 2);
|
||||||
|
|
||||||
|
(new DeleteDomains($tenant))->handle();
|
||||||
|
|
||||||
|
$this->assertSame($tenant->refresh()->domains()->count(), 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class DatabaseAndDomainTenant extends Etc\Tenant
|
||||||
|
{
|
||||||
|
use HasDomains;
|
||||||
|
}
|
||||||
|
|
@ -4,15 +4,10 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace Stancl\Tenancy\Tests\Etc;
|
namespace Stancl\Tenancy\Tests\Etc;
|
||||||
|
|
||||||
use Orchestra\Testbench\Console\Kernel;
|
use Orchestra\Testbench\Foundation\Console\Kernel;
|
||||||
|
|
||||||
class ConsoleKernel extends Kernel
|
class ConsoleKernel extends Kernel
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* The Artisan commands provided by your application.
|
|
||||||
*
|
|
||||||
* @var array
|
|
||||||
*/
|
|
||||||
protected $commands = [
|
protected $commands = [
|
||||||
ExampleCommand::class,
|
ExampleCommand::class,
|
||||||
AddUserCommand::class,
|
AddUserCommand::class,
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ class ExampleSeeder extends Seeder
|
||||||
{
|
{
|
||||||
DB::table('users')->insert([
|
DB::table('users')->insert([
|
||||||
'name' => Str::random(10),
|
'name' => Str::random(10),
|
||||||
'email' => Str::random(10).'@gmail.com',
|
'email' => Str::random(10) . '@gmail.com',
|
||||||
'password' => bcrypt('password'),
|
'password' => bcrypt('password'),
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
66
tests/Etc/tenant-schema.dump
Normal file
66
tests/Etc/tenant-schema.dump
Normal file
|
|
@ -0,0 +1,66 @@
|
||||||
|
/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
|
||||||
|
/*!40103 SET TIME_ZONE='+00:00' */;
|
||||||
|
/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
|
||||||
|
/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
|
||||||
|
/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
|
||||||
|
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
|
||||||
|
DROP TABLE IF EXISTS `failed_jobs`;
|
||||||
|
/*!40101 SET @saved_cs_client = @@character_set_client */;
|
||||||
|
/*!40101 SET character_set_client = utf8 */;
|
||||||
|
CREATE TABLE `failed_jobs` (
|
||||||
|
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
|
||||||
|
`uuid` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`connection` text COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`queue` text COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`payload` longtext COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`exception` longtext COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`failed_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
PRIMARY KEY (`id`),
|
||||||
|
UNIQUE KEY `failed_jobs_uuid_unique` (`uuid`)
|
||||||
|
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
|
||||||
|
/*!40101 SET character_set_client = @saved_cs_client */;
|
||||||
|
DROP TABLE IF EXISTS `migrations`;
|
||||||
|
/*!40101 SET @saved_cs_client = @@character_set_client */;
|
||||||
|
/*!40101 SET character_set_client = utf8 */;
|
||||||
|
CREATE TABLE `migrations` (
|
||||||
|
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
|
||||||
|
`migration` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`batch` int(11) NOT NULL,
|
||||||
|
PRIMARY KEY (`id`)
|
||||||
|
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
|
||||||
|
/*!40101 SET character_set_client = @saved_cs_client */;
|
||||||
|
DROP TABLE IF EXISTS `password_resets`;
|
||||||
|
/*!40101 SET @saved_cs_client = @@character_set_client */;
|
||||||
|
/*!40101 SET character_set_client = utf8 */;
|
||||||
|
CREATE TABLE `password_resets` (
|
||||||
|
`email` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`token` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`created_at` timestamp NULL DEFAULT NULL,
|
||||||
|
KEY `password_resets_email_index` (`email`)
|
||||||
|
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
|
||||||
|
/*!40101 SET character_set_client = @saved_cs_client */;
|
||||||
|
DROP TABLE IF EXISTS `users`;
|
||||||
|
/*!40101 SET @saved_cs_client = @@character_set_client */;
|
||||||
|
/*!40101 SET character_set_client = utf8 */;
|
||||||
|
CREATE TABLE `schema_users` (
|
||||||
|
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
|
||||||
|
`name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`email` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`email_verified_at` timestamp NULL DEFAULT NULL,
|
||||||
|
`password` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
|
||||||
|
`remember_token` varchar(100) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
|
||||||
|
`created_at` timestamp NULL DEFAULT NULL,
|
||||||
|
`updated_at` timestamp NULL DEFAULT NULL,
|
||||||
|
PRIMARY KEY (`id`),
|
||||||
|
UNIQUE KEY `users_email_unique` (`email`)
|
||||||
|
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
|
||||||
|
/*!40101 SET character_set_client = @saved_cs_client */;
|
||||||
|
/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
|
||||||
|
|
||||||
|
/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
|
||||||
|
/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
|
||||||
|
/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
|
||||||
|
/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
|
||||||
|
|
||||||
|
INSERT INTO `migrations` VALUES (2,'2014_10_12_100000_testbench_create_password_resets_table',1);
|
||||||
|
INSERT INTO `migrations` VALUES (3,'2019_08_19_000000_testbench_create_failed_jobs_table',1);
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
{"tenant_id":"The current tenant id is: acme"}
|
|
||||||
|
|
@ -20,7 +20,6 @@ use Stancl\Tenancy\Jobs\CreateDatabase;
|
||||||
use Stancl\Tenancy\Jobs\MigrateDatabase;
|
use Stancl\Tenancy\Jobs\MigrateDatabase;
|
||||||
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
||||||
use Stancl\Tenancy\Listeners\QueueableListener;
|
use Stancl\Tenancy\Listeners\QueueableListener;
|
||||||
use Stancl\Tenancy\Tenancy;
|
|
||||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||||
|
|
||||||
class EventListenerTest extends TestCase
|
class EventListenerTest extends TestCase
|
||||||
|
|
|
||||||
|
|
@ -4,12 +4,12 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace Stancl\Tenancy\Tests;
|
namespace Stancl\Tenancy\Tests;
|
||||||
|
|
||||||
use Illuminate\Foundation\Http\Exceptions\MaintenanceModeException;
|
|
||||||
use Illuminate\Support\Facades\Route;
|
use Illuminate\Support\Facades\Route;
|
||||||
use Stancl\Tenancy\Database\Concerns\MaintenanceMode;
|
use Stancl\Tenancy\Database\Concerns\MaintenanceMode;
|
||||||
use Stancl\Tenancy\Middleware\CheckTenantForMaintenanceMode;
|
use Stancl\Tenancy\Middleware\CheckTenantForMaintenanceMode;
|
||||||
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
use Stancl\Tenancy\Middleware\InitializeTenancyByDomain;
|
||||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||||
|
use Symfony\Component\HttpKernel\Exception\HttpException;
|
||||||
|
|
||||||
class MaintenanceModeTest extends TestCase
|
class MaintenanceModeTest extends TestCase
|
||||||
{
|
{
|
||||||
|
|
@ -32,7 +32,7 @@ class MaintenanceModeTest extends TestCase
|
||||||
|
|
||||||
$tenant->putDownForMaintenance();
|
$tenant->putDownForMaintenance();
|
||||||
|
|
||||||
$this->expectException(MaintenanceModeException::class);
|
$this->expectException(HttpException::class);
|
||||||
$this->withoutExceptionHandling()
|
$this->withoutExceptionHandling()
|
||||||
->get('http://acme.localhost/foo');
|
->get('http://acme.localhost/foo');
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,18 +4,31 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace Stancl\Tenancy\Tests;
|
namespace Stancl\Tenancy\Tests;
|
||||||
|
|
||||||
|
use Exception;
|
||||||
use Illuminate\Bus\Queueable;
|
use Illuminate\Bus\Queueable;
|
||||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
use Illuminate\Foundation\Bus\Dispatchable;
|
use Illuminate\Foundation\Bus\Dispatchable;
|
||||||
|
use Illuminate\Queue\Events\JobProcessed;
|
||||||
use Illuminate\Queue\Events\JobProcessing;
|
use Illuminate\Queue\Events\JobProcessing;
|
||||||
use Illuminate\Queue\InteractsWithQueue;
|
use Illuminate\Queue\InteractsWithQueue;
|
||||||
use Illuminate\Queue\SerializesModels;
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
use Illuminate\Support\Facades\Event;
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
use Spatie\Valuestore\Valuestore;
|
use Spatie\Valuestore\Valuestore;
|
||||||
|
use Stancl\JobPipeline\JobPipeline;
|
||||||
|
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
||||||
use Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper;
|
use Stancl\Tenancy\Bootstrappers\QueueTenancyBootstrapper;
|
||||||
|
use Stancl\Tenancy\Events\TenancyEnded;
|
||||||
use Stancl\Tenancy\Events\TenancyInitialized;
|
use Stancl\Tenancy\Events\TenancyInitialized;
|
||||||
|
use Stancl\Tenancy\Events\TenantCreated;
|
||||||
|
use Stancl\Tenancy\Jobs\CreateDatabase;
|
||||||
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
||||||
|
use Stancl\Tenancy\Listeners\RevertToCentralContext;
|
||||||
use Stancl\Tenancy\Tests\Etc\Tenant;
|
use Stancl\Tenancy\Tests\Etc\Tenant;
|
||||||
|
use Stancl\Tenancy\Tests\Etc\User;
|
||||||
|
|
||||||
class QueueTest extends TestCase
|
class QueueTest extends TestCase
|
||||||
{
|
{
|
||||||
|
|
@ -31,13 +44,68 @@ class QueueTest extends TestCase
|
||||||
config([
|
config([
|
||||||
'tenancy.bootstrappers' => [
|
'tenancy.bootstrappers' => [
|
||||||
QueueTenancyBootstrapper::class,
|
QueueTenancyBootstrapper::class,
|
||||||
|
DatabaseTenancyBootstrapper::class,
|
||||||
],
|
],
|
||||||
'queue.default' => 'redis',
|
'queue.default' => 'redis',
|
||||||
]);
|
]);
|
||||||
|
|
||||||
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
||||||
|
Event::listen(TenancyEnded::class, RevertToCentralContext::class);
|
||||||
|
|
||||||
$this->valuestore = Valuestore::make(__DIR__ . '/Etc/tmp/queuetest.json')->flush();
|
$this->createValueStore();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function tearDown(): void
|
||||||
|
{
|
||||||
|
$this->valuestore->flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function createValueStore(): void
|
||||||
|
{
|
||||||
|
$valueStorePath = __DIR__ . '/Etc/tmp/queuetest.json';
|
||||||
|
|
||||||
|
if (! file_exists($valueStorePath)) {
|
||||||
|
// The directory sometimes goes missing as well when the file is deleted in git
|
||||||
|
if (! is_dir(__DIR__ . '/Etc/tmp')) {
|
||||||
|
mkdir(__DIR__ . '/Etc/tmp');
|
||||||
|
}
|
||||||
|
|
||||||
|
file_put_contents($valueStorePath, '');
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->valuestore = Valuestore::make($valueStorePath)->flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function withFailedJobs()
|
||||||
|
{
|
||||||
|
Schema::connection('central')->create('failed_jobs', function (Blueprint $table) {
|
||||||
|
$table->increments('id');
|
||||||
|
$table->string('uuid')->unique();
|
||||||
|
$table->text('connection');
|
||||||
|
$table->text('queue');
|
||||||
|
$table->longText('payload');
|
||||||
|
$table->longText('exception');
|
||||||
|
$table->timestamp('failed_at')->useCurrent();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function withUsers()
|
||||||
|
{
|
||||||
|
Schema::create('users', function (Blueprint $table) {
|
||||||
|
$table->increments('id');
|
||||||
|
$table->string('name');
|
||||||
|
$table->string('email')->unique();
|
||||||
|
$table->string('password');
|
||||||
|
$table->rememberToken();
|
||||||
|
$table->timestamps();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function withTenantDatabases()
|
||||||
|
{
|
||||||
|
Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
|
||||||
|
return $event->tenant;
|
||||||
|
})->toListener());
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @test */
|
/** @test */
|
||||||
|
|
@ -49,7 +117,7 @@ class QueueTest extends TestCase
|
||||||
|
|
||||||
tenancy()->initialize($tenant);
|
tenancy()->initialize($tenant);
|
||||||
|
|
||||||
Event::fake([JobProcessing::class]);
|
Event::fake([JobProcessing::class, JobProcessed::class]);
|
||||||
|
|
||||||
dispatch(new TestJob($this->valuestore));
|
dispatch(new TestJob($this->valuestore));
|
||||||
|
|
||||||
|
|
@ -79,21 +147,95 @@ class QueueTest extends TestCase
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @test */
|
/**
|
||||||
public function tenancy_is_initialized_inside_queues()
|
* @test
|
||||||
|
*
|
||||||
|
* @testWith [true]
|
||||||
|
* [false]
|
||||||
|
*/
|
||||||
|
public function tenancy_is_initialized_inside_queues(bool $shouldEndTenancy)
|
||||||
{
|
{
|
||||||
$tenant = Tenant::create([
|
$this->withTenantDatabases();
|
||||||
'id' => 'acme',
|
$this->withFailedJobs();
|
||||||
]);
|
|
||||||
|
$tenant = Tenant::create();
|
||||||
|
|
||||||
tenancy()->initialize($tenant);
|
tenancy()->initialize($tenant);
|
||||||
|
|
||||||
dispatch(new TestJob($this->valuestore));
|
$this->withUsers();
|
||||||
|
|
||||||
|
$user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
|
||||||
|
|
||||||
|
$this->valuestore->put('userName', 'Bar');
|
||||||
|
|
||||||
|
dispatch(new TestJob($this->valuestore, $user));
|
||||||
|
|
||||||
$this->assertFalse($this->valuestore->has('tenant_id'));
|
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||||
|
|
||||||
|
if ($shouldEndTenancy) {
|
||||||
|
tenancy()->end();
|
||||||
|
}
|
||||||
|
|
||||||
$this->artisan('queue:work --once');
|
$this->artisan('queue:work --once');
|
||||||
|
|
||||||
$this->assertSame('The current tenant id is: acme', $this->valuestore->get('tenant_id'));
|
$this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
|
||||||
|
|
||||||
|
$this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id'));
|
||||||
|
|
||||||
|
$tenant->run(function () use ($user) {
|
||||||
|
$this->assertSame('Bar', $user->fresh()->name);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @test
|
||||||
|
*
|
||||||
|
* @testWith [true]
|
||||||
|
* [false]
|
||||||
|
*/
|
||||||
|
public function tenancy_is_initialized_when_retrying_jobs(bool $shouldEndTenancy)
|
||||||
|
{
|
||||||
|
if (! Str::startsWith(app()->version(), '8')) {
|
||||||
|
$this->markTestSkipped('queue:retry tenancy is only supported in Laravel 8');
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->withFailedJobs();
|
||||||
|
$this->withTenantDatabases();
|
||||||
|
|
||||||
|
$tenant = Tenant::create();
|
||||||
|
|
||||||
|
tenancy()->initialize($tenant);
|
||||||
|
|
||||||
|
$this->withUsers();
|
||||||
|
|
||||||
|
$user = User::create(['name' => 'Foo', 'email' => 'foo@bar.com', 'password' => 'secret']);
|
||||||
|
|
||||||
|
$this->valuestore->put('userName', 'Bar');
|
||||||
|
$this->valuestore->put('shouldFail', true);
|
||||||
|
|
||||||
|
dispatch(new TestJob($this->valuestore, $user));
|
||||||
|
|
||||||
|
$this->assertFalse($this->valuestore->has('tenant_id'));
|
||||||
|
|
||||||
|
if ($shouldEndTenancy) {
|
||||||
|
tenancy()->end();
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->artisan('queue:work --once');
|
||||||
|
|
||||||
|
$this->assertSame(1, DB::connection('central')->table('failed_jobs')->count());
|
||||||
|
$this->assertNull($this->valuestore->get('tenant_id')); // job failed
|
||||||
|
|
||||||
|
$this->artisan('queue:retry all');
|
||||||
|
$this->artisan('queue:work --once');
|
||||||
|
|
||||||
|
$this->assertSame(0, DB::connection('central')->table('failed_jobs')->count());
|
||||||
|
|
||||||
|
$this->assertSame('The current tenant id is: ' . $tenant->id, $this->valuestore->get('tenant_id')); // job succeeded
|
||||||
|
|
||||||
|
$tenant->run(function () use ($user) {
|
||||||
|
$this->assertSame('Bar', $user->fresh()->name);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @test */
|
/** @test */
|
||||||
|
|
@ -127,13 +269,31 @@ class TestJob implements ShouldQueue
|
||||||
/** @var Valuestore */
|
/** @var Valuestore */
|
||||||
protected $valuestore;
|
protected $valuestore;
|
||||||
|
|
||||||
public function __construct(Valuestore $valuestore)
|
/** @var User|null */
|
||||||
|
protected $user;
|
||||||
|
|
||||||
|
public function __construct(Valuestore $valuestore, User $user = null)
|
||||||
{
|
{
|
||||||
$this->valuestore = $valuestore;
|
$this->valuestore = $valuestore;
|
||||||
|
$this->user = $user;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function handle()
|
public function handle()
|
||||||
{
|
{
|
||||||
|
if ($this->valuestore->get('shouldFail')) {
|
||||||
|
$this->valuestore->put('shouldFail', false);
|
||||||
|
|
||||||
|
throw new Exception('failing');
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($this->user) {
|
||||||
|
assert($this->user->getConnectionName() === 'tenant');
|
||||||
|
}
|
||||||
|
|
||||||
$this->valuestore->put('tenant_id', 'The current tenant id is: ' . tenant('id'));
|
$this->valuestore->put('tenant_id', 'The current tenant id is: ' . tenant('id'));
|
||||||
|
|
||||||
|
if ($userName = $this->valuestore->get('userName')) {
|
||||||
|
$this->user->update(['name' => $userName]);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -589,7 +589,9 @@ class CentralUser extends Model implements SyncMaster
|
||||||
use ResourceSyncing, CentralConnection;
|
use ResourceSyncing, CentralConnection;
|
||||||
|
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
public $timestamps = false;
|
public $timestamps = false;
|
||||||
|
|
||||||
public $table = 'users';
|
public $table = 'users';
|
||||||
|
|
||||||
public function tenants(): BelongsToMany
|
public function tenants(): BelongsToMany
|
||||||
|
|
@ -633,7 +635,9 @@ class ResourceUser extends Model implements Syncable
|
||||||
use ResourceSyncing;
|
use ResourceSyncing;
|
||||||
|
|
||||||
protected $table = 'users';
|
protected $table = 'users';
|
||||||
|
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
public $timestamps = false;
|
public $timestamps = false;
|
||||||
|
|
||||||
public function getGlobalIdentifierKey()
|
public function getGlobalIdentifierKey()
|
||||||
|
|
|
||||||
|
|
@ -329,6 +329,7 @@ class Post extends Model
|
||||||
use BelongsToTenant;
|
use BelongsToTenant;
|
||||||
|
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
public $timestamps = false;
|
public $timestamps = false;
|
||||||
|
|
||||||
public function comments()
|
public function comments()
|
||||||
|
|
@ -345,6 +346,7 @@ class Post extends Model
|
||||||
class Comment extends Model
|
class Comment extends Model
|
||||||
{
|
{
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
public $timestamps = false;
|
public $timestamps = false;
|
||||||
|
|
||||||
public function post()
|
public function post()
|
||||||
|
|
@ -368,5 +370,6 @@ class ScopedComment extends Comment
|
||||||
class GlobalResource extends Model
|
class GlobalResource extends Model
|
||||||
{
|
{
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
public $timestamps = false;
|
public $timestamps = false;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,17 +4,22 @@ declare(strict_types=1);
|
||||||
|
|
||||||
namespace Stancl\Tenancy\Tests;
|
namespace Stancl\Tenancy\Tests;
|
||||||
|
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
use Illuminate\Support\Facades\Event;
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use PDO;
|
use PDO;
|
||||||
use Stancl\JobPipeline\JobPipeline;
|
use Stancl\JobPipeline\JobPipeline;
|
||||||
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
use Stancl\Tenancy\Bootstrappers\DatabaseTenancyBootstrapper;
|
||||||
use Stancl\Tenancy\Database\DatabaseManager;
|
use Stancl\Tenancy\Database\DatabaseManager;
|
||||||
|
use Stancl\Tenancy\Events\TenancyEnded;
|
||||||
use Stancl\Tenancy\Events\TenancyInitialized;
|
use Stancl\Tenancy\Events\TenancyInitialized;
|
||||||
use Stancl\Tenancy\Events\TenantCreated;
|
use Stancl\Tenancy\Events\TenantCreated;
|
||||||
use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
|
use Stancl\Tenancy\Exceptions\TenantDatabaseAlreadyExistsException;
|
||||||
use Stancl\Tenancy\Jobs\CreateDatabase;
|
use Stancl\Tenancy\Jobs\CreateDatabase;
|
||||||
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
use Stancl\Tenancy\Listeners\BootstrapTenancy;
|
||||||
|
use Stancl\Tenancy\Listeners\RevertToCentralContext;
|
||||||
|
use Stancl\Tenancy\TenantDatabaseManagers\MicrosoftSQLDatabaseManager;
|
||||||
use Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager;
|
use Stancl\Tenancy\TenantDatabaseManagers\MySQLDatabaseManager;
|
||||||
use Stancl\Tenancy\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager;
|
use Stancl\Tenancy\TenantDatabaseManagers\PermissionControlledMySQLDatabaseManager;
|
||||||
use Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager;
|
use Stancl\Tenancy\TenantDatabaseManagers\PostgreSQLDatabaseManager;
|
||||||
|
|
@ -99,9 +104,56 @@ class TenantDatabaseManagerTest extends TestCase
|
||||||
['sqlite', SQLiteDatabaseManager::class],
|
['sqlite', SQLiteDatabaseManager::class],
|
||||||
['pgsql', PostgreSQLDatabaseManager::class],
|
['pgsql', PostgreSQLDatabaseManager::class],
|
||||||
['pgsql', PostgreSQLSchemaManager::class],
|
['pgsql', PostgreSQLSchemaManager::class],
|
||||||
|
['sqlsrv', MicrosoftSQLDatabaseManager::class],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** @test */
|
||||||
|
public function the_tenant_connection_is_fully_removed()
|
||||||
|
{
|
||||||
|
config([
|
||||||
|
'tenancy.boostrappers' => [
|
||||||
|
DatabaseTenancyBootstrapper::class,
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
|
||||||
|
Event::listen(TenantCreated::class, JobPipeline::make([CreateDatabase::class])->send(function (TenantCreated $event) {
|
||||||
|
return $event->tenant;
|
||||||
|
})->toListener());
|
||||||
|
|
||||||
|
Event::listen(TenancyInitialized::class, BootstrapTenancy::class);
|
||||||
|
Event::listen(TenancyEnded::class, RevertToCentralContext::class);
|
||||||
|
|
||||||
|
$tenant = Tenant::create();
|
||||||
|
|
||||||
|
$this->assertSame(['central'], array_keys(app('db')->getConnections()));
|
||||||
|
$this->assertArrayNotHasKey('tenant', config('database.connections'));
|
||||||
|
|
||||||
|
tenancy()->initialize($tenant);
|
||||||
|
|
||||||
|
$this->createUsersTable();
|
||||||
|
|
||||||
|
$this->assertSame(['central', 'tenant'], array_keys(app('db')->getConnections()));
|
||||||
|
$this->assertArrayHasKey('tenant', config('database.connections'));
|
||||||
|
|
||||||
|
tenancy()->end();
|
||||||
|
|
||||||
|
$this->assertSame(['central'], array_keys(app('db')->getConnections()));
|
||||||
|
$this->assertNull(config('database.connections.tenant'));
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function createUsersTable()
|
||||||
|
{
|
||||||
|
Schema::create('users', function (Blueprint $table) {
|
||||||
|
$table->increments('id');
|
||||||
|
$table->string('name');
|
||||||
|
$table->string('email')->unique();
|
||||||
|
$table->string('password');
|
||||||
|
$table->rememberToken();
|
||||||
|
$table->timestamps();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
/** @test */
|
/** @test */
|
||||||
public function db_name_is_prefixed_with_db_path_when_sqlite_is_used()
|
public function db_name_is_prefixed_with_db_path_when_sqlite_is_used()
|
||||||
{
|
{
|
||||||
|
|
@ -144,7 +196,11 @@ class TenantDatabaseManagerTest extends TestCase
|
||||||
]);
|
]);
|
||||||
tenancy()->initialize($tenant);
|
tenancy()->initialize($tenant);
|
||||||
|
|
||||||
$this->assertSame($tenant->database()->getName(), config('database.connections.' . config('database.default') . '.schema'));
|
$schemaConfig = version_compare(app()->version(), '9.0', '>=') ?
|
||||||
|
config('database.connections.' . config('database.default') . '.search_path') :
|
||||||
|
config('database.connections.' . config('database.default') . '.schema');
|
||||||
|
|
||||||
|
$this->assertSame($tenant->database()->getName(), $schemaConfig);
|
||||||
$this->assertSame($originalDatabaseName, config(['database.connections.pgsql.database']));
|
$this->assertSame($originalDatabaseName, config(['database.connections.pgsql.database']));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -217,5 +273,6 @@ class TenantDatabaseManagerTest extends TestCase
|
||||||
/** @test */
|
/** @test */
|
||||||
public function path_used_by_sqlite_manager_can_be_customized()
|
public function path_used_by_sqlite_manager_can_be_customized()
|
||||||
{
|
{
|
||||||
|
$this->markTestIncomplete();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -172,6 +172,7 @@ class MyTenant extends Tenant
|
||||||
class AnotherTenant extends Model implements Contracts\Tenant
|
class AnotherTenant extends Model implements Contracts\Tenant
|
||||||
{
|
{
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
protected $table = 'tenants';
|
protected $table = 'tenants';
|
||||||
|
|
||||||
public function getTenantKeyName(): string
|
public function getTenantKeyName(): string
|
||||||
|
|
|
||||||
|
|
@ -274,11 +274,13 @@ class TenantUserImpersonationTest extends TestCase
|
||||||
class ImpersonationUser extends Authenticable
|
class ImpersonationUser extends Authenticable
|
||||||
{
|
{
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
protected $table = 'users';
|
protected $table = 'users';
|
||||||
}
|
}
|
||||||
|
|
||||||
class AnotherImpersonationUser extends Authenticable
|
class AnotherImpersonationUser extends Authenticable
|
||||||
{
|
{
|
||||||
protected $guarded = [];
|
protected $guarded = [];
|
||||||
|
|
||||||
protected $table = 'users';
|
protected $table = 'users';
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -48,8 +48,12 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
|
||||||
protected function getEnvironmentSetUp($app)
|
protected function getEnvironmentSetUp($app)
|
||||||
{
|
{
|
||||||
if (file_exists(__DIR__ . '/../.env')) {
|
if (file_exists(__DIR__ . '/../.env')) {
|
||||||
|
if (method_exists(\Dotenv\Dotenv::class, 'createImmutable')) {
|
||||||
|
\Dotenv\Dotenv::createImmutable(__DIR__ . '/..')->load();
|
||||||
|
} else {
|
||||||
\Dotenv\Dotenv::create(__DIR__ . '/..')->load();
|
\Dotenv\Dotenv::create(__DIR__ . '/..')->load();
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
$app['config']->set([
|
$app['config']->set([
|
||||||
'database.default' => 'central',
|
'database.default' => 'central',
|
||||||
|
|
@ -77,12 +81,17 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
|
||||||
],
|
],
|
||||||
'database.connections.sqlite.database' => ':memory:',
|
'database.connections.sqlite.database' => ':memory:',
|
||||||
'database.connections.mysql.host' => env('TENANCY_TEST_MYSQL_HOST', '127.0.0.1'),
|
'database.connections.mysql.host' => env('TENANCY_TEST_MYSQL_HOST', '127.0.0.1'),
|
||||||
|
'database.connections.sqlsrv.username' => env('TENANCY_TEST_SQLSRV_USERNAME', 'sa'),
|
||||||
|
'database.connections.sqlsrv.password' => env('TENANCY_TEST_SQLSRV_PASSWORD', 'P@ssword'),
|
||||||
|
'database.connections.sqlsrv.host' => env('TENANCY_TEST_SQLSRV_HOST', '127.0.0.1'),
|
||||||
|
'database.connections.sqlsrv.database' => null,
|
||||||
'database.connections.pgsql.host' => env('TENANCY_TEST_PGSQL_HOST', '127.0.0.1'),
|
'database.connections.pgsql.host' => env('TENANCY_TEST_PGSQL_HOST', '127.0.0.1'),
|
||||||
'tenancy.filesystem.disks' => [
|
'tenancy.filesystem.disks' => [
|
||||||
'local',
|
'local',
|
||||||
'public',
|
'public',
|
||||||
's3',
|
's3',
|
||||||
],
|
],
|
||||||
|
'filesystems.disks.s3.bucket' => 'foo',
|
||||||
'tenancy.redis.tenancy' => env('TENANCY_TEST_REDIS_TENANCY', true),
|
'tenancy.redis.tenancy' => env('TENANCY_TEST_REDIS_TENANCY', true),
|
||||||
'database.redis.client' => env('TENANCY_TEST_REDIS_CLIENT', 'phpredis'),
|
'database.redis.client' => env('TENANCY_TEST_REDIS_CLIENT', 'phpredis'),
|
||||||
'tenancy.redis.prefixed_connections' => ['default'],
|
'tenancy.redis.prefixed_connections' => ['default'],
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue