ahmido/TenantAtlas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity
d6f37f7b9f
TenantAtlas/specs/106-required-permissions-sidebar-context/tasks.md

8.8 KiB
Raw Blame History

Tasks: Required Permissions Sidebar Context Fix

Input: Design documents from /specs/106-required-permissions-sidebar-context/ Prerequisites: plan.md (required), spec.md (required for user stories), research.md, data-model.md, quickstart.md

Tests: This feature changes runtime behavior (middleware navigation logic), so tests are REQUIRED (Pest). Operations: N/A — no long-running/remote/queued/scheduled work. RBAC: No authorization changes. All 8 existing authorization checks are preserved. Only sidebar rendering is affected. Filament UI Action Surfaces: Exemption — no Filament Resource/Page/RelationManager created or modified. Filament UI UX-001: Exemption — no new screens, no layout changes. Badges: N/A — no badge changes.

Organization: Tasks are grouped by user story to enable independent implementation and testing of each story.

Format: [ID] [P?] [Story] Description

  • [P]: Can run in parallel (different files, no dependencies)
  • [Story]: Which user story this task belongs to (e.g., US1, US2)
  • Include exact file paths in descriptions

Phase 1: Setup

Purpose: No project initialization needed — this is a fix in an existing codebase. Phase is empty.

(No tasks — feature modifies existing files only.)

Phase 2: Foundational (Blocking Prerequisites)

Purpose: No foundational infrastructure changes needed. The middleware, test helpers, and page classes already exist.

(No tasks — all prerequisites are already in place.)

Checkpoint: Foundation ready — user story implementation can begin immediately.

Phase 3: User Story 1 — Consistent Workspace Sidebar on Required Permissions (Priority: P1) MVP

Goal: When navigating to /admin/tenants/{tenant}/required-permissions, the sidebar always shows workspace-level navigation instead of tenant-scoped navigation (Inventory, Backups & Restore, Directory, Governance, Findings). Note: Actual workspace nav item labels MUST be derived from configureNavigationForRequest() at implementation time — do not hardcode assumed names.

Independent Test: Navigate to /admin/tenants/{tenant}/required-permissions while a tenant context is active in the session. Verify workspace navigation items are present and tenant-scoped items are absent. Verify Livewire filter updates preserve workspace sidebar.

Tests for User Story 1

  • T001 [US1] Create sidebar context test file at tests/Feature/RequiredPermissions/RequiredPermissionsSidebarTest.php with test cases: (a) page shows workspace nav items — derive actual item labels from configureNavigationForRequest() output at implementation time (do NOT hardcode assumed labels from the spec), (b) page does not show tenant nav items (Inventory, Backups), (c) direct URL navigation shows workspace sidebar, (d) Livewire filter updates preserve workspace sidebar context, (e) non-member access still returns 404 after middleware change (explicit FR-002 regression guard)
  • T002 [US1] Add regression test in tests/Feature/RequiredPermissions/RequiredPermissionsSidebarTest.php asserting that tenant-scoped pages (e.g., a page under /admin/t/{tenant}/) still show tenant sidebar — no regression

Implementation for User Story 1

  • T003 [US1] Add isWorkspaceScopedPageWithTenant() private helper method to app/Support/Middleware/EnsureFilamentTenantSelected.php — regex match for /admin/tenants/{tenant}/required-permissions
  • T004 [US1] Add Livewire /livewire/update referer check for Required Permissions page in app/Support/Middleware/EnsureFilamentTenantSelected.php — add regex match in the existing /livewire/update block (after operations check, before the block returns)
  • T005 [US1] Add workspace-scoped page bypass in the $tenantParameter !== null block of app/Support/Middleware/EnsureFilamentTenantSelected.php — after all 8 authorization checks pass but before Filament::setTenant($tenant, true), call isWorkspaceScopedPageWithTenant($path) and return early with configureNavigationForRequest() (skip setTenant and rememberLastTenantId)
  • T006 [US1] Run tests: vendor/bin/sail artisan test --compact tests/Feature/RequiredPermissions/ — verify all new sidebar tests pass AND all existing Required Permissions tests still pass (no regression)

Checkpoint: User Story 1 complete — Required Permissions page always shows workspace sidebar. All existing functionality preserved.

