From 113f42196747d5f391f89abf57a07644f6f587c7 Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 13:06:34 +0100 Subject: [PATCH 1/9] Add public plugin namespace pages --- config/routes.php | 8 + src/Application.php | 2 +- src/Controller/PackagesController.php | 26 ++- src/Island/CatalogueIsland.php | 18 +- src/Model/Table/PackagesTable.php | 56 +++++- templates/Packages/by_namespace.php | 45 +++++ .../element/Packages/category_browser.php | 3 +- templates/element/Packages/package-row.php | 11 ++ templates/element/Packages/plugin-details.php | 10 +- templates/island/catalogue.php | 27 +-- tests/TestCase/ApplicationTest.php | 2 + .../Controller/PackagesControllerTest.php | 34 ++++ tests/TestCase/Island/CatalogueIslandTest.php | 47 +++++ .../Model/Table/PackagesTableTest.php | 49 +++++ tests/browser/namespaces.spec.js | 169 ++++++++++++++++++ 15 files changed, 486 insertions(+), 21 deletions(-) create mode 100644 templates/Packages/by_namespace.php create mode 100644 tests/browser/namespaces.spec.js diff --git a/config/routes.php b/config/routes.php index 996e4414..e88d10d8 100644 --- a/config/routes.php +++ b/config/routes.php @@ -59,6 +59,14 @@ * to use (in this case, templates/Pages/home.php)... */ $builder->connect('/', ['controller' => 'Packages', 'action' => 'index']); + $builder->get('/plugins/by/{namespace}', [ + 'controller' => 'Packages', + 'action' => 'byNamespace', + ], 'plugin:namespace') + ->setPatterns([ + 'namespace' => '[A-Za-z0-9][A-Za-z0-9_.-]*', + ]) + ->setPass(['namespace']); $builder->get('/plugins/{id}', ['controller' => 'Packages', 'action' => 'view'], 'plugin:view') ->setPatterns(['id' => '[0-9]+'])->setPass(['id']); $builder->connect('/requirements', ['controller' => 'Pages', 'action' => 'display', 'requirements']); diff --git a/src/Application.php b/src/Application.php index 103a7f8a..c9bd51e9 100644 --- a/src/Application.php +++ b/src/Application.php @@ -203,7 +203,7 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue } return !in_array($request->getMethod(), ['GET', 'HEAD'], true) - || !($path === '' || $path === '/packages' || preg_match('#^/plugins/[0-9]+$#', $path)); + || !($path === '' || $path === '/packages' || preg_match('#^/plugins/(?:[0-9]+|by/[A-Za-z0-9][A-Za-z0-9_.-]*)$#', $path)); }, ]), ); diff --git a/src/Controller/PackagesController.php b/src/Controller/PackagesController.php index aa0cd245..1d5f4fb4 100644 --- a/src/Controller/PackagesController.php +++ b/src/Controller/PackagesController.php @@ -4,6 +4,8 @@ namespace App\Controller; use App\Model\Table\PackagesTable; +use Cake\Http\Exception\NotFoundException; +use Cake\Http\Response; /** * Hosts the public catalogue; islands own subsequent interactions. @@ -16,7 +18,7 @@ class PackagesController extends AppController public function initialize(): void { parent::initialize(); - $this->Authentication->allowUnauthenticated(['index', 'view']); + $this->Authentication->allowUnauthenticated(['index', 'view', 'byNamespace']); } /** @@ -26,6 +28,28 @@ public function index(): void { } + /** + * Host a scoped catalogue with totals that do not change while filtering. + */ + public function byNamespace(string $namespace): ?Response + { + $canonicalNamespace = strtolower($namespace); + $stats = $this->fetchTable(PackagesTable::class)->namespaceStats($canonicalNamespace); + if ($stats['plugins'] === 0) { + throw new NotFoundException('Namespace not found.'); + } + if ($namespace !== $canonicalNamespace) { + return $this->redirect([ + '_name' => 'plugin:namespace', + 'namespace' => $canonicalNamespace, + '?' => $this->getRequest()->getQueryParams(), + ], 301); + } + $this->set(compact('namespace', 'stats')); + + return null; + } + /** * Provide a normal detail URL for direct links and browsers without JavaScript. */ diff --git a/src/Island/CatalogueIsland.php b/src/Island/CatalogueIsland.php index 77910955..6ccb8206 100644 --- a/src/Island/CatalogueIsland.php +++ b/src/Island/CatalogueIsland.php @@ -7,6 +7,7 @@ use Cake\Http\Exception\BadRequestException; use Interact\Attribute\Action; use Interact\Attribute\Pagination; +use Interact\Attribute\Prop; use Interact\Attribute\State; use Interact\Island; use Interact\Pagination\PaginationState; @@ -18,6 +19,9 @@ */ class CatalogueIsland extends Island { + #[Prop] + public ?string $namespace = null; + #[State(writable: true, url: true)] public string $search = ''; @@ -148,7 +152,7 @@ public function viewData(): array throw new BadRequestException('Search query is too long.'); } $options = $this->packages->filterOptions(); - $categoryOptions = $this->packages->categoryOptions(); + $categoryOptions = $this->packages->categoryOptions($this->namespace); if (!array_key_exists($this->category, $categoryOptions)) { $this->category = ''; } @@ -164,8 +168,8 @@ public function viewData(): array 'direction' => $this->paging->direction, ]; $hasFilters = trim($this->search) !== '' || $this->cakephpSlugs !== [] || $this->phpSlugs !== [] || $this->category !== '' || $this->awesomeOnly; - $showFeatured = !$hasFilters && $this->paging->page === 1; - $packages = $this->paginate($this->packages->find('catalogue', filters: $query)); + $showFeatured = $this->namespace === null && !$hasFilters && $this->paging->page === 1; + $packages = $this->paginate($this->packages->find('catalogue', filters: $query, namespace: $this->namespace)); return [ 'packages' => $packages, @@ -175,6 +179,14 @@ public function viewData(): array 'phpTags' => $options['php'], 'catalogueQuery' => $query, 'categoryOptions' => $categoryOptions, + 'catalogueRoute' => $this->namespace !== null ? [ + '_name' => 'plugin:namespace', + 'namespace' => $this->namespace, + ] : [ + 'plugin' => null, + 'controller' => 'Packages', + 'action' => 'index', + ], ]; } } diff --git a/src/Model/Table/PackagesTable.php b/src/Model/Table/PackagesTable.php index 77924cdc..1f1399ef 100644 --- a/src/Model/Table/PackagesTable.php +++ b/src/Model/Table/PackagesTable.php @@ -112,8 +112,11 @@ public function validationDefault(Validator $validator): Validator * @param array $filters Accepted search and version filters. * @return \Cake\ORM\Query\SelectQuery<\App\Model\Entity\Package> */ - public function findCatalogue(SelectQuery $query, array $filters): SelectQuery + public function findCatalogue(SelectQuery $query, array $filters, ?string $namespace = null): SelectQuery { + if ($namespace !== null) { + $query->find('namespace', namespace: $namespace); + } $query->find('search', search: $filters) ->contain(['Categories', 'Tags' => static fn(SelectQuery $tags) => $tags->orderByDesc('Tags.label')]); if (!empty($filters['category']) || !empty($filters['awesome'])) { @@ -131,6 +134,48 @@ public function findCatalogue(SelectQuery $query, array $filters): SelectQuery return $query; } + /** + * Match a literal Composer vendor prefix, including namespaces containing underscores. + * + * @param \Cake\ORM\Query\SelectQuery<\App\Model\Entity\Package> $query Package query. + * @return \Cake\ORM\Query\SelectQuery<\App\Model\Entity\Package> + */ + public function findNamespace(SelectQuery $query, string $namespace): SelectQuery + { + $prefix = strtr($namespace, [ + '!' => '!!', + '%' => '!%', + '_' => '!_', + ]) . '/%'; + + // Expression-owned bindings survive the ORM's eager-loading subqueries. + return $query->where(new QueryExpression([ + $query->expr()->like($this->aliasField('package'), $prefix), + "ESCAPE '!'", + ], [], '')); + } + + /** + * Hero totals cover the namespace before any interactive filters are applied. + * + * @return array{plugins: int, downloads: int, stars: int} + */ + public function namespaceStats(string $namespace): array + { + $query = $this->find('namespace', namespace: $namespace); + $totals = $query->select([ + 'plugins' => $query->func()->count('*'), + 'downloads' => $query->func()->sum('Packages.downloads'), + 'stars' => $query->func()->sum('Packages.stars'), + ])->first(); + + return [ + 'plugins' => (int)($totals?->get('plugins') ?? 0), + 'downloads' => (int)($totals?->get('downloads') ?? 0), + 'stars' => (int)($totals?->get('stars') ?? 0), + ]; + } + /** * Load configured featured packages without changing their display order. * @@ -158,15 +203,20 @@ public function findFeaturedCandidates(SelectQuery $query, string $search = ''): } /** - * @return array Imported categories and their directory-wide package counts. + * @return array Categories and counts within the current catalogue scope. */ - public function categoryOptions(): array + public function categoryOptions(?string $namespace = null): array { $query = $this->Categories->find(); $query->select(['Categories.slug', 'Categories.name', 'package_count' => $query->func()->count('CategoryMemberships.package_id')]) ->leftJoin(['CategoryMemberships' => 'categories_packages'], ['CategoryMemberships.category_id = Categories.id']) ->groupBy(['Categories.id', 'Categories.slug', 'Categories.name']) ->orderByAsc('Categories.name'); + if ($namespace !== null) { + $query->where([ + 'CategoryMemberships.package_id IN' => $this->find('namespace', namespace: $namespace)->select(['id']), + ]); + } $options = []; foreach ($query->all() as $category) { $options[$category->get('slug')] = ['name' => $category->get('name'), 'count' => (int)$category->get('package_count')]; diff --git a/templates/Packages/by_namespace.php b/templates/Packages/by_namespace.php new file mode 100644 index 00000000..a5d21b72 --- /dev/null +++ b/templates/Packages/by_namespace.php @@ -0,0 +1,45 @@ +assign('title', __('Plugins by {0}', $namespace)); +$statLabels = [ + 'plugins' => __('Plugins'), + 'downloads' => __('Downloads'), + 'stars' => __('Stars'), +]; +?> +
+ Html->link('← ' . __('Browse all plugins'), '/', [ + 'class' => 'mb-5 inline-flex min-h-8 items-center text-sm text-muted', + 'x-interact:navigate' => '', + ]) ?> +
+
+
+ +
+

+

+

+
+
+
+ $label) : ?> +
+
+
Number->format($stats[$key]) ?>
+
+ +
+
+
+
+Interact->render('Catalogue', props: compact('namespace'), key: 'namespace-catalogue-' . $namespace) ?> +element('Packages/plugin-modal') ?> diff --git a/templates/element/Packages/category_browser.php b/templates/element/Packages/category_browser.php index 0cd279b8..d0fa5170 100644 --- a/templates/element/Packages/category_browser.php +++ b/templates/element/Packages/category_browser.php @@ -7,6 +7,7 @@ * @var string $category * @var array $catalogueQuery * @var string $clearCategoryUrl + * @var array $catalogueRoute */ $allCategoriesSelected = $category === ''; ?> @@ -46,7 +47,7 @@ $categoryQuery = array_replace($catalogueQuery, ['category' => $slug]); $categorySelected = $slug === $category; ?> - > diff --git a/templates/element/Packages/package-row.php b/templates/element/Packages/package-row.php index 2704ffcc..9736bd73 100644 --- a/templates/element/Packages/package-row.php +++ b/templates/element/Packages/package-row.php @@ -2,6 +2,7 @@ /** * @var \App\View\IslandTemplateView $this * @var \App\Model\Entity\Package $package + * @var string|null $namespace */ $summaries = []; foreach (['CakePHP' => $package->cake_php_tag_groups, 'PHP' => $package->php_tag_groups] as $label => $groups) { @@ -11,6 +12,7 @@ } } $detailsUrl = $this->Url->build(['_name' => 'plugin:view', 'id' => $package->id]); +$packageNamespace = explode('/', $package->package, 2)[0]; ?>
@@ -20,6 +22,15 @@

description ?: __('No description available.')) ?>

+ + Html->link(__('More by {0}', $packageNamespace), [ + '_name' => 'plugin:namespace', + 'namespace' => $packageNamespace, + ], [ + 'class' => 'mt-1 inline-flex min-h-6 items-center text-xs text-muted hover:text-primary', + 'x-interact:navigate' => '', + ]) ?> + categories) : ?>
element('Packages/awesome_badge', compact('package')) ?> diff --git a/templates/element/Packages/plugin-details.php b/templates/element/Packages/plugin-details.php index c319f0d3..f643054f 100644 --- a/templates/element/Packages/plugin-details.php +++ b/templates/element/Packages/plugin-details.php @@ -14,7 +14,15 @@ ?>
-

/

+

+ Html->link($vendor, [ + '_name' => 'plugin:namespace', + 'namespace' => $vendor, + ], [ + 'aria-label' => __('View all plugins by {0}', $vendor), + 'x-interact:navigate' => '', + ]) ?> / +

element('Packages/awesome_badge', compact('package')) ?>

description ?: __('No description available.')) ?>

