From bd5987fb4610649d6eaa209abb90ed7961cd7401 Mon Sep 17 00:00:00 2001 From: HorizonCode Date: Fri, 10 Jan 2025 01:17:29 +0100 Subject: [PATCH] initial commit --- .gitignore | 175 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 15 ++++ biome.json | 30 ++++++++ bun.lockb | Bin 0 -> 10362 bytes index.ts | 3 + package.json | 18 +++++ src/MutexLock.ts | 51 +++++++++++++ src/types.ts | 10 +++ test/mutex.test.ts | 30 ++++++++ tsconfig.json | 27 +++++++ 10 files changed, 359 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 biome.json create mode 100755 bun.lockb create mode 100644 index.ts create mode 100644 package.json create mode 100644 src/MutexLock.ts create mode 100644 src/types.ts create mode 100644 test/mutex.test.ts create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9b1ee42 --- /dev/null +++ b/.gitignore @@ -0,0 +1,175 @@ +# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore + +# Logs + +logs +_.log +npm-debug.log_ +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Caches + +.cache + +# Diagnostic reports (https://nodejs.org/api/report.html) + +report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json + +# Runtime data + +pids +_.pid +_.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover + +lib-cov + +# Coverage directory used by tools like istanbul + +coverage +*.lcov + +# nyc test coverage + +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) + +.grunt + +# Bower dependency directory (https://bower.io/) + +bower_components + +# node-waf configuration + +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) + +build/Release + +# Dependency directories + +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) + +web_modules/ + +# TypeScript cache + +*.tsbuildinfo + +# Optional npm cache directory + +.npm + +# Optional eslint cache + +.eslintcache + +# Optional stylelint cache + +.stylelintcache + +# Microbundle cache + +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history + +.node_repl_history + +# Output of 'npm pack' + +*.tgz + +# Yarn Integrity file + +.yarn-integrity + +# dotenv environment variable files + +.env +.env.development.local +.env.test.local +.env.production.local +.env.local + +# parcel-bundler cache (https://parceljs.org/) + +.parcel-cache + +# Next.js build output + +.next +out + +# Nuxt.js build / generate output + +.nuxt +dist + +# Gatsby files + +# Comment in the public line in if your project uses Gatsby and not Next.js + +# https://nextjs.org/blog/next-9-1#public-directory-support + +# public + +# vuepress build output + +.vuepress/dist + +# vuepress v2.x temp and cache directory + +.temp + +# Docusaurus cache and generated files + +.docusaurus + +# Serverless directories + +.serverless/ + +# FuseBox cache + +.fusebox/ + +# DynamoDB Local files + +.dynamodb/ + +# TernJS port file + +.tern-port + +# Stores VSCode versions used for testing VSCode extensions + +.vscode-test + +# yarn v2 + +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# IntelliJ based IDEs +.idea + +# Finder (MacOS) folder config +.DS_Store diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7f7f94 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# mutex-lock-redis + +To install dependencies: + +```bash +bun install +``` + +To run: + +```bash +bun run index.ts +``` + +This project was created using `bun init` in bun v1.1.43. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. diff --git a/biome.json b/biome.json new file mode 100644 index 0000000..2eb0751 --- /dev/null +++ b/biome.json @@ -0,0 +1,30 @@ +{ + "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json", + "vcs": { + "enabled": false, + "clientKind": "git", + "useIgnoreFile": false + }, + "files": { + "ignoreUnknown": false, + "ignore": [] + }, + "formatter": { + "enabled": true, + "indentStyle": "tab" + }, + "organizeImports": { + "enabled": true + }, + "linter": { + "enabled": true, + "rules": { + "recommended": true + } + }, + "javascript": { + "formatter": { + "quoteStyle": "double" + } + } +} diff --git a/bun.lockb b/bun.lockb new file mode 100755 index 0000000000000000000000000000000000000000..5f27257301d61b751396d9f341a6078d47b94ba7 GIT binary patch literal 10362 zcmeHN3tWs@8=s~((uz>&q6^k#)lAcLlWy#iND9fN)z@vRscEKWrn}X2Q*2g<+*VR- zgk6gdr7e;VkxNLqq?WZImy}yReb0I4J@s0<41M44x4-Y_;q|=lIp_aB&w1W+o^#%L z3?FJ1B@vtX^Mz(SVYIP-lu!*WmOvB`7Q`3uSV1CjxSy02%~4}A7>sF|X+;+uIXBjf zXj5s_isZj2*Nv7nJh$!DsdcqZ`Fz#gQP2oPPp%lMf6y}OnTs2c&l(JdOw0@9OW-LF zu7U8J4q6?wlM;i0>McO`1s&%n5bz~ZMmANS02-BxC>;p;Gk6{iS`G9lWd@@UXenq^ zeh4&bA4ZiUL;At<2o(my0JIutebA2y216Hg9cUfUM<~4m^k8_-2CWTx5v9RKvOgc? z-%q!X)9ZgXudm5tUpHyKd423~AB(cX%MaL>)Ku&%nfdKGiRDBU_buk`e16)B)|{U% z>n$AG`r?Z1{B>J>8n5X-S$v-JMa%d;?E$; zzyEE38wufFBQdn09DBDl8aZ3wUe5BmaGfV7xlq;PK-!MR;&q7r3#djbG7s zfbmH*JTCi?{)+)*L-mhviq0Y2*JHRr{zG=73$0g01mijI;;{b^-b4{Fw88j9z>kCe zHK7dR4~jVo3C33fegfbjJdx2AX+;F%d%?u91U!n!2n(@QA;I{s0FTFy=C7jj5aYju zPUk`Y$af!u-vId8J-|N#{EQypCqU3}?*Trmhxi7-yY--dQ&=#rJ;2BG5MK>=d*~m{ zJ+yXF98^@$TtgR%+pwpT>lgNNk^`@!KhtQg^{3jS^^TqgP#Vq{>rOUOF{V{i0yVcmti2uTziBIanTE zk`{97b&-K;)#jL%lI96Je$<_&e!h=KnK!57ne(mDh0C-zUBA=m9%IlO-MW)+Nycq9c4=v8-$n|c}%*W_q0G%YyV<{Vg1fo{HurEw!8Y=BwV=6d2?E`Z@Xo$ZF)7m)opcJ%*#@p2eXcG@78Wgc|hYuYZVL8(A#;*WpUA}BQ@27 zO(!0jzG~$}^+(GhMhp!YS{z<5sjBl=&mZcVv(8`JI6=tfiEk`t{+Nd#|_}=xyW|R*)z9XqQ+K^)Z=E{W3$?S5!*U@4>h-=@zT$F#E|e5 zZEH2*s-W2kdKV^tYnc0Nb>ot=^YYW(|4}#axXwP^GeetK26>e*y_qjfq6X3y?ExH zi%vF6c_Dt8n(MDg3yxZ!lO#G8NkfLt;8ZHDsE{}=U(2^tc3h(p6FJ{xJ&hOdC&*@E zq(`RRojmE6YCC2`uG(VcCDZf@v1qBZJMGli9xW}hDcm#kH;>iR&wOrHn!0vgoXXc` z84G`2IrLd$nX6XN-S`3;FWQf=5L+sol6+^`7xtc0d24#}op|E>u&TI4Z#|g*efEiG?WJeMqgrtB=m{u(JizOPQzDJZo;(?$_aL;2K>TwbaGetRrj) zb9V6vLwC;naf8S02;SX4zwGPLH%}!dmNWgBg`~Xo#s9TsQrh?1?x|k7 z^Nmi`*<9s3-w__px>D9<~U$bD{=A+4K<>KBN z+MX44tU(sr1aN${uf%ER1Vh`O(%&7Zbz4WbqNSJ(cSH#q9KDTe4wKJr6 zksr{x0}HWmrFKozm13KKnan9Ay>~h#4L8?ws%5;>M@Z){MoPW}AJ@)ThjjTBtXF>bkN`}^Nsy3Q+L{qVh`zFM+2tnX2hSAKqg-*CEw zc#@(u)q)t(nKofi>y6d_-eWcURflx$!9*xglSbt29pQg^o zc4OyG5PkWG)$F4zxQ+n)3knod(SCxyxre}oI1q&)TU)CaN;eYav;QUAymWCNDSWIB!ux+4J1Q(1}hBIBLhKnGK z1gZw-!cYzTfzouiz#}r8O+z)-Bqp1x!FjZ9wmhf-Pswm5PR@q<`6Cmc?ARKA#whWsbm4(L2Nivi8Fliez@=K=dUgJm>Qhx#5qE_1(p^J2F`ZkEFn{A z(O9+>+nmF|c~P8Cgc>e~ZO&zn#hFr^VT2khHrEUN9us#c^z5 zM0lu#EfNPq5hUl$SaQuGS2kN396w%O9x4$Dsat=6NEA-p2aEk8La6%y0iP$7QV$ZI zpEv;5NcrJB77U%wlf1(K3Q21W*3h0+X8s`4L~7+AZRd82zCUpB19rV zfFMc&ZUO@%zN-u%mOHN2QLbO*?UlL zyc596Uk(@yp;$2}`JR!%=zWtTHCGHsP8I-?`a^m|6Ao}l0StDN_x0B`$5C(azgx)d z#2TT{6IuI?7u?l`LX+)D4oeHfK`o&e33VeB1@hiOM{5Oys4+_(am_6eTa+-6AHaXF zQS@d&Lw{tEVcJSDr^KLj9V20p+W|Qo6q(4-@UAhu5krt)P%HtTK(HrWg6m<8u>^c! zR4gmj+OjM1pwbw=(1QC`X`r7ND&8uVQ}~I)|CHqIa*F2diY{AN;ZYL78wSz(AS)Fa ze)sUmu1Fks J3xB_V{{vyL7bO4y literal 0 HcmV?d00001 diff --git a/index.ts b/index.ts new file mode 100644 index 0000000..2898c2d --- /dev/null +++ b/index.ts @@ -0,0 +1,3 @@ +import { MutexLock } from "./src/MutexLock"; + +export default MutexLock; diff --git a/package.json b/package.json new file mode 100644 index 0000000..f4fd4f7 --- /dev/null +++ b/package.json @@ -0,0 +1,18 @@ +{ + "name": "mutex-lock-redis", + "module": "index.ts", + "type": "module", + "scripts": { + "lint": "bunx biome check --write" + }, + "devDependencies": { + "@biomejs/biome": "1.9.4", + "@types/bun": "latest" + }, + "peerDependencies": { + "typescript": "^5.0.0" + }, + "dependencies": { + "redis": "^4.7.0" + } +} diff --git a/src/MutexLock.ts b/src/MutexLock.ts new file mode 100644 index 0000000..af97588 --- /dev/null +++ b/src/MutexLock.ts @@ -0,0 +1,51 @@ +import type { MutexOptions } from "./types"; +import redis from "redis"; + +type RedisClient = redis.RedisClientType< + redis.RedisDefaultModules & redis.RedisModules, + redis.RedisFunctions, + redis.RedisScripts +>; + +export class MutexLock { + redisClient: RedisClient; + mutexOptions: MutexOptions; + + constructor(redisClient: RedisClient, options: MutexOptions) { + this.mutexOptions = options; + this.redisClient = redisClient; + } + + static async create(options: MutexOptions) { + const redisClient = await redis + .createClient({ + url: `redis://${options.redis.host}:${options.redis.port}`, + }) + .connect(); + + return new MutexLock(redisClient, options); + } + + async obtainLock(lockName: string) { + const lockIdentifier = `mutexlock:${lockName}`; + const releaseFunc = async () => { + await this.redisClient.del(lockIdentifier); + }; + + while (true) { + const acquired = await this.redisClient.set(lockIdentifier, "1", { + NX: true + }); + + if (acquired) { + await this.redisClient.expire( + lockIdentifier, + this.mutexOptions.mutex?.ttl || 60 + ); + return releaseFunc; + } + await new Promise(resolve => + setTimeout(resolve, this.mutexOptions.mutex?.checkInterval || 100) + ); + } + }} diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..1bb59eb --- /dev/null +++ b/src/types.ts @@ -0,0 +1,10 @@ +export type MutexOptions = { + redis: { + host: string; + port: number; + }; + mutex?: { + checkInterval?: number; + ttl: number; + }; +}; diff --git a/test/mutex.test.ts b/test/mutex.test.ts new file mode 100644 index 0000000..67202b5 --- /dev/null +++ b/test/mutex.test.ts @@ -0,0 +1,30 @@ +import { test } from "bun:test"; +import { MutexLock } from "../src/MutexLock"; + +test( + "redis mutex", + async () => { + const mutexLock = await MutexLock.create({ + redis: { + host: "127.0.0.1", + port: 6379, + }, + }); + + const testLock = async () => { + const release = await mutexLock.obtainLock("test"); + console.log("got lock"); + try { + await new Promise((res) => setTimeout(res, 3000)); + } finally { + await release(); + console.log("released lock"); + } + }; + + await Promise.all([testLock(), testLock(), testLock(), testLock()]); + }, + { + timeout: Number.POSITIVE_INFINITY, + }, +); diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..ffc08ab --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,27 @@ +{ + "compilerOptions": { + // Enable latest features + "lib": ["ESNext", "DOM"], + "target": "ESNext", + "module": "ESNext", + "moduleDetection": "force", + "jsx": "react-jsx", + "allowJs": true, + + // Bundler mode + "moduleResolution": "bundler", + "allowImportingTsExtensions": true, + "verbatimModuleSyntax": true, + "noEmit": true, + + // Best practices + "strict": true, + "skipLibCheck": true, + "noFallthroughCasesInSwitch": true, + + // Some stricter flags (disabled by default) + "noUnusedLocals": false, + "noUnusedParameters": false, + "noPropertyAccessFromIndexSignature": false + } +}