Download the PHP package andreagroferreira/redis-stream without Composer

Redis Stream Package for Laravel

A powerful, reliable Redis Streams implementation for Laravel applications. This package makes it easy to work with Redis Streams for event-driven applications, message processing, and real-time data pipelines.

Features

• ✅ Proper exception handling with typed exceptions

• 🚀 Simple producer/consumer API for Redis Streams
• ♻️ Compatible with both phpredis and predis drivers
• 🔄 Automatic consumer group management
• 🔁 Retry handling for failed messages
• 📊 Batch publishing support for high-throughput applications
• 🛑 Graceful shutdown support
• ⚙️ Configurable stream trimming (MAXLEN)
• 📟 Built-in Artisan command for consuming streams

Installation

You can install the package via composer:

Redis Driver Requirements

This package supports both phpredis (the PHP extension) and predis (PHP library) drivers:

For PHP Redis Extension (recommended for production):

For Predis Library:

The package will automatically detect which driver you're using.

After installation, publish the configuration file:

Configuration

Configure your Redis connection for streams in your .env file:

You can also define custom streams in the redis_stream.php config file.

Usage

Exception Handling

This package provides specific exception types for better error handling:

• RedisStreamException: Base exception class for all Redis Stream errors
• ConnectionException: Thrown when Redis connection fails
• PublishException: Thrown when message publishing fails
• ConsumeException: Thrown when message consumption fails
• MessageProcessingException: Thrown when message processing fails

Example of handling exceptions:

Basic Example

Using the Artisan Command

Creating a Custom Handler

Batch Publishing

For high-throughput scenarios, you can publish messages in batches:

Stream Trimming

To manage stream size:

Creating Custom Stream Producers

You can access named stream producers defined in your config:

Generating Custom Producers and Consumers

This package provides Artisan commands to quickly scaffold custom producer and consumer classes:

Creating a Producer

This will generate an OrderProducer class that extends the base functionality of RedisStreamProducer.

Creating a Consumer

The --command flag will also generate a dedicated Artisan command to run this consumer:

Consumer Implementation Example

After generating a consumer, you can customize the handleMessage method to process specific event types:

Testing

This package uses Pest PHP for testing:

For code coverage:

Note: To run the full test suite including feature tests, you need to have Redis installed and configured locally. The feature tests interact with an actual Redis server to verify the Redis Stream functionality.

The tests include both unit tests for exceptions and feature tests for Redis Stream interactions. In our CI setup, we only verify basic functionality to avoid Redis configuration issues in automated environments.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• André Ferreira
• All Contributors

License

The MIT License (MIT). Please see License File for more information.