@vortus-solutions/redis-service

Redis Service Package with Lua Scripts

A Node.js package that provides a robust Redis service implementation with built-in Lua script support. This package helps manage Redis connections and execute predefined Lua scripts efficiently.

Features

• Connection management for multiple Redis instances
• Built-in Lua scripts for common operations
• Auto-pipelining support
• Promise-based API
• Connection error handling
• Customizable configuration

Installation

npm install @vortus-solutions/redis-service

Basic Usage

const RedisService = require('@vortus-solutions/redis-service');

// Create a single instance connection
await RedisService.createConnection('main', {
    host: '127.0.0.1',
    port: 6379,
    db: 0
}, []);

// Or create a cluster connection
await RedisService.createClusterConnection('cluster', {
    nodes: [
        { host: 'redis-node1.example.com', port: 6379 },
        { host: 'redis-node2.example.com', port: 6379 }
    ]
}, []);

// Get connection instance
const redis = RedisService.getConnection('main');

Available Lua Scripts

zaddLimit

Adds a member to a sorted set with a limit on the total number of members.

Parameters:

• key: Sorted set key
• score: Member score
• member: Value to add
• limit: Maximum number of members
• offset: Number of members to remove from start

expireNX

Sets expiration on a key only if it doesn't have one.

Parameters:

• key: Redis key
• ttl: Time to live in seconds

setHIfHigher

Sets hash field value only if new value is higher than existing.

Parameters:

• key: Hash key
• field: Hash field
• value: New value

setHIfLower

Sets hash field value only if new value is lower than existing.

Parameters:

• key: Hash key
• field: Hash field
• value: New value

getPolylineChunks

Retrieves polyline chunks based on latitude and longitude bounds.

Parameters:

• key: Base key for polyline data
• latitude: Target latitude
• longitude: Target longitude

API Reference

RedisService

Constructor

new RedisService()

Methods

• createConnection(connectionName, options = {}, luaScriptNames = []): Creates a new Redis single-instance connection.
• createClusterConnection(connectionName, options = {}, luaScriptNames = []): Creates a new Redis cluster connection.
• getConnection(connectionName): Returns the existing connection by name.
• closeAll(): Closes all active connections.

LuaScriptsService

Methods

• register(name, script): Register a new Lua script.
• get(name): Get a script by name.
• getScripts(names): Get multiple scripts by their names.
• getAvailableScripts(): List all available scripts.

Configuration Options

Default connection options can be customized when creating a connection. The service supports both single Redis instances and Redis clusters with separate methods. All additional options are forwarded directly to ioredis, supporting its full range of configuration options.

Single Instance Configuration

Use with createConnection() method:

const singleInstanceOptions = {
    enableAutoPipelining: false,
    showFriendlyErrorStack: true,
    enableOfflineQueue: true,
    host: '127.0.0.1',
    port: 6379,
    db: 0
};

// Create single instance connection
await RedisService.createConnection('main', singleInstanceOptions, []);

Cluster Configuration

Use with createClusterConnection() method:

const clusterOptions = {
    nodes: [
        { host: '127.0.0.1', port: 6379 },
        { host: '127.0.0.1', port: 6380 }
    ],
    scaleReads: 'slave',
    clusterRetryStrategy: (times) => Math.min(times * 100, 2000),
    maxRedirections: 16,
    enableAutoPipelining: true,
    showFriendlyErrorStack: true
};

// Create cluster connection
await RedisService.createClusterConnection('cluster', clusterOptions, []);

Common Options

• enableAutoPipelining: Enable automatic pipelining for improved performance
• showFriendlyErrorStack: Show detailed error stack traces
• enableOfflineQueue: Enable offline queue for connection retries
• keyPrefix: Prefix for all Redis keys
• password: Redis authentication password
• tls: Enable TLS encryption

Error Handling

The package includes built-in error handling for connection issues:

try {
    // For single instance
    await RedisService.createConnection('main', { host: 'localhost' });
    
    // Or for cluster
    await RedisService.createClusterConnection('cluster', { nodes: [...] });
} catch (error) {
    console.error('Redis connection error:', error);
}

Best Practices

• Always close connections when done:

  await RedisService.closeAll();
  

• Reuse connections instead of creating new ones.
• Handle connection errors appropriately.
• Use auto-pipelining for bulk operations.

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.