Merge pull request #8450 from ProcessMaker/multitenancy-updates

Multitenancy updates

Author: nolanpro

ProcessMaker/Console/Commands/TenantsCreate.php

@@ -4,7 +4,6 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Encryption\Encrypter;
-use Illuminate\Support\Env;
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\Crypt;
 use Illuminate\Support\Facades\DB;
@@ -32,13 +31,6 @@ class TenantsCreate extends Command
      */
     public function handle()
     {
-        // Datbase name should be .env DB_DATABASE + -tenant-<id>
-        // For example pm4_ci-003c0e7501-tenant-1
-
-        // For CI Instnaces, Domain is https://t1.ci-003c0e7501.engk8s.processmaker.net
-
-        // In prod, domain won't change
-
         $requiredOptions = ['name', 'database', 'url'];
 
         foreach ($requiredOptions as $option) {
@@ -99,6 +91,12 @@ public function handle()
                     $this->info('Moving ' . $subfolder . ' to ' . $tenantStoragePath);
                     rename($subfolder, $tenantStoragePath . '/' . basename($subfolder));
                 }
+
+                // Move all files from the root storage folder to the tenant storage folder
+                foreach (File::files($storageFolderOption) as $file) {
+                    $this->info('Moving ' . $file . ' to ' . $tenantStoragePath);
+                    rename($file, $tenantStoragePath . '/' . basename($file));
+                }
             } else {
                 $this->error('Storage folder does not exist: ' . $storageFolderOption);
 
@@ -184,7 +182,7 @@ public function handle()
         $this->line('- Seed the database');
         $this->line('- Run the install command for each package');
         $this->line('- Run artisan upgrade');
-        $this->line('- Generate passport keys with artisan passport:install');
+        $this->line('- Generate passport keys with artisan passport:keys');
         $this->info("For example, `TENANT={$tenant->id} php artisan migrate:fresh --seed`");
     }
 

ProcessMaker/Multitenancy/SwitchTenant.php

@@ -49,7 +49,7 @@ public function makeCurrent(IsTenant $tenant): void
         // the worker queue jobs since it reuses the same process.
         self::$originalConfig = self::$originalConfig ?? [];
         self::$originalConfig[$tenant->id] = self::$originalConfig[$tenant->id] ?? [
-            'host' => parse_url(config('app.url'), PHP_URL_HOST),
+            'app.url' => config('app.url'),
             'cache.stores.cache_settings.prefix' => config('cache.stores.cache_settings.prefix'),
             'app.instance' => config('app.instance') ?? config('database.connections.landlord.database'),
             'script-runner-microservice.callback' => config('script-runner-microservice.callback'),
@@ -73,10 +73,27 @@ public function makeCurrent(IsTenant $tenant): void
                 'root' => storage_path('lang'),
             ],
             'l5-swagger.defaults.paths.docs' => storage_path('api-docs'),
-            'cache.stores.cache_settings.prefix' =>  'tenant_id_' . $tenant->id . ':' . self::$originalConfig[$tenant->id]['cache.stores.cache_settings.prefix'],
             'app.instance' => self::$originalConfig[$tenant->id]['app.instance'] . '_' . $tenant->id,
-            'script-runner-microservice.callback' => str_replace(self::$originalConfig[$tenant->id]['host'], $tenant->domain, self::$originalConfig[$tenant->id]['script-runner-microservice.callback']),
         ];
+
+        if (!isset($tenant->config['cache.stores.cache_settings.prefix'])) {
+            $newConfig['cache.stores.cache_settings.prefix'] =
+                'tenant_id_' . $tenant->id . ':' . self::$originalConfig[$tenant->id]['cache.stores.cache_settings.prefix'];
+        }
+
+        if (!isset($tenant->config['script-runner-microservice.callback'])) {
+            $newConfig['script-runner-microservice.callback'] = str_replace(
+                self::$originalConfig[$tenant->id]['app.url'],
+                $tenant->config['app.url'],
+                self::$originalConfig[$tenant->id]['script-runner-microservice.callback']
+            );
+        }
+
+        if (!isset($tenant->config['app.docker_host_url'])) {
+            // There is no specific override in the tenant's config so set it to the app url
+            $newConfig['app.docker_host_url'] = $tenant->config['app.url'];
+        }
+
         config($newConfig);
 
         // Set config from the entry in the tenants table

ProcessMaker/Providers/ProcessMakerServiceProvider.php

@@ -9,6 +9,7 @@
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
 use Illuminate\Notifications\Events\BroadcastNotificationCreated;
 use Illuminate\Notifications\Events\NotificationSent;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Env;
 use Illuminate\Support\Facades;
 use Illuminate\Support\Facades\DB;
