Distributed Lock

Description

A Distributed Locking Mechanism implemented using Redis to provide Mutual Exclusion over Shared Resources in a Microservices Architecture.

In modern digital systems, we are often working with Distributed Workloads, Horizontal Scaling and Microservices. These systems do not share the same memory spaces or sometimes even the same host machine. Because of which traditional Mutex and Semaphore does not adapt with the current requirements to acquire exclusive access to shared resources. This library aims to bridge that gap using a common Remote Dictionary Server (Redis) with special attention to easy to integrate APIs and performance.

Installation

Install this package using your preferred package manager. See the example of yarn:

yarn add @theprodev/distributed-lock

Usage

Most common usage entails executing a block of code (asynchronous functions are supported) within a Mutual Exclusion region which ensures that no other code is being executed on the same resources.

import DistributedLock from "@theprodev/distributed-lock";

const distributedLock = new DistributedLock({
  host: "redis://example.com",
  port: 6379,
});

async function runExclusively() {
  return await distributedLock.execute("fetch", async () =>
    fetch("https://http.cat/200"),
  );
}

For any further usage, refer to the Type Declaration shipped with the package. Make sure your editor or IDE is capable of powering intellisense from the declaration file provided.

Testing

To run all the unit test suites, run the following after all the dependencies have been installed:

yarn test

To collect coverage on the tested files, execute the following command:

yarn test:cov

Reporting a Bug

Head on to Discussion section to report a bug or to ask for any feature. Feel to add your queries about using this library as well under Q & A section of it. Remember, do not create any Issues by yourself, maintainers of this repository will open one if deemed necessary.