feat(KAN-19): add responsive permission-aware navigation
This commit is contained in:
@@ -0,0 +1,107 @@
|
||||
<?php
|
||||
|
||||
namespace Tests\Feature;
|
||||
|
||||
use App\Models\Project;
|
||||
use App\Models\Team;
|
||||
use App\Models\User;
|
||||
use Illuminate\Foundation\Testing\RefreshDatabase;
|
||||
use Inertia\Testing\AssertableInertia as Assert;
|
||||
use PHPUnit\Framework\Attributes\DataProvider;
|
||||
use Symfony\Component\Process\Process;
|
||||
use Tests\TestCase;
|
||||
|
||||
class NavigationTest extends TestCase
|
||||
{
|
||||
use RefreshDatabase;
|
||||
|
||||
#[DataProvider('projectRoles')]
|
||||
public function test_navigation_uses_effective_project_permissions(string $role, bool $teamAccess, bool $canManage, bool $canCreateTickets): void
|
||||
{
|
||||
$user = User::factory()->create();
|
||||
$project = Project::factory()->create();
|
||||
$assignee = $user;
|
||||
if ($teamAccess) {
|
||||
$assignee = Team::factory()->create();
|
||||
$assignee->users()->attach($user);
|
||||
}
|
||||
$this->syncProjectPermissions($project, $assignee, [$role]);
|
||||
|
||||
$this->actingAs($user)->get(route('projects.board.index', $project))
|
||||
->assertOk()->assertInertia(fn (Assert $page) => $page
|
||||
->where('navigation.project', [
|
||||
'id' => $project->id,
|
||||
'name' => $project->name,
|
||||
'key' => $project->key,
|
||||
'canManage' => $canManage,
|
||||
'canCreateTickets' => $canCreateTickets,
|
||||
]));
|
||||
}
|
||||
|
||||
/** @return array<string, array{string, bool, bool, bool}> */
|
||||
public static function projectRoles(): array
|
||||
{
|
||||
return [
|
||||
'reader' => ['read', false, false, false],
|
||||
'writer' => ['write', false, false, true],
|
||||
'project admin' => ['admin', false, true, true],
|
||||
'team reader' => ['read', true, false, false],
|
||||
'team writer' => ['write', true, false, true],
|
||||
'team admin' => ['admin', true, true, true],
|
||||
];
|
||||
}
|
||||
|
||||
public function test_global_admin_has_project_actions_without_direct_membership(): void
|
||||
{
|
||||
$user = User::factory()->admin()->create();
|
||||
$project = Project::factory()->create();
|
||||
$this->actingAs($user)->get(route('projects.show', $project))
|
||||
->assertOk()->assertInertia(fn (Assert $page) => $page
|
||||
->where('navigation.project.canManage', true)
|
||||
->where('navigation.project.canCreateTickets', true)
|
||||
->where('auth.permissions.globalAdmin', true));
|
||||
}
|
||||
|
||||
public function test_every_project_admin_navigation_destination_is_authorized(): void
|
||||
{
|
||||
$user = User::factory()->create();
|
||||
$project = Project::factory()->create();
|
||||
$this->syncProjectPermissions($project, $user, ['admin']);
|
||||
foreach (['projects.show', 'projects.board.index', 'projects.backlog.index', 'projects.settings.general', 'projects.settings.board', 'projects.settings.metadata', 'projects.settings.repositories', 'projects.settings.notifications', 'projects.access'] as $route) {
|
||||
$this->actingAs($user)->get(route($route, $project))
|
||||
->assertOk()->assertInertia(fn (Assert $page) => $page
|
||||
->where('navigation.project.id', $project->id)
|
||||
->where('navigation.project.canManage', true)
|
||||
->where('auth.permissions.globalAdmin', false));
|
||||
}
|
||||
}
|
||||
|
||||
public function test_project_context_is_cleared_when_leaving_a_project(): void
|
||||
{
|
||||
$user = User::factory()->admin()->create();
|
||||
$project = Project::factory()->create();
|
||||
$this->actingAs($user)->get(route('projects.show', $project))
|
||||
->assertInertia(fn (Assert $page) => $page->where('navigation.project.id', $project->id));
|
||||
$this->get(route('dashboard'))->assertOk()
|
||||
->assertInertia(fn (Assert $page) => $page->where('navigation.project', null));
|
||||
$this->get(route('projects.create'))->assertOk()
|
||||
->assertInertia(fn (Assert $page) => $page->where('navigation.project', null));
|
||||
}
|
||||
|
||||
public function test_unrelated_projects_remain_inaccessible(): void
|
||||
{
|
||||
$user = User::factory()->create();
|
||||
$project = Project::factory()->create(['name' => 'Private project']);
|
||||
$this->actingAs($user)->get(route('projects.show', $project))
|
||||
->assertForbidden()->assertDontSee('Private project');
|
||||
}
|
||||
|
||||
public function test_navigation_rendering_and_url_matching(): void
|
||||
{
|
||||
$process = new Process(['node', 'tests/Fixtures/navigation.mjs'], base_path());
|
||||
$process->setTimeout(60);
|
||||
$process->run();
|
||||
$this->assertTrue($process->isSuccessful(), $process->getOutput().$process->getErrorOutput());
|
||||
$this->assertStringContainsString('Navigation behavior checks passed.', $process->getOutput());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
import { createApp, h } from 'vue';
|
||||
import { createInertiaApp, Head, usePage } from '@inertiajs/vue3';
|
||||
import '../../resources/css/app.css';
|
||||
import AppLayout from '../../resources/js/layouts/AppLayout.vue';
|
||||
import { createAppearance } from '../../resources/js/composables/useAppearance';
|
||||
import { createLocalization } from '../../resources/js/lib/localization';
|
||||
|
||||
const Preview = {
|
||||
setup() {
|
||||
const page = usePage();
|
||||
return () => {
|
||||
const title = page.url
|
||||
.split('?')[0]
|
||||
.split('/')
|
||||
.filter(Boolean)
|
||||
.at(-1);
|
||||
return h(
|
||||
AppLayout,
|
||||
{
|
||||
breadcrumbs: [
|
||||
{ title: 'Projects', href: '/projects' },
|
||||
...(page.props.navigation.project
|
||||
? [
|
||||
{
|
||||
title: page.props.navigation.project.name,
|
||||
href: '/projects/7',
|
||||
},
|
||||
]
|
||||
: []),
|
||||
{ title, href: page.url },
|
||||
],
|
||||
},
|
||||
() => [
|
||||
h(Head, { title }),
|
||||
h('div', { class: 'grid gap-column p-page' }, [
|
||||
h(
|
||||
'h1',
|
||||
{
|
||||
class: 'text-headline',
|
||||
'data-test': 'page-title',
|
||||
},
|
||||
title,
|
||||
),
|
||||
h(
|
||||
'p',
|
||||
{ class: 'text-muted-foreground' },
|
||||
'Navigation preview with isolated test data.',
|
||||
),
|
||||
h(
|
||||
'div',
|
||||
{
|
||||
class: 'grid gap-column sm:grid-cols-2 xl:grid-cols-3',
|
||||
},
|
||||
['To do', 'In progress', 'Done'].map((label) =>
|
||||
h(
|
||||
'section',
|
||||
{
|
||||
class: 'grid gap-stack rounded-md border bg-card p-card',
|
||||
},
|
||||
[
|
||||
h('h2', { class: 'text-title' }, label),
|
||||
h(
|
||||
'p',
|
||||
{},
|
||||
'Plan and track the next iteration.',
|
||||
),
|
||||
],
|
||||
),
|
||||
),
|
||||
),
|
||||
]),
|
||||
],
|
||||
);
|
||||
};
|
||||
},
|
||||
};
|
||||
|
||||
createInertiaApp({
|
||||
resolve: () => Preview,
|
||||
setup: ({ el, App, props, plugin }) =>
|
||||
createApp({ render: () => h(App, props) })
|
||||
.use(plugin)
|
||||
.use(createLocalization())
|
||||
.use(createAppearance())
|
||||
.mount(el),
|
||||
});
|
||||
@@ -0,0 +1,88 @@
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import vue from '@vitejs/plugin-vue';
|
||||
import tailwind from '@tailwindcss/vite';
|
||||
import { createServer } from 'vite';
|
||||
|
||||
const server = await createServer({
|
||||
configFile: false,
|
||||
plugins: [vue(), tailwind()],
|
||||
resolve: {
|
||||
alias: {
|
||||
'@': fileURLToPath(new URL('../../resources/js', import.meta.url)),
|
||||
},
|
||||
},
|
||||
server: { host: '127.0.0.1', port: 4175, strictPort: true, hmr: false },
|
||||
appType: 'custom',
|
||||
});
|
||||
|
||||
server.middlewares.use(async (request, response, next) => {
|
||||
const url = new URL(request.url, 'http://localhost');
|
||||
if (
|
||||
!/^\/(dashboard|projects|project-templates|teams|admin|settings)(\/|$)/.test(
|
||||
url.pathname,
|
||||
)
|
||||
) {
|
||||
return next();
|
||||
}
|
||||
const reader =
|
||||
request.headers.cookie?.includes('navigation_test_role=reader') ??
|
||||
false;
|
||||
const project = url.pathname.startsWith('/projects/7')
|
||||
? {
|
||||
id: 7,
|
||||
name: 'Engineering · Platform and developer experience',
|
||||
key: 'ENG',
|
||||
canManage: !reader,
|
||||
canCreateTickets: !reader,
|
||||
}
|
||||
: null;
|
||||
const page = {
|
||||
component: 'NavigationPreview',
|
||||
url: request.url,
|
||||
version: null,
|
||||
clearHistory: false,
|
||||
encryptHistory: false,
|
||||
props: {
|
||||
name: 'KanbanGit',
|
||||
sidebarOpen: !request.headers.cookie?.includes(
|
||||
'sidebar_state=false',
|
||||
),
|
||||
auth: {
|
||||
permissions: {
|
||||
globalAdmin: !reader,
|
||||
projectCreate: !reader,
|
||||
canManageTeams: !reader,
|
||||
},
|
||||
user: {
|
||||
id: 1,
|
||||
name: 'Alex Morgan',
|
||||
email: 'alex@example.test',
|
||||
avatar: null,
|
||||
},
|
||||
},
|
||||
navigation: { project },
|
||||
},
|
||||
};
|
||||
response.setHeader('Vary', 'X-Inertia');
|
||||
if (request.headers['x-inertia']) {
|
||||
response.setHeader('X-Inertia', 'true');
|
||||
response.setHeader('Content-Type', 'application/json');
|
||||
response.end(JSON.stringify(page));
|
||||
return;
|
||||
}
|
||||
const escapedPage = JSON.stringify(page)
|
||||
.replaceAll('&', '&')
|
||||
.replaceAll('"', '"')
|
||||
.replaceAll('<', '<');
|
||||
const html =
|
||||
'<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"></head><body><div id="app" data-page="' +
|
||||
escapedPage +
|
||||
'"></div><script type="module" src="/tests/Fixtures/navigation-preview.mjs"></script></body></html>';
|
||||
response.setHeader('Content-Type', 'text/html');
|
||||
response.end(await server.transformIndexHtml(request.url, html));
|
||||
});
|
||||
|
||||
await server.listen();
|
||||
console.log(
|
||||
'Navigation fixture ready at http://127.0.0.1:4175/projects/7/board',
|
||||
);
|
||||
@@ -0,0 +1,230 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import vue from '@vitejs/plugin-vue';
|
||||
import { createServer } from 'vite';
|
||||
import { createSSRApp, h } from 'vue';
|
||||
import { renderToString } from 'vue/server-renderer';
|
||||
import { createInertiaApp } from '@inertiajs/vue3';
|
||||
|
||||
const server = await createServer({
|
||||
configFile: false,
|
||||
plugins: [vue()],
|
||||
resolve: {
|
||||
alias: {
|
||||
'@': fileURLToPath(new URL('../../resources/js', import.meta.url)),
|
||||
},
|
||||
},
|
||||
server: { middlewareMode: true, hmr: false, watch: null },
|
||||
appType: 'custom',
|
||||
});
|
||||
|
||||
try {
|
||||
const {
|
||||
matchesNavigationUrl,
|
||||
projectNavigation,
|
||||
projectSettingsNavigation,
|
||||
workspaceNavigation,
|
||||
} = await server.ssrLoadModule('/resources/js/lib/navigation.ts');
|
||||
const { createLocalization } = await server.ssrLoadModule(
|
||||
'/resources/js/lib/localization.ts',
|
||||
);
|
||||
const { createAppearance } = await server.ssrLoadModule(
|
||||
'/resources/js/composables/useAppearance.ts',
|
||||
);
|
||||
const { en } = await server.ssrLoadModule('/resources/js/locales/en.ts');
|
||||
const { default: AppLayout } = await server.ssrLoadModule(
|
||||
'/resources/js/layouts/AppLayout.vue',
|
||||
);
|
||||
const locale = createLocalization();
|
||||
const permissions = {
|
||||
globalAdmin: false,
|
||||
projectCreate: false,
|
||||
canManageTeams: false,
|
||||
};
|
||||
const project = {
|
||||
id: 7,
|
||||
name: 'Engineering',
|
||||
key: 'ENG',
|
||||
canManage: false,
|
||||
canCreateTickets: false,
|
||||
};
|
||||
const targets = (items) => items.map((item) => item.href.url);
|
||||
assert.deepEqual(targets(workspaceNavigation(permissions, locale.t)), [
|
||||
'/dashboard',
|
||||
'/projects',
|
||||
]);
|
||||
assert.deepEqual(
|
||||
targets(
|
||||
workspaceNavigation(
|
||||
{ ...permissions, canManageTeams: true },
|
||||
locale.t,
|
||||
),
|
||||
),
|
||||
['/dashboard', '/projects', '/teams'],
|
||||
);
|
||||
assert.deepEqual(
|
||||
targets(
|
||||
workspaceNavigation(
|
||||
{ ...permissions, projectCreate: true },
|
||||
locale.t,
|
||||
),
|
||||
),
|
||||
['/dashboard', '/projects', '/project-templates'],
|
||||
);
|
||||
assert.ok(
|
||||
targets(
|
||||
workspaceNavigation(
|
||||
{ ...permissions, globalAdmin: true },
|
||||
locale.t,
|
||||
),
|
||||
).includes('/admin/users'),
|
||||
);
|
||||
assert.equal(projectNavigation(null, locale.t).length, 0);
|
||||
assert.deepEqual(targets(projectNavigation(project, locale.t)), [
|
||||
'/projects/7',
|
||||
'/projects/7/board',
|
||||
'/projects/7/backlog',
|
||||
]);
|
||||
assert.equal(projectSettingsNavigation(project, locale.t).length, 0);
|
||||
assert.deepEqual(
|
||||
targets(
|
||||
projectSettingsNavigation(
|
||||
{ ...project, canManage: true },
|
||||
locale.t,
|
||||
),
|
||||
),
|
||||
[
|
||||
'/projects/7/settings/general',
|
||||
'/projects/7/settings/board',
|
||||
'/projects/7/settings/metadata',
|
||||
'/projects/7/settings/repositories',
|
||||
'/projects/7/settings/notifications',
|
||||
'/projects/7/access',
|
||||
],
|
||||
);
|
||||
for (const [target, current, section, expected] of [
|
||||
['/projects', '/projects/7/board', true, true],
|
||||
['/projects', '/project-templates', true, false],
|
||||
['/projects/7', '/projects/70', true, false],
|
||||
['/projects/7', '/projects/7/board', false, false],
|
||||
[
|
||||
'/projects/7/board',
|
||||
'/projects/7/board?filter=mine#lane',
|
||||
false,
|
||||
true,
|
||||
],
|
||||
[
|
||||
'/projects/7/board/',
|
||||
'https://kanbangit.test/projects/7/board',
|
||||
false,
|
||||
true,
|
||||
],
|
||||
['/', '/projects', true, false],
|
||||
]) {
|
||||
assert.equal(matchesNavigationUrl(target, current, section), expected);
|
||||
}
|
||||
const render = async (
|
||||
url,
|
||||
projectContext,
|
||||
authPermissions = permissions,
|
||||
localization = locale,
|
||||
) => {
|
||||
const response = await createInertiaApp({
|
||||
page: {
|
||||
component: 'Preview',
|
||||
url,
|
||||
version: null,
|
||||
clearHistory: false,
|
||||
encryptHistory: false,
|
||||
props: {
|
||||
name: 'KanbanGit',
|
||||
sidebarOpen: true,
|
||||
appearance: 'light',
|
||||
auth: {
|
||||
permissions: authPermissions,
|
||||
user: {
|
||||
id: 1,
|
||||
name: 'Test User',
|
||||
email: 'test@example.test',
|
||||
avatar: null,
|
||||
},
|
||||
},
|
||||
navigation: { project: projectContext },
|
||||
},
|
||||
},
|
||||
resolve: () => ({
|
||||
render: () =>
|
||||
h(
|
||||
AppLayout,
|
||||
{
|
||||
breadcrumbs: [
|
||||
{ title: 'Board', href: '/projects/7/board' },
|
||||
],
|
||||
},
|
||||
() => h('h1', {}, 'Content'),
|
||||
),
|
||||
}),
|
||||
render: renderToString,
|
||||
setup: ({ App, props, plugin }) =>
|
||||
createSSRApp({ render: () => h(App, props) })
|
||||
.use(plugin)
|
||||
.use(localization)
|
||||
.use(createAppearance('light')),
|
||||
});
|
||||
return response.body;
|
||||
};
|
||||
const reader = await render('/projects/7/board?filter=mine', project);
|
||||
assert.match(
|
||||
reader,
|
||||
/<a(?=[^>]*href="\/projects\/7\/board")(?=[^>]*aria-current="page")[^>]*>/,
|
||||
);
|
||||
assert.doesNotMatch(reader, /href="\/projects\/7\/settings/);
|
||||
assert.doesNotMatch(reader, /href="\/admin\/users"/);
|
||||
assert.doesNotMatch(reader, /href="\/projects\/7\/tickets\/create/);
|
||||
assert.doesNotMatch(reader, /Laravel Starter Kit|vue-starter-kit/);
|
||||
assert.match(reader, /aria-controls="app-navigation"/);
|
||||
const writer = await render('/projects/7/backlog', {
|
||||
...project,
|
||||
canCreateTickets: true,
|
||||
});
|
||||
assert.match(
|
||||
writer,
|
||||
/href="\/projects\/7\/tickets\/create\?source=backlog"/,
|
||||
);
|
||||
assert.doesNotMatch(writer, /href="\/projects\/7\/settings/);
|
||||
const admin = await render('/projects/7/settings/general', {
|
||||
...project,
|
||||
canManage: true,
|
||||
canCreateTickets: true,
|
||||
});
|
||||
assert.match(
|
||||
admin,
|
||||
/<a(?=[^>]*href="\/projects\/7\/settings\/general")(?=[^>]*aria-current="page")[^>]*>/,
|
||||
);
|
||||
// Render another page in the same process to catch stale module-level Inertia state.
|
||||
const dashboard = await render('/dashboard', null);
|
||||
assert.match(
|
||||
dashboard,
|
||||
/<a(?=[^>]*href="\/dashboard")(?=[^>]*aria-current="page")[^>]*>/,
|
||||
);
|
||||
assert.doesNotMatch(dashboard, /href="\/projects\/7/);
|
||||
const translated = await render(
|
||||
'/dashboard',
|
||||
null,
|
||||
permissions,
|
||||
createLocalization(
|
||||
{ locale: 'de' },
|
||||
{
|
||||
de: {
|
||||
...en,
|
||||
'navigation.dashboard': 'Übersicht',
|
||||
'navigation.expand': 'Navigation öffnen',
|
||||
},
|
||||
},
|
||||
),
|
||||
);
|
||||
assert.match(translated, /Übersicht/);
|
||||
console.log('Navigation behavior checks passed.');
|
||||
} finally {
|
||||
await server.close();
|
||||
}
|
||||
Reference in New Issue
Block a user