Skip to content

Refactor export tests, document queue requirements, and add AI agent guidelines #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nielsdrost7 merged 7 commits into from
Nov 13, 2025
Merged

Refactor export tests, document queue requirements, and add AI agent guidelines #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0310daa
Initial plan
Copilot Nov 13, 2025
8209814
Refactor Expenses, Invoices, and Quotes export tests to use Queue fakes
Copilot Nov 13, 2025
bd8e4fd
Complete export test refactoring for all modules and remove exports m…
Copilot Nov 13, 2025
1dcbcfc
Add export architecture documentation explaining temporary nature of …
Copilot Nov 13, 2025
02ffdef
Clean up unused imports in ExpensesExportImportTest
Copilot Nov 13, 2025
1372a9b
Update README and documentation files with queue requirements for exp…
Copilot Nov 13, 2025
a8ccdbc
Create comprehensive .junie/guidelines.md for AI agent configuration
Copilot Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ This project is **InvoicePlane v2**, a **multi-tenant Laravel application** with
- **Module System:** nwidart/laravel-modules
- **Permissions:** spatie/laravel-permission
- **Multi-tenancy:** Filament Companies with `BelongsToCompany` trait
- **Queue System:** Required for export functionality (Redis, database, or sync for local development)

## Development Commands

Expand Down Expand Up @@ -57,8 +58,16 @@ composer install
cp .env.example .env
php artisan key:generate
php artisan migrate --seed

# Start queue worker for export functionality
php artisan queue:work
```

**Queue Configuration:**
- Export functionality requires a queue worker to be running
- For local development, you can use `QUEUE_CONNECTION=sync` in `.env`
- For production, use Redis or database queue driver with Supervisor

## Related Documentation

- **Installation:** `.github/INSTALLATION.md`
Expand Down Expand Up @@ -124,6 +133,15 @@ php artisan migrate --seed
- Reusable logic (e.g., fixtures, setup) must live in abstract test cases, not inline.
- Tests have inline comment blocks above sections (Arrange, Act, Assert).

### Export System Rules

- **Exports use Filament's asynchronous export system** which requires queue workers.
- **Export tests must use fakes:** `Queue::fake()`, `Storage::fake()`, and verify job dispatching with `Bus::assertChained()`.
- **The `exports` table is temporary** and managed by Filament for job coordination only.
- **No export history feature** - export records are ephemeral and auto-prunable.
- **Queue configuration is required** for export functionality to work in production.
- See `Modules/Core/Filament/Exporters/README.md` for export architecture details.

### Database & Models

- **No `$fillable` array in Models.**
Expand Down
Loading