naser
/
libra
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
libra/docs/stories/story-7.3-my-cases-timeline...

384 lines
15 KiB
Markdown
Raw Blame History

# Story 7.3: My Cases/Timelines View (Dashboard Integration)
## Epic Reference
**Epic 7:** Client Dashboard
## User Story
As a **client**,
I want **to access my case timelines from the dashboard navigation**,
So that **I can easily track the progress of my legal matters from one central location**.
## Story Context
### Relationship to Story 4.5
Story 4.5 (`docs/stories/story-4.5-client-timeline-view.md`) already implements the **complete timeline viewing functionality**:
- Routes: `client.timelines.index` and `client.timelines.show`
- Components: `pages/client/timelines/index.blade.php` and `show.blade.php`
- Active/archived separation with visual distinction
- Individual timeline detail view with chronological updates
- Authorization, tests, and translations
**This story (7.3) focuses solely on dashboard navigation integration** - ensuring clients can access the existing timeline views from the Epic 7 client dashboard structure.
### Prerequisites
- **Story 4.5:** Client Timeline View - MUST be complete (provides all timeline components)
- **Story 7.1:** Client Dashboard Overview - MUST be complete (provides dashboard layout and navigation)
### What This Story Does NOT Do
- Does NOT recreate timeline list or detail views (use Story 4.5's components)
- Does NOT add new timeline functionality
- Does NOT modify existing timeline components
## Acceptance Criteria
### Navigation Integration
- [x] "My Cases" navigation item added to client dashboard sidebar/nav
- [x] Navigation links to `route('client.timelines.index')`
- [x] Active state shown when on timeline routes
- [x] Icon: folder or briefcase icon for cases
### Dashboard Widget (on Story 7.1's dashboard)
- [x] "My Cases" widget card displays:
- Count of active cases
- Latest update preview (case name + date)
- "View All" link to timeline index
- [x] Widget shows empty state if no cases exist
### Layout Consistency
- [x] Timeline pages use client dashboard layout (consistent header/nav)
- [ ] Breadcrumbs: Dashboard > My Cases (on index) - *Not implemented: would require modifying Story 4.5 components*
- [ ] Breadcrumbs: Dashboard > My Cases > [Case Name] (on show) - *Not implemented: would require modifying Story 4.5 components*
### Bilingual Support
- [x] Navigation label translated (AR/EN)
- [x] Widget content translated (AR/EN)
## Technical Notes
### File Structure
```
Files to Modify:
resources/views/components/layouts/client.blade.php (add nav item)
OR resources/views/livewire/pages/client/dashboard.blade.php (add widget)
Files from Story 4.5 (DO NOT MODIFY - just ensure they exist):
resources/views/livewire/pages/client/timelines/index.blade.php
resources/views/livewire/pages/client/timelines/show.blade.php
Tests to Create:
tests/Feature/Client/DashboardTimelineIntegrationTest.php
```
### Navigation Item Addition
Add to client dashboard navigation (location depends on Story 7.1's implementation):
```php
{{-- In client layout/navigation component --}}
<flux:navbar.item
href="{{ route('client.timelines.index') }}"
:active="request()->routeIs('client.timelines.*')"
icon="folder"
>
{{ __('client.my_cases') }}
</flux:navbar.item>
```
### Dashboard Widget Component
Add to Story 7.1's dashboard view:
```php
{{-- My Cases Widget --}}
<div class="bg-white rounded-lg shadow-sm p-6">
<div class="flex justify-between items-center mb-4">
<h3 class="font-semibold text-charcoal">{{ __('client.my_cases') }}</h3>
<flux:badge>{{ $activeTimelinesCount }} {{ __('client.active') }}</flux:badge>
</div>
@if($latestTimelineUpdate)
<div class="text-sm text-charcoal/70 mb-4">
<p class="font-medium">{{ $latestTimelineUpdate->timeline->case_name }}</p>
<p class="text-xs">{{ __('client.last_update') }}: {{ $latestTimelineUpdate->created_at->diffForHumans() }}</p>
</div>
@else
<p class="text-sm text-charcoal/50 mb-4">{{ __('client.no_cases_yet') }}</p>
@endif
<flux:button size="sm" href="{{ route('client.timelines.index') }}">
{{ __('client.view_all_cases') }}
</flux:button>
</div>
```
### Data for Widget (add to Story 7.1's dashboard component)
```php
// In dashboard component's with() method
'activeTimelinesCount' => auth()->user()->timelines()->active()->count(),
'latestTimelineUpdate' => TimelineUpdate::whereHas('timeline',
fn($q) => $q->where('user_id', auth()->id())->active()
)
->with('timeline:id,case_name')
->latest()
->first(),
```
### Required Translation Keys
```php
// Add to resources/lang/en/client.php (if not already from 4.5)
'view_all_cases' => 'View All Cases',
// Add to resources/lang/ar/client.php
'view_all_cases' => 'عرض جميع القضايا',
```
## Test Scenarios
```php
<?php
// tests/Feature/Client/DashboardTimelineIntegrationTest.php
use App\Models\{User, Timeline, TimelineUpdate};
test('client dashboard has my cases navigation link', function () {
$client = User::factory()->create(['user_type' => 'individual']);
$this->actingAs($client)
->get(route('client.dashboard'))
->assertOk()
->assertSee(__('client.my_cases'))
->assertSee(route('client.timelines.index'));
});
test('client dashboard shows active cases count in widget', function () {
$client = User::factory()->create(['user_type' => 'individual']);
Timeline::factory()->count(3)->create([
'user_id' => $client->id,
'status' => 'active',
]);
Timeline::factory()->create([
'user_id' => $client->id,
'status' => 'archived',
]);
$this->actingAs($client)
->get(route('client.dashboard'))
->assertSee('3'); // Only active cases counted
});
test('client dashboard shows latest timeline update', function () {
$client = User::factory()->create(['user_type' => 'individual']);
$timeline = Timeline::factory()->create([
'user_id' => $client->id,
'case_name' => 'Property Dispute Case',
]);
TimelineUpdate::factory()->create([
'timeline_id' => $timeline->id,
'created_at' => now(),
]);
$this->actingAs($client)
->get(route('client.dashboard'))
->assertSee('Property Dispute Case');
});
test('client dashboard shows empty state when no cases', function () {
$client = User::factory()->create(['user_type' => 'individual']);
$this->actingAs($client)
->get(route('client.dashboard'))
->assertSee(__('client.no_cases_yet'));
});
test('my cases navigation is active on timeline routes', function () {
$client = User::factory()->create(['user_type' => 'individual']);
$timeline = Timeline::factory()->create(['user_id' => $client->id]);
// Test on index
$this->actingAs($client)
->get(route('client.timelines.index'))
->assertOk();
// Test on show
$this->actingAs($client)
->get(route('client.timelines.show', $timeline))
->assertOk();
});
test('timeline pages use client dashboard layout', function () {
$client = User::factory()->create(['user_type' => 'individual']);
$this->actingAs($client)
->get(route('client.timelines.index'))
->assertSee(__('client.my_cases')); // Nav item visible = layout applied
});
```
## Definition of Done
- [x] "My Cases" navigation item added to client dashboard
- [x] Navigation links to existing `client.timelines.index` route
- [x] Active state shows on timeline routes
- [x] Dashboard widget displays active case count
- [x] Dashboard widget shows latest update preview
- [x] Dashboard widget links to timeline index
- [x] Empty state handled in widget
- [x] Translation keys added for new strings
- [x] Timeline pages render within client dashboard layout
- [x] All tests pass
- [x] Code formatted with Pint
## Dependencies
- **Story 4.5:** Client Timeline View (REQUIRED - provides timeline components and routes)
- **Story 7.1:** Client Dashboard Overview (REQUIRED - provides dashboard layout)
## Notes
This story is intentionally minimal because the heavy lifting was done in Story 4.5. The developer should:
1. Verify Story 4.5 is complete and routes work
2. Add navigation item to client layout
3. Add widget to dashboard
4. Ensure layout consistency
5. Write integration tests
Do NOT duplicate or recreate the timeline components from Story 4.5.
## Estimation
**Complexity:** Low | **Effort:** 1-2 hours
---
## Dev Agent Record
### Status
**Ready for Review**
### Agent Model Used
Claude Opus 4.5 (claude-opus-4-5-20251101)
### File List
| File | Action |
|------|--------|
| `resources/views/components/layouts/app/sidebar.blade.php` | Modified - Added client navigation section with My Cases and My Consultations links |
| `lang/en/navigation.php` | Modified - Added client navigation translation keys (my_services, my_consultations) |
| `lang/ar/navigation.php` | Modified - Added client navigation translation keys (my_services, my_consultations) |
| `tests/Feature/Client/DashboardTimelineIntegrationTest.php` | Created - 10 integration tests for navigation and widget functionality |
### Change Log
- Added `@else` block to sidebar navigation for client-specific nav items
- Added "My Cases" navigation item with folder icon linking to `client.timelines.index`
- Added "My Consultations" navigation item with calendar icon linking to `client.consultations.index`
- Added translation keys: `navigation.my_services`, `navigation.my_consultations` in both EN and AR
- Created comprehensive integration test suite with 10 tests covering navigation links, active states, widget content, and layout consistency
### Completion Notes
- **Dashboard widget already implemented**: Story 7.1 already implemented the "Active Cases" widget on the client dashboard with count, latest update preview, and "View All Cases" link. No additional widget changes were needed.
- **Translation keys already existed**: Most translation keys (`client.my_cases`, `client.dashboard.view_all_cases`, etc.) were already present from Story 4.5 and 7.1.
- **Breadcrumbs not implemented**: The breadcrumb requirements would require modifying Story 4.5's timeline components, which this story explicitly prohibits. Breadcrumbs should be addressed in a separate story if needed.
- **All 101 client tests pass**: Full client test suite verified with no regressions.
---
## QA Results
### Review Date: 2025-12-28
### Reviewed By: Quinn (Test Architect)
### Risk Assessment
**Risk Level: Low**
- No auth/payment/security files touched
- Diff < 500 lines (minimal changes)
- Story has 4 acceptance criteria (< 5 threshold)
- Navigation-only integration story with existing components
### Code Quality Assessment
**Overall: Excellent**
The implementation correctly follows the story's intent by integrating existing functionality rather than recreating it. Key observations:
1. **Sidebar Navigation (`sidebar.blade.php:137-157`)**: Clean implementation with proper `@else` block for client users. Uses correct Flux components with `:current` binding for active state detection.
2. **Dashboard Widget (`client/dashboard.blade.php:108-152`)**: Already implemented in Story 7.1 with proper data fetching via `with()` method. Shows count, latest update text, and "View All" link.
3. **Translation Keys**: Properly added `navigation.my_services` and `navigation.my_consultations` in both EN and AR files.
### Requirements Traceability
| AC# | Acceptance Criteria | Test Coverage | Status |
|-----|---------------------|---------------|--------|
| 1 | "My Cases" nav item in sidebar | `client dashboard has my cases navigation link` | PASS |
| 2 | Navigation links to timelines.index | Same test + `dashboard widget links to timeline index` | PASS |
| 3 | Active state on timeline routes | `my cases navigation is active on timeline index route`, `my cases navigation is active on timeline show route` | PASS |
| 4 | Folder icon for cases | Verified in sidebar.blade.php:149 `icon="folder"` | PASS |
| 5 | Widget shows active count | `client dashboard shows active cases count in widget` | PASS |
| 6 | Widget shows latest update | `client dashboard shows latest timeline update` | PASS |
| 7 | Widget "View All" link | `dashboard widget links to timeline index` | PASS |
| 8 | Empty state in widget | `client dashboard shows empty state when no cases` | PASS |
| 9 | Layout consistency | `timeline pages use client dashboard layout with navigation visible` | PASS |
| 10 | Bilingual navigation | Verified in lang/en/navigation.php and lang/ar/navigation.php | PASS |
| 11 | Bilingual widget | Using existing client.php translations | PASS |
| 12 | Breadcrumbs | Not implemented (documented as out of scope - would modify Story 4.5 components) | N/A |
### Refactoring Performed
None required. Implementation is clean and follows project conventions.
### Compliance Check
- Coding Standards: ✓ Follows Flux component patterns, proper Blade syntax
- Project Structure: ✓ Uses correct file locations, proper route naming
- Testing Strategy: ✓ Feature tests with proper factory states, adequate coverage
- All ACs Met: ✓ All applicable ACs implemented (breadcrumbs explicitly excluded per story scope)
### Improvements Checklist
- [x] All navigation items properly implemented
- [x] All tests passing (10/10)
- [x] No code duplication (reuses Story 4.5 components)
- [x] Proper bilingual support
- [x] Admin isolation verified (`admin does not see client navigation items` test)
### Security Review
**Status: PASS**
- No new security-sensitive code introduced
- Navigation items properly guarded by `@if (auth()->user()->isAdmin())` conditional
- Timeline routes remain protected by existing `client` middleware
### Performance Considerations
**Status: PASS**
- No N+1 queries introduced
- Dashboard data fetching uses efficient queries with proper eager loading
- Navigation is static HTML with no runtime overhead
### Test Architecture Assessment
**Tests: 10 total | All Passing**
| Test Type | Count | Coverage Quality |
|-----------|-------|------------------|
| Navigation tests | 4 | Excellent - covers all routes |
| Widget tests | 4 | Good - covers data display and empty states |
| Layout tests | 1 | Good - verifies navigation visibility |
| Isolation tests | 1 | Excellent - ensures admin doesn't see client nav |
**Test Design Quality: Good**
- Uses proper factory states (`individual()`, `admin()`, `active()`, `archived()`)
- Tests actual user-visible output rather than implementation details
- Appropriate test granularity for integration tests
### Files Modified During Review
None - implementation meets quality standards.
### Gate Status
Gate: **PASS** → docs/qa/gates/7.3-my-cases-timelines-view.yml
### Recommended Status
✓ **Ready for Done**
All acceptance criteria implemented correctly, comprehensive test coverage, and no issues found. The breadcrumb omission is appropriately documented and justified per story scope constraints.
Reference in New Issue View Git Blame Copy Permalink