Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 57 additions & 25 deletions src/Plugin/Plugins.php
Original file line number Diff line number Diff line change
Expand Up @@ -185,23 +185,7 @@ public function loadPlugins(): void
->orderBy('handle')
->get()
->keyBy('handle')
->map(function (object $row) {
try {
$configData = $this->getPluginConfigData($row->handle);
} catch (InvalidPluginException) {
return false;
}

// Clean up the row data
$row = (array) $row;
$row['edition'] = $configData['edition'] ?? null;
$row['settings'] = $configData['settings'] ?? [];
$row['licenseKey'] = $configData['licenseKey'] ?? null;
$row['enabled'] = ! empty($configData['enabled']);
$row['installDate'] = DateTimeHelper::toDateTime($row['installDate']);

return $row;
})
->map(fn (object $row) => $this->storedInfoFromRow($row))
->filter()
->all();

Expand Down Expand Up @@ -440,7 +424,7 @@ public function disablePlugin(string $handle): bool
return true;
}

if (($plugin = $this->getPlugin($handle)) === null) {
if (($plugin = $this->enabledPlugin($handle)) === null) {
throw new InvalidPluginException($handle);
}

Expand Down Expand Up @@ -516,7 +500,7 @@ public function installPlugin(string $handle, ?string $edition = null): bool
->where('track', "plugin:$handle")
->delete();

$info['id'] = DB::table(Table::PLUGINS)->insertGetId([
$pluginId = DB::table(Table::PLUGINS)->insertGetId([
'handle' => $handle,
'version' => $plugin->version,
'schemaVersion' => $plugin->schemaVersion,
Expand All @@ -526,8 +510,6 @@ public function installPlugin(string $handle, ?string $edition = null): bool
'uid' => Str::uuid(),
]);

$info['enabled'] = $projectConfig->get($configKey.'.enabled') ?? true;

$plugin->install();

try {
Expand Down Expand Up @@ -564,7 +546,9 @@ public function installPlugin(string $handle, ?string $edition = null): bool
message: "Install plugin “{$handle}”",
);

$this->storedPluginInfo[$handle] = $info;
$this->storedPluginInfo[$handle] = $this->storedInfoFromRow(
DB::table(Table::PLUGINS)->where('id', $pluginId)->first(),
);
$plugin->publishAssets();

event(new PluginInstalled($plugin));
Expand Down Expand Up @@ -609,7 +593,7 @@ public function uninstallPlugin(string $handle, bool $force = false): bool
$projectConfig->readOnly = false;

try {
if (($plugin = $this->getPlugin($handle)) === null && ! $force) {
if (($plugin = $enabled ? $this->enabledPlugin($handle) : null) === null && ! $force) {
throw new InvalidPluginException($handle);
}

Expand Down Expand Up @@ -991,7 +975,7 @@ public function getPluginInfo(string $handle): array
$pluginInfo = $this->getStoredPluginInfo($handle);

// Get the plugin if it's enabled
$plugin = $this->getPlugin($handle);
$plugin = $this->enabledPlugin($handle);

$info = array_merge([
'developer' => null,
Expand All @@ -1011,7 +995,7 @@ public function getPluginInfo(string $handle): array
}

$info['isInstalled'] = $installed = $pluginInfo !== null;
$info['isEnabled'] = $plugin !== null;
$info['isEnabled'] = $this->isPluginEnabled($handle);
$info['isForceDisabled'] = $this->isPluginForceDisabled($handle);
$info['private'] = str_starts_with($handle, '_');
$info['moduleId'] = $handle;
Expand Down Expand Up @@ -1409,6 +1393,54 @@ private function ensurePluginsAreNotLaravelProviders(): void
}
}

/**
* Builds a plugin’s stored info from its `plugins` row and project config.
*
* @return array<string, mixed>|null null if the plugin has no project config
*/
private function storedInfoFromRow(object $row): ?array
{
try {
$configData = $this->getPluginConfigData($row->handle);
} catch (InvalidPluginException) {
return null;
}

$info = (array) $row;
$info['edition'] = $configData['edition'] ?? null;
$info['settings'] = $configData['settings'] ?? [];
$info['licenseKey'] = $configData['licenseKey'] ?? null;
$info['enabled'] = ! empty($configData['enabled']);
$info['installDate'] = DateTimeHelper::toDateTime($info['installDate']);

return $info;
}

/**
* Returns an enabled plugin, including one enabled or installed during this request.
*
* Plugins load once per request, so {@see getPlugin()} doesn’t return a plugin enabled or installed since then.
*/
private function enabledPlugin(string $handle): ?PluginInterface
{
if (($plugin = $this->getPlugin($handle)) !== null) {
return $plugin;
}

$info = $this->getStoredPluginInfo($handle);

if ($info === null || ! $info['enabled']) {
return null;
}

try {
return $this->createPlugin($handle, $info);
} catch (InvalidPluginException) {
// The plugin’s package is gone, like loadPlugins() skips it
return null;
}
}

/**
* Load config data for plugin by its handle.
*
Expand Down
36 changes: 36 additions & 0 deletions tests/Feature/Plugin/PluginLifecycleTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,42 @@
->and($plugins->getPlugin('c-disabled'))->toBeNull();
});

it('treats a plugin enabled earlier in the same request as enabled', function (string $operation) {
$plugins = app(Plugins::class);

configureLifecyclePlugins($plugins, [
'c-disabled' => [DisabledLifecycleTestPlugin::class, false],
]);

$plugins->loadPlugins();
$plugins->enablePlugin('c-disabled');

expect($plugins->getPluginInfo('c-disabled')['isEnabled'])->toBeTrue();

$plugins->$operation('c-disabled');

expect($plugins->isPluginEnabled('c-disabled'))->toBeFalse()
->and($plugins->isPluginInstalled('c-disabled'))->toBe($operation === 'disablePlugin');
})->with(['disablePlugin', 'uninstallPlugin']);

it('stores the same info for a plugin installed during the request as for a loaded one', function () {
$plugins = app(Plugins::class);

configureLifecyclePlugins($plugins, [
'c-disabled' => [DisabledLifecycleTestPlugin::class, false],
]);

$plugins->loadPlugins();
$plugins->uninstallPlugin('c-disabled', true);
$plugins->installPlugin('c-disabled');
$plugin = $plugins->createPlugin('c-disabled');

expect($plugins->getStoredPluginInfo('c-disabled'))
->toMatchArray(['handle' => 'c-disabled', 'version' => $plugin->version, 'schemaVersion' => $plugin->schemaVersion, 'enabled' => true])
->and($plugins->isPluginUpdatePending($plugin))->toBeFalse()
->and($plugins->hasPluginVersionNumberChanged($plugin))->toBeFalse();
});

it('returns null for plugin classes that do not implement the plugin interface', function () {
$plugins = app(Plugins::class);

Expand Down
Loading