Phase 4: User Story 2 — Context Bar Reflects Tenant Scope (Priority: P2)

Goal: The context bar (top bar) correctly shows the tenant name for orientation while the sidebar displays workspace navigation.

Independent Test: Navigate to Required Permissions for a specific tenant. Verify the page heading or context area displays the tenant name. Verify sidebar shows workspace navigation.

Implementation for User Story 2

  • T007 [US2] Verify context bar behavior in tests/Feature/RequiredPermissions/RequiredPermissionsSidebarTest.php — add assertion that the page response contains the tenant display name. Note: The page resolves $scopedTenant from the route param via resolveScopedTenant() (NOT from Filament::getTenant()), so the tenant name is available even though Filament::setTenant() is skipped. Verify the heading renders the tenant's display_name.

Checkpoint: User Story 2 complete — tenant name visible in page context while sidebar remains workspace-scoped.

Phase 5: Polish & Cross-Cutting Concerns

Purpose: Code quality, formatting, and final validation.

  • T008 Run vendor/bin/sail bin pint --dirty --format agent to ensure code style compliance on app/Support/Middleware/EnsureFilamentTenantSelected.php
  • T009 Run full Required Permissions test suite: vendor/bin/sail artisan test --compact tests/Feature/RequiredPermissions/ — final regression check
  • T010 Run quickstart.md validation: verify all steps described in specs/106-required-permissions-sidebar-context/quickstart.md are implemented

Dependencies & Execution Order

Phase Dependencies

  • Setup (Phase 1): Empty — no setup needed
  • Foundational (Phase 2): Empty — no foundational work needed
  • User Story 1 (Phase 3): Can start immediately — core fix
  • User Story 2 (Phase 4): Can start after US1 (depends on sidebar fix being in place to verify both sidebar + context bar)
  • Polish (Phase 5): Depends on US1 + US2 completion

User Story Dependencies

  • User Story 1 (P1): No dependencies — can start immediately. This IS the MVP.
  • User Story 2 (P2): Soft dependency on US1 (needs the sidebar fix to verify context bar works alongside workspace sidebar). Can technically be verified independently since the page already renders tenant name.

Within Each User Story

  • Tests (T001, T002) can be written in parallel with each other
  • Implementation tasks (T003, T004, T005) are sequential — each builds on the previous
  • T006 (test run) depends on T001–T005 all being complete

Parallel Opportunities

  • T001 and T002 can run in parallel (different test cases, same new file)
  • T003, T004, T005 modify the same file sequentially — no parallelism
  • T007 (US2) can start after T005 is complete

Parallel Example: User Story 1

# Write both test groups in parallel:
Task T001: "Create sidebar context tests in tests/Feature/RequiredPermissions/RequiredPermissionsSidebarTest.php"
Task T002: "Add regression test for tenant-scoped pages in tests/Feature/RequiredPermissions/RequiredPermissionsSidebarTest.php"

# Then implement sequentially (same file):
Task T003: "Add isWorkspaceScopedPageWithTenant() helper"
Task T004: "Add Livewire referer check"
Task T005: "Add workspace-scoped page bypass in tenant param block"

# Then validate:
Task T006: "Run all Required Permissions tests"

Implementation Strategy

MVP First (User Story 1 Only)

  1. Skip Phase 1 + Phase 2 (empty)
  2. Complete Phase 3: User Story 1 (T001–T006)
  3. STOP and VALIDATE: All Required Permissions tests pass, sidebar shows workspace nav
  4. This is a shippable fix.

Incremental Delivery

  1. User Story 1 (T001–T006): Sidebar fix → Test → Ship (MVP!)
  2. User Story 2 (T007): Context bar verification → Test → Ship
  3. Polish (T008–T010): Code style + final validation

Notes

  • Total tasks: 10
  • Tasks per user story: US1 = 6, US2 = 1, Polish = 3
  • Parallel opportunities: T001 + T002 (test writing)
  • All middleware changes are in a single file: app/Support/Middleware/EnsureFilamentTenantSelected.php
  • All new tests are in a single file: tests/Feature/RequiredPermissions/RequiredPermissionsSidebarTest.php
  • Suggested MVP scope: User Story 1 only (T001–T006) — this fully resolves the sidebar bug
  • Format validation: All tasks follow - [ ] [TaskID] [P?] [Story?] Description with file path format