diff --git a/templates/island/catalogue.php b/templates/island/catalogue.php index f712dea7..a4c468e9 100644 --- a/templates/island/catalogue.php +++ b/templates/island/catalogue.php @@ -13,6 +13,8 @@ * @var array $categoryOptions * @var string $category * @var bool $awesomeOnly + * @var string|null $namespace + * @var array $catalogueRoute */ $sortLabels = [ 'latest_stable_release_date' => __('Latest release'), @@ -20,24 +22,27 @@ 'stars' => __('Stars'), ]; $sortLabel = $sortLabels[$catalogueQuery['sort']] ?? __('Latest release'); -$clearUrl = $this->Url->build([ - 'controller' => 'Packages', 'action' => 'index', 'plugin' => null, - '?' => ['sort' => $catalogueQuery['sort'], 'direction' => $catalogueQuery['direction']], +$clearUrl = $this->Url->build($catalogueRoute + [ + '?' => [ + 'sort' => $catalogueQuery['sort'], + 'direction' => $catalogueQuery['direction'], + ], ]); -$clearCategoryUrl = $this->Url->build([ - 'controller' => 'Packages', 'action' => 'index', 'plugin' => null, +$clearCategoryUrl = $this->Url->build($catalogueRoute + [ '?' => array_replace($catalogueQuery, ['category' => '']), ]); ?>
-

+ +

+
Form->create(null, [ 'type' => 'get', - 'url' => ['controller' => 'Packages', 'action' => 'index', 'plugin' => null], + 'url' => $catalogueRoute, 'class' => 'min-w-0 flex-1', 'id' => 'catalogue-search-form', 'role' => 'search', @@ -107,7 +112,7 @@ ?> @@ -118,7 +123,7 @@
- element('Packages/category_browser', compact('categoryOptions', 'category', 'catalogueQuery', 'clearCategoryUrl')) ?> + element('Packages/category_browser', compact('categoryOptions', 'category', 'catalogueQuery', 'clearCategoryUrl', 'catalogueRoute')) ?>
@@ -140,7 +145,7 @@
$awesomeOnly ? '0' : '1']); ?> element('awesome_logo') ?> @@ -180,7 +185,7 @@
- element('Packages/package-row', compact('package')) ?> + element('Packages/package-row', compact('package', 'namespace')) ?>
diff --git a/tests/TestCase/ApplicationTest.php b/tests/TestCase/ApplicationTest.php index 6b216614..590ccb3a 100644 --- a/tests/TestCase/ApplicationTest.php +++ b/tests/TestCase/ApplicationTest.php @@ -131,6 +131,8 @@ public function testRateLimitProfiles(): void ['/', 'GET', [], 90], ['/', 'GET', ['search' => 'users'], 15], ['/plugins/1', 'GET', [], 90], + ['/plugins/by/dereuromark', 'GET', [], 90], + ['/plugins/by/dereuromark', 'GET', ['search' => 'tools'], 15], ['/_interact/update', 'POST', [], 30], ]; foreach ($requests as [$path, $method, $query, $limit]) { diff --git a/tests/TestCase/Controller/PackagesControllerTest.php b/tests/TestCase/Controller/PackagesControllerTest.php index df33d2f7..67da7840 100644 --- a/tests/TestCase/Controller/PackagesControllerTest.php +++ b/tests/TestCase/Controller/PackagesControllerTest.php @@ -3,6 +3,7 @@ namespace App\Test\TestCase\Controller; +use Cake\Routing\Router; use Cake\TestSuite\IntegrationTestTrait; use Cake\TestSuite\TestCase; use Override; @@ -24,6 +25,7 @@ class PackagesControllerTest extends TestCase #[Override] protected array $fixtures = [ 'app.FeaturedPlugins', 'app.Packages', + 'app.Categories', 'app.CategoriesPackages', 'plugin.Tags.Tags', 'plugin.Tags.Tagged', ]; @@ -102,6 +104,38 @@ public function testMissingPluginDetails(): void $this->assertResponseCode(404); } + /** + * Namespace pages are public, scoped, and expose totals unaffected by filters. + */ + public function testNamespacePage(): void + { + $this->get('/plugins/by/dereuromark?search=no-match'); + $this->assertResponseOk(); + $this->assertResponseContains('Plugins by dereuromark'); + $this->assertResponseContains('data-namespace-stat="downloads">20,000'); + $this->assertResponseContains('data-namespace-stat="stars">300'); + $this->assertResponseContains('No plugins found'); + $this->assertResponseContains('action="/plugins/by/dereuromark"'); + $this->assertResponseContains('rel="canonical" href="' . Router::url([ + '_name' => 'plugin:namespace', + 'namespace' => 'dereuromark', + ], true) . '"'); + $this->assertResponseNotContains('data-featured-plugins'); + $this->assertResponseNotContains('markstory/asset_compress'); + } + + /** + * Canonical casing retains query strings, while unknown namespaces return 404. + */ + public function testNamespaceCanonicalUrlAndMissingNamespace(): void + { + $this->get('/plugins/by/Dereuromark?search=tools&sort=stars'); + $this->assertResponseCode(301); + $this->assertRedirect('/plugins/by/dereuromark?search=tools&sort=stars'); + $this->get('/plugins/by/not-a-namespace'); + $this->assertResponseCode(404); + } + /** * Public catalogue documents provide the runtime and navigation metadata. */ diff --git a/tests/TestCase/Island/CatalogueIslandTest.php b/tests/TestCase/Island/CatalogueIslandTest.php index 244c9c61..8f1673b5 100644 --- a/tests/TestCase/Island/CatalogueIslandTest.php +++ b/tests/TestCase/Island/CatalogueIslandTest.php @@ -8,6 +8,7 @@ use Cake\Http\ServerRequest; use Cake\TestSuite\TestCase; use Interact\TestSuite\IslandTestTrait; +use InvalidArgumentException; use Override; use Tags\Model\Table\TaggedTable; use Tags\Model\Table\TagsTable; @@ -57,6 +58,52 @@ public function testUnknownCategoryIsCleared(): void $this->testIsland('Catalogue')->call('selectCategory', 'not-a-category')->assertSet('category', ''); } + /** + * Paging, filtering and resetting retain the server-owned namespace scope. + */ + public function testNamespaceScopeSurvivesUpdates(): void + { + $request = new ServerRequest(['url' => 'http://localhost/plugins/by/vendor']); + $island = $this->testIsland('Catalogue', ['namespace' => 'vendor'], request: $request) + ->assertDontSee('data-featured-plugins') + ->assertDontSee('markstory/asset_compress') + ->set('paging.page', 2) + ->assertSet('paging.page', 2) + ->set('search', 'package-01') + ->assertSet('paging.page', 1) + ->assertSee('vendor/package-01') + ->assertDontSee('vendor/package-02') + ->call('clearFilters') + ->assertSet('namespace', 'vendor') + ->assertDontSee('data-featured-plugins') + ->assertDontSee('markstory/asset_compress'); + $this->assertStringContainsString('/plugins/by/vendor?', $island->result()->html); + $this->assertStringNotContainsString('/_interact/update?', $island->result()->html); + } + + /** + * Namespaced category choices exclude unrelated categories and remain stable while searching. + */ + public function testNamespaceCategoryChoices(): void + { + $this->testIsland('Catalogue', ['namespace' => 'markstory']) + ->assertSee('Asset Management') + ->assertDontSee('Authentication & Authorization') + ->set('search', 'no-match') + ->assertSee('Asset Management') + ->assertSee('No plugins found'); + } + + /** + * Browser updates cannot replace the namespace supplied by the hosting page. + */ + public function testNamespaceCannotBeChangedByUpdates(): void + { + $island = $this->testIsland('Catalogue', ['namespace' => 'vendor']); + $this->expectException(InvalidArgumentException::class); + $island->set('namespace', 'cakedc'); + } + /** * Keep featured selection and cached options deterministic. */ diff --git a/tests/TestCase/Model/Table/PackagesTableTest.php b/tests/TestCase/Model/Table/PackagesTableTest.php index 2dd75ff5..4871c728 100644 --- a/tests/TestCase/Model/Table/PackagesTableTest.php +++ b/tests/TestCase/Model/Table/PackagesTableTest.php @@ -81,4 +81,53 @@ public function testFeaturedCandidates(): void 'vendor/package-07', 'vendor/package-08', 'vendor/package-09', ], $results->extract('package')->toList()); } + + /** + * Namespace matching is literal and ends at the Composer vendor separator. + */ + public function testNamespaceMatching(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $packages->updateAll(['package' => 'vendor_extra/one'], ['id' => 2]); + $packages->updateAll(['package' => 'vendorXextra/two'], ['id' => 3]); + $packages->updateAll(['package' => 'vendor_extra_more/three'], ['id' => 4]); + $packages->updateAll(['package' => 'vendor.extra/four'], ['id' => 5]); + $this->assertSame([2], $packages->find('namespace', namespace: 'vendor_extra')->all()->extract('id')->toList()); + $this->assertSame([5], $packages->find('namespace', namespace: 'vendor.extra')->all()->extract('id')->toList()); + $this->assertSame(0, $packages->find('namespace', namespace: 'vendor%')->count()); + $this->assertSame(0, $packages->find('namespace', namespace: "vendor' OR 1=1")->count()); + $this->assertSame(19, $packages->find('namespace', namespace: 'vendor')->count()); + } + + /** + * Totals and category counts cover only the requested namespace. + */ + public function testNamespaceStatisticsAndCategories(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $this->assertSame([ + 'plugins' => 23, + 'downloads' => 22701, + 'stars' => 2001, + ], $packages->namespaceStats('vendor')); + $this->assertSame([ + 'plugins' => 0, + 'downloads' => 0, + 'stars' => 0, + ], $packages->namespaceStats('missing')); + $this->assertSame([ + 'asset-management' => [ + 'name' => 'Asset Management', + 'count' => 1, + ], + 'code-analysis' => [ + 'name' => 'Code Analysis', + 'count' => 1, + ], + ], $packages->categoryOptions('markstory')); + $this->assertSame([], $packages->categoryOptions('vendor')); + $this->assertSame(1, $packages->find('catalogue', filters: ['awesome' => true], namespace: 'markstory')->count()); + $this->assertSame(0, $packages->find('catalogue', filters: ['search' => 'users'], namespace: 'markstory')->count()); + $this->assertSame(0, $packages->find('catalogue', filters: ['category' => 'authentication-authorization'], namespace: 'markstory')->count()); + } } diff --git a/tests/browser/namespaces.spec.js b/tests/browser/namespaces.spec.js new file mode 100644 index 00000000..317a523b --- /dev/null +++ b/tests/browser/namespaces.spec.js @@ -0,0 +1,169 @@ +import { test, expect } from '@playwright/test' + +const rows = page => page.locator('[data-package-row]') +const hero = page => page.locator('[data-namespace-hero]') +const pageErrors = new WeakMap() +const chooseSort = async (page, label) => { + await page.getByLabel('Sort plugins', { exact: true }).click() + await page.locator('.sort-options').getByRole('link', { name: label, exact: true }).click() +} + +test.beforeEach(async ({ page }) => { + const errors = [] + page.on('pageerror', error => errors.push(error.message)) + pageErrors.set(page, errors) +}) + +test.afterEach(async ({ page }) => { + expect(pageErrors.get(page)).toEqual([]) +}) + +test('namespace hero totals and catalogue results use the Composer prefix', async ({ page }) => { + await page.goto('/plugins/by/vendor') + await expect(page.getByRole('heading', { level: 1 })).toHaveText('Plugins by vendor') + await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') + await expect(hero(page).locator('[data-namespace-stat="downloads"]')).toHaveText('22,701') + await expect(hero(page).locator('[data-namespace-stat="stars"]')).toHaveText('2,001') + await expect(rows(page)).toHaveCount(21) + expect(await rows(page).evaluateAll(elements => elements.every(element => element.textContent.includes('vendor/package-')))).toBe(true) + await expect(page.locator('[data-featured-plugins]')).toHaveCount(0) + await expect(page.locator('link[rel="canonical"]')).toHaveAttribute('href', 'http://127.0.0.1:8765/plugins/by/vendor') + await expect(page.locator('meta[name="robots"]')).toHaveCount(0) + await page.screenshot({ path: 'tmp/namespace-desktop.png', fullPage: true, animations: 'disabled' }) +}) + +test('search, version filters, sorting and reset retain the namespace and hero', async ({ page }) => { + await page.goto('/plugins/by/vendor') + await page.evaluate(() => { window.namespaceMarker = 'retained' }) + await chooseSort(page, 'Downloads') + await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).fill('package-01') + await expect(rows(page)).toHaveCount(1) + await expect(rows(page)).toContainText('vendor/package-01') + await page.getByRole('button', { name: 'CakePHP 4.4', exact: true }).click() + await expect(rows(page)).toHaveCount(0) + await expect(page.getByText('No plugins found', { exact: true })).toBeVisible() + await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') + await expect(page.locator('meta[name="robots"]')).toHaveAttribute('content', 'noindex,nofollow') + await page.getByRole('link', { name: 'Reset filters', exact: true }).click() + await expect(rows(page)).toHaveCount(21) + await expect(page).toHaveURL('/plugins/by/vendor?sort=downloads') + expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') + await expect(page.getByRole('search')).toHaveAttribute('action', '/plugins/by/vendor') +}) + +test('pagination and history stay on the namespace page', async ({ page }) => { + await page.goto('/plugins/by/vendor') + await page.evaluate(() => { window.namespaceMarker = 'retained' }) + await page.getByRole('link', { name: 'Last', exact: true }).click() + await expect(page).toHaveURL('/plugins/by/vendor?page=2') + await expect(rows(page)).toHaveCount(2) + await page.getByRole('link', { name: 'First', exact: true }).click() + await expect(page).toHaveURL('/plugins/by/vendor') + await expect(rows(page)).toHaveCount(21) + await page.goBack() + await expect(page).toHaveURL('/plugins/by/vendor?page=2') + await expect(rows(page)).toHaveCount(2) + await page.goForward() + await expect(rows(page)).toHaveCount(21) + expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') + await page.reload() + await expect(rows(page)).toHaveCount(21) +}) + +test('category choices and detail filters stay within the namespace', async ({ page }) => { + await page.goto('/plugins/by/markstory') + await page.getByText('Browse categories', { exact: true }).click() + const categories = page.getByRole('group', { name: 'Plugin categories', exact: true }) + await expect(categories.getByRole('link', { name: 'Asset Management, 1 plugin', exact: true })).toBeVisible() + await expect(categories.getByRole('link', { name: /Authentication/ })).toHaveCount(0) + await categories.getByRole('link', { name: 'Asset Management, 1 plugin', exact: true }).click() + await expect(page).toHaveURL('/plugins/by/markstory?category=asset-management') + await expect(rows(page)).toHaveCount(1) + await page.getByRole('button', { name: 'Awesome only', exact: true }).click() + await expect(rows(page)).toHaveCount(1) + await rows(page).getByRole('link', { name: 'markstory/asset_compress', exact: true }).click() + const dialog = page.getByRole('dialog') + await dialog.getByRole('link', { name: 'Code Analysis', exact: true }).click() + await expect(dialog).not.toBeVisible() + await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) + await expect(page).toHaveURL(/category=code-analysis/) + await expect(rows(page)).toHaveCount(1) + await expect(hero(page).locator('[data-namespace-stat="downloads"]')).toHaveText('5,000') + await rows(page).getByRole('link', { name: 'markstory/asset_compress', exact: true }).click() + await dialog.getByRole('link', { name: 'PHP 8.5', exact: true }).click() + await expect(rows(page)).toHaveCount(1) + await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) + await expect(page).toHaveURL(/php_slugs/) + await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') +}) + +test('namespace links navigate from rows, modal details and standalone details', async ({ page }) => { + await page.goto('/') + await page.evaluate(() => { window.namespaceMarker = 'retained' }) + await page.getByRole('link', { name: 'More by dereuromark', exact: true }).click() + await expect(page).toHaveURL('/plugins/by/dereuromark') + expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') + await page.goBack() + await expect(page).toHaveURL('/') + await page.locator('#package-26').getByRole('link', { name: 'dereuromark/cakephp-tools', exact: true }).click() + await page.getByRole('dialog').getByRole('link', { name: 'View all plugins by dereuromark', exact: true }).click() + await expect(page).toHaveURL('/plugins/by/dereuromark') + await expect(page.getByRole('dialog')).not.toBeVisible() + await expect(hero(page)).toBeVisible() + expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') + await page.goto('/plugins/26') + await page.evaluate(() => { window.namespaceMarker = 'retained' }) + await page.getByRole('link', { name: 'View all plugins by dereuromark', exact: true }).click() + await expect(page).toHaveURL('/plugins/by/dereuromark') + expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') +}) + +test('namespace pages support native links and search without JavaScript', async ({ browser }) => { + const context = await browser.newContext({ javaScriptEnabled: false }) + const page = await context.newPage() + try { + await page.goto('/plugins/by/markstory') + await page.getByText('Browse categories', { exact: true }).click() + await page.getByRole('link', { name: 'Asset Management, 1 plugin', exact: true }).click() + await expect(page).toHaveURL(/\/plugins\/by\/markstory\?.*category=asset-management/) + await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).fill('no-match') + await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).press('Enter') + await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) + await expect(rows(page)).toHaveCount(0) + await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') + await page.getByRole('link', { name: 'Reset filters', exact: true }).click() + await expect(rows(page)).toHaveCount(1) + await page.goto('/plugins/by/vendor') + await page.getByRole('link', { name: 'Last', exact: true }).click() + await expect(page).toHaveURL('/plugins/by/vendor?page=2') + await expect(rows(page)).toHaveCount(2) + } finally { + await context.close() + } +}) + +test('namespace hero fits mobile screens in both themes', async ({ page, context }) => { + for (const width of [390, 320]) { + await page.setViewportSize({ width, height: 844 }) + for (const theme of ['cakephp', 'cakephp-dark']) { + await context.addCookies([{ name: 'theme', value: theme, domain: '127.0.0.1', path: '/' }]) + await page.goto('/plugins/by/dereuromark') + await expect(page.locator('html')).toHaveAttribute('data-theme', theme) + await expect(hero(page)).toBeVisible() + expect(await page.evaluate(() => document.documentElement.scrollWidth <= window.innerWidth)).toBe(true) + await page.screenshot({ path: `tmp/namespace-mobile-${theme}-${width}.png`, fullPage: true, animations: 'disabled' }) + // Real catalogue totals reach tens of millions; ensure values fit their individual cells. + await hero(page).locator('[data-namespace-stat="downloads"]').evaluate(element => { element.textContent = '62,789,075' }) + await hero(page).locator('[data-namespace-stat="stars"]').evaluate(element => { element.textContent = '1,740' }) + expect(await hero(page).locator('[data-namespace-stat]').evaluateAll(elements => elements.every(element => element.scrollWidth <= element.clientWidth))).toBe(true) + } + } +}) + +test('namespace URLs canonicalize casing and unknown namespaces return 404', async ({ page }) => { + await page.goto('/plugins/by/Dereuromark?search=tools&sort=stars') + await expect(page).toHaveURL('/plugins/by/dereuromark?search=tools&sort=stars') + await expect(rows(page)).toHaveCount(1) + const response = await page.goto('/plugins/by/unknown-namespace') + expect(response.status()).toBe(404) +}) From ff32f4817ece735851606a7881a113dfe313b347 Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 13:40:51 +0100 Subject: [PATCH 2/9] Separate namespace statistics and link GitHub profiles --- src/Controller/PackagesController.php | 6 +++-- src/Model/Table/PackagesTable.php | 26 +++++++++++++++++++ templates/Packages/by_namespace.php | 25 ++++++++++++------ .../Controller/PackagesControllerTest.php | 13 ++++++++++ .../Model/Table/PackagesTableTest.php | 26 +++++++++++++++++++ tests/browser/namespaces.spec.js | 23 +++++++++------- 6 files changed, 99 insertions(+), 20 deletions(-) diff --git a/src/Controller/PackagesController.php b/src/Controller/PackagesController.php index 1d5f4fb4..fd4e3a23 100644 --- a/src/Controller/PackagesController.php +++ b/src/Controller/PackagesController.php @@ -34,7 +34,8 @@ public function index(): void public function byNamespace(string $namespace): ?Response { $canonicalNamespace = strtolower($namespace); - $stats = $this->fetchTable(PackagesTable::class)->namespaceStats($canonicalNamespace); + $packages = $this->fetchTable(PackagesTable::class); + $stats = $packages->namespaceStats($canonicalNamespace); if ($stats['plugins'] === 0) { throw new NotFoundException('Namespace not found.'); } @@ -45,7 +46,8 @@ public function byNamespace(string $namespace): ?Response '?' => $this->getRequest()->getQueryParams(), ], 301); } - $this->set(compact('namespace', 'stats')); + $githubUrl = $packages->namespaceGithubUrl($namespace); + $this->set(compact('namespace', 'stats', 'githubUrl')); return null; } diff --git a/src/Model/Table/PackagesTable.php b/src/Model/Table/PackagesTable.php index 1f1399ef..7d304f59 100644 --- a/src/Model/Table/PackagesTable.php +++ b/src/Model/Table/PackagesTable.php @@ -176,6 +176,32 @@ public function namespaceStats(string $namespace): array ]; } + /** + * Link only an unambiguous GitHub repository owner, never guess from the Composer prefix. + */ + public function namespaceGithubUrl(string $namespace): ?string + { + $owners = []; + $repositories = $this->find('namespace', namespace: $namespace)->select(['repo_url'])->distinct()->all(); + foreach ($repositories as $package) { + $url = preg_replace('#^git@github\.com:#i', 'https://github.com/', trim($package->repo_url)) ?? $package->repo_url; + $host = strtolower((string)parse_url($url, PHP_URL_HOST)); + if (!in_array($host, ['github.com', 'www.github.com'], true)) { + continue; + } + $parts = explode('/', trim((string)parse_url($url, PHP_URL_PATH), '/')); + if (count($parts) < 2 || $parts[1] === '' || !preg_match('/^[a-z0-9][a-z0-9-]*$/iD', $parts[0])) { + continue; + } + $owners[strtolower($parts[0])] = true; + if (count($owners) > 1) { + return null; + } + } + + return $owners !== [] ? 'https://github.com/' . array_key_first($owners) : null; + } + /** * Load configured featured packages without changing their display order. * diff --git a/templates/Packages/by_namespace.php b/templates/Packages/by_namespace.php index a5d21b72..1cbbcf3e 100644 --- a/templates/Packages/by_namespace.php +++ b/templates/Packages/by_namespace.php @@ -3,6 +3,7 @@ * @var \App\View\AppView $this * @var string $namespace * @var array{plugins: int, downloads: int, stars: int} $stats + * @var string|null $githubUrl */ $this->assign('title', __('Plugins by {0}', $namespace)); $statLabels = [ @@ -30,16 +31,24 @@

-
- $label) : ?> -
-
-
Number->format($stats[$key]) ?>
-
- -
+ + + element('github_icon') ?> + + + +
+
+ $label) : ?> +
+
+
Number->format($stats[$key]) ?>
+
+ +
+
Interact->render('Catalogue', props: compact('namespace'), key: 'namespace-catalogue-' . $namespace) ?> element('Packages/plugin-modal') ?> diff --git a/tests/TestCase/Controller/PackagesControllerTest.php b/tests/TestCase/Controller/PackagesControllerTest.php index 67da7840..3ac1adc1 100644 --- a/tests/TestCase/Controller/PackagesControllerTest.php +++ b/tests/TestCase/Controller/PackagesControllerTest.php @@ -3,6 +3,7 @@ namespace App\Test\TestCase\Controller; +use App\Model\Table\PackagesTable; use Cake\Routing\Router; use Cake\TestSuite\IntegrationTestTrait; use Cake\TestSuite\TestCase; @@ -112,6 +113,7 @@ public function testNamespacePage(): void $this->get('/plugins/by/dereuromark?search=no-match'); $this->assertResponseOk(); $this->assertResponseContains('Plugins by dereuromark'); + $this->assertResponseContains('href="https://github.com/dereuromark"'); $this->assertResponseContains('data-namespace-stat="downloads">20,000'); $this->assertResponseContains('data-namespace-stat="stars">300'); $this->assertResponseContains('No plugins found'); @@ -136,6 +138,17 @@ public function testNamespaceCanonicalUrlAndMissingNamespace(): void $this->assertResponseCode(404); } + /** + * A namespace spanning different GitHub owners must not advertise an inferred profile. + */ + public function testNamespaceOmitsAmbiguousGithubProfile(): void + { + $this->fetchTable(PackagesTable::class)->updateAll(['repo_url' => 'https://github.com/another-owner/plugin'], ['id' => 2]); + $this->get('/plugins/by/vendor'); + $this->assertResponseOk(); + $this->assertResponseNotContains('GitHub profile'); + } + /** * Public catalogue documents provide the runtime and navigation metadata. */ diff --git a/tests/TestCase/Model/Table/PackagesTableTest.php b/tests/TestCase/Model/Table/PackagesTableTest.php index 4871c728..ac7cad21 100644 --- a/tests/TestCase/Model/Table/PackagesTableTest.php +++ b/tests/TestCase/Model/Table/PackagesTableTest.php @@ -130,4 +130,30 @@ public function testNamespaceStatisticsAndCategories(): void $this->assertSame(0, $packages->find('catalogue', filters: ['search' => 'users'], namespace: 'markstory')->count()); $this->assertSame(0, $packages->find('catalogue', filters: ['category' => 'authentication-authorization'], namespace: 'markstory')->count()); } + + /** + * Repository URLs identify a profile independently of the Composer namespace. + */ + public function testNamespaceGithubProfile(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $this->assertSame('https://github.com/vendor', $packages->namespaceGithubUrl('vendor')); + $packages->updateAll(['repo_url' => 'https://www.github.com/Actual-Owner/plugin.git'], ['id' => 1]); + $this->assertSame('https://github.com/actual-owner', $packages->namespaceGithubUrl('markstory')); + $packages->updateAll(['repo_url' => 'git@github.com:Actual-Owner/plugin.git'], ['id' => 1]); + $this->assertSame('https://github.com/actual-owner', $packages->namespaceGithubUrl('markstory')); + $packages->updateAll(['repo_url' => 'https://github.com/another-owner/plugin'], ['id' => 2]); + $this->assertNull($packages->namespaceGithubUrl('vendor')); + $unsupportedUrls = [ + 'https://gitlab.com/markstory/plugin', + 'https://github.com.example.com/markstory/plugin', + 'https://github.com/markstory', + 'https://github.com/invalid_owner/plugin', + ]; + foreach ($unsupportedUrls as $url) { + $packages->updateAll(['repo_url' => $url], ['id' => 1]); + $this->assertNull($packages->namespaceGithubUrl('markstory')); + } + $this->assertNull($packages->namespaceGithubUrl('missing')); + } } diff --git a/tests/browser/namespaces.spec.js b/tests/browser/namespaces.spec.js index 317a523b..b44db998 100644 --- a/tests/browser/namespaces.spec.js +++ b/tests/browser/namespaces.spec.js @@ -2,6 +2,7 @@ import { test, expect } from '@playwright/test' const rows = page => page.locator('[data-package-row]') const hero = page => page.locator('[data-namespace-hero]') +const stats = page => page.getByRole('region', { name: 'Namespace statistics', exact: true }) const pageErrors = new WeakMap() const chooseSort = async (page, label) => { await page.getByLabel('Sort plugins', { exact: true }).click() @@ -21,9 +22,11 @@ test.afterEach(async ({ page }) => { test('namespace hero totals and catalogue results use the Composer prefix', async ({ page }) => { await page.goto('/plugins/by/vendor') await expect(page.getByRole('heading', { level: 1 })).toHaveText('Plugins by vendor') - await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') - await expect(hero(page).locator('[data-namespace-stat="downloads"]')).toHaveText('22,701') - await expect(hero(page).locator('[data-namespace-stat="stars"]')).toHaveText('2,001') + await expect(hero(page).locator('[data-namespace-stat]')).toHaveCount(0) + await expect(hero(page).getByRole('link', { name: 'GitHub profile' })).toHaveAttribute('href', 'https://github.com/vendor') + await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') + await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('22,701') + await expect(stats(page).locator('[data-namespace-stat="stars"]')).toHaveText('2,001') await expect(rows(page)).toHaveCount(21) expect(await rows(page).evaluateAll(elements => elements.every(element => element.textContent.includes('vendor/package-')))).toBe(true) await expect(page.locator('[data-featured-plugins]')).toHaveCount(0) @@ -42,7 +45,7 @@ test('search, version filters, sorting and reset retain the namespace and hero', await page.getByRole('button', { name: 'CakePHP 4.4', exact: true }).click() await expect(rows(page)).toHaveCount(0) await expect(page.getByText('No plugins found', { exact: true })).toBeVisible() - await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') + await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') await expect(page.locator('meta[name="robots"]')).toHaveAttribute('content', 'noindex,nofollow') await page.getByRole('link', { name: 'Reset filters', exact: true }).click() await expect(rows(page)).toHaveCount(21) @@ -88,13 +91,13 @@ test('category choices and detail filters stay within the namespace', async ({ p await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) await expect(page).toHaveURL(/category=code-analysis/) await expect(rows(page)).toHaveCount(1) - await expect(hero(page).locator('[data-namespace-stat="downloads"]')).toHaveText('5,000') + await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('5,000') await rows(page).getByRole('link', { name: 'markstory/asset_compress', exact: true }).click() await dialog.getByRole('link', { name: 'PHP 8.5', exact: true }).click() await expect(rows(page)).toHaveCount(1) await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) await expect(page).toHaveURL(/php_slugs/) - await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') + await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') }) test('namespace links navigate from rows, modal details and standalone details', async ({ page }) => { @@ -130,7 +133,7 @@ test('namespace pages support native links and search without JavaScript', async await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).press('Enter') await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) await expect(rows(page)).toHaveCount(0) - await expect(hero(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') + await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') await page.getByRole('link', { name: 'Reset filters', exact: true }).click() await expect(rows(page)).toHaveCount(1) await page.goto('/plugins/by/vendor') @@ -153,9 +156,9 @@ test('namespace hero fits mobile screens in both themes', async ({ page, context expect(await page.evaluate(() => document.documentElement.scrollWidth <= window.innerWidth)).toBe(true) await page.screenshot({ path: `tmp/namespace-mobile-${theme}-${width}.png`, fullPage: true, animations: 'disabled' }) // Real catalogue totals reach tens of millions; ensure values fit their individual cells. - await hero(page).locator('[data-namespace-stat="downloads"]').evaluate(element => { element.textContent = '62,789,075' }) - await hero(page).locator('[data-namespace-stat="stars"]').evaluate(element => { element.textContent = '1,740' }) - expect(await hero(page).locator('[data-namespace-stat]').evaluateAll(elements => elements.every(element => element.scrollWidth <= element.clientWidth))).toBe(true) + await stats(page).locator('[data-namespace-stat="downloads"]').evaluate(element => { element.textContent = '62,789,075' }) + await stats(page).locator('[data-namespace-stat="stars"]').evaluate(element => { element.textContent = '1,740' }) + expect(await stats(page).locator('[data-namespace-stat]').evaluateAll(elements => elements.every(element => element.scrollWidth <= element.clientWidth))).toBe(true) } } }) From b31b58eac62547f55fb2ca0744a65075a26c3cef Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 13:46:48 +0100 Subject: [PATCH 3/9] Refine namespace header and add Packagist link --- templates/Packages/by_namespace.php | 70 +++++++++++------- .../Controller/PackagesControllerTest.php | 2 + tests/browser/namespaces.spec.js | 10 ++- webroot/img/packagist-logo.png | Bin 0 -> 4573 bytes 4 files changed, 53 insertions(+), 29 deletions(-) create mode 100644 webroot/img/packagist-logo.png diff --git a/templates/Packages/by_namespace.php b/templates/Packages/by_namespace.php index 1cbbcf3e..1ba045d5 100644 --- a/templates/Packages/by_namespace.php +++ b/templates/Packages/by_namespace.php @@ -6,6 +6,7 @@ * @var string|null $githubUrl */ $this->assign('title', __('Plugins by {0}', $namespace)); +$packagistUrl = 'https://packagist.org/packages/' . rawurlencode($namespace) . '/'; $statLabels = [ 'plugins' => __('Plugins'), 'downloads' => __('Downloads'), @@ -17,38 +18,51 @@ 'class' => 'mb-5 inline-flex min-h-8 items-center text-sm text-muted', 'x-interact:navigate' => '', ]) ?> -
-
-
-
+
+
+ $label) : ?> +
+
+
Number->format($stats[$key]) ?>
+
+ +
+
+ Interact->render('Catalogue', props: compact('namespace'), key: 'namespace-catalogue-' . $namespace) ?> element('Packages/plugin-modal') ?> diff --git a/tests/TestCase/Controller/PackagesControllerTest.php b/tests/TestCase/Controller/PackagesControllerTest.php index 3ac1adc1..6ed85ea1 100644 --- a/tests/TestCase/Controller/PackagesControllerTest.php +++ b/tests/TestCase/Controller/PackagesControllerTest.php @@ -114,6 +114,7 @@ public function testNamespacePage(): void $this->assertResponseOk(); $this->assertResponseContains('Plugins by dereuromark'); $this->assertResponseContains('href="https://github.com/dereuromark"'); + $this->assertResponseContains('href="https://packagist.org/packages/dereuromark/"'); $this->assertResponseContains('data-namespace-stat="downloads">20,000'); $this->assertResponseContains('data-namespace-stat="stars">300'); $this->assertResponseContains('No plugins found'); @@ -147,6 +148,7 @@ public function testNamespaceOmitsAmbiguousGithubProfile(): void $this->get('/plugins/by/vendor'); $this->assertResponseOk(); $this->assertResponseNotContains('GitHub profile'); + $this->assertResponseContains('href="https://packagist.org/packages/vendor/"'); } /** diff --git a/tests/browser/namespaces.spec.js b/tests/browser/namespaces.spec.js index b44db998..30e1a12e 100644 --- a/tests/browser/namespaces.spec.js +++ b/tests/browser/namespaces.spec.js @@ -24,6 +24,14 @@ test('namespace hero totals and catalogue results use the Composer prefix', asyn await expect(page.getByRole('heading', { level: 1 })).toHaveText('Plugins by vendor') await expect(hero(page).locator('[data-namespace-stat]')).toHaveCount(0) await expect(hero(page).getByRole('link', { name: 'GitHub profile' })).toHaveAttribute('href', 'https://github.com/vendor') + await expect(hero(page).getByRole('link', { name: 'Packagist', exact: true })).toHaveAttribute('href', 'https://packagist.org/packages/vendor/') + await expect(hero(page).getByRole('link', { name: 'Packagist', exact: true })).toHaveAttribute('target', '_blank') + await expect(hero(page).getByRole('link', { name: 'GitHub profile' })).toHaveText('') + await expect(hero(page).getByRole('link', { name: 'Packagist', exact: true })).toHaveText('') + const headingBounds = await hero(page).boundingBox() + const statsBounds = await stats(page).boundingBox() + expect(statsBounds.x).toBeGreaterThan(headingBounds.x + headingBounds.width) + expect(statsBounds.y).toBe(headingBounds.y) await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('22,701') await expect(stats(page).locator('[data-namespace-stat="stars"]')).toHaveText('2,001') @@ -32,7 +40,7 @@ test('namespace hero totals and catalogue results use the Composer prefix', asyn await expect(page.locator('[data-featured-plugins]')).toHaveCount(0) await expect(page.locator('link[rel="canonical"]')).toHaveAttribute('href', 'http://127.0.0.1:8765/plugins/by/vendor') await expect(page.locator('meta[name="robots"]')).toHaveCount(0) - await page.screenshot({ path: 'tmp/namespace-desktop.png', fullPage: true, animations: 'disabled' }) + await page.screenshot({ path: 'tmp/namespace-desktop.png', animations: 'disabled' }) }) test('search, version filters, sorting and reset retain the namespace and hero', async ({ page }) => { diff --git a/webroot/img/packagist-logo.png b/webroot/img/packagist-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..76c0e62a20d7ca8f50ce24b1e5acb8b4af2b932f GIT binary patch literal 4573 zcma)9XE5B47X7VmS=Oq%>JmLf3( z>#9o-HCn>U|9yO)-kG`Qo-=d4+?hLf=Emw_)FEI57ytl>23p17Z@2rm$O!+kx}3cO z01%w$X&b5jwesIl9G~=kdXWz!G9wd3#=*h@WHygV*OB)xvI3} zW^in+e*~wjs%2_nr>$#pS5l6Zopa>-=Fr4OL-Rmo?WdxOrleN|g11G-XLs!!Jwzp> zZ*lX}($dGs0ow;R-=?=e_e{5Z8g=&$xg#bCfk3Ag4|)a{T0f81Hue^jy!Y}CcX0NU zS5VtIyvZx7k59^Z5&1GCED`JC{lL_k3C`TuI#gcWR`RwbCL!yQjgzcAN?KL{OaY0P z2YwvgWarnAl7Vgb0Sg|$m<#9{m~ZczsIKoy&n{0%FA5Ba_X~=4^$4)BcQb$FprLK3 zuA#@t$-~aUjbLUY2U8Fclcy*GEF=IqA&{C;8X22zW$U76Xs)BBrGV0ql2)K&fFE7l z00jr5Q~1ulncTwKjNG^3;bDpj3c@1d7QF; zh!pVi=g+Op&F|x5!$V(_l9Cc*A_3j!fczssL{~*tQdUe@k`}}X2JP?f}wx%~s*li#^F6F+Qqr(pFK4}QP=0{NTXFn0f5R{Lq*95yR?z@ zz>8U(E^4D&RN{NoAS5+&elmAV3`_4}@8IANm0{azvl#_PIA@m*{fppjEH~Ww?Mk`s zpV33?K!syq;l=VP80!objw8(x!}lx#Vvr=mmQNI0sc9d};P19J$9Y5#9hjeq>h83cM!r z8yv|qvR^y>18wg?P>67!cSA_?r>Er<9Kink#%*kcwi_Rky|KxdUCjeR{CxoGgT}k>6}T9nQ%hf zy|fy`WFqZYS6rU02LoFXsN;GfVro(wxN7QGpDvZ${VFG%%`2W<1<%!ivTLsH9vsxF zPo2X~KQk`zP32tsqV~r~b^?#Wlb*VYoc_B?=cyh~Yy~K?SL;DM374cX6+}q2TO&@U zdBvvicp6cI=cQ{MUTz{0s#l2C&n#bTCfS;7m&0Hxc6Fnoo!y_jqv1rIvp?3f0qeOc ze6?}hDlKy$Qrr?jCVCX<5MvJOu^rddV0mnKkKu7gD+qPt&{djn_bxiH30y1e1}V(g ziperF#w>uH$TbzZnKH>IH(11MtCt7q-amC3c$IAHwHKjv4W{uz+6fgKgUwv;G{9>1 zpq~km2Kq+`^?K)1rDle52Ka7!*SNu1e}gQ7dL}Ir<9T2e#XHfpIHva#C6M5hxfADT zCNCKm$5|;6&MYfheWoFlWWeuB_{v>PP!^c_D4mR)M_BJzDGG;`?h{RnlNsxFU}8NB z^rqfw8mXFF?x6%9r|udDf4WyRuYao>{SUf`2m9f*+boU1O@ zt=5%0)vUXp3B+>fD>FTLtoBd=O*j0l8ZJ9wD_9&uZ$~Bo)A~_Q<+0iUq5b`IjY3Si zrNXd2fMxhmjswkCpHAAQc56Re5idv9Ch1k|SlUO)z$;c?7pc91^v>szRS9#J&NWQ~ zuFzFRSclm3QXBeY*GQCj=gIEjK~!ha{IEF<8yQaPO{DoJZ{NjVUcWVw%O&13>0tew zX2{49sr08o2i=l7l1^-izmf`}oXx?uu_+b~bn+3po%sYqsT14VraC{?+orsvEISX^ zu0UmcVe9+w%*iZA^vNI6?%wF6;LF~{s8%E)?m1b$^~cwgt81-|HeIPlHN8Jd*U(C}FT#{Zx9{&Xnir_e&g!*!_y=l4-jucfX{#}C zKUxnLF~i~FYs4DG6>^85f2KV{aVd2AtnKo0?cMVa?d3CW>r7GN<93>& zaiH_lH1Q@tCF-uT9pLOl=B4XN8|yh2_zNl7Vs zMTl0Eac z5837qZCWN!nrXWSiP3&y!pO!KZ%WP#tgK9&?fOsr#wkIaX^?*128U%=6vwr6r~cxV z(bZ^e5?Z-ygx|WCqNj_t*F#Y#`5t^_s@>{--kbg76Q*6d%$ zey2L<`LXgqAFLLGI|ehnyGKIwb8PF~ePD&JI!rt7%%I95M*%HzyYZs*!EH-w(aN+k zG0;BaXQ5+**IlqXC1&wqGsQf2l+Q1ok5A9#;zKv;M+Y+STEDp;Vbx~{_4oR;wQgmN zd&a7+r1*P4=Gj}Z{7vdW{`jUyfH^B!yb3i@kt^f54)1&$^lkIp!o$bhI$#`@115IH zCCAri{sh4xGy)OOY!th7%QH7Q%4}4=TzaUR$(Xq@`)>y%1iMFDlFs9;Z%JPezlFAQlUTw*D^fT(-8yUaztg3iaXRj}_ z7Y=Rc@33PvI;z|f7@yq{%0_?7l&}~^NWcT=Mvc(%{p%mi4Pf1|Gn`XwVN3Xu0sYj< z`euayXdPJ}%A$BIxFkL6Wji!ZkjbY5^WrpCEeRw{j<6qJ;Y#leCQGXkt6s`aOzxhT zda*st#cw0eqPJk8DRe$AVD`BR_r`>*%DC-@d)SeFtAftNz&>oUb?Y9--7p*Z^k`Hq z45F31G{JY4Kr}yBMg$o)rRAVM-H4MkMYeKIEMOGl<|z}a!mY^WNZ>7YF}Jo#^{d_~ zo86|=Ii3y^*PIOOnfFzy7oyT8&E?^>OSZxPi7QzHNpi{ev4*K?FDIl2H9M27JENKP zObU(e8I#XH6_j^TfiJmGD4!T zrtCcz?4%!f(|5zXec5*`wj*+PLvNyl20C2G))6uGB!1!#DcuG6q5F|OLTeXhv@W+T zh`aWp)Im9C8!aRY%FGQ>DB);{JT^U6wO?JXh+<rnb!vwH*<^6+WJd@OMm1(e?|d^HY?OE~%mmZ0$N{*T`T#xQ$hDM(?&FrQ<0|Po9YS zb^V7y$(~1#UURk}D~i`SWy&Y>38y1U{iFEfi9Kx+hQ2xT%U!N10qQnNdBHy`y&2{R z$BHuQ9I0uy%c6WFdnE}K!Lcgc`b$Sfvu5FHtARlclY~a}znHiLtRbNdB1#`>tEv}L z9482%1FuvKqjdQ?9dm*PHMY7C9V97tnp%-hm4nD-hZsKWPJv?|5cdHQ^b~fkj)%X5 z)xFx6BC9hr@L7dd6p_l_lT#0d-IGNgc~xyEh*2GS#tl4?lD2(3O+Yj7km22vkG~wd zYnC&4;XPqPwedG#vCV&C%c8X@^0xgt+n@ZRpr<@_j4}G=QmL&-!%y(}SrPiQlRGv0 z+k%Bxc|ZIp36nH}IAc2Ov8-v-slV2JCbSzDo0@PNLujKRtOcR8Up+n*@tCU$34r=! z9m{^n9cz7^4Ks4B^H|Puugms z9nq5_8l6k@1`4- z?u%&eyq3sYYHw3#nJcKMl`6ia$6vHrGA1&KIpi20^2Y z)Kyrlrr|b)L43i-p%~8}vGGLcqC257vxJ2SqKAi;z$8D5`amPWY{!dnc&$x-v64tl zf5iEqSX7;X_Dj#T-U-4Urn@*+{JQCAxUI^2{<`ch-O6wFBQB21NWss>rlUbSu83{} zfntyMc@mmbpf+E--Hgv7BZ#Y$|zb@W=jaLxyC$7Nom)sZ1n}_ zTY%LvcfII1xi`ZwS&zjG3b_Ah`GN!mFg_(YF4f5%asZ$K1Nn+s>qX1#b7Z4K*(`K1 z4?fvV88u69ogc1A$xDS?xA{}E%LkmawC>9sU0-=V&20B@VIt~c4i8g{cFoE5q}3mB z(P@GX=VdG3&kFYYZMH?yYv|C~HY>HUKIBcfxpZ=ENj;h$a=yvsx!BCL$xOJxJvx$? z>zOn29H03#k6Y_8Nz>o^wHQq`x=aV-^9}jg=_u(&@J45}BhYVYj4R@7MRqi(fu>i7 ziJgrJO;&gJG|2A&Z>gTR)$FL9E&V1(M_etRmBUJIW7SZ7dn7E{4XGusC#^mNy0#oB z7dh5x8rq*;Xz_e1EkJa6b{}`J(spqin+a literal 0 HcmV?d00001 From c5f1c8b05615d16d5508eacae0513399513e80ce Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 14:03:42 +0100 Subject: [PATCH 4/9] Simplify namespace header copy --- templates/Packages/by_namespace.php | 1 - 1 file changed, 1 deletion(-) diff --git a/templates/Packages/by_namespace.php b/templates/Packages/by_namespace.php index 1ba045d5..0852ae97 100644 --- a/templates/Packages/by_namespace.php +++ b/templates/Packages/by_namespace.php @@ -30,7 +30,6 @@

-

From 84a3f786d2b0cf368a9a152f773f7820d151913e Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 14:54:04 +0100 Subject: [PATCH 5/9] Refine namespace profiles and add Composer package URLs --- config/app.php | 8 + config/routes.php | 20 ++- playwright.config.js | 1 + resources/css/style.css | 77 ++++++++ resources/js/app.js | 32 ++++ src/Application.php | 6 +- src/Controller/PackagesController.php | 9 +- src/Island/NamespaceProfileIsland.php | 37 ++++ src/Service/GithubProfileService.php | 71 ++++++++ src/View/AppView.php | 3 + src/View/Helper/NumberHelper.php | 36 ++++ src/View/IslandTemplateView.php | 4 + templates/Packages/by_namespace.php | 87 ++++----- templates/Packages/view.php | 6 + .../element/Loading/namespace_profile.php | 32 ++++ templates/element/Namespaces/profile.php | 55 ++++++ templates/element/Packages/package-row.php | 8 +- templates/island/featured_plugins.php | 6 +- templates/island/namespace_profile.php | 16 ++ templates/layout/default.php | 2 +- tests/TestCase/ApplicationTest.php | 7 +- .../Controller/PackagesControllerTest.php | 100 ++++++++++- tests/TestCase/Island/CatalogueIslandTest.php | 4 +- .../Island/NamespaceProfileIslandTest.php | 67 +++++++ .../Service/GithubProfileServiceTest.php | 113 ++++++++++++ .../TestCase/View/Helper/NumberHelperTest.php | 56 ++++++ tests/bootstrap.php | 2 + tests/browser/catalogue.spec.js | 4 +- tests/browser/namespaces.spec.js | 167 ++++++++++++++---- tests/browser/setup.php | 6 + 30 files changed, 926 insertions(+), 116 deletions(-) create mode 100644 src/Island/NamespaceProfileIsland.php create mode 100644 src/Service/GithubProfileService.php create mode 100644 src/View/Helper/NumberHelper.php create mode 100644 templates/element/Loading/namespace_profile.php create mode 100644 templates/element/Namespaces/profile.php create mode 100644 templates/island/namespace_profile.php create mode 100644 tests/TestCase/Island/NamespaceProfileIslandTest.php create mode 100644 tests/TestCase/Service/GithubProfileServiceTest.php create mode 100644 tests/TestCase/View/Helper/NumberHelperTest.php diff --git a/config/app.php b/config/app.php index 29a1d6f6..9bd83e7f 100644 --- a/config/app.php +++ b/config/app.php @@ -157,6 +157,14 @@ 'url' => env('CACHE_DEFAULT_URL'), ], + 'github_profiles' => [ + 'className' => FileEngine::class, + 'path' => CACHE . 'github_profiles' . DS, + 'prefix' => 'plugins_github_profiles_', + 'duration' => '+1 day', + 'url' => env('CACHE_GITHUB_PROFILES_URL'), + ], + 'rate_limit' => [ 'className' => FileEngine::class, 'path' => CACHE . 'rate_limit' . DS, diff --git a/config/routes.php b/config/routes.php index e88d10d8..f6815f14 100644 --- a/config/routes.php +++ b/config/routes.php @@ -59,16 +59,26 @@ * to use (in this case, templates/Pages/home.php)... */ $builder->connect('/', ['controller' => 'Packages', 'action' => 'index']); - $builder->get('/plugins/by/{namespace}', [ + $packageSegment = '[A-Za-z0-9][A-Za-z0-9_.-]*'; + $builder->get('/plugins/{namespace}/{name}', [ + 'controller' => 'Packages', + 'action' => 'view', + ], 'plugin:view') + ->setPatterns([ + 'namespace' => $packageSegment, + 'name' => $packageSegment, + ]) + ->setPass(['namespace', 'name']) + ->setExtensions([]); + $builder->get('/plugins/{namespace}', [ 'controller' => 'Packages', 'action' => 'byNamespace', ], 'plugin:namespace') ->setPatterns([ - 'namespace' => '[A-Za-z0-9][A-Za-z0-9_.-]*', + 'namespace' => $packageSegment, ]) - ->setPass(['namespace']); - $builder->get('/plugins/{id}', ['controller' => 'Packages', 'action' => 'view'], 'plugin:view') - ->setPatterns(['id' => '[0-9]+'])->setPass(['id']); + ->setPass(['namespace']) + ->setExtensions([]); $builder->connect('/requirements', ['controller' => 'Pages', 'action' => 'display', 'requirements']); /* diff --git a/playwright.config.js b/playwright.config.js index ab7fdb2e..d77fce92 100644 --- a/playwright.config.js +++ b/playwright.config.js @@ -17,6 +17,7 @@ export default defineConfig({ DEBUG: 'false', RATE_LIMIT_ENABLED: 'false', CACHE_DEFAULT_URL: 'array://', + CACHE_GITHUB_PROFILES_URL: `file://${fileURLToPath(new URL('./tmp/browser-github-profiles/', import.meta.url))}`, CACHE_MODEL_URL: 'array://', CACHE_PERSISTENT_URL: 'array://', }, diff --git a/resources/css/style.css b/resources/css/style.css index 582d73e6..4709dad2 100644 --- a/resources/css/style.css +++ b/resources/css/style.css @@ -174,6 +174,81 @@ body::before { & h1 { @apply mb-2 text-[clamp(1.875rem,3.5vw,2.5rem)] leading-tight font-bold tracking-[-0.025em]; } & p { @apply text-muted; } } +.namespace-hero { + @apply relative isolate overflow-hidden border-b border-base-300 bg-base-100; + --namespace-rose: color-mix(in srgb, var(--color-primary) 28%, transparent); + &::before, &::after { + content: ""; + position: absolute; + z-index: -1; + pointer-events: none; + } + &::before { + inset: -45%; + background: + radial-gradient(ellipse at 15% 45%, var(--namespace-rose), transparent 50%), + radial-gradient(ellipse at 75% 35%, var(--glow-violet), transparent 50%), + radial-gradient(ellipse at 60% 80%, var(--glow-amber), transparent 45%); + animation: namespace-gradient 22s ease-in-out infinite alternate; + } + &::after { + inset: -60%; + background: radial-gradient(ellipse at 60% 50%, var(--glow-violet), transparent 58%); + animation: namespace-light 30s ease-in-out infinite alternate; + } +} +[data-theme="cakephp"] .namespace-hero { + --namespace-rose: color-mix(in srgb, var(--color-cake-red) 46%, transparent); + --glow-violet: #7d85dd66; + --glow-amber: #ffb98166; + background-color: var(--color-base-200); +} +.namespace-profile { + @apply grid min-w-0 items-center gap-8 pt-24 pb-12 md:gap-10 lg:min-h-72 lg:grid-cols-[minmax(0,1fr)_auto] + lg:gap-16 lg:py-20; +} +.namespace-toolbar { + @apply absolute inset-x-0 top-3 flex items-center justify-between gap-3 md:top-4; +} +.namespace-title { + @apply text-[clamp(1.75rem,5vw,4rem)] leading-none font-bold tracking-[-0.055em] wrap-anywhere; +} +.namespace-avatar { + @apply relative size-14 overflow-hidden rounded-xl bg-primary/10 text-lg font-semibold text-primary + md:size-24 md:rounded-2xl md:text-2xl; + & img { @apply absolute inset-0 size-full object-cover; } +} +.namespace-identity { + @apply flex min-w-0 items-center gap-4 md:gap-5; + min-height: max(6rem, calc(clamp(1.75rem, 5vw, 4rem) + 3.25rem)); +} +.namespace-description { + @apply mt-3 line-clamp-2 max-w-[42ch] text-sm leading-5 text-muted; +} +.namespace-profile-links { + @apply mt-2 ml-18 flex gap-1 md:ml-29; +} +.namespace-profile-link { + @apply size-8 min-h-8 border-0 bg-transparent p-0 text-muted shadow-none hover:bg-base-100/40 hover:text-primary; + & svg { @apply size-4.5; } +} +@media (pointer: coarse) { + .namespace-profile-link { @apply size-11 min-h-11; } +} +.namespace-statistics { + @apply w-full min-w-0 md:max-w-md lg:w-96; +} +.namespace-stat-value { + @apply text-[clamp(1.5rem,2.8vw,2.5rem)] leading-tight font-semibold tracking-tight tabular-nums; +} +@keyframes namespace-gradient { + from { transform: translate3d(-4%, -3%, 0) rotate(-6deg) scale(1); } + to { transform: translate3d(5%, 4%, 0) rotate(7deg) scale(1.12); } +} +@keyframes namespace-light { + from { transform: translate3d(4%, 0, 0) rotate(-15deg); } + to { transform: translate3d(-4%, 3%, 0) rotate(20deg); } +} .catalogue-discovery { @apply mb-6 rounded-2xl border border-base-300 bg-base-100 p-4 md:p-5; } @@ -466,7 +541,9 @@ body::before { @keyframes page-loading { from { transform: translateX(-100%); } to { transform: translateX(300%); } } @media (prefers-reduced-motion: reduce) { .page-loading-bar, .loading { animation: none; } + .namespace-hero::before, .namespace-hero::after { animation: none; } } @media (forced-colors: active) { body::before { display: none; } + .namespace-hero::before, .namespace-hero::after { display: none; } } diff --git a/resources/js/app.js b/resources/js/app.js index a13096fa..68112598 100644 --- a/resources/js/app.js +++ b/resources/js/app.js @@ -18,6 +18,38 @@ const register = (Alpine) => { }, }) + Alpine.data('namespaceCounters', () => ({ + frame: null, + init() { + const motion = window.matchMedia('(prefers-reduced-motion: reduce)') + if (motion.matches) return + const counters = Array.from(this.$el.querySelectorAll('[data-count-up-value]'), (element, index) => ({ + element, + total: Number(element.dataset.countUpValue), + final: element.textContent.trim(), + delay: index * 200, + })) + const formatter = new Intl.NumberFormat('en', { notation: 'compact', maximumFractionDigits: 1 }) + const started = performance.now() + const tick = now => { + let complete = true + for (const counter of counters) { + const progress = motion.matches ? 1 : Math.max(0, Math.min((now - started - counter.delay) / 1100, 1)) + const eased = 1 - (1 - progress) ** 3 + counter.element.textContent = progress === 1 + ? counter.final + : formatter.format(Math.round(counter.total * eased)).replace('K', 'k') + complete &&= progress === 1 + } + this.frame = complete ? null : requestAnimationFrame(tick) + } + this.frame = requestAnimationFrame(tick) + }, + destroy() { + if (this.frame !== null) cancelAnimationFrame(this.frame) + }, + })) + Alpine.data('catalogue', () => ({ categorySearch: '', categoriesToggled(event) { diff --git a/src/Application.php b/src/Application.php index c9bd51e9..87f56570 100644 --- a/src/Application.php +++ b/src/Application.php @@ -20,12 +20,14 @@ use App\Command\SyncPackagesCommand; use App\Event\AfterGithubIdentify; use App\Http\RateLimit\AtomicFixedWindowRateLimiter; +use App\Island\NamespaceProfileIsland; use App\Middleware\ThemeCookieMiddleware; use App\Model\Table\PackagesTable; use App\Model\Table\UsersTable; use App\Policy\RequestPolicy; use App\Service\AwesomeListImporter; use App\Service\AwesomeListParser; +use App\Service\GithubProfileService; use App\Service\PackagistImporter; use Authentication\AuthenticationService; use Authentication\AuthenticationServiceInterface; @@ -203,7 +205,7 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue } return !in_array($request->getMethod(), ['GET', 'HEAD'], true) - || !($path === '' || $path === '/packages' || preg_match('#^/plugins/(?:[0-9]+|by/[A-Za-z0-9][A-Za-z0-9_.-]*)$#', $path)); + || !($path === '' || $path === '/packages' || preg_match('#^/plugins/[A-Za-z0-9][A-Za-z0-9_.-]*(?:/[A-Za-z0-9][A-Za-z0-9_.-]*)?$#', $path)); }, ]), ); @@ -223,6 +225,8 @@ public function services(ContainerInterface $container): void { $container->addShared(PackagesTable::class, static fn(): RepositoryInterface => FactoryLocator::get('Table')->get(PackagesTable::class)); $container->addShared(Client::class); + $container->addShared(GithubProfileService::class)->addArgument(Client::class); + $container->add(NamespaceProfileIsland::class)->addArgument(GithubProfileService::class); $container->addShared(AwesomeListParser::class); $container->addShared('packagist.http', static function (): Client { $client = new Client(); diff --git a/src/Controller/PackagesController.php b/src/Controller/PackagesController.php index fd4e3a23..6a57b01e 100644 --- a/src/Controller/PackagesController.php +++ b/src/Controller/PackagesController.php @@ -55,9 +55,14 @@ public function byNamespace(string $namespace): ?Response /** * Provide a normal detail URL for direct links and browsers without JavaScript. */ - public function view(string $id): void + public function view(string $namespace, string $name): void { - $package = $this->fetchTable(PackagesTable::class)->get($id, contain: ['Tags', 'Categories']); + $package = $this->fetchTable(PackagesTable::class)->find() + ->where([ + 'Packages.package' => strtolower($namespace . '/' . $name), + ]) + ->contain(['Tags', 'Categories']) + ->firstOrFail(); $this->set(compact('package')); } } diff --git a/src/Island/NamespaceProfileIsland.php b/src/Island/NamespaceProfileIsland.php new file mode 100644 index 00000000..efa7fff5 --- /dev/null +++ b/src/Island/NamespaceProfileIsland.php @@ -0,0 +1,37 @@ + + */ + public function viewData(): array + { + return [ + 'profile' => $this->profiles->profile(basename($this->githubUrl)), + ]; + } +} diff --git a/src/Service/GithubProfileService.php b/src/Service/GithubProfileService.php new file mode 100644 index 00000000..f7043b5a --- /dev/null +++ b/src/Service/GithubProfileService.php @@ -0,0 +1,71 @@ +get($key); + if (is_array($cached)) { + return $cached !== [] ? $cached : null; + } + + $profile = null; + try { + $response = $this->client->get('https://api.github.com/users/' . rawurlencode($owner), [], [ + 'timeout' => 3, + 'headers' => [ + 'Accept' => 'application/vnd.github+json', + 'User-Agent' => 'plugins.cakephp.org', + 'X-GitHub-Api-Version' => '2022-11-28', + ], + ]); + $data = $response->isOk() ? $response->getJson() : null; + if (is_array($data) && is_string($data['login'] ?? null) && strcasecmp($data['login'], $owner) === 0) { + $avatarUrl = $data['avatar_url'] ?? null; + if ( + !is_string($avatarUrl) || + parse_url($avatarUrl, PHP_URL_SCHEME) !== 'https' || + !in_array(parse_url($avatarUrl, PHP_URL_HOST), ['avatars.githubusercontent.com', 'github.com'], true) + ) { + $avatarUrl = null; + } + $bio = is_string($data['bio'] ?? null) ? trim($data['bio']) : ''; + $profile = [ + 'avatarUrl' => $avatarUrl, + 'bio' => $bio !== '' ? $bio : null, + ]; + } + } catch (ClientExceptionInterface) { + // Optional enrichment must not prevent the catalogue from rendering. + } + $cache->set($key, $profile ?? [], $profile !== null ? 86400 : 900); + + return $profile; + } +} diff --git a/src/View/AppView.php b/src/View/AppView.php index d2bbe6c4..7a214a6b 100644 --- a/src/View/AppView.php +++ b/src/View/AppView.php @@ -15,6 +15,7 @@ */ namespace App\View; +use App\View\Helper\NumberHelper; use Cake\View\View; /** @@ -25,6 +26,7 @@ * @link https://book.cakephp.org/5/en/views.html#the-app-view * @property \Authentication\View\Helper\IdentityHelper $Identity * @property \App\View\Helper\UserHelper $User + * @property \App\View\Helper\NumberHelper $Number * @property \Interact\View\Helper\InteractHelper $Interact * @property \CakeVite\View\Helper\ViteHelper $Vite */ @@ -44,6 +46,7 @@ public function initialize(): void $this->loadHelper('Paginator', ['templates' => 'paginator-templates']); $this->loadHelper('Form', ['templates' => 'form-templates']); $this->loadHelper('Html', ['templates' => 'html-templates']); + $this->loadHelper('Number', ['className' => NumberHelper::class]); $this->loadHelper('Authentication.Identity'); $this->loadHelper('User'); $this->loadHelper('Interact.Interact'); diff --git a/src/View/Helper/NumberHelper.php b/src/View/Helper/NumberHelper.php new file mode 100644 index 00000000..f00dfe26 --- /dev/null +++ b/src/View/Helper/NumberHelper.php @@ -0,0 +1,36 @@ += 1_000_000_000 => 1_000_000_000, + $value >= 1_000_000 => 1_000_000, + $value >= 1_000 => 1_000, + default => 1, + }; + $suffix = match ($divisor) { + 1_000_000_000 => 'B', + 1_000_000 => 'M', + 1_000 => 'k', + default => '', + }; + + return $this->format($value / $divisor, [ + 'precision' => $divisor === 1 ? 0 : 1, + 'after' => $suffix, + ]); + } +} diff --git a/src/View/IslandTemplateView.php b/src/View/IslandTemplateView.php index 1f5d2428..2f49a561 100644 --- a/src/View/IslandTemplateView.php +++ b/src/View/IslandTemplateView.php @@ -3,11 +3,14 @@ namespace App\View; +use App\View\Helper\NumberHelper; use Interact\View\Helper\PaginatorHelper; use Interact\View\TemplateView; /** * Shares application presentation templates with isolated island renders. + * + * @property \App\View\Helper\NumberHelper $Number */ class IslandTemplateView extends TemplateView { @@ -19,6 +22,7 @@ public function initialize(): void parent::initialize(); $this->addHelper('Form', ['templates' => 'form-templates', 'autoSetCustomValidity' => false]); $this->addHelper('Html', ['templates' => 'html-templates']); + $this->addHelper('Number', ['className' => NumberHelper::class]); $this->addHelper('Paginator', ['className' => PaginatorHelper::class, 'templates' => 'paginator-templates']); } } diff --git a/templates/Packages/by_namespace.php b/templates/Packages/by_namespace.php index 0852ae97..58656abb 100644 --- a/templates/Packages/by_namespace.php +++ b/templates/Packages/by_namespace.php @@ -6,62 +6,51 @@ * @var string|null $githubUrl */ $this->assign('title', __('Plugins by {0}', $namespace)); -$packagistUrl = 'https://packagist.org/packages/' . rawurlencode($namespace) . '/'; $statLabels = [ 'plugins' => __('Plugins'), 'downloads' => __('Downloads'), 'stars' => __('Stars'), ]; ?> -
- Html->link('← ' . __('Browse all plugins'), '/', [ - 'class' => 'mb-5 inline-flex min-h-8 items-center text-sm text-muted', - 'x-interact:navigate' => '', - ]) ?> -
-
-
-
-
-
-
- $label) : ?> -
-
-
Number->format($stats[$key]) ?>
-
- -
-
+ + + +
-
+ Interact->render('Catalogue', props: compact('namespace'), key: 'namespace-catalogue-' . $namespace) ?> element('Packages/plugin-modal') ?> diff --git a/templates/Packages/view.php b/templates/Packages/view.php index 19cad8ba..c418a3e3 100644 --- a/templates/Packages/view.php +++ b/templates/Packages/view.php @@ -4,6 +4,12 @@ * @var \App\Model\Entity\Package $package */ $this->assign('title', $package->package); +[$namespace, $name] = explode('/', $package->package, 2); +$this->assign('canonicalUrl', $this->Url->build([ + '_name' => 'plugin:view', + 'namespace' => $namespace, + 'name' => $name, +], ['fullBase' => true])); ?>

package) ?>

diff --git a/templates/element/Loading/namespace_profile.php b/templates/element/Loading/namespace_profile.php new file mode 100644 index 00000000..4c7174c0 --- /dev/null +++ b/templates/element/Loading/namespace_profile.php @@ -0,0 +1,32 @@ + +
+ element('Namespaces/profile', [ + 'namespace' => $namespace, + 'githubUrl' => $githubUrl, + 'profile' => null, + 'loading' => true, + ]) ?> + +
+

+ Form->button(__('Try again'), [ + 'type' => 'button', + 'class' => 'btn btn-ghost btn-sm mt-2', + '@click' => '$server.sync()', + 'x-show' => '$server.error && $server.error.recovery === "retry"', + ':disabled' => '$server.busy', + ]) ?> + Form->button(__('Reload page'), [ + 'type' => 'button', + 'class' => 'btn btn-ghost btn-sm mt-2', + '@click' => 'window.location.reload()', + 'x-show' => '$server.error && $server.error.recovery === "reload"', + ]) ?> +
+
diff --git a/templates/element/Namespaces/profile.php b/templates/element/Namespaces/profile.php new file mode 100644 index 00000000..01665f19 --- /dev/null +++ b/templates/element/Namespaces/profile.php @@ -0,0 +1,55 @@ + +
+
+ +
+

+

+
+
+ +
diff --git a/templates/element/Packages/package-row.php b/templates/element/Packages/package-row.php index 9736bd73..6505c265 100644 --- a/templates/element/Packages/package-row.php +++ b/templates/element/Packages/package-row.php @@ -11,8 +11,12 @@ $summaries[] = $label . ' ' . implode(', ', $majors); } } -$detailsUrl = $this->Url->build(['_name' => 'plugin:view', 'id' => $package->id]); -$packageNamespace = explode('/', $package->package, 2)[0]; +[$packageNamespace, $packageName] = explode('/', $package->package, 2); +$detailsUrl = $this->Url->build([ + '_name' => 'plugin:view', + 'namespace' => $packageNamespace, + 'name' => $packageName, +]); ?>
diff --git a/templates/island/featured_plugins.php b/templates/island/featured_plugins.php index cb11bbf4..7e4d67ca 100644 --- a/templates/island/featured_plugins.php +++ b/templates/island/featured_plugins.php @@ -21,7 +21,11 @@ $tone = ['rose', 'violet', 'amber'][hexdec(substr(hash('sha256', $package->package), 0, 4)) % 3]; ?>
- element('Packages/plugin-avatar', [ diff --git a/templates/island/namespace_profile.php b/templates/island/namespace_profile.php new file mode 100644 index 00000000..c21eb329 --- /dev/null +++ b/templates/island/namespace_profile.php @@ -0,0 +1,16 @@ + +
+ element('Namespaces/profile', [ + 'namespace' => $namespace, + 'githubUrl' => $githubUrl, + 'profile' => $profile, + 'loading' => false, + ]) ?> +
diff --git a/templates/layout/default.php b/templates/layout/default.php index 7cc41d16..ee2b9884 100644 --- a/templates/layout/default.php +++ b/templates/layout/default.php @@ -17,7 +17,7 @@ $cakeDescription = 'CakePHP Plugins'; $request = $this->getRequest(); $theme = $request->getCookie('theme') === 'cakephp-dark' ? 'cakephp-dark' : 'cakephp'; -$canonicalUrl = $this->Url->build($request->getPath() ?: '/', ['fullBase' => true]); +$canonicalUrl = $this->fetch('canonicalUrl') ?: $this->Url->build($request->getPath() ?: '/', ['fullBase' => true]); ?> diff --git a/tests/TestCase/ApplicationTest.php b/tests/TestCase/ApplicationTest.php index 590ccb3a..89542fe4 100644 --- a/tests/TestCase/ApplicationTest.php +++ b/tests/TestCase/ApplicationTest.php @@ -130,9 +130,10 @@ public function testRateLimitProfiles(): void $requests = [ ['/', 'GET', [], 90], ['/', 'GET', ['search' => 'users'], 15], - ['/plugins/1', 'GET', [], 90], - ['/plugins/by/dereuromark', 'GET', [], 90], - ['/plugins/by/dereuromark', 'GET', ['search' => 'tools'], 15], + ['/plugins/markstory/asset_compress', 'GET', [], 90], + ['/plugins/vendor.name/plugin_name.json', 'GET', [], 90], + ['/plugins/dereuromark', 'GET', [], 90], + ['/plugins/dereuromark', 'GET', ['search' => 'tools'], 15], ['/_interact/update', 'POST', [], 30], ]; foreach ($requests as [$path, $method, $query, $limit]) { diff --git a/tests/TestCase/Controller/PackagesControllerTest.php b/tests/TestCase/Controller/PackagesControllerTest.php index 6ed85ea1..7a4a86c0 100644 --- a/tests/TestCase/Controller/PackagesControllerTest.php +++ b/tests/TestCase/Controller/PackagesControllerTest.php @@ -4,6 +4,7 @@ namespace App\Test\TestCase\Controller; use App\Model\Table\PackagesTable; +use App\Service\GithubProfileService; use Cake\Routing\Router; use Cake\TestSuite\IntegrationTestTrait; use Cake\TestSuite\TestCase; @@ -90,10 +91,86 @@ public function testAutocompleteEndpointIsRemoved(): void */ public function testPublicPluginDetails(): void { - $this->get('/plugins/1'); + $this->get('/plugins/markstory/asset_compress'); $this->assertResponseOk(); $this->assertResponseContains('composer require markstory/asset_compress'); $this->assertResponseContains('https://packagist.org/packages/markstory/asset_compress'); + $this->assertResponseContains('href="/plugins/markstory"'); + $this->assertResponseContains('rel="canonical" href="' . Router::url([ + '_name' => 'plugin:view', + 'namespace' => 'markstory', + 'name' => 'asset_compress', + ], true) . '"'); + } + + /** + * Composer punctuation remains literal, including names ending in a response extension. + */ + public function testPackageRoutePreservesDotsAndUnderscores(): void + { + $this->fetchTable(PackagesTable::class)->updateAll([ + 'package' => 'vendor.name/plugin_name.json', + ], ['id' => 2]); + $this->get('/plugins/vendor.name/plugin_name.json'); + $this->assertResponseOk(); + $this->assertNoRedirect(); + $this->assertResponseContains('composer require vendor.name/plugin_name.json'); + $this->assertResponseContains('rel="canonical" href="' . Router::url([ + '_name' => 'plugin:view', + 'namespace' => 'vendor.name', + 'name' => 'plugin_name.json', + ], true) . '"'); + } + + /** + * Detail lookups use the complete package name and expose its stored lowercase canonical URL. + */ + public function testPackageLookupAndCanonicalUrl(): void + { + $this->get('/plugins/MARKSTORY/ASSET_COMPRESS'); + $this->assertResponseOk(); + $this->assertNoRedirect(); + $this->assertResponseContains('rel="canonical" href="' . Router::url([ + '_name' => 'plugin:view', + 'namespace' => 'markstory', + 'name' => 'asset_compress', + ], true) . '"'); + foreach (['/plugins/markstory/asset-compress', '/plugins/another-vendor/asset_compress'] as $path) { + $this->get($path); + $this->assertResponseCode(404); + } + } + + /** + * The hierarchy does not reserve "by" or numeric namespaces for the removed routes. + */ + public function testPackageHierarchyHasNoReservedNamespacePrefixes(): void + { + $packages = $this->fetchTable(PackagesTable::class); + foreach (['by', '123'] as $namespace) { + $packages->updateAll([ + 'package' => $namespace . '/cakephp-tools', + ], ['id' => 2]); + $this->get('/plugins/' . $namespace); + $this->assertResponseOk(); + $this->assertNoRedirect(); + $this->assertResponseContains('href="/plugins/' . $namespace . '/cakephp-tools"'); + $this->get('/plugins/' . $namespace . '/cakephp-tools'); + $this->assertResponseOk(); + $this->assertNoRedirect(); + } + } + + /** + * Old public routes are removed without compatibility redirects. + */ + public function testOldPublicUrlsAreNotRedirected(): void + { + foreach (['/plugins/1', '/plugins/by/dereuromark'] as $path) { + $this->get($path); + $this->assertResponseCode(404); + $this->assertNoRedirect(); + } } /** @@ -101,7 +178,7 @@ public function testPublicPluginDetails(): void */ public function testMissingPluginDetails(): void { - $this->get('/plugins/99999'); + $this->get('/plugins/missing/package'); $this->assertResponseCode(404); } @@ -110,15 +187,20 @@ public function testMissingPluginDetails(): void */ public function testNamespacePage(): void { - $this->get('/plugins/by/dereuromark?search=no-match'); + $service = $this->createMock(GithubProfileService::class); + $service->expects($this->never())->method('profile'); + $this->mockService(GithubProfileService::class, static fn(): GithubProfileService => $service); + $this->get('/plugins/dereuromark?search=no-match'); $this->assertResponseOk(); $this->assertResponseContains('Plugins by dereuromark'); $this->assertResponseContains('href="https://github.com/dereuromark"'); $this->assertResponseContains('href="https://packagist.org/packages/dereuromark/"'); - $this->assertResponseContains('data-namespace-stat="downloads">20,000'); + $this->assertResponseContains('data-namespace-stat="downloads">20k'); $this->assertResponseContains('data-namespace-stat="stars">300'); $this->assertResponseContains('No plugins found'); - $this->assertResponseContains('action="/plugins/by/dereuromark"'); + $this->assertResponseContains('action="/plugins/dereuromark"'); + $this->assertResponseContains('data-namespace-profile-loading'); + $this->assertResponseContains('skeleton'); $this->assertResponseContains('rel="canonical" href="' . Router::url([ '_name' => 'plugin:namespace', 'namespace' => 'dereuromark', @@ -132,10 +214,10 @@ public function testNamespacePage(): void */ public function testNamespaceCanonicalUrlAndMissingNamespace(): void { - $this->get('/plugins/by/Dereuromark?search=tools&sort=stars'); + $this->get('/plugins/Dereuromark?search=tools&sort=stars'); $this->assertResponseCode(301); - $this->assertRedirect('/plugins/by/dereuromark?search=tools&sort=stars'); - $this->get('/plugins/by/not-a-namespace'); + $this->assertRedirect('/plugins/dereuromark?search=tools&sort=stars'); + $this->get('/plugins/not-a-namespace'); $this->assertResponseCode(404); } @@ -145,7 +227,7 @@ public function testNamespaceCanonicalUrlAndMissingNamespace(): void public function testNamespaceOmitsAmbiguousGithubProfile(): void { $this->fetchTable(PackagesTable::class)->updateAll(['repo_url' => 'https://github.com/another-owner/plugin'], ['id' => 2]); - $this->get('/plugins/by/vendor'); + $this->get('/plugins/vendor'); $this->assertResponseOk(); $this->assertResponseNotContains('GitHub profile'); $this->assertResponseContains('href="https://packagist.org/packages/vendor/"'); diff --git a/tests/TestCase/Island/CatalogueIslandTest.php b/tests/TestCase/Island/CatalogueIslandTest.php index 8f1673b5..8afb4bc9 100644 --- a/tests/TestCase/Island/CatalogueIslandTest.php +++ b/tests/TestCase/Island/CatalogueIslandTest.php @@ -63,7 +63,7 @@ public function testUnknownCategoryIsCleared(): void */ public function testNamespaceScopeSurvivesUpdates(): void { - $request = new ServerRequest(['url' => 'http://localhost/plugins/by/vendor']); + $request = new ServerRequest(['url' => 'http://localhost/plugins/vendor']); $island = $this->testIsland('Catalogue', ['namespace' => 'vendor'], request: $request) ->assertDontSee('data-featured-plugins') ->assertDontSee('markstory/asset_compress') @@ -77,7 +77,7 @@ public function testNamespaceScopeSurvivesUpdates(): void ->assertSet('namespace', 'vendor') ->assertDontSee('data-featured-plugins') ->assertDontSee('markstory/asset_compress'); - $this->assertStringContainsString('/plugins/by/vendor?', $island->result()->html); + $this->assertStringContainsString('/plugins/vendor?', $island->result()->html); $this->assertStringNotContainsString('/_interact/update?', $island->result()->html); } diff --git a/tests/TestCase/Island/NamespaceProfileIslandTest.php b/tests/TestCase/Island/NamespaceProfileIslandTest.php new file mode 100644 index 00000000..ffd809ea --- /dev/null +++ b/tests/TestCase/Island/NamespaceProfileIslandTest.php @@ -0,0 +1,67 @@ +createMock(GithubProfileService::class); + $service->expects($this->once())->method('profile')->with('github-owner')->willReturn([ + 'avatarUrl' => 'https://avatars.githubusercontent.com/u/123', + 'bio' => '', + ]); + $this->mockService(GithubProfileService::class, static fn(): GithubProfileService => $service); + $island = $this->testIsland('NamespaceProfile', [ + 'namespace' => 'composer-vendor', + 'githubUrl' => 'https://github.com/github-owner', + ])->assertSee('composer-vendor')->assertSee('')->assertSee('https://avatars.githubusercontent.com/u/123'); + $this->assertStringNotContainsString('', $island->result()->html); + $this->assertStringNotContainsString('skeleton', $island->result()->html); + } + + /** + * Unavailable enrichment renders initials and the same generic description. + */ + public function testUnavailableProfileKeepsIdentityAndDescription(): void + { + $service = $this->createStub(GithubProfileService::class); + $service->method('profile')->willReturn(null); + $this->mockService(GithubProfileService::class, static fn(): GithubProfileService => $service); + $this->testIsland('NamespaceProfile', [ + 'namespace' => 'example', + 'githubUrl' => 'https://github.com/example', + ])->assertSee('EX') + ->assertSee('Plugins for your CakePHP projects.')->assertDontSee('data-namespace-avatar'); + } + + /** + * Accounts with an avatar but no bio get the generic description. + */ + public function testMissingBioUsesFallback(): void + { + $service = $this->createStub(GithubProfileService::class); + $service->method('profile')->willReturn([ + 'avatarUrl' => 'https://avatars.githubusercontent.com/u/123', + 'bio' => null, + ]); + $this->mockService(GithubProfileService::class, static fn(): GithubProfileService => $service); + $this->testIsland('NamespaceProfile', [ + 'namespace' => 'example', + 'githubUrl' => 'https://github.com/example', + ])->assertSee('Plugins for your CakePHP projects.')->assertSee('data-namespace-avatar'); + } +} diff --git a/tests/TestCase/Service/GithubProfileServiceTest.php b/tests/TestCase/Service/GithubProfileServiceTest.php new file mode 100644 index 00000000..f768ee78 --- /dev/null +++ b/tests/TestCase/Service/GithubProfileServiceTest.php @@ -0,0 +1,113 @@ +createMock(Client::class); + $client->expects($this->once())->method('get')->with('https://api.github.com/users/cakedc')->willReturn(new Response( + ['HTTP/1.1 200 OK'], + json_encode([ + 'login' => 'CakeDC', + 'type' => 'Organization', + 'avatar_url' => 'https://avatars.githubusercontent.com/u/123', + 'bio' => ' CakePHP development and consulting. ', + 'email' => 'private@example.com', + ], JSON_THROW_ON_ERROR), + )); + $expected = [ + 'avatarUrl' => 'https://avatars.githubusercontent.com/u/123', + 'bio' => 'CakePHP development and consulting.', + ]; + $this->assertSame($expected, new GithubProfileService($client)->profile('CakeDC')); + $this->assertSame($expected, new GithubProfileService($client)->profile('cakedc')); + } + + /** + * Missing, throttled, and invalid responses all use a cached fallback. + */ + #[DataProvider('unavailableProfiles')] + public function testUnavailableProfileUsesCachedFallback(string $status, string $body): void + { + $client = $this->createMock(Client::class); + $client->expects($this->once())->method('get')->willReturn(new Response([$status], $body)); + $service = new GithubProfileService($client); + $this->assertNull($service->profile('example')); + $this->assertNull($service->profile('example')); + } + + /** + * @return array + */ + public static function unavailableProfiles(): array + { + return [ + 'missing' => ['HTTP/1.1 404 Not Found', '{}'], + 'rate limited' => ['HTTP/1.1 403 Forbidden', '{}'], + 'server error' => ['HTTP/1.1 503 Unavailable', '{}'], + 'malformed JSON' => ['HTTP/1.1 200 OK', 'Unavailable'], + 'wrong profile' => ['HTTP/1.1 200 OK', '{"login":"somebody-else"}'], + ]; + } + + /** + * Network failures do not repeatedly retry on subsequent catalogue visits. + */ + public function testNetworkFailureUsesCachedFallback(): void + { + $client = $this->createMock(Client::class); + $client->expects($this->once())->method('get')->willThrowException(new ClientException('Connection failed')); + $service = new GithubProfileService($client); + $this->assertNull($service->profile('example')); + $this->assertNull($service->profile('example')); + } + + /** + * Do not render non-GitHub avatar URLs or blank biographies. + */ + public function testUnsafeAvatarAndEmptyBioAreOmitted(): void + { + $client = $this->createStub(Client::class); + $client->method('get')->willReturn(new Response( + ['HTTP/1.1 200 OK'], + '{"login":"example","avatar_url":"javascript:alert(1)","bio":" "}', + )); + $this->assertSame(['avatarUrl' => null, 'bio' => null], new GithubProfileService($client)->profile('example')); + } + + /** + * Invalid owner values never become outbound request paths. + */ + public function testInvalidOwnerDoesNotFetch(): void + { + $client = $this->createMock(Client::class); + $client->expects($this->never())->method('get'); + $this->assertNull(new GithubProfileService($client)->profile('../users')); + } +} diff --git a/tests/TestCase/View/Helper/NumberHelperTest.php b/tests/TestCase/View/Helper/NumberHelperTest.php new file mode 100644 index 00000000..0e9483f7 --- /dev/null +++ b/tests/TestCase/View/Helper/NumberHelperTest.php @@ -0,0 +1,56 @@ +assertSame($expected, new NumberHelper(new View())->compact($value)); + } + + /** + * @return array + */ + public static function compactCounts(): array + { + return [ + 'zero' => [0, '0'], + 'small count' => [42, '42'], + 'before thousands' => [999, '999'], + 'thousands' => [1_000, '1k'], + 'rounded thousands' => [22_701, '22.7k'], + 'millions' => [1_000_000, '1M'], + 'rounded millions' => [8_789_626, '8.8M'], + 'billions' => [1_000_000_000, '1B'], + ]; + } + + /** + * Decimal separators follow the current CakePHP locale. + */ + public function testCompactUsesCurrentLocale(): void + { + $locale = I18n::getLocale(); + try { + I18n::setLocale('de_DE'); + $this->assertSame('22,7k', new NumberHelper(new View())->compact(22_701)); + } finally { + I18n::setLocale($locale); + } + } +} diff --git a/tests/bootstrap.php b/tests/bootstrap.php index b9894b08..0400291c 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -41,6 +41,8 @@ // Fixture-derived options must never populate the development application's cache. Cache::drop('default'); Cache::setConfig('default', ['className' => ArrayEngine::class]); +Cache::drop('github_profiles'); +Cache::setConfig('github_profiles', ['className' => ArrayEngine::class]); if (empty($_SERVER['HTTP_HOST']) && !Configure::read('App.fullBaseUrl')) { Configure::write('App.fullBaseUrl', 'http://localhost'); diff --git a/tests/browser/catalogue.spec.js b/tests/browser/catalogue.spec.js index 590433a9..b315906d 100644 --- a/tests/browser/catalogue.spec.js +++ b/tests/browser/catalogue.spec.js @@ -166,7 +166,7 @@ test('category filters and source attribution work without JavaScript', async ({ await expect(page).toHaveURL(/awesome=1/) await expect(rows(page)).toHaveCount(1) await rows(page).locator('.package-name a').click() - await expect(page).toHaveURL(/plugins\/1$/) + await expect(page).toHaveURL(/plugins\/markstory\/asset_compress$/) await expect(page.locator('.plugin-category-links a')).toHaveCount(2) await expect(page.getByRole('link', { name: 'Awesome CakePHP', exact: true })).toBeVisible() await page.getByRole('link', { name: 'Code Analysis', exact: true }).click() @@ -478,7 +478,7 @@ test('GET search, version links, details and pagination work without JavaScript' await expect(page).toHaveURL(/search=users/) await expect(rows(page)).toContainText('cakedc/users') await rows(page).getByRole('link', { name: 'cakedc/users', exact: true }).click() - await expect(page).toHaveURL(/plugins\/25$/) + await expect(page).toHaveURL(/plugins\/cakedc\/users$/) await expect(page.locator('.plugin-details')).toContainText('composer require cakedc/users') await page.goto('http://127.0.0.1:8765/') await page.getByRole('group', { name: 'CakePHP version', exact: true }).getByRole('button', { name: 'CakePHP 4.4' }).click() diff --git a/tests/browser/namespaces.spec.js b/tests/browser/namespaces.spec.js index 30e1a12e..bc8261f8 100644 --- a/tests/browser/namespaces.spec.js +++ b/tests/browser/namespaces.spec.js @@ -13,6 +13,10 @@ test.beforeEach(async ({ page }) => { const errors = [] page.on('pageerror', error => errors.push(error.message)) pageErrors.set(page, errors) + await page.route('https://avatars.githubusercontent.com/**', route => route.fulfill({ + contentType: 'image/png', + path: 'webroot/img/packagist-logo.png', + })) }) test.afterEach(async ({ page }) => { @@ -20,31 +24,39 @@ test.afterEach(async ({ page }) => { }) test('namespace hero totals and catalogue results use the Composer prefix', async ({ page }) => { - await page.goto('/plugins/by/vendor') - await expect(page.getByRole('heading', { level: 1 })).toHaveText('Plugins by vendor') + await page.goto('/plugins/vendor') + await expect(page.getByRole('heading', { level: 1 })).toHaveText('vendor') await expect(hero(page).locator('[data-namespace-stat]')).toHaveCount(0) - await expect(hero(page).getByRole('link', { name: 'GitHub profile' })).toHaveAttribute('href', 'https://github.com/vendor') - await expect(hero(page).getByRole('link', { name: 'Packagist', exact: true })).toHaveAttribute('href', 'https://packagist.org/packages/vendor/') - await expect(hero(page).getByRole('link', { name: 'Packagist', exact: true })).toHaveAttribute('target', '_blank') - await expect(hero(page).getByRole('link', { name: 'GitHub profile' })).toHaveText('') - await expect(hero(page).getByRole('link', { name: 'Packagist', exact: true })).toHaveText('') + await expect(page.locator('[data-namespace-banner]').getByRole('link', { name: 'GitHub profile' })).toHaveAttribute('href', 'https://github.com/vendor') + await expect(page.locator('[data-namespace-banner]').getByRole('link', { name: 'Packagist', exact: true })).toHaveAttribute('href', 'https://packagist.org/packages/vendor/') + await expect(page.locator('[data-namespace-banner]').getByRole('link', { name: 'Packagist', exact: true })).toHaveAttribute('target', '_blank') + await expect(page.locator('[data-namespace-banner]').getByRole('link', { name: 'GitHub profile' })).toHaveText('') + await expect(page.locator('[data-namespace-banner]').getByRole('link', { name: 'Packagist', exact: true })).toHaveText('') + const bannerBounds = await page.locator('[data-namespace-banner]').boundingBox() + const navbarBounds = await page.locator('.site-header').boundingBox() + expect(bannerBounds.x).toBe(0) + expect(bannerBounds.width).toBe(page.viewportSize().width) + expect(bannerBounds.y).toBe(navbarBounds.y + navbarBounds.height) const headingBounds = await hero(page).boundingBox() const statsBounds = await stats(page).boundingBox() expect(statsBounds.x).toBeGreaterThan(headingBounds.x + headingBounds.width) - expect(statsBounds.y).toBe(headingBounds.y) + expect(Math.abs(statsBounds.y + statsBounds.height / 2 - headingBounds.y - headingBounds.height / 2)).toBeLessThan(1) + expect(Math.abs(statsBounds.y + statsBounds.height / 2 - bannerBounds.y - bannerBounds.height / 2)).toBeLessThan(1) await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('23') - await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('22,701') - await expect(stats(page).locator('[data-namespace-stat="stars"]')).toHaveText('2,001') + await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('22.7k') + await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveAttribute('aria-label', '22,701') + await expect(stats(page).locator('[data-namespace-stat="stars"]')).toHaveText('2k') + await expect(stats(page).locator('[data-namespace-stat="stars"]')).toHaveAttribute('aria-label', '2,001') await expect(rows(page)).toHaveCount(21) expect(await rows(page).evaluateAll(elements => elements.every(element => element.textContent.includes('vendor/package-')))).toBe(true) await expect(page.locator('[data-featured-plugins]')).toHaveCount(0) - await expect(page.locator('link[rel="canonical"]')).toHaveAttribute('href', 'http://127.0.0.1:8765/plugins/by/vendor') + await expect(page.locator('link[rel="canonical"]')).toHaveAttribute('href', 'http://127.0.0.1:8765/plugins/vendor') await expect(page.locator('meta[name="robots"]')).toHaveCount(0) await page.screenshot({ path: 'tmp/namespace-desktop.png', animations: 'disabled' }) }) test('search, version filters, sorting and reset retain the namespace and hero', async ({ page }) => { - await page.goto('/plugins/by/vendor') + await page.goto('/plugins/vendor') await page.evaluate(() => { window.namespaceMarker = 'retained' }) await chooseSort(page, 'Downloads') await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).fill('package-01') @@ -57,22 +69,22 @@ test('search, version filters, sorting and reset retain the namespace and hero', await expect(page.locator('meta[name="robots"]')).toHaveAttribute('content', 'noindex,nofollow') await page.getByRole('link', { name: 'Reset filters', exact: true }).click() await expect(rows(page)).toHaveCount(21) - await expect(page).toHaveURL('/plugins/by/vendor?sort=downloads') + await expect(page).toHaveURL('/plugins/vendor?sort=downloads') expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') - await expect(page.getByRole('search')).toHaveAttribute('action', '/plugins/by/vendor') + await expect(page.getByRole('search')).toHaveAttribute('action', '/plugins/vendor') }) test('pagination and history stay on the namespace page', async ({ page }) => { - await page.goto('/plugins/by/vendor') + await page.goto('/plugins/vendor') await page.evaluate(() => { window.namespaceMarker = 'retained' }) await page.getByRole('link', { name: 'Last', exact: true }).click() - await expect(page).toHaveURL('/plugins/by/vendor?page=2') + await expect(page).toHaveURL('/plugins/vendor?page=2') await expect(rows(page)).toHaveCount(2) await page.getByRole('link', { name: 'First', exact: true }).click() - await expect(page).toHaveURL('/plugins/by/vendor') + await expect(page).toHaveURL('/plugins/vendor') await expect(rows(page)).toHaveCount(21) await page.goBack() - await expect(page).toHaveURL('/plugins/by/vendor?page=2') + await expect(page).toHaveURL('/plugins/vendor?page=2') await expect(rows(page)).toHaveCount(2) await page.goForward() await expect(rows(page)).toHaveCount(21) @@ -82,13 +94,13 @@ test('pagination and history stay on the namespace page', async ({ page }) => { }) test('category choices and detail filters stay within the namespace', async ({ page }) => { - await page.goto('/plugins/by/markstory') + await page.goto('/plugins/markstory') await page.getByText('Browse categories', { exact: true }).click() const categories = page.getByRole('group', { name: 'Plugin categories', exact: true }) await expect(categories.getByRole('link', { name: 'Asset Management, 1 plugin', exact: true })).toBeVisible() await expect(categories.getByRole('link', { name: /Authentication/ })).toHaveCount(0) await categories.getByRole('link', { name: 'Asset Management, 1 plugin', exact: true }).click() - await expect(page).toHaveURL('/plugins/by/markstory?category=asset-management') + await expect(page).toHaveURL('/plugins/markstory?category=asset-management') await expect(rows(page)).toHaveCount(1) await page.getByRole('button', { name: 'Awesome only', exact: true }).click() await expect(rows(page)).toHaveCount(1) @@ -96,36 +108,41 @@ test('category choices and detail filters stay within the namespace', async ({ p const dialog = page.getByRole('dialog') await dialog.getByRole('link', { name: 'Code Analysis', exact: true }).click() await expect(dialog).not.toBeVisible() - await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) + await expect(page).toHaveURL(/\/plugins\/markstory\?/) await expect(page).toHaveURL(/category=code-analysis/) await expect(rows(page)).toHaveCount(1) - await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('5,000') + await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('5k') await rows(page).getByRole('link', { name: 'markstory/asset_compress', exact: true }).click() await dialog.getByRole('link', { name: 'PHP 8.5', exact: true }).click() await expect(rows(page)).toHaveCount(1) - await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) + await expect(page).toHaveURL(/\/plugins\/markstory\?/) await expect(page).toHaveURL(/php_slugs/) await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') }) test('namespace links navigate from rows, modal details and standalone details', async ({ page }) => { await page.goto('/') + await expect(page.locator('#package-26').getByRole('link', { name: 'dereuromark/cakephp-tools', exact: true })) + .toHaveAttribute('href', '/plugins/dereuromark/cakephp-tools') + await expect(page.locator('[data-featured-plugins]').getByRole('link', { name: 'View markstory/asset_compress details', exact: true })) + .toHaveAttribute('href', '/plugins/markstory/asset_compress') await page.evaluate(() => { window.namespaceMarker = 'retained' }) await page.getByRole('link', { name: 'More by dereuromark', exact: true }).click() - await expect(page).toHaveURL('/plugins/by/dereuromark') + await expect(page).toHaveURL('/plugins/dereuromark') expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') await page.goBack() await expect(page).toHaveURL('/') await page.locator('#package-26').getByRole('link', { name: 'dereuromark/cakephp-tools', exact: true }).click() await page.getByRole('dialog').getByRole('link', { name: 'View all plugins by dereuromark', exact: true }).click() - await expect(page).toHaveURL('/plugins/by/dereuromark') + await expect(page).toHaveURL('/plugins/dereuromark') await expect(page.getByRole('dialog')).not.toBeVisible() await expect(hero(page)).toBeVisible() expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') - await page.goto('/plugins/26') + await page.goto('/plugins/dereuromark/cakephp-tools') + await expect(page.locator('link[rel="canonical"]')).toHaveAttribute('href', 'http://127.0.0.1:8765/plugins/dereuromark/cakephp-tools') await page.evaluate(() => { window.namespaceMarker = 'retained' }) await page.getByRole('link', { name: 'View all plugins by dereuromark', exact: true }).click() - await expect(page).toHaveURL('/plugins/by/dereuromark') + await expect(page).toHaveURL('/plugins/dereuromark') expect(await page.evaluate(() => window.namespaceMarker)).toBe('retained') }) @@ -133,48 +150,120 @@ test('namespace pages support native links and search without JavaScript', async const context = await browser.newContext({ javaScriptEnabled: false }) const page = await context.newPage() try { - await page.goto('/plugins/by/markstory') + await page.goto('/plugins/markstory') await page.getByText('Browse categories', { exact: true }).click() await page.getByRole('link', { name: 'Asset Management, 1 plugin', exact: true }).click() - await expect(page).toHaveURL(/\/plugins\/by\/markstory\?.*category=asset-management/) + await expect(page).toHaveURL(/\/plugins\/markstory\?.*category=asset-management/) await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).fill('no-match') await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).press('Enter') - await expect(page).toHaveURL(/\/plugins\/by\/markstory\?/) + await expect(page).toHaveURL(/\/plugins\/markstory\?/) await expect(rows(page)).toHaveCount(0) await expect(stats(page).locator('[data-namespace-stat="plugins"]')).toHaveText('1') await page.getByRole('link', { name: 'Reset filters', exact: true }).click() await expect(rows(page)).toHaveCount(1) - await page.goto('/plugins/by/vendor') + await page.goto('/plugins/vendor') await page.getByRole('link', { name: 'Last', exact: true }).click() - await expect(page).toHaveURL('/plugins/by/vendor?page=2') + await expect(page).toHaveURL('/plugins/vendor?page=2') await expect(rows(page)).toHaveCount(2) } finally { await context.close() } }) +test('namespace profile loads lazily without moving the hero or blocking the catalogue', async ({ page }) => { + let release + const gate = new Promise(resolve => { release = resolve }) + await page.route('**/_interact/update', async route => { + await gate + await route.continue() + }, { times: 1 }) + const response = await page.goto('/plugins/vendor') + expect(await response.text()).toContain('data-namespace-profile-loading') + const banner = page.locator('[data-namespace-banner]') + let loadingBounds + try { + await expect(hero(page).getByRole('heading', { level: 1 })).toHaveText('vendor') + await expect(hero(page).locator('.skeleton')).toBeVisible() + await expect(hero(page).locator('[data-namespace-description]')).toHaveText('Plugins for your CakePHP projects.') + await expect(rows(page)).toHaveCount(21) + loadingBounds = await banner.boundingBox() + } finally { + release() + } + const avatar = hero(page).locator('[data-namespace-avatar]') + await expect(avatar).toBeVisible() + await expect(hero(page).locator('[data-namespace-description]')).toHaveText('CakePHP plugins by vendor.') + await expect(hero(page).locator('.skeleton')).toHaveCount(0) + expect(await banner.boundingBox()).toEqual(loadingBounds) + await avatar.evaluate(element => { element.avatarMarker = 'retained' }) + await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).fill('package-01') + await expect(rows(page)).toHaveCount(1) + expect(await avatar.evaluate(element => element.avatarMarker)).toBe('retained') +}) + +test('a failed avatar leaves readable initials and the generic description', async ({ page }) => { + await page.route('https://avatars.githubusercontent.com/**', route => route.abort()) + await page.goto('/plugins/cakedc') + await expect(page.locator('[data-namespace-profile]')).toBeVisible() + await expect(hero(page).locator('[data-namespace-avatar]')).toBeHidden() + await expect(hero(page).locator('.namespace-avatar')).toContainText('CA') + await expect(hero(page).locator('[data-namespace-description]')).toHaveText('Plugins for your CakePHP projects.') +}) + +test('namespace counters count up in sequence without shifting the layout', async ({ page }) => { + await page.clock.install({ time: new Date('2026-01-01T00:00:00Z') }) + await page.clock.pauseAt(new Date('2026-01-01T00:00:01Z')) + await page.goto('/plugins/vendor') + const plugins = stats(page).locator('[data-namespace-stat="plugins"]') + const downloads = stats(page).locator('[data-namespace-stat="downloads"]') + const stars = stats(page).locator('[data-namespace-stat="stars"]') + const counterBounds = () => page.locator('[data-namespace-hero], [data-namespace-stats], [data-namespace-stat]').evaluateAll(elements => elements.map(element => { + const { x, y, width, height } = element.getBoundingClientRect() + return { x, y, width, height } + })) + await page.clock.runFor(100) + const initialBounds = await counterBounds() + expect(Number(await plugins.textContent())).toBeGreaterThan(0) + await expect(downloads).toHaveText('0') + await expect(stars).toHaveText('0') + await page.clock.runFor(200) + expect(await downloads.textContent()).not.toBe('0') + await expect(stars).toHaveText('0') + expect(await counterBounds()).toEqual(initialBounds) + await page.clock.runFor(300) + expect(await stars.textContent()).not.toBe('0') + expect(await counterBounds()).toEqual(initialBounds) + await expect(downloads).toHaveAttribute('aria-label', '22,701') + await page.clock.runFor(1200) + await expect(downloads).toHaveText('22.7k') + await expect(plugins).toHaveText('23') + await expect(stars).toHaveText('2k') + expect(await counterBounds()).toEqual(initialBounds) +}) + test('namespace hero fits mobile screens in both themes', async ({ page, context }) => { + await page.emulateMedia({ reducedMotion: 'reduce' }) for (const width of [390, 320]) { await page.setViewportSize({ width, height: 844 }) for (const theme of ['cakephp', 'cakephp-dark']) { await context.addCookies([{ name: 'theme', value: theme, domain: '127.0.0.1', path: '/' }]) - await page.goto('/plugins/by/dereuromark') + await page.goto('/plugins/dereuromark') await expect(page.locator('html')).toHaveAttribute('data-theme', theme) await expect(hero(page)).toBeVisible() + await expect(stats(page).locator('[data-namespace-stat="downloads"]')).toHaveText('20k') expect(await page.evaluate(() => document.documentElement.scrollWidth <= window.innerWidth)).toBe(true) await page.screenshot({ path: `tmp/namespace-mobile-${theme}-${width}.png`, fullPage: true, animations: 'disabled' }) - // Real catalogue totals reach tens of millions; ensure values fit their individual cells. - await stats(page).locator('[data-namespace-stat="downloads"]').evaluate(element => { element.textContent = '62,789,075' }) - await stats(page).locator('[data-namespace-stat="stars"]').evaluate(element => { element.textContent = '1,740' }) expect(await stats(page).locator('[data-namespace-stat]').evaluateAll(elements => elements.every(element => element.scrollWidth <= element.clientWidth))).toBe(true) + const banner = page.locator('[data-namespace-banner]') + expect(await banner.evaluate(element => ['::before', '::after'].every(pseudo => getComputedStyle(element, pseudo).animationName === 'none'))).toBe(true) } } }) test('namespace URLs canonicalize casing and unknown namespaces return 404', async ({ page }) => { - await page.goto('/plugins/by/Dereuromark?search=tools&sort=stars') - await expect(page).toHaveURL('/plugins/by/dereuromark?search=tools&sort=stars') + await page.goto('/plugins/Dereuromark?search=tools&sort=stars') + await expect(page).toHaveURL('/plugins/dereuromark?search=tools&sort=stars') await expect(rows(page)).toHaveCount(1) - const response = await page.goto('/plugins/by/unknown-namespace') + const response = await page.goto('/plugins/unknown-namespace') expect(response.status()).toBe(404) }) diff --git a/tests/browser/setup.php b/tests/browser/setup.php index d77e2d21..46abe7f5 100644 --- a/tests/browser/setup.php +++ b/tests/browser/setup.php @@ -54,6 +54,12 @@ } } Cache::clearAll(); +foreach (['vendor', 'markstory', 'dereuromark', 'cakedc'] as $owner) { + Cache::pool('github_profiles')->set('github_profile_v2_' . $owner, [ + 'avatarUrl' => 'https://avatars.githubusercontent.com/u/123', + 'bio' => $owner === 'cakedc' ? null : 'CakePHP plugins by ' . $owner . '.', + ], 3600); +} if (!is_dir(TMP . 'browser-sessions')) { mkdir(TMP . 'browser-sessions', 0700, true); } From a006747c9688e8577ba83ee0840409f8f9defe67 Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 15:01:26 +0100 Subject: [PATCH 6/9] Use a named route for catalogue links --- config/routes.php | 5 ++++- src/Island/CatalogueIsland.php | 4 +--- templates/Packages/by_namespace.php | 4 +++- templates/Packages/view.php | 2 +- templates/element/Packages/plugin-details.php | 14 ++++++++++++-- 5 files changed, 21 insertions(+), 8 deletions(-) diff --git a/config/routes.php b/config/routes.php index f6815f14..16074258 100644 --- a/config/routes.php +++ b/config/routes.php @@ -58,7 +58,10 @@ * its action called 'display', and we pass a param to select the view file * to use (in this case, templates/Pages/home.php)... */ - $builder->connect('/', ['controller' => 'Packages', 'action' => 'index']); + $builder->connect('/', [ + 'controller' => 'Packages', + 'action' => 'index', + ], ['_name' => 'plugin:index']); $packageSegment = '[A-Za-z0-9][A-Za-z0-9_.-]*'; $builder->get('/plugins/{namespace}/{name}', [ 'controller' => 'Packages', diff --git a/src/Island/CatalogueIsland.php b/src/Island/CatalogueIsland.php index 6ccb8206..56140268 100644 --- a/src/Island/CatalogueIsland.php +++ b/src/Island/CatalogueIsland.php @@ -183,9 +183,7 @@ public function viewData(): array '_name' => 'plugin:namespace', 'namespace' => $this->namespace, ] : [ - 'plugin' => null, - 'controller' => 'Packages', - 'action' => 'index', + '_name' => 'plugin:index', ], ]; } diff --git a/templates/Packages/by_namespace.php b/templates/Packages/by_namespace.php index 58656abb..b61438aa 100644 --- a/templates/Packages/by_namespace.php +++ b/templates/Packages/by_namespace.php @@ -15,7 +15,9 @@
- Html->link('← ' . __('Browse all plugins'), '/', [ + Html->link('← ' . __('Browse all plugins'), [ + '_name' => 'plugin:index', + ], [ 'class' => 'inline-flex min-h-8 items-center text-sm text-muted', 'x-interact:navigate' => '', ]) ?> diff --git a/templates/Packages/view.php b/templates/Packages/view.php index c418a3e3..315723f3 100644 --- a/templates/Packages/view.php +++ b/templates/Packages/view.php @@ -13,7 +13,7 @@ ?>

package) ?>

- +
diff --git a/templates/element/Packages/plugin-details.php b/templates/element/Packages/plugin-details.php index f643054f..9ee27689 100644 --- a/templates/element/Packages/plugin-details.php +++ b/templates/element/Packages/plugin-details.php @@ -68,7 +68,12 @@
categories as $category) : ?> name) ?>
@@ -109,7 +114,12 @@ label); ?> From edd17263f2b7c87b830185ce6aacf50a38647d12 Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 15:11:54 +0100 Subject: [PATCH 7/9] Index stored package namespaces for exact lookups --- .../20261113120000_AddPackageNamespace.php | 41 +++++++++++++++++ config/Migrations/schema-dump-default.lock | Bin 19786 -> 20542 bytes src/Model/Entity/Package.php | 2 + src/Model/Table/PackagesTable.php | 33 +++++++++----- tests/Fixture/PackagesFixture.php | 5 ++ .../Controller/PackagesControllerTest.php | 11 +++-- .../Model/Table/PackagesTableTest.php | 43 ++++++++++++++++-- .../Service/PackagistImporterTest.php | 1 + 8 files changed, 116 insertions(+), 20 deletions(-) create mode 100644 config/Migrations/20261113120000_AddPackageNamespace.php diff --git a/config/Migrations/20261113120000_AddPackageNamespace.php b/config/Migrations/20261113120000_AddPackageNamespace.php new file mode 100644 index 00000000..a527f19b --- /dev/null +++ b/config/Migrations/20261113120000_AddPackageNamespace.php @@ -0,0 +1,41 @@ +table('packages') + ->addColumn('namespace', 'string', [ + 'limit' => 255, + 'null' => true, + ]) + ->update(); + + $this->execute("UPDATE packages SET namespace = LOWER(SUBSTR(package, 1, INSTR(package, '/') - 1))"); + + $this->table('packages') + ->changeColumn('namespace', 'string', [ + 'limit' => 255, + 'null' => false, + ]) + ->addIndex(['namespace']) + ->update(); + } + + /** + * The full Composer name remains available after rollback. + */ + public function down(): void + { + $this->table('packages') + ->removeIndex(['namespace']) + ->removeColumn('namespace') + ->update(); + } +} diff --git a/config/Migrations/schema-dump-default.lock b/config/Migrations/schema-dump-default.lock index 16238958d3cd695c712df84efbc71ddc12d472d0..45fa958edc511bf8192fd4bf45290a4c134b9a5a 100644 GIT binary patch delta 172 zcmX>#i*erq#tlNMjFy`dE!Hw_KA@(=!&_`+X{D5xn44N$keEFAqO~mtoD=8fGE`2I(xGN GH#-@iZx2)e diff --git a/src/Model/Entity/Package.php b/src/Model/Entity/Package.php index e2a4a8d8..8bd5ee7d 100644 --- a/src/Model/Entity/Package.php +++ b/src/Model/Entity/Package.php @@ -12,6 +12,7 @@ * * @property int $id * @property string $package + * @property string $namespace * @property string $description * @property string $repo_url * @property int $downloads @@ -42,6 +43,7 @@ class Package extends Entity #[Override] protected array $_accessible = [ 'id' => false, + 'namespace' => false, '*' => true, ]; diff --git a/src/Model/Table/PackagesTable.php b/src/Model/Table/PackagesTable.php index 7d304f59..4d3afb5b 100644 --- a/src/Model/Table/PackagesTable.php +++ b/src/Model/Table/PackagesTable.php @@ -4,8 +4,11 @@ namespace App\Model\Table; use App\Model\Filter\PackagesCollection; +use ArrayObject; use Cake\Cache\Cache; use Cake\Database\Expression\QueryExpression; +use Cake\Datasource\EntityInterface; +use Cake\Event\EventInterface; use Cake\ORM\Query\SelectQuery; use Cake\ORM\Table; use Cake\Validation\Validator; @@ -105,6 +108,20 @@ public function validationDefault(Validator $validator): Validator return $validator; } + /** + * Derive the indexed vendor whenever an import creates or renames a package. + * + * @param \Cake\Event\EventInterface $event Save event. + * @param \Cake\Datasource\EntityInterface $entity Package being saved. + * @param \ArrayObject $options Save options. + */ + public function beforeSave(EventInterface $event, EntityInterface $entity, ArrayObject $options): void + { + if ($entity->isNew() || $entity->isDirty('package')) { + $entity->set('namespace', strtolower(explode('/', (string)$entity->get('package'), 2)[0])); + } + } + /** * Build the public catalogue with its version associations. * @@ -135,24 +152,16 @@ public function findCatalogue(SelectQuery $query, array $filters, ?string $names } /** - * Match a literal Composer vendor prefix, including namespaces containing underscores. + * Match the indexed Composer namespace exactly. * * @param \Cake\ORM\Query\SelectQuery<\App\Model\Entity\Package> $query Package query. * @return \Cake\ORM\Query\SelectQuery<\App\Model\Entity\Package> */ public function findNamespace(SelectQuery $query, string $namespace): SelectQuery { - $prefix = strtr($namespace, [ - '!' => '!!', - '%' => '!%', - '_' => '!_', - ]) . '/%'; - - // Expression-owned bindings survive the ORM's eager-loading subqueries. - return $query->where(new QueryExpression([ - $query->expr()->like($this->aliasField('package'), $prefix), - "ESCAPE '!'", - ], [], '')); + return $query->where([ + $this->aliasField('namespace') => $namespace, + ]); } /** diff --git a/tests/Fixture/PackagesFixture.php b/tests/Fixture/PackagesFixture.php index dda787d9..8a09f5bd 100644 --- a/tests/Fixture/PackagesFixture.php +++ b/tests/Fixture/PackagesFixture.php @@ -64,6 +64,11 @@ public function init(): void ]; } + foreach ($this->records as &$record) { + $record['namespace'] = strtolower(explode('/', $record['package'], 2)[0]); + } + unset($record); + parent::init(); } } diff --git a/tests/TestCase/Controller/PackagesControllerTest.php b/tests/TestCase/Controller/PackagesControllerTest.php index 7a4a86c0..450d9ad9 100644 --- a/tests/TestCase/Controller/PackagesControllerTest.php +++ b/tests/TestCase/Controller/PackagesControllerTest.php @@ -108,9 +108,11 @@ public function testPublicPluginDetails(): void */ public function testPackageRoutePreservesDotsAndUnderscores(): void { - $this->fetchTable(PackagesTable::class)->updateAll([ + $packages = $this->fetchTable(PackagesTable::class); + $package = $packages->patchEntity($packages->get(2), [ 'package' => 'vendor.name/plugin_name.json', - ], ['id' => 2]); + ]); + $packages->saveOrFail($package); $this->get('/plugins/vendor.name/plugin_name.json'); $this->assertResponseOk(); $this->assertNoRedirect(); @@ -148,9 +150,10 @@ public function testPackageHierarchyHasNoReservedNamespacePrefixes(): void { $packages = $this->fetchTable(PackagesTable::class); foreach (['by', '123'] as $namespace) { - $packages->updateAll([ + $package = $packages->patchEntity($packages->get(2), [ 'package' => $namespace . '/cakephp-tools', - ], ['id' => 2]); + ]); + $packages->saveOrFail($package); $this->get('/plugins/' . $namespace); $this->assertResponseOk(); $this->assertNoRedirect(); diff --git a/tests/TestCase/Model/Table/PackagesTableTest.php b/tests/TestCase/Model/Table/PackagesTableTest.php index ac7cad21..2bd1784c 100644 --- a/tests/TestCase/Model/Table/PackagesTableTest.php +++ b/tests/TestCase/Model/Table/PackagesTableTest.php @@ -88,10 +88,17 @@ public function testFeaturedCandidates(): void public function testNamespaceMatching(): void { $packages = $this->fetchTable(PackagesTable::class); - $packages->updateAll(['package' => 'vendor_extra/one'], ['id' => 2]); - $packages->updateAll(['package' => 'vendorXextra/two'], ['id' => 3]); - $packages->updateAll(['package' => 'vendor_extra_more/three'], ['id' => 4]); - $packages->updateAll(['package' => 'vendor.extra/four'], ['id' => 5]); + $names = [ + 2 => 'vendor_extra/one', + 3 => 'vendorXextra/two', + 4 => 'vendor_extra_more/three', + 5 => 'vendor.extra/four', + ]; + foreach ($names as $id => $name) { + $package = $packages->get($id); + $package->package = $name; + $packages->saveOrFail($package); + } $this->assertSame([2], $packages->find('namespace', namespace: 'vendor_extra')->all()->extract('id')->toList()); $this->assertSame([5], $packages->find('namespace', namespace: 'vendor.extra')->all()->extract('id')->toList()); $this->assertSame(0, $packages->find('namespace', namespace: 'vendor%')->count()); @@ -99,6 +106,34 @@ public function testNamespaceMatching(): void $this->assertSame(19, $packages->find('namespace', namespace: 'vendor')->count()); } + /** + * Imports derive the namespace, and renames cannot retain a stale or forged vendor. + */ + public function testNamespaceIsDerivedOnCreateAndRename(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $package = $packages->newEntity([ + 'package' => 'Example_Vendor/plugin', + 'namespace' => 'forged', + 'description' => 'Example package.', + 'repo_url' => 'https://github.com/example/plugin', + 'downloads' => 100, + 'stars' => 10, + 'latest_stable_version' => '1.0.0', + 'latest_stable_release_date' => null, + ]); + $packages->saveOrFail($package); + $this->assertSame('example_vendor', $packages->get($package->id)->namespace); + $package = $packages->patchEntity($package, [ + 'package' => 'different.vendor/plugin', + 'namespace' => 'forged-again', + ]); + $packages->saveOrFail($package); + $this->assertSame('different.vendor', $packages->get($package->id)->namespace); + $this->assertSame(0, $packages->find('namespace', namespace: 'example_vendor')->count()); + $this->assertSame(1, $packages->find('namespace', namespace: 'different.vendor')->count()); + } + /** * Totals and category counts cover only the requested namespace. */ diff --git a/tests/TestCase/Service/PackagistImporterTest.php b/tests/TestCase/Service/PackagistImporterTest.php index 19217804..c55088a4 100644 --- a/tests/TestCase/Service/PackagistImporterTest.php +++ b/tests/TestCase/Service/PackagistImporterTest.php @@ -61,6 +61,7 @@ public function testSyncUpdatesMetadataAndPreservesCategories(): void $package = $packages->get(1, contain: ['Categories', 'Tags']); $this->assertCount(2, $package->categories); $this->assertSame('Updated plugin description', $package->description); + $this->assertSame('markstory', $package->namespace); $this->assertSame('5.1.0', $package->latest_stable_version); $this->assertEquals(new Date('2026-04-05'), $package->latest_stable_release_date); $this->assertContains('cakephp-5-4', array_column($package->tags, 'slug')); From 83529bf987cbdc3857d81a406fe84d9849ce105f Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 15:24:58 +0100 Subject: [PATCH 8/9] Share GitHub API requests and preserve avatars under rate limits --- config/app.php | 1 + src/Application.php | 19 ++++- src/Event/AfterGithubIdentify.php | 22 +++--- src/Service/GithubApiService.php | 49 +++++++++++++ src/Service/GithubProfileService.php | 25 ++++--- .../Event/AfterGithubIdentifyTest.php | 4 +- .../TestCase/Service/GithubApiServiceTest.php | 70 +++++++++++++++++++ .../Service/GithubProfileServiceTest.php | 50 +++++++++---- 8 files changed, 200 insertions(+), 40 deletions(-) create mode 100644 src/Service/GithubApiService.php create mode 100644 tests/TestCase/Service/GithubApiServiceTest.php diff --git a/config/app.php b/config/app.php index 9bd83e7f..dd9b52ee 100644 --- a/config/app.php +++ b/config/app.php @@ -108,6 +108,7 @@ 'GitHub' => [ 'applicationId' => env('AUTH_ID_GITHUB'), 'applicationSecret' => env('AUTH_SECRET_GITHUB'), + 'apiToken' => env('GITHUB_API_TOKEN'), ], 'Packages' => [ diff --git a/src/Application.php b/src/Application.php index 87f56570..61c4ac40 100644 --- a/src/Application.php +++ b/src/Application.php @@ -27,6 +27,7 @@ use App\Policy\RequestPolicy; use App\Service\AwesomeListImporter; use App\Service\AwesomeListParser; +use App\Service\GithubApiService; use App\Service\GithubProfileService; use App\Service\PackagistImporter; use Authentication\AuthenticationService; @@ -45,7 +46,6 @@ use Cake\Datasource\FactoryLocator; use Cake\Datasource\RepositoryInterface; use Cake\Error\Middleware\ErrorHandlerMiddleware; -use Cake\Event\EventManager; use Cake\Http\BaseApplication; use Cake\Http\Client; use Cake\Http\Client\ClientEvent; @@ -85,8 +85,16 @@ public function bootstrap(): void new TableLocator()->allowFallbackClass(false), ); } + } - EventManager::instance()->on(new AfterGithubIdentify()); + /** + * Resolve authentication event listeners through CakePHP's container. + * + * @return list> + */ + public function eventListeners(): array + { + return [AfterGithubIdentify::class]; } /** @@ -225,7 +233,12 @@ public function services(ContainerInterface $container): void { $container->addShared(PackagesTable::class, static fn(): RepositoryInterface => FactoryLocator::get('Table')->get(PackagesTable::class)); $container->addShared(Client::class); - $container->addShared(GithubProfileService::class)->addArgument(Client::class); + $container->addShared(GithubApiService::class)->addArguments([ + Client::class, + (string)Configure::read('GitHub.apiToken', ''), + ]); + $container->addShared(GithubProfileService::class)->addArgument(GithubApiService::class); + $container->addShared(AfterGithubIdentify::class)->addArgument(GithubApiService::class); $container->add(NamespaceProfileIsland::class)->addArgument(GithubProfileService::class); $container->addShared(AwesomeListParser::class); $container->addShared('packagist.http', static function (): Client { diff --git a/src/Event/AfterGithubIdentify.php b/src/Event/AfterGithubIdentify.php index 6a45add5..0bfb9272 100644 --- a/src/Event/AfterGithubIdentify.php +++ b/src/Event/AfterGithubIdentify.php @@ -6,15 +6,23 @@ use ADmad\SocialAuth\Middleware\SocialAuthMiddleware; use App\Model\Entity\User; use App\Model\Enum\UserRole; +use App\Model\Table\UsersTable; +use App\Service\GithubApiService; use Cake\Event\EventInterface; use Cake\Event\EventListenerInterface; -use Cake\Http\Client; use Cake\ORM\Locator\LocatorAwareTrait; class AfterGithubIdentify implements EventListenerInterface { use LocatorAwareTrait; + /** + * Resolve the shared GitHub client through the application container. + */ + public function __construct(private readonly GithubApiService $github) + { + } + /** * Returns a list of events this object is interested in. * @@ -41,22 +49,14 @@ public function afterIdentify(EventInterface $event, User $user): void return; } - $http = new Client([ - 'headers' => [ - 'Authorization' => 'Bearer ' . $token, - 'Accept' => 'application/vnd.github+json', - 'User-Agent' => 'plugins.cakephp.org', - ], - ]); - - $response = $http->get('https://api.github.com/user/memberships/orgs/cakephp'); + $response = $this->github->get('/user/memberships/orgs/cakephp', token: $token); if (!$response->isOk() && $response->getStatusCode() !== 404) { return; } $isCakePHPDev = $response->isOk() && ($response->getJson()['state'] ?? null) === 'active'; - $usersTable = $this->getTableLocator()->get('Users'); + $usersTable = $this->fetchTable(UsersTable::class); // Organization membership is authoritative, even for the last administrator. $user->set('is_cakephp_dev', $isCakePHPDev); $user->set('role', $isCakePHPDev ? UserRole::Admin : UserRole::User); diff --git a/src/Service/GithubApiService.php b/src/Service/GithubApiService.php new file mode 100644 index 00000000..62b15004 --- /dev/null +++ b/src/Service/GithubApiService.php @@ -0,0 +1,49 @@ + $query Query parameters. + * @param string|null $token OAuth token for this request only. + */ + public function get(string $path, array $query = [], ?string $token = null): Response + { + if (!str_starts_with($path, '/') || str_starts_with($path, '//')) { + throw new InvalidArgumentException('GitHub API requests require a relative path starting with one slash.'); + } + $headers = [ + 'Accept' => 'application/vnd.github+json', + 'User-Agent' => 'plugins.cakephp.org', + 'X-GitHub-Api-Version' => '2022-11-28', + ]; + $token ??= $this->token; + if ($token !== '') { + $headers['Authorization'] = 'Bearer ' . $token; + } + + return $this->client->get('https://api.github.com' . $path, $query, [ + 'timeout' => 3, + 'headers' => $headers, + ]); + } +} diff --git a/src/Service/GithubProfileService.php b/src/Service/GithubProfileService.php index f7043b5a..9f271b02 100644 --- a/src/Service/GithubProfileService.php +++ b/src/Service/GithubProfileService.php @@ -4,7 +4,6 @@ namespace App\Service; use Cake\Cache\Cache; -use Cake\Http\Client; use Psr\Http\Client\ClientExceptionInterface; /** @@ -15,7 +14,7 @@ class GithubProfileService /** * Construct without fetching; lazy island rendering owns the network request. */ - public function __construct(private readonly Client $client) + public function __construct(private readonly GithubApiService $github) { } @@ -28,23 +27,23 @@ public function profile(string $owner): ?array return null; } $owner = strtolower($owner); + $fallback = [ + 'avatarUrl' => 'https://github.com/' . rawurlencode($owner) . '.png?size=192', + 'bio' => null, + ]; $key = 'github_profile_v2_' . $owner; $cache = Cache::pool('github_profiles'); $cached = $cache->get($key); if (is_array($cached)) { - return $cached !== [] ? $cached : null; + return $cached !== [] ? [ + 'avatarUrl' => $cached['avatarUrl'] ?? $fallback['avatarUrl'], + 'bio' => $cached['bio'] ?? null, + ] : $fallback; } $profile = null; try { - $response = $this->client->get('https://api.github.com/users/' . rawurlencode($owner), [], [ - 'timeout' => 3, - 'headers' => [ - 'Accept' => 'application/vnd.github+json', - 'User-Agent' => 'plugins.cakephp.org', - 'X-GitHub-Api-Version' => '2022-11-28', - ], - ]); + $response = $this->github->get('/users/' . rawurlencode($owner)); $data = $response->isOk() ? $response->getJson() : null; if (is_array($data) && is_string($data['login'] ?? null) && strcasecmp($data['login'], $owner) === 0) { $avatarUrl = $data['avatar_url'] ?? null; @@ -53,7 +52,7 @@ public function profile(string $owner): ?array parse_url($avatarUrl, PHP_URL_SCHEME) !== 'https' || !in_array(parse_url($avatarUrl, PHP_URL_HOST), ['avatars.githubusercontent.com', 'github.com'], true) ) { - $avatarUrl = null; + $avatarUrl = $fallback['avatarUrl']; } $bio = is_string($data['bio'] ?? null) ? trim($data['bio']) : ''; $profile = [ @@ -66,6 +65,6 @@ public function profile(string $owner): ?array } $cache->set($key, $profile ?? [], $profile !== null ? 86400 : 900); - return $profile; + return $profile ?? $fallback; } } diff --git a/tests/TestCase/Event/AfterGithubIdentifyTest.php b/tests/TestCase/Event/AfterGithubIdentifyTest.php index dc24dcd7..11e51010 100644 --- a/tests/TestCase/Event/AfterGithubIdentifyTest.php +++ b/tests/TestCase/Event/AfterGithubIdentifyTest.php @@ -8,7 +8,9 @@ use App\Event\AfterGithubIdentify; use App\Model\Enum\UserRole; use App\Model\Table\UsersTable; +use App\Service\GithubApiService; use Cake\Event\Event; +use Cake\Http\Client; use Cake\Http\TestSuite\HttpClientTrait; use Cake\TestSuite\TestCase; use Override; @@ -48,7 +50,7 @@ public function testSynchronizesMembership( $this->newClientResponse($status, ['Content-Type: application/json'], $body), ); - $listener = new AfterGithubIdentify(); + $listener = new AfterGithubIdentify(new GithubApiService(new Client())); $listener->setTableLocator($this->getTableLocator()); $listener->afterIdentify(new Event(SocialAuthMiddleware::EVENT_AFTER_IDENTIFY), $user); diff --git a/tests/TestCase/Service/GithubApiServiceTest.php b/tests/TestCase/Service/GithubApiServiceTest.php new file mode 100644 index 00000000..d32189c1 --- /dev/null +++ b/tests/TestCase/Service/GithubApiServiceTest.php @@ -0,0 +1,70 @@ +createMock(Client::class); + $client->expects($this->once())->method('get')->with('https://api.github.com/users/example', [], [ + 'timeout' => 3, + 'headers' => [ + 'Accept' => 'application/vnd.github+json', + 'User-Agent' => 'plugins.cakephp.org', + 'X-GitHub-Api-Version' => '2022-11-28', + ], + ])->willReturn($response); + $this->assertSame($response, new GithubApiService($client)->get('/users/example')); + } + + /** + * User-specific credentials override the application token for one request only. + */ + public function testRequestTokenDoesNotLeakIntoSubsequentRequests(): void + { + $client = $this->createMock(Client::class); + $requests = []; + $client->expects($this->exactly(3))->method('get')->willReturnCallback( + static function (string $url, array $query, array $options) use (&$requests): Response { + $requests[] = [$url, $query, $options['headers']['Authorization'] ?? null]; + + return new Response(['HTTP/1.1 200 OK'], '{}'); + }, + ); + $github = new GithubApiService($client, 'application-token'); + $github->get('/user/memberships/orgs/cakephp', token: 'user-token'); + $github->get('/users/example', ['page' => 2]); + $github->get('/users/example', token: ''); + $this->assertSame([ + ['https://api.github.com/user/memberships/orgs/cakephp', [], 'Bearer user-token'], + ['https://api.github.com/users/example', ['page' => 2], 'Bearer application-token'], + ['https://api.github.com/users/example', [], null], + ], $requests); + } + + /** + * A caller cannot direct the configured application token to another host. + */ + public function testAbsoluteUrlsAreRejected(): void + { + $client = $this->createMock(Client::class); + $client->expects($this->never())->method('get'); + $this->expectException(InvalidArgumentException::class); + new GithubApiService($client, 'application-token')->get('https://example.com/users'); + } +} diff --git a/tests/TestCase/Service/GithubProfileServiceTest.php b/tests/TestCase/Service/GithubProfileServiceTest.php index f768ee78..4f11afa5 100644 --- a/tests/TestCase/Service/GithubProfileServiceTest.php +++ b/tests/TestCase/Service/GithubProfileServiceTest.php @@ -3,9 +3,9 @@ namespace App\Test\TestCase\Service; +use App\Service\GithubApiService; use App\Service\GithubProfileService; use Cake\Cache\Cache; -use Cake\Http\Client; use Cake\Http\Client\Exception\ClientException; use Cake\Http\Client\Response; use Cake\TestSuite\TestCase; @@ -30,8 +30,8 @@ protected function setUp(): void */ public function testProfileIsCachedAcrossRequestsAndCasing(): void { - $client = $this->createMock(Client::class); - $client->expects($this->once())->method('get')->with('https://api.github.com/users/cakedc')->willReturn(new Response( + $client = $this->createMock(GithubApiService::class); + $client->expects($this->once())->method('get')->with('/users/cakedc')->willReturn(new Response( ['HTTP/1.1 200 OK'], json_encode([ 'login' => 'CakeDC', @@ -55,11 +55,17 @@ public function testProfileIsCachedAcrossRequestsAndCasing(): void #[DataProvider('unavailableProfiles')] public function testUnavailableProfileUsesCachedFallback(string $status, string $body): void { - $client = $this->createMock(Client::class); + $client = $this->createMock(GithubApiService::class); $client->expects($this->once())->method('get')->willReturn(new Response([$status], $body)); $service = new GithubProfileService($client); - $this->assertNull($service->profile('example')); - $this->assertNull($service->profile('example')); + $this->assertSame([ + 'avatarUrl' => 'https://github.com/example.png?size=192', + 'bio' => null, + ], $service->profile('example')); + $this->assertSame([ + 'avatarUrl' => 'https://github.com/example.png?size=192', + 'bio' => null, + ], $service->profile('example')); } /** @@ -81,11 +87,17 @@ public static function unavailableProfiles(): array */ public function testNetworkFailureUsesCachedFallback(): void { - $client = $this->createMock(Client::class); + $client = $this->createMock(GithubApiService::class); $client->expects($this->once())->method('get')->willThrowException(new ClientException('Connection failed')); $service = new GithubProfileService($client); - $this->assertNull($service->profile('example')); - $this->assertNull($service->profile('example')); + $this->assertSame([ + 'avatarUrl' => 'https://github.com/example.png?size=192', + 'bio' => null, + ], $service->profile('example')); + $this->assertSame([ + 'avatarUrl' => 'https://github.com/example.png?size=192', + 'bio' => null, + ], $service->profile('example')); } /** @@ -93,12 +105,12 @@ public function testNetworkFailureUsesCachedFallback(): void */ public function testUnsafeAvatarAndEmptyBioAreOmitted(): void { - $client = $this->createStub(Client::class); + $client = $this->createStub(GithubApiService::class); $client->method('get')->willReturn(new Response( ['HTTP/1.1 200 OK'], '{"login":"example","avatar_url":"javascript:alert(1)","bio":" "}', )); - $this->assertSame(['avatarUrl' => null, 'bio' => null], new GithubProfileService($client)->profile('example')); + $this->assertSame(['avatarUrl' => 'https://github.com/example.png?size=192', 'bio' => null], new GithubProfileService($client)->profile('example')); } /** @@ -106,8 +118,22 @@ public function testUnsafeAvatarAndEmptyBioAreOmitted(): void */ public function testInvalidOwnerDoesNotFetch(): void { - $client = $this->createMock(Client::class); + $client = $this->createMock(GithubApiService::class); $client->expects($this->never())->method('get'); $this->assertNull(new GithubProfileService($client)->profile('../users')); } + + /** + * Existing cached failures must not hide otherwise accessible public avatars. + */ + public function testCachedRateLimitStillProvidesPublicAvatar(): void + { + Cache::pool('github_profiles')->set('github_profile_v2_lordsimal', [], 900); + $client = $this->createMock(GithubApiService::class); + $client->expects($this->never())->method('get'); + $this->assertSame([ + 'avatarUrl' => 'https://github.com/lordsimal.png?size=192', + 'bio' => null, + ], new GithubProfileService($client)->profile('LordSimal')); + } } From 8d6a627ef62e828cf087b1b61fd74481ab94f6cb Mon Sep 17 00:00:00 2001 From: Jasper Smet Date: Fri, 13 Nov 2026 16:42:57 +0100 Subject: [PATCH 9/9] Add publisher directory with version-aware rankings --- ...61113160000_AddMonthlyPackageDownloads.php | 20 ++ config/Migrations/schema-dump-default.lock | Bin 20542 -> 21045 bytes config/routes.php | 4 + resources/css/style.css | 24 +- src/Application.php | 18 +- src/Controller/PackagesController.php | 6 +- src/Controller/PublishersController.php | 27 +++ src/Island/PublishersIsland.php | 131 +++++++++++ src/Model/Entity/Package.php | 1 + src/Model/Table/PackagesTable.php | 171 +++++++++++++- src/Service/GithubProfileService.php | 17 +- src/Service/PackagistImporter.php | 4 +- templates/Packages/by_namespace.php | 7 +- templates/Publishers/index.php | 11 + templates/element/navbar.php | 18 +- templates/island/publishers.php | 199 ++++++++++++++++ tests/Fixture/PackagesFixture.php | 6 + tests/Fixture/PublisherTaggedFixture.php | 41 ++++ tests/Fixture/PublisherVersionsFixture.php | 34 +++ tests/TestCase/ApplicationServicesTest.php | 113 +++++++++ tests/TestCase/ApplicationTest.php | 2 + .../Controller/PackagesControllerTest.php | 33 +++ .../Controller/PublishersControllerTest.php | 90 ++++++++ .../TestCase/Island/PublishersIslandTest.php | 87 +++++++ .../Model/Table/PackagesTableTest.php | 116 +++++++++- .../Service/GithubProfileServiceTest.php | 12 + .../Service/PackagistImporterTest.php | 6 +- tests/browser/publishers-state.php | 34 +++ tests/browser/publishers.spec.js | 215 ++++++++++++++++++ 29 files changed, 1411 insertions(+), 36 deletions(-) create mode 100644 config/Migrations/20261113160000_AddMonthlyPackageDownloads.php create mode 100644 src/Controller/PublishersController.php create mode 100644 src/Island/PublishersIsland.php create mode 100644 templates/Publishers/index.php create mode 100644 templates/island/publishers.php create mode 100644 tests/Fixture/PublisherTaggedFixture.php create mode 100644 tests/Fixture/PublisherVersionsFixture.php create mode 100644 tests/TestCase/ApplicationServicesTest.php create mode 100644 tests/TestCase/Controller/PublishersControllerTest.php create mode 100644 tests/TestCase/Island/PublishersIslandTest.php create mode 100644 tests/browser/publishers-state.php create mode 100644 tests/browser/publishers.spec.js diff --git a/config/Migrations/20261113160000_AddMonthlyPackageDownloads.php b/config/Migrations/20261113160000_AddMonthlyPackageDownloads.php new file mode 100644 index 00000000..293442da --- /dev/null +++ b/config/Migrations/20261113160000_AddMonthlyPackageDownloads.php @@ -0,0 +1,20 @@ +table('packages') + ->addColumn('monthly_downloads', 'integer', [ + 'null' => true, + 'default' => null, + ]) + ->update(); + } +} diff --git a/config/Migrations/schema-dump-default.lock b/config/Migrations/schema-dump-default.lock index 45fa958edc511bf8192fd4bf45290a4c134b9a5a..320af07ac76b4fce41e5ba7b2cc8e407e4590442 100644 GIT binary patch delta 123 zcmdnDfN|>*#tlNMn}e;_Gj2Yhc8iy<*vin{N+~x#uOuU2{)?j;1J^bA6Svytho-So0A0&3 ARR910 delta 50 zcmdnGgmK>j#tlNMjFy{yY}YbQzAw69bAm4)z|PvJu4q diff --git a/config/routes.php b/config/routes.php index 16074258..48b40ca8 100644 --- a/config/routes.php +++ b/config/routes.php @@ -62,6 +62,10 @@ 'controller' => 'Packages', 'action' => 'index', ], ['_name' => 'plugin:index']); + $builder->get('/publishers', [ + 'controller' => 'Publishers', + 'action' => 'index', + ], 'publisher:index'); $packageSegment = '[A-Za-z0-9][A-Za-z0-9_.-]*'; $builder->get('/plugins/{namespace}/{name}', [ 'controller' => 'Packages', diff --git a/resources/css/style.css b/resources/css/style.css index 4709dad2..1eaf2064 100644 --- a/resources/css/style.css +++ b/resources/css/style.css @@ -236,7 +236,7 @@ body::before { .namespace-profile-link { @apply size-11 min-h-11; } } .namespace-statistics { - @apply w-full min-w-0 md:max-w-md lg:w-96; + @apply w-full min-w-0 md:max-w-lg lg:w-[30rem]; } .namespace-stat-value { @apply text-[clamp(1.5rem,2.8vw,2.5rem)] leading-tight font-semibold tracking-tight tabular-nums; @@ -252,6 +252,28 @@ body::before { .catalogue-discovery { @apply mb-6 rounded-2xl border border-base-300 bg-base-100 p-4 md:p-5; } +.publisher-controls { + @apply mb-5 flex flex-col gap-3 rounded-2xl border border-base-300 bg-base-100 p-4 md:flex-row md:items-center md:p-5; +} +.publisher-row { + @apply grid grid-cols-1 items-center gap-4 border-b border-base-300 p-4 + hover:bg-row-hover/40 md:grid-cols-[minmax(0,1fr)_19rem] md:p-5; +} +.publisher-rank { + @apply absolute -right-2 -bottom-1 z-10 min-h-6 min-w-7 rounded-full border-2 border-base-100 + bg-base-content px-1.5 text-xs leading-none font-semibold text-base-100 tabular-nums; +} +.publisher-avatar { + @apply relative size-14 overflow-hidden rounded-xl bg-primary/10 text-lg font-semibold text-primary md:size-16; + & img { @apply absolute inset-0 size-full object-cover; } +} +.publisher-name { + @apply text-lg leading-tight font-semibold wrap-anywhere; + & a { @apply text-base-content hover:text-primary; } +} +.publisher-plugin { @apply h-auto max-w-full px-2 py-1 text-xs whitespace-normal text-muted wrap-anywhere hover:text-primary; } +.publisher-statistics { @apply grid grid-cols-3 gap-x-4 md:gap-x-6; } +.publisher-statistics > div { @apply row-span-2 grid grid-rows-subgrid; } .reset-filters { @apply inline-flex min-h-10 shrink-0 items-center justify-center gap-1.5 text-[0.8125rem] font-medium whitespace-nowrap max-md:w-10; diff --git a/src/Application.php b/src/Application.php index 61c4ac40..80250c6b 100644 --- a/src/Application.php +++ b/src/Application.php @@ -17,19 +17,13 @@ namespace App; use ADmad\SocialAuth\Middleware\SocialAuthMiddleware; -use App\Command\SyncPackagesCommand; use App\Event\AfterGithubIdentify; use App\Http\RateLimit\AtomicFixedWindowRateLimiter; -use App\Island\NamespaceProfileIsland; use App\Middleware\ThemeCookieMiddleware; use App\Model\Table\PackagesTable; use App\Model\Table\UsersTable; use App\Policy\RequestPolicy; -use App\Service\AwesomeListImporter; -use App\Service\AwesomeListParser; use App\Service\GithubApiService; -use App\Service\GithubProfileService; -use App\Service\PackagistImporter; use Authentication\AuthenticationService; use Authentication\AuthenticationServiceInterface; use Authentication\AuthenticationServiceProviderInterface; @@ -57,6 +51,7 @@ use Cake\ORM\Locator\TableLocator; use Cake\Routing\Middleware\AssetMiddleware; use Cake\Routing\Middleware\RoutingMiddleware; +use League\Container\ReflectionContainer; use Packagist\Api\Client as PackagistClient; use Psr\Http\Message\ServerRequestInterface; use SocialConnect\OAuth2\Provider\GitHub; @@ -213,7 +208,7 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue } return !in_array($request->getMethod(), ['GET', 'HEAD'], true) - || !($path === '' || $path === '/packages' || preg_match('#^/plugins/[A-Za-z0-9][A-Za-z0-9_.-]*(?:/[A-Za-z0-9][A-Za-z0-9_.-]*)?$#', $path)); + || !in_array($path, ['', '/packages', '/publishers'], true) && !preg_match('#^/plugins/[A-Za-z0-9][A-Za-z0-9_.-]*(?:/[A-Za-z0-9][A-Za-z0-9_.-]*)?$#', $path); }, ]), ); @@ -231,16 +226,14 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue */ public function services(ContainerInterface $container): void { + // Interact constructs fresh island roots separately from cached service dependencies. + $container->delegate(new ReflectionContainer(cacheResolutions: !Configure::read('debug'))); $container->addShared(PackagesTable::class, static fn(): RepositoryInterface => FactoryLocator::get('Table')->get(PackagesTable::class)); $container->addShared(Client::class); $container->addShared(GithubApiService::class)->addArguments([ Client::class, (string)Configure::read('GitHub.apiToken', ''), ]); - $container->addShared(GithubProfileService::class)->addArgument(GithubApiService::class); - $container->addShared(AfterGithubIdentify::class)->addArgument(GithubApiService::class); - $container->add(NamespaceProfileIsland::class)->addArgument(GithubProfileService::class); - $container->addShared(AwesomeListParser::class); $container->addShared('packagist.http', static function (): Client { $client = new Client(); $userAgent = (string)env('PACKAGIST_USER_AGENT', 'plugins.cakephp.org (https://plugins.cakephp.org; mailto=security@cakephp.org)'); @@ -252,9 +245,6 @@ public function services(ContainerInterface $container): void return $client; }); $container->addShared(PackagistClient::class)->addArgument('packagist.http'); - $container->addShared(PackagistImporter::class)->addArguments([PackagesTable::class, PackagistClient::class]); - $container->addShared(AwesomeListImporter::class)->addArguments([PackagesTable::class, Client::class, AwesomeListParser::class]); - $container->add(SyncPackagesCommand::class)->addArguments([PackagistImporter::class, AwesomeListImporter::class]); } /** diff --git a/src/Controller/PackagesController.php b/src/Controller/PackagesController.php index 6a57b01e..3faffea3 100644 --- a/src/Controller/PackagesController.php +++ b/src/Controller/PackagesController.php @@ -47,7 +47,11 @@ public function byNamespace(string $namespace): ?Response ], 301); } $githubUrl = $packages->namespaceGithubUrl($namespace); - $this->set(compact('namespace', 'stats', 'githubUrl')); + $backUrl = $this->getRequest()->referer(); + if ($backUrl === null || parse_url($backUrl, PHP_URL_PATH) === $this->getRequest()->getPath()) { + $backUrl = ['_name' => 'plugin:index']; + } + $this->set(compact('namespace', 'stats', 'githubUrl', 'backUrl')); return null; } diff --git a/src/Controller/PublishersController.php b/src/Controller/PublishersController.php new file mode 100644 index 00000000..fb3424cc --- /dev/null +++ b/src/Controller/PublishersController.php @@ -0,0 +1,27 @@ +Search->setConfig('actions', [], false); + $this->Authentication->allowUnauthenticated(['index']); + } + + /** + * Render the directory island in the shared application layout. + */ + public function index(): void + { + } +} diff --git a/src/Island/PublishersIsland.php b/src/Island/PublishersIsland.php new file mode 100644 index 00000000..0ec30abf --- /dev/null +++ b/src/Island/PublishersIsland.php @@ -0,0 +1,131 @@ + 20, + 'maxLimit' => 20, + 'sortableFields' => [], + ], + url: ['page' => 'page'], + history: true, + )] + public PaginationState $paging; + + /** + * Only the pure avatar URL builder is needed; profile lookups remain on profile pages. + */ + public function __construct(private readonly GithubProfileService $profiles) + { + } + + /** + * Preserve explicit history paging while resetting pages after filter changes. + */ + public function updated(UpdatedPaths $paths): void + { + if (($paths->has('search') || $paths->has('sort') || $paths->has('cakephp')) && !$paths->has('paging.page')) { + $this->paging->page = 1; + } + } + + /** + * Retain the selected popularity metric when clearing a search. + */ + #[Action] + public function clearSearch(): void + { + $this->search = ''; + $this->paging->page = 1; + } + + /** + * Aggregate once, then batch-load details for the visible page. + * + * @return array + */ + public function viewData(): array + { + if (mb_strlen($this->search) > 100) { + throw new BadRequestException('Search query is too long.'); + } + $sortOptions = [ + 'monthly_downloads' => __('Monthly downloads'), + 'downloads' => __('Lifetime downloads'), + 'stars' => __('Stars'), + 'plugins' => __('Plugin count'), + ]; + if (!isset($sortOptions[$this->sort])) { + $this->sort = 'monthly_downloads'; + } + $packages = $this->fetchTable(PackagesTable::class); + $majors = $packages->publisherMajors(); + $current = $majors[0] ?? null; + $versionOptions = []; + if ($current !== null) { + $versionOptions['current'] = __('CakePHP {0} (current)', $current); + foreach ($majors as $major) { + if ($major !== $current) { + $versionOptions[$major] = __('CakePHP {0}', $major); + } + } + } + $versionOptions['all'] = __('All versions'); + if (!isset($versionOptions[$this->cakephp])) { + $this->cakephp = $current !== null ? 'current' : 'all'; + } + $major = match ($this->cakephp) { + 'all' => null, + 'current' => $current, + default => $this->cakephp, + }; + $publishers = $this->paginate($packages->unhydratedFind('publishers', search: $this->search, sort: $this->sort, major: $major)); + $namespaces = []; + foreach ($publishers as $publisher) { + $namespaces[] = $publisher['namespace']; + } + $details = $packages->publisherDetails($namespaces, $this->sort, $major); + foreach ($details as &$detail) { + $detail['avatarUrl'] = $detail['githubUrl'] !== null + ? $this->profiles->avatarUrl(basename($detail['githubUrl']), 96) + : null; + } + unset($detail); + + return [ + 'publishers' => $publishers, + 'details' => $details, + 'sortOptions' => $sortOptions, + 'versionOptions' => $versionOptions, + 'selectedMajor' => $major, + 'showRanks' => trim($this->search) === '', + 'rankStart' => ($this->paging->page - 1) * $this->paging->limit + 1, + ]; + } +} diff --git a/src/Model/Entity/Package.php b/src/Model/Entity/Package.php index 8bd5ee7d..9e69b234 100644 --- a/src/Model/Entity/Package.php +++ b/src/Model/Entity/Package.php @@ -16,6 +16,7 @@ * @property string $description * @property string $repo_url * @property int $downloads + * @property int|null $monthly_downloads * @property int $stars * @property string|null $latest_stable_version * @property \Cake\I18n\Date|null $latest_stable_release_date diff --git a/src/Model/Table/PackagesTable.php b/src/Model/Table/PackagesTable.php index 4d3afb5b..606fd1a6 100644 --- a/src/Model/Table/PackagesTable.php +++ b/src/Model/Table/PackagesTable.php @@ -6,6 +6,7 @@ use App\Model\Filter\PackagesCollection; use ArrayObject; use Cake\Cache\Cache; +use Cake\Database\Expression\FunctionExpression; use Cake\Database\Expression\QueryExpression; use Cake\Datasource\EntityInterface; use Cake\Event\EventInterface; @@ -90,6 +91,10 @@ public function validationDefault(Validator $validator): Validator ->requirePresence('downloads', 'create') ->notEmptyString('downloads'); + $validator + ->nonNegativeInteger('monthly_downloads') + ->allowEmptyString('monthly_downloads'); + $validator ->integer('stars') ->requirePresence('stars', 'create') @@ -164,6 +169,141 @@ public function findNamespace(SelectQuery $query, string $namespace): SelectQuer ]); } + /** + * Rank Composer namespaces from packages supporting the selected CakePHP major. + * + * @param \Cake\ORM\Query\SelectQuery $query Package query. + * @param string $search Case-insensitive namespace substring. + * @param string $sort Popularity metric. + * @param string|null $major CakePHP major; null includes all versions. + * @return \Cake\ORM\Query\SelectQuery + */ + public function findPublishers(SelectQuery $query, string $search = '', string $sort = 'monthly_downloads', ?string $major = null): SelectQuery + { + $query->select([ + 'namespace' => $this->aliasField('namespace'), + 'plugins' => $query->func()->count('*'), + 'downloads' => $query->func()->sum($this->aliasField('downloads')), + 'monthly_downloads' => $query->expr()->case() + ->when($query->expr()->eq($query->func()->count($this->aliasField('monthly_downloads')), $query->func()->count('*'))) + ->then($query->func()->sum($this->aliasField('monthly_downloads'))), + 'stars' => $query->func()->sum($this->aliasField('stars')), + 'latest_release' => $query->func()->max($this->aliasField('latest_stable_release_date'))->setReturnType('string'), + ])->where([ + $this->aliasField('namespace') . ' !=' => '', + ])->groupBy($this->aliasField('namespace')); + + if ($major !== null) { + $query->where($query->expr()->exists($this->publisherCompatibility($major))); + } + + $search = mb_strtolower(trim($search)); + if ($search !== '') { + $query->where($query->expr()->gt(new FunctionExpression('INSTR', [ + $this->aliasField('namespace') => 'identifier', + $search, + ]), 0, 'integer')); + } + $sort = match ($sort) { + 'downloads', 'stars', 'plugins' => $sort, + default => 'monthly_downloads', + }; + + return $query->orderBy([ + $sort => 'DESC', + $this->aliasField('namespace') => 'ASC', + ]); + } + + /** + * Batch profile owners and two popular plugins for the visible publishers. + * + * @param list $namespaces Visible namespace names. + * @param string $sort Popularity metric; plugin-count rankings preview monthly downloads. + * @param string|null $major CakePHP major; null includes all versions. + * @return array}> + */ + public function publisherDetails(array $namespaces, string $sort = 'monthly_downloads', ?string $major = null): array + { + if ($namespaces === []) { + return []; + } + $details = array_fill_keys($namespaces, ['githubUrl' => null, 'plugins' => []]); + $owners = []; + $metric = match ($sort) { + 'stars', 'downloads' => $sort, + default => 'monthly_downloads', + }; + $packages = $this->find()->select(['namespace', 'package', 'repo_url']) + ->where(['namespace IN' => $namespaces]) + ->orderBy([ + $this->aliasField($metric) => 'DESC', + $this->aliasField('package') => 'ASC', + ]); + if ($major !== null) { + $packages->select(['publisher_compatible' => $packages->expr()->exists($this->publisherCompatibility($major))]); + } + foreach ($packages->all() as $package) { + $namespace = $package->namespace; + $owner = $this->githubOwner($package->repo_url); + if ($owner !== null) { + $owners[$namespace][$owner] = true; + } + if (($major === null || $package->get('publisher_compatible')) && count($details[$namespace]['plugins']) < 2) { + $details[$namespace]['plugins'][] = [ + 'package' => $package->package, + 'name' => explode('/', $package->package, 2)[1], + ]; + } + } + foreach ($owners as $namespace => $namespaceOwners) { + if (count($namespaceOwners) === 1) { + $details[$namespace]['githubUrl'] = 'https://github.com/' . array_key_first($namespaceOwners); + } + } + + return $details; + } + + /** + * EXISTS counts a compatible package once even when several minor-version tags match. + * + * @return \Cake\ORM\Query\SelectQuery + */ + private function publisherCompatibility(string $major): SelectQuery + { + $junction = $this->Tagged->getTarget(); + $alias = $junction->getAlias(); + + return $junction->find()->select([$alias . '.fk_id']) + ->innerJoin(['PublisherVersion' => $this->Tags->getTarget()->getTable()], ['PublisherVersion.id = ' . $alias . '.tag_id']) + ->where([ + $alias . '.fk_model' => $this->getAlias(), + 'PublisherVersion.slug LIKE' => 'cakephp-' . $major . '-%', + ]) + ->where(static fn(QueryExpression $exp) => $exp->equalFields($alias . '.fk_id', 'Packages.id')); + } + + /** + * Derive supported major choices from the catalogue's existing compatibility metadata. + * + * @return list + */ + public function publisherMajors(): array + { + $majors = []; + foreach (array_keys($this->filterOptions()['cakephp']) as $slug) { + if (preg_match('/^cakephp-(\d+)-\d+$/D', $slug, $matches)) { + $major = $matches[1]; + if (!in_array($major, $majors, true)) { + $majors[] = $major; + } + } + } + + return $majors; + } + /** * Hero totals cover the namespace before any interactive filters are applied. * @@ -193,16 +333,10 @@ public function namespaceGithubUrl(string $namespace): ?string $owners = []; $repositories = $this->find('namespace', namespace: $namespace)->select(['repo_url'])->distinct()->all(); foreach ($repositories as $package) { - $url = preg_replace('#^git@github\.com:#i', 'https://github.com/', trim($package->repo_url)) ?? $package->repo_url; - $host = strtolower((string)parse_url($url, PHP_URL_HOST)); - if (!in_array($host, ['github.com', 'www.github.com'], true)) { - continue; - } - $parts = explode('/', trim((string)parse_url($url, PHP_URL_PATH), '/')); - if (count($parts) < 2 || $parts[1] === '' || !preg_match('/^[a-z0-9][a-z0-9-]*$/iD', $parts[0])) { - continue; + $owner = $this->githubOwner($package->repo_url); + if ($owner !== null) { + $owners[$owner] = true; } - $owners[strtolower($parts[0])] = true; if (count($owners) > 1) { return null; } @@ -211,6 +345,25 @@ public function namespaceGithubUrl(string $namespace): ?string return $owners !== [] ? 'https://github.com/' . array_key_first($owners) : null; } + /** + * Resolve repository owners consistently for profile pages and publisher rows. + */ + private function githubOwner(string $url): ?string + { + $url = preg_replace('#^git@github\.com:#i', 'https://github.com/', trim($url)) ?? $url; + $host = strtolower((string)parse_url($url, PHP_URL_HOST)); + $parts = explode('/', trim((string)parse_url($url, PHP_URL_PATH), '/')); + if ( + !in_array($host, ['github.com', 'www.github.com'], true) || + count($parts) < 2 || $parts[1] === '' || + !preg_match('/^[a-z0-9][a-z0-9-]*$/iD', $parts[0]) + ) { + return null; + } + + return strtolower($parts[0]); + } + /** * Load configured featured packages without changing their display order. * diff --git a/src/Service/GithubProfileService.php b/src/Service/GithubProfileService.php index 9f271b02..41642360 100644 --- a/src/Service/GithubProfileService.php +++ b/src/Service/GithubProfileService.php @@ -18,17 +18,30 @@ public function __construct(private readonly GithubApiService $github) { } + /** + * Build an avatar URL without performing an API request. + */ + public function avatarUrl(string $owner, int $size = 192): ?string + { + if (!preg_match('/^[a-z0-9][a-z0-9-]*$/iD', $owner)) { + return null; + } + + return 'https://github.com/' . rawurlencode(strtolower($owner)) . '.png?size=' . $size; + } + /** * @return array{avatarUrl: string|null, bio: string|null}|null */ public function profile(string $owner): ?array { - if (!preg_match('/^[a-z0-9][a-z0-9-]*$/iD', $owner)) { + $avatarUrl = $this->avatarUrl($owner); + if ($avatarUrl === null) { return null; } $owner = strtolower($owner); $fallback = [ - 'avatarUrl' => 'https://github.com/' . rawurlencode($owner) . '.png?size=192', + 'avatarUrl' => $avatarUrl, 'bio' => null, ]; $key = 'github_profile_v2_' . $owner; diff --git a/src/Service/PackagistImporter.php b/src/Service/PackagistImporter.php index d0c7cf8d..52045a37 100644 --- a/src/Service/PackagistImporter.php +++ b/src/Service/PackagistImporter.php @@ -106,7 +106,7 @@ public function sync(?callable $progress = null): array } /** - * @return array{package: string, description: string, repo_url: string, downloads: int, stars: int, tag_list: array, latest_stable_version: ?string, latest_stable_release_date: ?\Cake\I18n\Date, is_abandoned: bool} + * @return array{package: string, description: string, repo_url: string, downloads: int, monthly_downloads: int, stars: int, tag_list: array, latest_stable_version: ?string, latest_stable_release_date: ?\Cake\I18n\Date, is_abandoned: bool} */ private function getDataForPackage(string $packageName): array { @@ -119,6 +119,7 @@ private function getDataForPackage(string $packageName): array 'description' => $metaDetails->getDescription(), 'repo_url' => $metaDetails->getRepository(), 'downloads' => $metaDetails->getDownloads()->getTotal(), + 'monthly_downloads' => $metaDetails->getDownloads()->getMonthly(), 'stars' => $metaDetails->getGithubStars(), 'tag_list' => [], 'latest_stable_version' => null, @@ -166,6 +167,7 @@ private function getDataForPackage(string $packageName): array 'description' => $metaDetails->getDescription(), 'repo_url' => $metaDetails->getRepository(), 'downloads' => $metaDetails->getDownloads()->getTotal(), + 'monthly_downloads' => $metaDetails->getDownloads()->getMonthly(), 'stars' => $metaDetails->getGithubStars(), 'tag_list' => $meta, 'latest_stable_version' => $latestStable ? $latestStable->getVersion() : null, diff --git a/templates/Packages/by_namespace.php b/templates/Packages/by_namespace.php index b61438aa..f394b587 100644 --- a/templates/Packages/by_namespace.php +++ b/templates/Packages/by_namespace.php @@ -4,6 +4,7 @@ * @var string $namespace * @var array{plugins: int, downloads: int, stars: int} $stats * @var string|null $githubUrl + * @var array|string $backUrl */ $this->assign('title', __('Plugins by {0}', $namespace)); $statLabels = [ @@ -15,9 +16,7 @@
- Html->link('← ' . __('Browse all plugins'), [ - '_name' => 'plugin:index', - ], [ + Html->link('← ' . __('Back'), $backUrl, [ 'class' => 'inline-flex min-h-8 items-center text-sm text-muted', 'x-interact:navigate' => '', ]) ?> @@ -40,7 +39,7 @@ ]) ?>
-
+
$label) : ?>
diff --git a/templates/Publishers/index.php b/templates/Publishers/index.php new file mode 100644 index 00000000..60a6baf9 --- /dev/null +++ b/templates/Publishers/index.php @@ -0,0 +1,11 @@ +assign('title', __('Publishers')); +?> +
+
+

