fa/breadcrumb-the-shire
1
0
Fork 1
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat: extend module platform with UI slots, runtime components, CLI tooling and {{userId}} search support

Browse Source 
Completes the generic module platform that enables modules to contribute
UI elements, runtime JS components, and search resources without any
core hardcoding.

New generic UI slot types:
- topbar.right_item: module-contributed topbar buttons
- layout.body_end_template: module-contributed dialog/overlay templates
- layout.head_style: module-contributed global CSS
- runtime.component: declarative JS component registration with phase ordering

New infrastructure:
- ModuleAutoloader: PSR-4 autoloading for module-local PHP classes
- ModuleRuntimePageBuilder: symlinks module pages into runtime directory
- ModuleRuntimeAssetPublisher: publishes module CSS/JS to web/modules/
- ModulePermissionSynchronizer: syncs module permissions to DB
- CLI scripts: module-runtime-sync, module-build, module-migrate,
  module-permissions-sync, module-assets-sync
- {{userId}} placeholder in SearchDataService for user-scoped search queries
- Component runtime with phased initialization (early/default/late)
- AppContainer.protectExistingBindings() to prevent module→core overwrites
- Architecture tests: ModuleStructureContractTest, CoreTemplateIsolationTest,
  FrontendComponentRuntimeContractTest, AppContainerIsolationContractTest

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Felix Schneider
2026-03-18 22:19:56 +01:00
parent c364e2b46d
commit c7b8fd516a
139 changed files with 7591 additions and 2535 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
tests/Architecture/ModuleRegistryContractTest.php
View File

@@ -19,9 +19,9 @@ final class ModuleRegistryContractTest extends TestCase
public function testAddressBookModuleLoadsWhenEnabled(): void
{
$registry = app(ModuleRegistry::class);
$modulesDir = dirname(__DIR__, 2) . '/modules';
$registry = ModuleRegistry::boot($modulesDir, ['addressbook']);
// config/modules.php has addressbook enabled by default
self::assertTrue($registry->hasModule('addressbook'));
self::assertNotEmpty($registry->getSearchResources());
self::assertNotEmpty($registry->getLayoutContextProviders());
@@ -32,8 +32,16 @@ final class ModuleRegistryContractTest extends TestCase
{
$modulesDir = dirname(__DIR__, 2) . '/modules';
// Boot a fresh registry with no modules enabled (simulates APP_ENABLED_MODULES='')
$registry = ModuleRegistry::boot($modulesDir, []);
putenv('APP_ENABLED_MODULES=');
try {
$enabledModules = ModuleRegistry::resolveEnabledModules([
'enabled_modules' => ['addressbook', 'bookmarks'],
]);
self::assertSame([], $enabledModules, 'APP_ENABLED_MODULES empty string must disable all modules.');
$registry = ModuleRegistry::boot($modulesDir, $enabledModules);
} finally {
putenv('APP_ENABLED_MODULES');
}
self::assertSame([], $registry->getModules());
self::assertSame([], $registry->getRoutes());
@@ -54,14 +62,53 @@ final class ModuleRegistryContractTest extends TestCase
$raw = require $manifestFile;
self::assertIsArray($raw);
self::assertSame('addressbook', $raw['id']);
// Permissions owned by Core PermissionService, not module
self::assertSame([], $raw['permissions']);
// Asset groups owned by config/assets.php, not module
self::assertSame([], $raw['asset_groups']);
self::assertSame([[
'key' => 'address_book.view',
'description' => 'Can view address book',
'active' => true,
'is_system' => true,
]], $raw['permissions']);
self::assertArrayHasKey('address-book', $raw['asset_groups']);
self::assertSame(
['modules/addressbook/css/pages/address-book-view.css'],
$raw['asset_groups']['address-book']
);
self::assertNotEmpty($raw['search_resources']);
self::assertNotEmpty($raw['layout_context_providers']);
self::assertNotEmpty($raw['session_providers']);
self::assertArrayHasKey('aside.tab_panel', $raw['ui_slots']);
self::assertArrayHasKey('search.resource_item', $raw['ui_slots']);
self::assertArrayHasKey('user.edit.aside_action', $raw['ui_slots']);
$routes = is_array($raw['routes'] ?? null) ? $raw['routes'] : [];
$routeByPath = [];
foreach ($routes as $route) {
if (!is_array($route)) {
continue;
}
$routeByPath[(string) ($route['path'] ?? '')] = (string) ($route['target'] ?? '');
}
self::assertSame('address-book', $routeByPath['address-book'] ?? null);
self::assertSame('address-book/data', $routeByPath['address-book/data'] ?? null);
self::assertSame('address-book', $routeByPath['addressbook'] ?? null);
self::assertSame('address-book', $routeByPath['adressbook'] ?? null);
}
public function testBookmarksModuleManifestIsValid(): void
{
$modulesDir = dirname(__DIR__, 2) . '/modules';
$manifestFile = $modulesDir . '/bookmarks/module.php';
self::assertFileExists($manifestFile, 'Bookmarks module manifest must exist');
$raw = require $manifestFile;
self::assertIsArray($raw);
self::assertSame('bookmarks', $raw['id']);
self::assertArrayHasKey('aside.tab_panel', $raw['ui_slots']);
self::assertArrayHasKey('topbar.right_item', $raw['ui_slots']);
self::assertArrayHasKey('layout.body_end_template', $raw['ui_slots']);
self::assertArrayHasKey('layout.head_style', $raw['ui_slots']);
self::assertArrayHasKey('runtime.component', $raw['ui_slots']);
}
public function testModuleProviderClassesExist(): void
@@ -104,11 +151,11 @@ final class ModuleRegistryContractTest extends TestCase
file_put_contents($fixturesDir . '/mod-a/module.php', '<?php return ' . var_export([
'id' => 'mod-a',
'permissions' => ['shared.perm'],
'permissions' => [['key' => 'shared.perm', 'description' => 'Shared']],
], true) . ';');
file_put_contents($fixturesDir . '/mod-b/module.php', '<?php return ' . var_export([
'id' => 'mod-b',
'permissions' => ['shared.perm'],
'permissions' => [['key' => 'shared.perm', 'description' => 'Shared duplicate']],
], true) . ';');
$this->expectException(\RuntimeException::class);