Ai Controller Jobs Laravel Package

Getting Started

Install the package via Composer: composer require aimeos/ai-controller-jobs. No manual service provider registration—Laravel auto-discovers it. Your first step is configuring job settings in config/aimeos.php, especially the jobs section (e.g., queue connection, default timeout). Then, wire it into Laravel’s scheduler in app/Console/Kernel.php by adding a recurring task like $schedule->command('ai:job maintenance')->daily();. Run a manual test with php artisan ai:job maintenance to confirm job controllers execute without errors. Check logs immediately—many issues surface as silent CLI failures.

Implementation Patterns

• Leverage built-in jobs first: Use stock controllers like Aimeos\Jobs\Index\Rebuild, Aimeos\Jobs\Email\Send, or Aimeos\Jobs\Maintenance\Cleanup before building custom ones.
• Custom job creation: Extend \Aimeos\Base\Job\Standard, implement run(\Aimeos\MShop\Context\Item\Iface $context), and register your class in config/aimeos/jobs.php (e.g., 'product-sync' => \App\Jobs\ProductSync::class).
• Batch processing: Break large datasets into chunks using the context’s MShop manager (e.g., $manager->search()->slice(0, 100))—job controllers handle one chunk per run() call.
• Queue integration: Inside a job controller, dispatch Laravel jobs from the controller (e.g., dispatch(new SyncExternalCatalog($context))) for heavy I/O or external API calls, but keep the core Aimeos job lightweight.
• Context-driven logging: Use $context->getLogger()->info('Started catalog rebuild') or Laravel’s \Log::channel('jobs')—context provides shared handles (DB, cache, config), avoiding hardcoded dependencies.

Gotchas and Tips

• Context isolation is critical: Never store state in static properties or closures—each job run must be idempotent and isolated. Always use $context for configuration, DB access, and logging.
• CLI vs. queue caveats: Jobs run via Horizon/SQS may not expose --verbose; wrap all logic in try/catch and log exceptions explicitly. Test with php artisan ai:job maintenance 2>&1 | tee output.log to catch stderr.
• Namespace safety: Aimeos uses short job names (e.g., maintenance). Always prefix your custom job keys (e.g., acme/maintenance) and register them fully-qualified to avoid collisions or override conflicts.
• Config override pitfalls: Overriding jobs via config/aimeos/jobs.php replaces the default controller—ensure your custom class maintains the same interface (i.e., accepts $context and returns void).
• Silent deadlocks: Long-running jobs using persistent DB connections may exhaust pool limits. Use Laravel’s queue timeout settings and avoid blocking operations (e.g., remote file downloads) without async fallback.