+

+
+
+Interact->render('Publishers', key: 'publishers-directory') ?> diff --git a/templates/element/navbar.php b/templates/element/navbar.php index 164e632a..b2b7dc2a 100644 --- a/templates/element/navbar.php +++ b/templates/element/navbar.php @@ -7,10 +7,24 @@ $minimal = $minimal ?? false; $requirements = $this->getRequest()->getPath() === '/requirements'; +$publishers = $this->getRequest()->getPath() === '/publishers'; $loggedIn = !$minimal && $this->Identity->isLoggedIn(); $links = [ - ['label' => __('Browse plugins'), 'url' => '/', 'active' => !$requirements], - ['label' => __('Listing requirements'), 'url' => '/requirements', 'active' => $requirements], + [ + 'label' => __('Browse plugins'), + 'url' => '/', + 'active' => !$requirements && !$publishers, + ], + [ + 'label' => __('Publishers'), + 'url' => ['_name' => 'publisher:index'], + 'active' => $publishers, + ], + [ + 'label' => __('Listing requirements'), + 'url' => '/requirements', + 'active' => $requirements, + ], ]; $loginUrl = [ 'prefix' => false, 'plugin' => 'ADmad/SocialAuth', 'controller' => 'Auth', 'action' => 'login', 'provider' => 'github', diff --git a/templates/island/publishers.php b/templates/island/publishers.php new file mode 100644 index 00000000..9bdcedf6 --- /dev/null +++ b/templates/island/publishers.php @@ -0,0 +1,199 @@ +> $publishers + * @var array}> $details + * @var array $sortOptions + * @var array $versionOptions + * @var string|null $selectedMajor + * @var string $search + * @var string $sort + * @var string $cakephp + * @var bool $showRanks + * @var int $rankStart + */ +$this->Form->setTemplates([ + 'input' => '', + 'select' => '', + 'button' => '{{text}}', +]); +$clearQuery = []; +if ($sort !== 'monthly_downloads') { + $clearQuery['sort'] = $sort; +} +if ($cakephp !== 'current') { + $clearQuery['cakephp'] = $cakephp; +} +$clearUrl = $this->Url->build([ + '_name' => 'publisher:index', + '?' => $clearQuery, +]); +$statLabels = [ + 'plugins' => __('Plugins'), + ($sort === 'downloads' ? 'downloads' : 'monthly_downloads') => $sort === 'downloads' ? __('Lifetime downloads') : __('Monthly downloads'), + 'stars' => __('Stars'), +]; +?> +
+ Form->create(null, [ + 'type' => 'get', + 'url' => ['_name' => 'publisher:index'], + 'class' => 'publisher-controls', + 'role' => 'search', + 'aria-label' => __('Find publishers'), + 'x-interact:submit' => '$server.sync()', + ]) ?> + + + + + + + + Form->end() ?> + +

