archtechx / tenancy

Automatic multi-tenancy for Laravel. No code changes needed.

Tenancy for Laravel — stancl/tenancy

Automatic multi-tenancy for your Laravel app.

You won't have to change a thing in your application's code.

• ✔️ No model traits to change database connection
• ✔️ No replacing of Laravel classes (Cache, Storage, ...) with tenancy-aware classes
• ✔️ Built-in tenant identification based on hostname (including second level domains)

Documentation

Documentation can be found here: https://tenancyforlaravel.com/docs/v3/

The repository with the documentation source code can be found here: stancl/tenancy-docs.

Need help?

Credits

• Package created by Samuel Štancl
• Design help & current logo by Florian Karsten

tenancy's Issues

Predis support?

Perhaps predis could work if tenancy support for Redis was disabled in the config?

Allow tenants to use multiple domains

I'm not sure if there are many practical uses for this, but code-wise this shouldn't be hard to add.

Also add API to easily add and remove domains.

Load tenant routes using the service provider

https://stackoverflow.com/a/43518552/

Explain how to test a multi-tenant app

Add tests

• all parts of BootstrapsTenancy - finished apart from tagCache()

Fix return type in docblock

https://github.com/stancl/tenancy/blob/1.x/src/TenantManager.php#L200

Says array but it's a collection.

Test compatibility with Lumen

Better error handling for requirements

When \Redis::OPT_PREFIX is not defined, show a readable error suggesting that phpredis doesn't seem to be installed.

#47

---

This has been resolved in #59

PHP Parse error: Syntax error, unexpected T_DOUBLE_ARROW on line 1

I am getting error while while creating tenent in tinker

>>> tenant()->create('tenant1.localhost')
=> [
     "uuid" => "e5611150-9a9e-11e9-8315-b9eb127de2b8",
     "domain" => "tenant1.localhost",
   ]

Error

PHP Parse error: Syntax error, unexpected T_DOUBLE_ARROW on line 1

I tried on different projects , different php versions bu no luck.

I was following this article
https://stancl.github.io/blog/how-to-make-any-laravel-app-multi-tenant-in-5-minutes/

Thanks for this incredible package.

Document tenant database managers

Associative arrays are stored as objects

>>> tenant()->put('foo', ['a' => 'b']);
=> {#3209
     +"a": "b",
   }

Better error messages

>>> tenancy()->findByDomain('laravel.localhostt')
TypeError: Argument 1 passed to Stancl/Tenancy/TenantManager::find() must be of the type string, null given, called in /var/www/laravel/test/vendor/stancl/tenancy/src/TenantManager.php on line 152

Add better error handling to RedisStorageDriver

>>> tenant()->delete('nonexistent_uuid')
PHP Notice:  Undefined index: domain in /.../StorageDrivers/RedisStorageDriver.php on line 58

Instead of having DatabaseCreators, have classes that can both create and delete DBs

Don't migrate after tenant()->create()

Load middleware groups using the service provider

Like this:

https://github.com/laravel/telescope/blob/60764eea6e231a3fc1b93e9e2bd111c2c2cc4310/src/TelescopeServiceProvider.php#L21

Add more database-related artisan commands

Perhaps some of these?

• migrate:fresh Drop all tables and re-run all migrations
• migrate:install Create the migration repository
• migrate:refresh Reset and re-run all migrations
• migrate:reset Rollback all database migrations
• migrate:status Show the status of each migration

Move TODOs from code to GH issues

HTTPS certificates

When the yourclient.yourapp.com, yourclient2.yourapp.com model is used, a wildcard cert can take care of HTTPS. However, when the yourapp.yourclient.com, yourapp.yourclient2.com model is used, there needs to be some feature for HTTPS management. Luckily file-based verification can be used with Let's Encrypt, so perhaps creating a route to verify the domain ownership is sufficient? Auto renewal etc could be added too.

Add shared users between tenants

Like Stripe administration.

`artisan tinker` uses wrong hostname

>>> tenant()->currentDomain()
=> "laravel.localhost"

Could be due to some weird config on my computer.

Find a way to run the same tests multiple times with different settings

Add more data separation tests

• Redis
• Filesystem

Use a Tenant class instead of arrays

• would be __invoke()able similarly to TenantManager
• could be constructed based on JSON, id or an array

Better argument name than "values" for kv pairs in StorageDriver

Test how the package works with "async" features of Laravel

• Events

• Jobs

• Events happen only in the lifecycle of a request, so assuming the tenant is identified at the beginning and then not switched, events are ok. (Support for events even with reidentification should be added at some point).

Add a class for global (non-suffixed) Storage

TODO: Add some method/class that would use the config stored in this variable:

https://github.com/stancl/tenancy/blob/6473806d0de4c8b1f10e781a814e78dce4d46761/src/Traits/BootstrapsTenancy.php#L7

Use phpstan or larastan in .travis.yml?

It would be run before phpunit.

Closed: Maybe this will be useful later. For now, this is not a priority.

CommandsTest isn't passing for 5.8

https://travis-ci.com/stancl/tenancy/jobs/194972896#L628-L641

Add a MySQL/SQLite storage driver

Putting arrays into tenant storage is problematic

>>> tenancy()->put('foo', [1, 2]);
=> [
     1,
     2,
   ]
>>> tenancy()->get('foo')
=> "Array"

Arrays should be serialized into JSON, but then JSON strings need to be recognized from regular strings.

See if 5.6 can be supported too

Add tenancy()->end()

