Refactor SwitchTenant task #8623
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
This is the final PR Bugbot will review for you during this billing cycle
Your free Bugbot reviews will reset on December 21
Details
Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
| } | ||
|
|
||
| $this->info('Current Tenant ID: ' . ($currentTenant?->id ?? 'NONE')); | ||
| \Log::warning('TenantsVerify: Current Tenant ID: ' . ($currentTenant?->id ?? 'NONE')); |
There was a problem hiding this comment.
Bug: Debug logging to warning level left in diagnostic command
The command now writes \Log::warning() entries for informational output that was previously only displayed via $this->info() and $this->table(). Line 52 replaces console info output with a warning-level log entry, and line 173 adds warning-level logging for every row in the table output. Using warning-level logging for routine informational output in a diagnostic command will create unnecessary noise in production logs every time tenants:verify runs.
Additional Locations (1)
| $tenantSettingsPrefix = 'tenant_' . $tenant->getKey() . ':' . $this->originalSettingsPrefix; | ||
| config()->set('cache.stores.cache_settings.prefix', $tenantSettingsPrefix); | ||
| $this->storeName = 'cache_settings'; | ||
| $this->setCachePrefix($cachePrefix); |
There was a problem hiding this comment.
Bug: Wrong prefix passed to setCachePrefix for settings store
In makeCurrent(), $tenantSettingsPrefix is calculated as 'tenant_X:' + originalSettingsPrefix (e.g., 'tenant_X:settings') and the config is correctly set, but setCachePrefix() is called with $cachePrefix (just 'tenant_X:') instead. Similarly, in forgetCurrent(), $this->originalPrefix is passed instead of $this->originalSettingsPrefix. This causes the cache_settings store to have a mismatched prefix, potentially breaking cache isolation between tenants.
Additional Locations (1)
| config()->set('cache.stores.cache_settings.prefix', $tenantSettingsPrefix); | ||
| $this->storeName = 'cache_settings'; | ||
| $this->setCachePrefix($cachePrefix); | ||
| } |
There was a problem hiding this comment.
Bug: Parent's makeCurrent not called, originalPrefix never initialized
The makeCurrent method completely overrides the parent SpatiePrefixCacheTask without calling parent::makeCurrent($tenant). The parent class sets $this->originalPrefix to save the original cache prefix before applying tenant-specific values. Since the parent is never called, $this->originalPrefix remains uninitialized. When forgetCurrent() is called, it passes $this->originalPrefix (which is null/undefined) to setCachePrefix(), causing the cache prefix to be incorrectly reset instead of restoring the original landlord value.
Additional Locations (1)
| config()->set('cache.stores.cache_settings.prefix', $this->originalSettingsPrefix); | ||
| $this->storeName = 'cache_settings'; | ||
| $this->setCachePrefix($this->originalPrefix); | ||
| } |
There was a problem hiding this comment.
Bug: Default cache store prefix never restored when forgetting tenant
In forgetCurrent(), the first setCachePrefix call on line 26 operates on the wrong cache store. The storeName property is left at 'cache_settings' from the previous makeCurrent() call, so line 26 restores the cache_settings store instead of the default cache store. The default store's prefix is never restored to its original value. The code needs to reset storeName to its default value before the first setCachePrefix call, mirroring the order in makeCurrent() where the default store is handled first.
|
|
QA server K8S was successfully deployed https://tenant-1.ci-be8634c205.engk8s.processmaker.net |
Refactor how we switch tenants
ci:multitenancy
ci:deploy
ci:k8s-branch:remove-tenant-specific-cache
Note
Refactors tenant switching to set env/config per-tenant, adds cache settings prefixing and JSON-enabled
tenants:verify, integrates DB switch task, and removes legacy bootstrap/queue Horizon listen logic.ProcessMaker\Multitenancy\SwitchTenantnow saves landlord config, setsAPP_URL, updatesapp.instance,app.url, filesystem roots, lang path, decrypts and setsapp.key, and resets logging;forgetCurrent()restores landlord paths/keys.ProcessMaker\Multitenancy\PrefixCacheTaskprefixes default cache andcache_settingsstore per-tenant; registered inconfig/multitenancy.phpalongsideSwitchTenantDatabaseTask.MakeQueueTenantAwareActionavoids exceptions when multitenancy is disabled; wired inconfig/multitenancy.php.tenants:verify: Adds--jsonoutput, structured tables/logging, expected per-tenant validations (paths, configs, env vars), and error aggregation.TenantBootstrapperintegration andApplication::bootstrapWithoverride; deleteHorizonListencommand and related Horizon bootstrap/event hooks fromProcessMakerServiceProvider.MULTITENANCY=falsetophpunit.xml.PackageManifestsingleton override; no other provider registration changes.Written by Cursor Bugbot for commit a64fbed. This will update automatically on new commits. Configure here.