@@ -43,6 +44,7 @@
 use RuntimeException;
 use Spatie\Multitenancy\Events\MadeTenantCurrentEvent;
 use Spatie\Multitenancy\Events\TenantNotFoundForRequestEvent;
+use Spatie\Multitenancy\TenantCollection;
 
 /**
  * Provide our ProcessMaker specific services.
@@ -93,26 +95,51 @@ public function boot(): void
         // This sets up individual supervisors for each tenant so that one tenant does not block
         // the queue for another tenant. This must be done here instead of SwitchTenant.php because
         // there is a single horizon instance for all tenants.
-        if ($this->app->runningInConsole() && config('app.multitenancy')) {
-            $tenantIds = Tenant::all()->pluck('id')->toArray();
+        if ($this->app->runningInConsole() && config('app.multitenancy') && $this->horizonTenantsNotSet()) {
+            $tenants = Tenant::all();
             $config = config('horizon.environments');
-            $config = $this->addTenantSupervisors($config, $tenantIds);
+            $config = $this->addTenantSupervisors($config, $tenants);
             config(['horizon.environments' => $config]);
         }
     }
 
-    private function addTenantSupervisors(array $config, array $tenantIds): array
+    private function horizonTenantsNotSet(): bool
     {
+        $firstKey = array_keys(config('horizon.environments.production'))[0];
+        if (str_starts_with($firstKey, 'tenant')) {
+            // Already cached
+            return false;
+        }
+
+        return true;
+    }
+
+    private function addTenantSupervisors(array $config, TenantCollection $tenants): array
+    {
+        $tenantsConfigById = $tenants->mapWithKeys(function ($tenant) {
+            return [$tenant->id => $tenant->config];
+        });
+
         foreach ($config as $env => &$supervisors) {
             $newSupervisors = [];
 
             foreach ($supervisors as $supervisorName => $settings) {
-                foreach ($tenantIds as $tenantId) {
+                foreach ($tenants as $tenant) {
+                    $tenantId = $tenant->id;
                     $tenantSupervisorName = "tenant-{$tenantId}-{$supervisorName}";
 
                     // Copy original settings
                     $tenantSettings = $settings;
 
+                    // Set tenant-specific settings
+                    $tenantConfig = $tenantsConfigById[$tenantId];
+                    foreach (['balance', 'tries', 'timeout', 'minProcesses', 'maxProcesses'] as $key) {
+                        $value = Arr::get($tenantConfig, "horizon.{$supervisorName}.{$key}", null);
+                        if ($value !== null) {
+                            $tenantSettings[$key] = $value;
+                        }
+                    }
+
                     // Prepend tenant ID to each queue
                     if (isset($tenantSettings['queue']) && is_array($tenantSettings['queue'])) {
                         $tenantSettings['queue'] = array_map(function ($queue) use ($tenantId) {

README.md

@@ -530,15 +530,13 @@ You can provide an optional description, for example `Metrics::gauge('active_tas
 
 Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.
 
-# Multitenancy (Alpha)
+# Multitenancy
 
-**Note that this feature is disabled for clients. It's not fully implemented yet.**
-
-ProcessMaker is now set up as a multitenant application. By default, there is one tenant.
+ProcessMaker can now be set up as a multitenant application.
 
 ## Requirements
 
-- Your MySql user `DB_USERNAME` will need to be able to create databases.
+- Create an empty datbase named `landlord`. Your `DB_USERNAME` should have permission to write to this table.
 
 ## Transition your dev instnace to multitenancy
 
@@ -547,10 +545,15 @@ ProcessMaker is now set up as a multitenant application. By default, there is on
    php artisan tenants:enable --migrate
    ```
    This command will
-   - Create the landlord database
    - Set your existing database as the tenant database
-   - Move your existing storage folder to `storage/tenant_1`
-   - Update your .env DB_DATABASE to the new landlord database name
+   - Move your existing `storage` folder to `storage/tenant_1`
+   - Move your existing `resources/lang` folder to `resources/lang/tenant_1`
+   - Enable multitenancy in your .env
+
+## Using `valet share` for the script microservice
+
+In the landlord tenant's table you will need to set the domain to the ngroc domain (without https://) and, in the config, column
+you will need to set the `app.url` to the ngroc domain (including the https://)  
 
 ## Add another tenant
 
@@ -593,9 +596,10 @@ Create a folder `storage/transitions` if it doesn't exist.
 
 In that folder create a new folder for each instance you want to migrate.
 
-The folder should contain exactly 2 things:
+The folder should contain exactly 3 things:
 - the .env from the instance you want to migrate
 - the storage folder from the instance you want to migrate, named `storage`
+- the resources/lang folder, named `lang`
 
 Run the following command to migrate the instance(s) to a tenant:
 ```