+ + +

+
+ +
+ +
+

+

+ +
+ +
    + + +
  1. +
    +
    + + + # + +
    +
    +

    + Html->link($namespace, [ + '_name' => 'plugin:namespace', + 'namespace' => $namespace, + ], ['x-interact:navigate' => '']) ?> +

    +

    +
      + +
    • + Html->link($plugin['name'], [ + '_name' => 'plugin:view', + 'namespace' => $namespace, + 'name' => $plugin['name'], + ], [ + 'class' => 'publisher-plugin badge badge-sm badge-soft', + 'aria-label' => __('View {0} details', $plugin['package']), + 'x-interact:navigate' => '', + ]) ?> +
      • + +
    + +

    + + +

    + +
    +
    +
    + $label) : ?> +
    +
    +
    + Number->compact((int)$publisher[$key])) : '—' ?> +
    +
    + +
    +
    2. + +
+ +
+ 0) : ?> +
+

Paginator->counter(__('Showing {{start}}–{{end}} of {{count}} publishers')) ?>

+ +
+ +
+
diff --git a/tests/Fixture/PackagesFixture.php b/tests/Fixture/PackagesFixture.php index 8a09f5bd..42c28bce 100644 --- a/tests/Fixture/PackagesFixture.php +++ b/tests/Fixture/PackagesFixture.php @@ -66,6 +66,12 @@ public function init(): void foreach ($this->records as &$record) { $record['namespace'] = strtolower(explode('/', $record['package'], 2)[0]); + $record['monthly_downloads'] = match ($record['id']) { + 1 => 150, + 25 => 1200, + 26 => 2000, + default => 100 - $record['id'], + }; } unset($record); diff --git a/tests/Fixture/PublisherTaggedFixture.php b/tests/Fixture/PublisherTaggedFixture.php new file mode 100644 index 00000000..b6996da0 --- /dev/null +++ b/tests/Fixture/PublisherTaggedFixture.php @@ -0,0 +1,41 @@ +records = []; + for ($id = 1; $id <= 26; $id++) { + $this->records[] = [ + 'tag_id' => $id === 25 ? 3 : 1, + 'fk_id' => $id, + 'fk_model' => 'Packages', + 'created' => '2026-01-01 00:00:00', + 'modified' => '2026-01-01 00:00:00', + ]; + } + $this->records[] = [ + 'tag_id' => 2, + 'fk_id' => 1, + 'fk_model' => 'Packages', + 'created' => '2026-01-01 00:00:00', + 'modified' => '2026-01-01 00:00:00', + ]; + parent::init(); + } +} diff --git a/tests/Fixture/PublisherVersionsFixture.php b/tests/Fixture/PublisherVersionsFixture.php new file mode 100644 index 00000000..86fc3d91 --- /dev/null +++ b/tests/Fixture/PublisherVersionsFixture.php @@ -0,0 +1,34 @@ +records = []; + foreach ([1 => ['cakephp-5-4', 'CakePHP: 5.4'], 2 => ['cakephp-5-3', 'CakePHP: 5.3'], 3 => ['cakephp-4-4', 'CakePHP: 4.4']] as $id => [$slug, $label]) { + $this->records[] = [ + 'id' => $id, + 'slug' => $slug, + 'label' => $label, + 'created' => '2026-01-01 00:00:00', + 'modified' => '2026-01-01 00:00:00', + ]; + } + parent::init(); + } +} diff --git a/tests/TestCase/ApplicationServicesTest.php b/tests/TestCase/ApplicationServicesTest.php new file mode 100644 index 00000000..736ce063 --- /dev/null +++ b/tests/TestCase/ApplicationServicesTest.php @@ -0,0 +1,113 @@ +services($container); + $this->assertSame($this->fetchTable(PackagesTable::class), $container->get(PackagesTable::class)); + $this->assertInstanceOf(PackagistImporter::class, $container->get(PackagistImporter::class)); + $this->assertInstanceOf(AwesomeListImporter::class, $container->get(AwesomeListImporter::class)); + $this->assertInstanceOf(SyncPackagesCommand::class, $container->get(SyncPackagesCommand::class)); + $this->assertInstanceOf(AfterGithubIdentify::class, $container->get(AfterGithubIdentify::class)); + } + + /** + * Autowired services still receive explicit HTTP overrides and scalar configuration. + */ + public function testAutowiringRespectsConfiguredDependencies(): void + { + Configure::write('GitHub.apiToken', 'application-test-token'); + $container = new Container(); + new Application(dirname(__DIR__, 2) . '/config')->services($container); + $client = $this->createMock(Client::class); + $client->expects($this->once())->method('get')->with( + 'https://api.github.com/users/autowiring-example', + [], + $this->callback(static fn(array $options): bool => $options['headers']['Authorization'] === 'Bearer application-test-token'), + )->willReturn(new Response( + ['HTTP/1.1 200 OK', 'Content-Type: application/json'], + '{"login":"autowiring-example","bio":"Configured dependencies"}', + )); + $container->addShared(Client::class, $client, true); + $profile = $container->get(GithubProfileService::class)->profile('autowiring-example'); + $this->assertSame('Configured dependencies', $profile['bio']); + } + + /** + * Production reuses autowired services while development disables the cache. + */ + #[DataProvider('debugModes')] + public function testAutowiringCachesServicesInProduction(bool $debug): void + { + Configure::write('debug', $debug); + $container = new Container(); + new Application(dirname(__DIR__, 2) . '/config')->services($container); + $profile = $container->get(GithubProfileService::class); + $otherProfile = $container->get(GithubProfileService::class); + if ($debug) { + $this->assertNotSame($profile, $otherProfile); + } else { + $this->assertSame($profile, $otherProfile); + } + } + + /** + * Interact must never reuse mutable state between island constructions. + */ + #[DataProvider('debugModes')] + public function testIslandsRemainFresh(bool $debug): void + { + Configure::write('debug', $debug); + $container = new Container(); + new Application(dirname(__DIR__, 2) . '/config')->services($container); + $publishers = Services::fresh($container, PublishersIsland::class); + $publishers->search = 'vendor'; + $otherPublishers = Services::fresh($container, PublishersIsland::class); + $this->assertNotSame($publishers, $otherPublishers); + $this->assertSame('', $otherPublishers->search); + $profile = Services::fresh($container, NamespaceProfileIsland::class); + $profile->namespace = 'vendor'; + $otherProfile = Services::fresh($container, NamespaceProfileIsland::class); + $this->assertNotSame($profile, $otherProfile); + $this->assertSame('', $otherProfile->namespace); + } + + /** + * @return array + */ + public static function debugModes(): array + { + return [ + 'development' => [true], + 'production' => [false], + ]; + } +} diff --git a/tests/TestCase/ApplicationTest.php b/tests/TestCase/ApplicationTest.php index 89542fe4..72ec7cb9 100644 --- a/tests/TestCase/ApplicationTest.php +++ b/tests/TestCase/ApplicationTest.php @@ -130,6 +130,8 @@ public function testRateLimitProfiles(): void $requests = [ ['/', 'GET', [], 90], ['/', 'GET', ['search' => 'users'], 15], + ['/publishers', 'GET', [], 90], + ['/publishers', 'GET', ['sort' => 'stars'], 15], ['/plugins/markstory/asset_compress', 'GET', [], 90], ['/plugins/vendor.name/plugin_name.json', 'GET', [], 90], ['/plugins/dereuromark', 'GET', [], 90], diff --git a/tests/TestCase/Controller/PackagesControllerTest.php b/tests/TestCase/Controller/PackagesControllerTest.php index 450d9ad9..8783f7bd 100644 --- a/tests/TestCase/Controller/PackagesControllerTest.php +++ b/tests/TestCase/Controller/PackagesControllerTest.php @@ -9,6 +9,7 @@ use Cake\TestSuite\IntegrationTestTrait; use Cake\TestSuite\TestCase; use Override; +use PHPUnit\Framework\Attributes\DataProvider; /** * App\Controller\PackagesController Test Case @@ -224,6 +225,38 @@ public function testNamespaceCanonicalUrlAndMissingNamespace(): void $this->assertResponseCode(404); } + /** + * Return to local referring pages with their filters; direct visits keep a catalogue fallback. + */ + #[DataProvider('namespaceReferrers')] + public function testNamespaceBackLink(?string $referrer, string $expected): void + { + if ($referrer !== null) { + $this->configRequest([ + 'environment' => [ + 'HTTP_REFERER' => str_starts_with($referrer, '/') ? Router::url($referrer, true) : $referrer, + ], + ]); + } + $this->get('/plugins/vendor'); + $this->assertResponseOk(); + $this->assertResponseRegExp('/]+href="' . preg_quote(h($expected), '/') . '"[^>]*>← Back<\/a>/'); + } + + /** + * @return array + */ + public static function namespaceReferrers(): array + { + return [ + 'publisher overview' => ['/publishers?search=vendor&sort=stars&cakephp=all', '/publishers?search=vendor&sort=stars&cakephp=all'], + 'filtered catalogue' => ['/?search=tools&sort=downloads', '/?search=tools&sort=downloads'], + 'direct visit' => [null, '/'], + 'external visit' => ['https://example.com/publishers', '/'], + 'self reference' => ['/plugins/vendor?sort=downloads', '/'], + ]; + } + /** * A namespace spanning different GitHub owners must not advertise an inferred profile. */ diff --git a/tests/TestCase/Controller/PublishersControllerTest.php b/tests/TestCase/Controller/PublishersControllerTest.php new file mode 100644 index 00000000..38b86e63 --- /dev/null +++ b/tests/TestCase/Controller/PublishersControllerTest.php @@ -0,0 +1,90 @@ + + */ + #[Override] + protected array $fixtures = ['app.Packages', 'app.PublisherVersions', 'app.PublisherTagged']; + + /** + * Version options must reflect this test's compatibility fixtures. + */ + protected function setUp(): void + { + parent::setUp(); + Cache::delete('package_filter_tags_v1'); + } + + /** + * The first response includes rankings, avatar URLs, and canonical detail links. + */ + public function testPublicDirectory(): void + { + $github = $this->createMock(GithubApiService::class); + $github->expects($this->never())->method('get'); + $this->mockService(GithubApiService::class, static fn(): GithubApiService => $github); + $this->get('/publishers'); + $this->assertResponseOk(); + $this->assertResponseContains('data-publisher-namespace="vendor"'); + $this->assertResponseContains('href="/plugins/vendor"'); + $this->assertResponseContains('href="/plugins/vendor/package-01"'); + $this->assertResponseContains('https://github.com/vendor.png?size=96'); + $this->assertResponseContains('action="/publishers"'); + $this->assertResponseContains('data-publisher-rank'); + $this->assertResponseNotContains('data-publisher-namespace="cakedc"'); + $this->assertResponseContains('Monthly downloads'); + $this->assertResponseContains('Latest release'); + } + + /** + * Native GET search and invalid sorting remain usable without JavaScript. + */ + public function testSearchAndSortFallback(): void + { + $this->get('/publishers?search=MARK&sort=invalid'); + $this->assertResponseOk(); + $this->assertResponseContains('data-publisher-namespace="markstory"'); + $this->assertResponseContains('data-publisher-namespace="dereuromark"'); + $this->assertResponseNotContains('data-publisher-namespace="vendor"'); + $this->assertResponseNotContains('data-publisher-rank'); + $this->get('/publishers?search=no-such-publisher'); + $this->assertResponseOk(); + $this->assertResponseContains('No publishers found'); + } + + /** + * Older compatible publishers are discoverable through explicit version selection. + */ + public function testVersionSelectionAndMissingMonthlyData(): void + { + $this->get('/publishers?cakephp=4'); + $this->assertResponseOk(); + $this->assertResponseContains('data-publisher-namespace="cakedc"'); + $this->assertResponseNotContains('data-publisher-namespace="vendor"'); + $this->get('/publishers?cakephp=all'); + $this->assertResponseContains('data-publisher-namespace="cakedc"'); + $this->assertResponseContains('data-publisher-namespace="vendor"'); + $this->fetchTable(PackagesTable::class)->updateAll(['monthly_downloads' => null], ['id' => 1]); + $this->get('/publishers?search=markstory&cakephp=invalid'); + $this->assertResponseOk(); + $this->assertResponseContains('Counts and rankings include plugins compatible with CakePHP 5.'); + $this->assertResponseContains('Awaiting package sync'); + } +} diff --git a/tests/TestCase/Island/PublishersIslandTest.php b/tests/TestCase/Island/PublishersIslandTest.php new file mode 100644 index 00000000..66d7ffa3 --- /dev/null +++ b/tests/TestCase/Island/PublishersIslandTest.php @@ -0,0 +1,87 @@ + + */ + #[Override] + protected array $fixtures = ['app.Packages', 'app.PublisherVersions', 'app.PublisherTagged']; + + /** + * Version options must reflect this test's compatibility fixtures. + */ + protected function setUp(): void + { + parent::setUp(); + Cache::delete('package_filter_tags_v1'); + } + + /** + * Filtering and sorting do not trigger external profile lookups. + */ + public function testSearchSortAndClear(): void + { + $github = $this->createMock(GithubApiService::class); + $github->expects($this->never())->method('get'); + $this->mockService(GithubApiService::class, static fn(): GithubApiService => $github); + $this->testIsland('Publishers') + ->assertSee('data-publisher-rank') + ->assertDontSee('/plugins/cakedc') + ->set('cakephp', 'all') + ->set('sort', 'stars') + ->assertSet('sort', 'stars') + ->set('search', 'cakedc') + ->assertSee('/plugins/cakedc') + ->assertDontSee('/plugins/vendor') + ->assertDontSee('data-publisher-rank') + ->call('clearSearch') + ->assertSet('search', '') + ->assertSet('sort', 'stars') + ->assertSet('cakephp', 'all') + ->set('sort', 'invalid') + ->assertSet('sort', 'monthly_downloads'); + } + + /** + * Search changes return to page one and rank numbering spans pages. + */ + public function testPaginationAndFilterReset(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $record = $packages->get(1)->toArray(); + unset($record['id']); + $record['tag_list'] = ['CakePHP: 5.4']; + for ($i = 1; $i <= 21; $i++) { + $name = sprintf('publisher-%02d', $i); + $record['package'] = $name . '/plugin'; + $packages->saveOrFail($packages->newEntity($record)); + } + $this->testIsland('Publishers') + ->set('paging.page', 2) + ->assertSet('paging.page', 2) + ->assertSee('Rank 21') + ->set('cakephp', '4') + ->assertSet('paging.page', 1) + ->assertSee('/plugins/cakedc') + ->set('cakephp', 'current') + ->set('search', 'vendor') + ->assertSet('paging.page', 1) + ->assertDontSee('data-publisher-rank'); + } +} diff --git a/tests/TestCase/Model/Table/PackagesTableTest.php b/tests/TestCase/Model/Table/PackagesTableTest.php index 2bd1784c..da663e4f 100644 --- a/tests/TestCase/Model/Table/PackagesTableTest.php +++ b/tests/TestCase/Model/Table/PackagesTableTest.php @@ -4,6 +4,7 @@ namespace App\Test\TestCase\Model\Table; use App\Model\Table\PackagesTable; +use Cake\Cache\Cache; use Cake\TestSuite\TestCase; use Override; @@ -16,7 +17,16 @@ class PackagesTableTest extends TestCase * @var list */ #[Override] - protected array $fixtures = ['app.Packages', 'app.Categories', 'app.CategoriesPackages', 'plugin.Tags.Tags', 'plugin.Tags.Tagged']; + protected array $fixtures = ['app.Packages', 'app.Categories', 'app.CategoriesPackages', 'app.PublisherVersions', 'app.PublisherTagged']; + + /** + * Version options must reflect this test's compatibility fixtures. + */ + protected function setUp(): void + { + parent::setUp(); + Cache::delete('package_filter_tags_v1'); + } /** * Grid counts represent unique packages in each category across the directory. @@ -191,4 +201,108 @@ public function testNamespaceGithubProfile(): void } $this->assertNull($packages->namespaceGithubUrl('missing')); } + + /** + * Rankings use namespace totals, with stable alphabetical ties. + */ + public function testPublisherRankings(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $downloads = $packages->unhydratedFind('publishers')->all()->toList(); + $this->assertSame(['vendor', 'dereuromark', 'cakedc', 'markstory'], array_column($downloads, 'namespace')); + $this->assertEquals([ + 'namespace' => 'vendor', + 'plugins' => 23, + 'downloads' => 22701, + 'monthly_downloads' => 2001, + 'stars' => 2001, + 'latest_release' => '2025-02-24', + ], $downloads[0]); + $this->assertSame(['vendor', 'cakedc', 'markstory', 'dereuromark'], $packages->unhydratedFind('publishers', sort: 'stars')->all()->extract('namespace')->toList()); + $this->assertSame(['vendor', 'cakedc', 'dereuromark', 'markstory'], $packages->unhydratedFind('publishers', sort: 'plugins')->all()->extract('namespace')->toList()); + $this->assertEquals($downloads, $packages->unhydratedFind('publishers', sort: 'unknown')->all()->toList()); + $packages->updateAll(['downloads' => 5000], ['id' => 25]); + $this->assertSame(['vendor', 'dereuromark', 'cakedc', 'markstory'], $packages->unhydratedFind('publishers', sort: 'downloads')->all()->extract('namespace')->toList()); + } + + /** + * Search uses literal substrings rather than SQL wildcard semantics. + */ + public function testPublisherSearch(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $this->assertSame(['dereuromark'], $packages->unhydratedFind('publishers', search: ' REURO ')->all()->extract('namespace')->toList()); + $this->assertSame(0, $packages->unhydratedFind('publishers', search: '%')->count()); + $package = $packages->get(2); + $package->package = 'vendor_extra/package'; + $packages->saveOrFail($package); + $this->assertSame(['vendor_extra'], $packages->unhydratedFind('publishers', search: '_')->all()->extract('namespace')->toList()); + } + + /** + * Previews are bounded, metric-aware, and consider every repository owner. + */ + public function testPublisherDetails(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $details = $packages->publisherDetails(['vendor', 'markstory']); + $this->assertSame(['vendor/package-01', 'vendor/package-02'], array_column($details['vendor']['plugins'], 'package')); + $this->assertSame('https://github.com/vendor', $details['vendor']['githubUrl']); + $this->assertCount(1, $details['markstory']['plugins']); + $packages->updateAll(['stars' => 999, 'repo_url' => 'https://github.com/another-owner/plugin'], ['id' => 24]); + $this->assertNull($packages->publisherDetails(['vendor'])['vendor']['githubUrl']); + $this->assertSame(['vendor/package-23', 'vendor/package-01'], array_column($packages->publisherDetails(['vendor'], 'stars')['vendor']['plugins'], 'package')); + $this->assertSame(['vendor/package-01', 'vendor/package-02'], array_column($packages->publisherDetails(['vendor'], 'plugins')['vendor']['plugins'], 'package')); + $this->assertSame([], $packages->publisherDetails([])); + } + + /** + * Legacy-only packages cannot inflate current-major totals or previews. + */ + public function testPublisherCompatibilityScope(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $this->assertSame(['5', '4'], $packages->publisherMajors()); + $packages->updateAll([ + 'monthly_downloads' => 999999, + 'downloads' => 99999999, + 'stars' => 99999, + ], ['id' => 25]); + $this->assertSame('cakedc', $packages->unhydratedFind('publishers')->first()['namespace']); + $current = $packages->unhydratedFind('publishers', major: '5')->all()->toList(); + $this->assertSame(['vendor', 'dereuromark', 'markstory'], array_column($current, 'namespace')); + $this->assertEquals(1, $current[2]['plugins']); + $this->assertEquals(150, $current[2]['monthly_downloads']); + $this->assertSame('2025-01-15', $current[2]['latest_release']); + + $packages->Tagged->updateAll(['tag_id' => 3], ['fk_id' => 24, 'fk_model' => 'Packages']); + $packages->updateAll([ + 'monthly_downloads' => 999999, + 'repo_url' => 'https://github.com/another-owner/plugin', + ], ['id' => 24]); + $vendor = $packages->unhydratedFind('publishers', major: '5', search: 'vendor')->first(); + $this->assertEquals(22, $vendor['plugins']); + $this->assertEquals(1925, $vendor['monthly_downloads']); + $details = $packages->publisherDetails(['vendor'], major: '5'); + $this->assertSame(['package-01', 'package-02'], array_column($details['vendor']['plugins'], 'name')); + $this->assertNull($details['vendor']['githubUrl']); + $this->assertSame('cakedc', $packages->unhydratedFind('publishers', major: '4')->first()['namespace']); + } + + /** + * Recent usage can reverse lifetime rankings; missing data is never treated as zero. + */ + public function testMonthlyRankingsAndUnknownCounts(): void + { + $packages = $this->fetchTable(PackagesTable::class); + $packages->updateAll(['monthly_downloads' => 3000], ['id' => 1]); + $this->assertSame('markstory', $packages->unhydratedFind('publishers', major: '5')->first()['namespace']); + $this->assertSame('vendor', $packages->unhydratedFind('publishers', major: '5', sort: 'downloads')->first()['namespace']); + $packages->updateAll(['monthly_downloads' => null], ['id' => 2]); + $vendor = $packages->unhydratedFind('publishers', search: 'vendor')->first(); + $this->assertNull($vendor['monthly_downloads']); + $packages->updateAll(['monthly_downloads' => 0], ['id' => 1]); + $this->assertSame(['dereuromark', 'markstory', 'vendor'], $packages->unhydratedFind('publishers', major: '5')->all()->extract('namespace')->toList()); + $this->assertEquals(0, $packages->unhydratedFind('publishers', search: 'markstory')->first()['monthly_downloads']); + } } diff --git a/tests/TestCase/Service/GithubProfileServiceTest.php b/tests/TestCase/Service/GithubProfileServiceTest.php index 4f11afa5..4623714f 100644 --- a/tests/TestCase/Service/GithubProfileServiceTest.php +++ b/tests/TestCase/Service/GithubProfileServiceTest.php @@ -123,6 +123,18 @@ public function testInvalidOwnerDoesNotFetch(): void $this->assertNull(new GithubProfileService($client)->profile('../users')); } + /** + * Directory avatars do not consume API quota. + */ + public function testAvatarUrlDoesNotFetchMetadata(): void + { + $github = $this->createMock(GithubApiService::class); + $github->expects($this->never())->method('get'); + $service = new GithubProfileService($github); + $this->assertSame('https://github.com/example.png?size=96', $service->avatarUrl('Example', 96)); + $this->assertNull($service->avatarUrl('invalid_owner')); + } + /** * Existing cached failures must not hide otherwise accessible public avatars. */ diff --git a/tests/TestCase/Service/PackagistImporterTest.php b/tests/TestCase/Service/PackagistImporterTest.php index c55088a4..34cf1cc2 100644 --- a/tests/TestCase/Service/PackagistImporterTest.php +++ b/tests/TestCase/Service/PackagistImporterTest.php @@ -43,7 +43,10 @@ public function testSyncUpdatesMetadataAndPreservesCategories(): void $version = new Version(); $version->fromArray(['version' => '5.1.0', 'time' => '2026-04-05T11:22:33+00:00', 'require' => ['php' => '^8.2', 'cakephp/cakephp' => '^5.0']]); $downloads = new Downloads(); - $downloads->fromArray(['total' => 12345]); + $downloads->fromArray([ + 'total' => 12345, + 'monthly' => 1234, + ]); $metadata = new Package(); $metadata->fromArray([ 'description' => 'Updated plugin description', 'repository' => 'https://github.com/markstory/asset_compress', @@ -62,6 +65,7 @@ public function testSyncUpdatesMetadataAndPreservesCategories(): void $this->assertCount(2, $package->categories); $this->assertSame('Updated plugin description', $package->description); $this->assertSame('markstory', $package->namespace); + $this->assertSame(1234, $package->monthly_downloads); $this->assertSame('5.1.0', $package->latest_stable_version); $this->assertEquals(new Date('2026-04-05'), $package->latest_stable_release_date); $this->assertContains('cakephp-5-4', array_column($package->tags, 'slug')); diff --git a/tests/browser/publishers-state.php b/tests/browser/publishers-state.php new file mode 100644 index 00000000..c3af03b5 --- /dev/null +++ b/tests/browser/publishers-state.php @@ -0,0 +1,34 @@ +setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); +$connection->exec("DELETE FROM tags_tagged WHERE fk_model = 'Packages' AND fk_id BETWEEN 1001 AND 1021"); +$connection->exec('DELETE FROM packages WHERE id BETWEEN 1001 AND 1021'); +if (($argv[1] ?? '') !== 'seed') { + exit; +} +$record = $connection->query('SELECT * FROM packages WHERE id = 1')->fetch(PDO::FETCH_ASSOC); +if (!$record) { + throw new RuntimeException('Browser package fixture is missing.'); +} +$columns = implode(', ', array_keys($record)); +$parameters = implode(', ', array_fill(0, count($record), '?')); +$insert = $connection->prepare("INSERT INTO packages ($columns) VALUES ($parameters)"); +for ($i = 1; $i <= 21; $i++) { + $record['id'] = 1000 + $i; + $record['namespace'] = sprintf('publisher-%02d', $i); + $record['package'] = $record['namespace'] . '/plugin'; + $record['repo_url'] = 'https://gitlab.com/example/plugin'; + $record['downloads'] = 10; + $record['monthly_downloads'] = 10; + $record['stars'] = 0; + $insert->execute(array_values($record)); + $connection->prepare("INSERT INTO tags_tagged (tag_id, fk_id, fk_model, created, modified) VALUES (1, ?, 'Packages', '2026-01-01', '2026-01-01')")->execute([$record['id']]); +} diff --git a/tests/browser/publishers.spec.js b/tests/browser/publishers.spec.js new file mode 100644 index 00000000..c46d9f76 --- /dev/null +++ b/tests/browser/publishers.spec.js @@ -0,0 +1,215 @@ +import { test, expect } from '@playwright/test' +import { execFileSync } from 'node:child_process' + +const rows = page => page.locator('[data-publisher-namespace]') +const names = page => rows(page).evaluateAll(elements => elements.map(element => element.dataset.publisherNamespace)) +const search = page => page.getByRole('searchbox', { name: 'Search publishers', exact: true }) +const sort = page => page.getByRole('combobox', { name: 'Rank publishers by', exact: true }) +const version = page => page.getByRole('combobox', { name: 'CakePHP version', exact: true }) +const errors = new WeakMap() + +test.beforeEach(async ({ page }) => { + const messages = [] + page.on('pageerror', error => messages.push(error.message)) + errors.set(page, messages) + await page.route('https://github.com/*.png*', route => route.fulfill({ + contentType: 'image/png', + path: 'webroot/img/packagist-logo.png', + })) + await page.route('https://avatars.githubusercontent.com/**', route => route.fulfill({ + contentType: 'image/png', + path: 'webroot/img/packagist-logo.png', + })) +}) + +test.afterEach(async ({ page }) => { + expect(errors.get(page)).toEqual([]) +}) + +test('directory ranks publishers with totals and two popular plugins', async ({ page }) => { + let islandUpdates = 0 + page.on('request', request => { + if (request.url().endsWith('/_interact/update')) islandUpdates++ + }) + await page.goto('/publishers') + await expect(page.getByRole('heading', { level: 1 })).toHaveText('Publishers') + await expect.poll(() => names(page)).toEqual(['vendor', 'dereuromark', 'markstory']) + await expect(page.locator('.desktop-nav').getByRole('link', { name: 'Publishers', exact: true })).toHaveAttribute('aria-current', 'page') + const vendor = rows(page).first() + await expect(vendor.locator('[data-publisher-rank]')).toHaveText('#1') + await expect(vendor.locator('[data-publisher-stat="plugins"]')).toHaveText('23') + await expect(vendor.locator('[data-publisher-stat="monthly_downloads"]')).toHaveText('2k') + await expect(vendor.locator('[data-publisher-stat="monthly_downloads"]')).toHaveAttribute('aria-label', '2,001') + await expect(vendor.locator('[data-publisher-stat="stars"]')).toHaveText('2k') + await expect(vendor.getByRole('list', { name: 'Popular plugins by vendor' }).getByRole('link')).toHaveText(['package-01', 'package-02']) + await expect(vendor.locator('[data-publisher-avatar]')).toHaveJSProperty('naturalWidth', 100) + expect(islandUpdates).toBe(0) + await page.screenshot({ path: 'tmp/publishers-desktop.png', fullPage: true }) +}) + +test('live search and sorting preserve URL state and browser history', async ({ page }) => { + await page.goto('/publishers') + await page.evaluate(() => { window.publisherMarker = 'retained' }) + await sort(page).selectOption('stars') + await expect(page).toHaveURL('/publishers?sort=stars') + await expect.poll(() => names(page)).toEqual(['vendor', 'markstory', 'dereuromark']) + await version(page).selectOption('all') + await expect(page).toHaveURL('/publishers?sort=stars&cakephp=all') + await expect.poll(() => names(page)).toEqual(['vendor', 'cakedc', 'markstory', 'dereuromark']) + await search(page).fill('MARK') + await expect(rows(page)).toHaveCount(2) + await expect.poll(() => names(page)).toEqual(['markstory', 'dereuromark']) + await expect(page).toHaveURL(/search=MARK/) + await expect(page.locator('[data-publisher-rank]')).toHaveCount(0) + await page.getByRole('link', { name: 'Clear search', exact: true }).click() + await expect(page).toHaveURL('/publishers?sort=stars&cakephp=all') + await expect(rows(page)).toHaveCount(4) + await sort(page).selectOption('plugins') + await expect(page).toHaveURL('/publishers?sort=plugins&cakephp=all') + await expect.poll(() => names(page)).toEqual(['vendor', 'cakedc', 'dereuromark', 'markstory']) + await page.goBack() + await expect(page).toHaveURL('/publishers?sort=stars&cakephp=all') + await expect.poll(() => names(page)).toEqual(['vendor', 'cakedc', 'markstory', 'dereuromark']) + expect(await page.evaluate(() => window.publisherMarker)).toBe('retained') + await page.reload() + await expect(sort(page)).toHaveValue('stars') + await search(page).fill('no-match') + await expect(page.getByRole('heading', { name: 'No publishers found' })).toBeVisible() +}) + +test('directory navigation and publisher and plugin links use Interact', async ({ page }) => { + await page.goto('/') + await page.evaluate(() => { window.publisherMarker = 'retained' }) + await page.locator('.desktop-nav').getByRole('link', { name: 'Publishers', exact: true }).click() + await expect(page).toHaveURL('/publishers') + await rows(page).first().getByRole('link', { name: 'vendor', exact: true }).click() + await expect(page).toHaveURL('/plugins/vendor') + await expect(page.getByRole('heading', { level: 1 })).toHaveText('vendor') + await page.getByRole('link', { name: '← Back', exact: true }).click() + await expect(page).toHaveURL('/publishers') + await rows(page).first().getByRole('link', { name: 'View vendor/package-01 details', exact: true }).click() + await expect(page).toHaveURL('/plugins/vendor/package-01') + await expect(page.getByRole('heading', { level: 1 })).toHaveText('vendor/package-01') + expect(await page.evaluate(() => window.publisherMarker)).toBe('retained') +}) + +test('publisher back link retains overview filters after searching within a profile', async ({ page }) => { + await page.goto('/publishers?search=vendor&sort=stars&cakephp=all') + await rows(page).first().getByRole('link', { name: 'vendor', exact: true }).click() + await expect(page).toHaveURL('/plugins/vendor') + await page.getByRole('searchbox', { name: 'Search plugins', exact: true }).fill('package-01') + await expect(page.locator('[data-package-row]')).toHaveCount(1) + await page.getByRole('link', { name: '← Back', exact: true }).click() + await expect(page).toHaveURL('/publishers?search=vendor&sort=stars&cakephp=all') + await expect(search(page)).toHaveValue('vendor') + await expect(sort(page)).toHaveValue('stars') + await expect(version(page)).toHaveValue('all') + await expect(rows(page)).toHaveCount(1) +}) + +test('version selection scopes totals, previews and latest release without hiding older publishers', async ({ page }) => { + await page.goto('/publishers') + await expect(version(page)).toHaveValue('current') + await expect(sort(page)).toHaveValue('monthly_downloads') + await expect(page.locator('[data-publisher-scope]')).toContainText('CakePHP 5') + await version(page).selectOption('4') + await expect(rows(page)).toHaveCount(1) + await expect(rows(page).first()).toHaveAttribute('data-publisher-namespace', 'cakedc') + await expect(rows(page).first().locator('[data-publisher-stat="monthly_downloads"]')).toHaveText('1.2k') + await expect(rows(page).first().locator('time')).toHaveAttribute('datetime', '2025-03-01') + await expect(page.locator('[data-publisher-scope]')).toContainText('CakePHP 4') + await sort(page).selectOption('downloads') + await expect(rows(page).first().locator('[data-publisher-stat="downloads"]')).toHaveText('9k') + await search(page).fill('cake') + await expect(page.locator('[data-publisher-rank]')).toHaveCount(0) + await page.getByRole('link', { name: 'Clear search', exact: true }).click() + await expect(search(page)).toHaveValue('') + await expect(page).not.toHaveURL(/search=/) + await expect(version(page)).toHaveValue('4') + await expect(sort(page)).toHaveValue('downloads') + await page.reload() + await expect(rows(page)).toHaveCount(1) + await version(page).selectOption('all') + await expect(rows(page)).toHaveCount(4) + await page.goBack() + await expect(rows(page)).toHaveCount(1) + await expect(version(page)).toHaveValue('4') +}) + +test('pagination maintains ranks and sorting or searching resets to page one', async ({ page }) => { + execFileSync('php', ['tests/browser/publishers-state.php', 'seed']) + try { + await page.goto('/publishers') + await expect(rows(page)).toHaveCount(20) + await page.getByRole('link', { name: 'Next', exact: true }).click() + await expect(page).toHaveURL('/publishers?page=2') + await expect(rows(page)).toHaveCount(4) + await expect(rows(page).first().locator('[data-publisher-rank]')).toHaveText('#21') + await page.goBack() + await expect(rows(page)).toHaveCount(20) + await page.goForward() + await expect(rows(page)).toHaveCount(4) + await page.reload() + await expect(rows(page)).toHaveCount(4) + await sort(page).selectOption('stars') + await expect(page).toHaveURL('/publishers?sort=stars') + await expect(rows(page)).toHaveCount(20) + await page.getByRole('link', { name: 'Next', exact: true }).click() + await expect(rows(page)).toHaveCount(4) + await version(page).selectOption('4') + await expect(rows(page)).toHaveCount(1) + await expect(rows(page).first()).toHaveAttribute('data-publisher-namespace', 'cakedc') + await expect(page).not.toHaveURL(/page=2/) + await version(page).selectOption('current') + await search(page).fill('vendor') + await expect(rows(page)).toHaveCount(1) + await expect(page).not.toHaveURL(/page=2/) + await expect(page.locator('[data-publisher-rank]')).toHaveCount(0) + } finally { + execFileSync('php', ['tests/browser/publishers-state.php', 'clear']) + } +}) + +test('native GET search, sorting and links work without JavaScript', async ({ browser }) => { + const context = await browser.newContext({ javaScriptEnabled: false }) + const page = await context.newPage() + try { + await page.goto('/publishers') + await sort(page).selectOption('stars') + await search(page).fill('MARK') + await page.getByRole('button', { name: 'Apply', exact: true }).click() + await expect(rows(page)).toHaveCount(2) + await expect.poll(() => names(page)).toEqual(['markstory', 'dereuromark']) + await page.getByRole('link', { name: 'markstory', exact: true }).click() + await expect(page).toHaveURL('/plugins/markstory') + await page.getByRole('link', { name: '← Back', exact: true }).click() + await expect(rows(page)).toHaveCount(2) + await expect(search(page)).toHaveValue('MARK') + await expect(sort(page)).toHaveValue('stars') + await page.goto('/publishers?cakephp=all') + await page.getByRole('link', { name: 'View cakedc/users details', exact: true }).click() + await expect(page).toHaveURL('/plugins/cakedc/users') + } finally { + await context.close() + } +}) + +test('directory fits mobile screens in both themes and handles missing avatars', async ({ page, context }) => { + await page.route('https://github.com/*.png*', route => route.abort()) + for (const width of [390, 320]) { + await page.setViewportSize({ width, height: 844 }) + for (const theme of ['cakephp', 'cakephp-dark']) { + await context.addCookies([{ name: 'theme', value: theme, domain: '127.0.0.1', path: '/' }]) + await page.goto('/publishers') + await expect(rows(page)).toHaveCount(3) + await expect(rows(page).first().locator('[data-publisher-avatar]')).toBeHidden() + await expect(rows(page).first().locator('.publisher-avatar')).toHaveText('VE') + expect(await page.evaluate(() => document.documentElement.scrollWidth <= innerWidth)).toBe(true) + expect(await rows(page).evaluateAll(elements => elements.every(element => element.scrollWidth <= element.clientWidth))).toBe(true) + await page.locator('.mobile-menu summary').click() + await expect(page.getByRole('navigation', { name: 'Mobile navigation' }).getByRole('link', { name: 'Publishers', exact: true })).toHaveAttribute('aria-current', 'page') + await page.locator('.mobile-menu summary').click() + await page.screenshot({ path: `tmp/publishers-mobile-${theme}-${width}.png`, fullPage: true }) + } + } +})