Myrrix Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the bundle via Composer:

   composer require bcc/myrrix-bundle
   

   Enable the bundle in config/bundles.php:

   return [
       // ...
       MichelSalib\BCCMyrrixBundle\BCCMyrrixBundle::class => ['all' => true],
   ];
   

2. Configuration Publish the default config:

   php bin/console bcc-myrrix:install
   

   Edit config/packages/bcc_myrrix.yaml to match your Myrrix cluster settings (e.g., host, port, namespace).

3. First Use Case Inject the MyrrixClient service and interact with Myrrix:

   use MichelSalib\BCCMyrrixBundle\Service\MyrrixClient;
   
   class RecommendationService
   {
       public function __construct(private MyrrixClient $myrrix)
       {
       }
   
       public function getRecommendations(string $userId, int $limit = 5): array
       {
           return $this->myrrix->recommend($userId, $limit);
       }
   }
   

Implementation Patterns

Core Workflows

1. Recommendation Fetching Use the MyrrixClient to fetch recommendations:

   $recommendations = $myrrix->recommend('user_123', 10);
   // Returns array of recommended items (e.g., ['item_456', 'item_789']).
   

2. Feedback Handling Log implicit/explicit feedback:

   $myrrix->logFeedback('user_123', 'item_456', 'click'); // 'click', 'purchase', etc.
   

3. Model Management Deploy/update models via CLI:

   php bin/console bcc-myrrix:deploy-model --model=my_model --path=/path/to/model
   

Integration Tips

• Symfony Events: Trigger Myrrix actions on Symfony events (e.g., kernel.request for real-time recommendations).
• Cache Layer: Cache recommendations (e.g., with Symfony Cache component) to reduce Myrrix load.
• Async Processing: Use Symfony Messenger to queue feedback logs for batch processing.

Gotchas and Tips

Pitfalls

1. Connection Issues

   • Myrrix may throw ConnectionException if the cluster is down. Implement retry logic:

     try {
         $myrrix->recommend($userId);
     } catch (ConnectionException $e) {
         // Fallback to cached recommendations or default items.
     }
     

2. Namespace Conflicts Ensure the namespace in bcc_myrrix.yaml matches your Myrrix cluster’s configuration. Mismatches cause silent failures.

3. Model Deployment

   • Models must be in Myrrix’s expected format (e.g., .model files). Validate before deployment:

     php bin/console bcc-myrrix:validate-model --path=/path/to/model
     

Debugging

• Logs: Enable debug mode in bcc_myrrix.yaml (debug: true) for verbose output.
• CLI Commands: Use bcc-myrrix:status to check cluster health:

  php bin/console bcc-myrrix:status
  

Extension Points

1. Custom Metrics Extend the FeedbackLogger to support custom metrics:

   $myrrix->logCustomMetric('user_123', 'session_duration', 120);
   

2. Recommendation Filters Override the RecommendationFilter service to pre/post-process recommendations:

   # config/services.yaml
   MichelSalib\BCCMyrrixBundle\Service\RecommendationFilter:
       arguments:
           $customFilter: '@app.custom_recommendation_filter'
   

3. Event Listeners Subscribe to Myrrix events (e.g., model.deployed) via Symfony’s event dispatcher.