Changing the identified tenant breaks storage_path

>>> storage_path()
=> "/var/www/laravel/test/storage"
>>> tenancy()->all()
=> Illuminate\Support\Collection {#3181
     all: [
       [
         "uuid" => "8075a580-1cb8-11e9-8822-49c5d8f8ff23",
         "domain" => "dev.localhost",
       ],
       [
         "uuid" => "1e22e620-1cb8-11e9-93b6-8d1b78ac0bcd",
         "domain" => "laravel.localhost",
         "abc" => "def",
       ],
     ],
   }
>>> tenancy()->init('dev.localhost')
=> [
     "uuid" => "8075a580-1cb8-11e9-8822-49c5d8f8ff23",
     "domain" => "dev.localhost",
   ]
>>> storage_path()
=> "/var/www/laravel/test/storage/tenant8075a580-1cb8-11e9-8822-49c5d8f8ff23"
>>> tenancy()->init('laravel.localhost')
=> [
     "uuid" => "1e22e620-1cb8-11e9-93b6-8d1b78ac0bcd",
     "domain" => "laravel.localhost",
     "abc" => "def",
   ]
>>> storage_path()
=> "/var/www/laravel/test/storage/tenant8075a580-1cb8-11e9-8822-49c5d8f8ff23/tenant1e22e620-1cb8-11e9-93b6-8d1b78ac0bcd"

Check if it breaks anything else (write a test).

Instead of reconnecting the database, avoid connecting to the default DB in the first place

This should increase performance.

Tests shouldn't be passing

5.7 tests are passing but 5.8 aren't. Seems to be a change in Artisan syntax? https://travis-ci.com/stancl/tenancy/jobs/194956720

Also neither version's tests should be passing due to #38

• Fix artisan commands for 5.8
• Break tests by writing good tests for the jobs. #40

Handle array|string argument types in the TenantManager instead of the storage drivers

https://github.com/stancl/tenancy/blob/cbabb9136d82e8f7a5fe9d0b66d8df60922412e1/src/StorageDrivers/RedisStorageDriver.php#L30-L35

This conversion should be done in the TenantManager, to keep the storage drivers' code as straightforward as possible.

CacheManager doesn't merge the tags properly

>>> cache()->tags([1,2])->getTags()->getNames()
=> [
     1,
     2,
   ]
>>> tenancy()->init()
=> [
     "uuid" => "[...]",
     "domain" => "laravel.localhost",
     "foo" => [
       "a" => "b",
       "c" => "d",
     ],
   ]
>>> cache()->tags([1,2])->getTags()->getNames()
=> [
     "tenant45b1a950-2d81-11e9-a4f5-bf999e894159",
     [
       1,
       2,
     ],
   ]

Write a Postgres DB manager

Explicitly specify global namespace wherever possible

This will improve performance.

Add a function to TenantManager for changing a tenant's domain

Add require-dev so that the package can be developed comfortably on its own

Right now it's necessary to test the features in a laravel/laravel instance.

Add laravel/framework and artisan tinker to require-dev?

Tenancy documentation and can it do the requested

@stancl
I stumbled upon your blog post, I will say i am really impressed by your package, I would say it remove 99% time meant for the development of multi-tenancy app.
But i hit a snag because i could not get the complete documentation.
I would love it if you could write more tutorials on how to build a panel/control dashboard to create, delete and suspend a tenant app.
Preferably continuing from your Tutorial.
I have an app which i am working which allow user's to send emails On the free plan and Limited number of SMS on the pro plan.
Currently i use hard coded variables for that. Something like this in my controller
$use_sms = true; if($use_sms === true){ //Function to send SMS }
How do i do such using your package..

Thanks.
Moneya

The helpers file shouldn't be namespaced

Make sure the roots for storage_path() and the Storage facade make sense

Why are files in {storage_path()}/app/public in the image in README?

Fix Jobs' docblocks

Better tenant-specific assets

Code like this is problematic:

public static function productImage($product_id)
{
    return asset("storage/images/products/$product_id.png");
}

\Image::make($image)
    ->resize(750, 750, $constraint)//->resizeCanvas(750, 750)
    ->save(storage_path("app/public/images/products/{$product->id}.png"))
    ->resize(300, 300, $constraint)//->resizeCanvas(300, 300)
    ->save(storage_path("app/public/images/products/thumbnails/{$product->id}.png"));

But code like this seems to work (= doesn't delete the image, since the code above put it in the wrong directory):

if (\Helper::imageExists($product->id) && $image_deleted) {
    Storage::delete("public/images/products/{$product->id}.png");
    Storage::delete("public/images/products/thumbnails/{$product->id}.png");
}

• Try to fix storage_path() and asset()
  • app()->useStoragePath(app()->storagePath() . $path)
  • app('url')->forceRootUrl(asset('') . $url)
• Add a class for global (non-suffixed) Storage (unrelated to this issue, but it might be a useful feature) #8

Undefined class constant 'OPT_PREFIX' on a new Installation of Laravel 5.8

I was trying to test this package in a brand new Laravel 5.8 app, I went as far as
https://github.com/stancl/tenancy#creating-a-new-tenant
and in the next step, I got the error of
Symfony\Component\Debug\Exception\FatalThrowableError : Undefined class constant 'OPT_PREFIX'
on
/vendor/stancl/tenancy/src/StorageDrivers/RedisStorageDriver.php:75

Thanks

Add support for global cache

Create a Tenancy facade

Some people prefer facades over global helpers and creating one shouldn't be too hard.