h5p-redis-lock

This package provides a lock mechanism that can be used if the @lumieducation/server library runs in multi-process or cluster-mode. The locks are needed to avoid race conditions when installing libraries.

Requirements

The lock only works in conjunction with a custom H5P server using @lumieducation/h5p-server. Check out the documentation on the library for more details.

Usage

import { createClient } from '@redis/client';
import { H5PEditor, H5PPlayer } from '@lumieducation/h5p-server';
import RedisLockProvider from '@lumieducation/h5p-redis-lock';

// Create a regular redis connection
const redisClient = createClient({
    socket: {
        port,
        host,
    },
    database
});
try {
    await redisClient.connect();
}
catch (error) {
    // handle error
}

// Create the lock provider
const lockProvider = new RedisLockProvider(redisClient);

// Pass it to the editor and player object
const h5pEditor = new H5PEditor( /*other parameters*/, options: { lockProvider } );
const h5pPlayer = new H5PPlayer( /*other parameters*/, options: { lockProvider } );
Copy

It is important to make sure that all instances of H5PEditor use a Redis lock provider that points to the same database. Otherwise race conditions can happen.