Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xtheprodev/distributed-lock
Distributed Lock to execute Mutual Exclusion of a Shared Resource in a Microservice Architecture
https://github.com/0xtheprodev/distributed-lock
distributed-lock distributed-systems hacktoberfest microservices mutex nestjs nodejs redis typescript
Last synced: 3 months ago
JSON representation
Distributed Lock to execute Mutual Exclusion of a Shared Resource in a Microservice Architecture
- Host: GitHub
- URL: https://github.com/0xtheprodev/distributed-lock
- Owner: 0xTheProDev
- License: mit
- Created: 2024-07-20T10:49:18.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T22:43:10.000Z (3 months ago)
- Last Synced: 2024-10-19T13:51:08.453Z (3 months ago)
- Topics: distributed-lock, distributed-systems, hacktoberfest, microservices, mutex, nestjs, nodejs, redis, typescript
- Language: TypeScript
- Homepage:
- Size: 1.11 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Distributed Lock
[](https://github.com/0xTheProDev/distributed-lock)
---
[](https://github.com/0xTheProDev/distributed-lock/actions/workflows/regression.yml)
[](https://github.com/0xTheProDev/distributed-lock/actions/workflows/release.yml)
[](https://github.com/sponsors/0xTheProDev)
[](https://nodejs.org)
[](https://www.npmjs.com/package/@theprodev/distributed-lock)
[](https://www.npmjs.com/package/@theprodev/distributed-lock)
[](https://www.npmjs.com/package/@theprodev/distributed-lock)
[](https://www.npmjs.com/package/@theprodev/distributed-lock)
[](https://codecov.io/github/0xTheProDev/distributed-lock)
[](https://www.npmjs.com/package/@theprodev/distributed-lock)
[](https://github.com/0xTheProDev/distributed-lock/blob/main/LICENSE)
[](https://github.com/0xTheProDev/distributed-lock/issues)
[](https://github.com/0xTheProDev/distributed-lock/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/0xTheProDev/distributed-lock/pulls)
[](https://github.com/0xTheProDev/distributed-lock/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/0xTheProDev/distributed-lock/graphs/contributors)
[](https://github.com/0xTheProDev/distributed-lock/pulse)
## 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.
[Read More](https://martin.kleppmann.com/2016/02/08/how-to-do-distributed-locking.html).
## Installation
Install this package using your preferred package manager. See the example of [yarn](https://yarnpkg.com):
```sh
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.
```ts
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](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html) 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:
```sh
yarn test
```
- To collect coverage on the tested files, execute the following command:
```sh
yarn test:cov
```
## Reporting a Bug
Head on to [**Discussion**](https://github.com/0xTheProDev/distributed-lock/discussions) 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.
## Changelog
See [CHANGELOG](https://github.com/0xTheProDev/distributed-lock/blob/main/CHANGELOG.md) for more details on what has been changed in the latest release.
## Contributing
See [Contributing Guidelines](https://github.com/0xTheProDev/distributed-lock/blob/main/.github/CONTRIBUTING.md).
## License
This project is licensed under the terms of the MIT license, see [LICENSE](https://github.com/0xTheProDev/distributed-lock/blob/main/LICENSE) for more details.
