@tslock/gcs 2.1.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/gcs-lock-provider.ts","../src/gcs-storage-accessor.ts","../src/gcs-errors.ts","../src/gcs-provider-config.ts"],"sourcesContent":["export { GcsLockProvider } from './gcs-lock-provider.js';\nexport type { GcsProviderConfig } from './gcs-provider-config.js';\nexport { createGcsProviderConfig } from './gcs-provider-config.js';\n","import type { Storage } from '@google-cloud/storage';\nimport {\n type ExtensibleLockProvider,\n type LockConfiguration,\n type SimpleLock,\n StorageBasedLockProvider,\n} from '@tslock/core';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\nimport { GcsStorageAccessor } from './gcs-storage-accessor.js';\n\nexport class GcsLockProvider implements ExtensibleLockProvider {\n private readonly delegate: StorageBasedLockProvider;\n\n constructor(storage: Storage, config: GcsProviderConfig) {\n const accessor = new GcsStorageAccessor(storage, config);\n this.delegate = new StorageBasedLockProvider(accessor);\n }\n\n lock(config: LockConfiguration): Promise<SimpleLock | undefined> {\n return this.delegate.lock(config);\n }\n\n clearCache(name: string): void {\n this.delegate.clearCache(name);\n }\n}\n","import type { FileMetadata, SaveOptions, Storage } from '@google-cloud/storage';\nimport {\n AbstractStorageAccessor,\n ClockProvider,\n type LockConfiguration,\n LockException,\n Utils,\n lockAtMostUntil,\n unlockTime,\n} from '@tslock/core';\nimport { isNotFound, isPreconditionFailed } from './gcs-errors.js';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\n\ntype GetResult = {\n generation: number;\n metadata: Record<string, string>;\n} | null;\n\nexport class GcsStorageAccessor extends AbstractStorageAccessor {\n constructor(\n private readonly storage: Storage,\n private readonly config: GcsProviderConfig,\n ) {\n super();\n }\n\n protected override getHostname(): string {\n return this.config.lockedBy;\n }\n\n private objectKey(name: string): string {\n return this.config.objectPrefix + name;\n }\n\n private file(name: string): ReturnType<ReturnType<Storage['bucket']>['file']> {\n return this.storage.bucket(this.config.bucket).file(this.objectKey(name));\n }\n\n private async getWithMetadata(name: string): Promise<GetResult> {\n try {\n const file = this.file(name);\n const [metadata] = await file.getMetadata();\n return {\n generation: Number(metadata.generation ?? 0),\n metadata: (metadata.metadata ?? {}) as Record<string, string>,\n };\n } catch (e) {\n if (isNotFound(e)) return null;\n throw e;\n }\n }\n\n private parseLockUntil(metadata: Record<string, string> | undefined): number {\n const raw = metadata?.lockUntil;\n if (!raw) throw new LockException('Corrupted lock record: missing lockUntil');\n const ms = Date.parse(raw);\n if (Number.isNaN(ms)) throw new LockException(`Corrupted lock record: unparseable lockUntil '${raw}'`);\n return ms;\n }\n\n private buildMetadata(config: LockConfiguration): Record<string, string> {\n return {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: Utils.toIsoString(config.createdAt),\n lockedBy: this.getHostname(),\n lockName: config.name,\n };\n }\n\n override async insertRecord(config: LockConfiguration): Promise<boolean> {\n const file = this.file(config.name);\n const [exists] = await file.exists();\n if (exists) return false;\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: 0 },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async updateRecord(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) throw new LockException(`Lock record not found: ${config.name}`);\n const lockUntil = this.parseLockUntil(current.metadata);\n if (lockUntil > ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: current.generation },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async unlock(config: LockConfiguration): Promise<void> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(unlockTime(config)),\n lockedAt: current.metadata.lockedAt ?? Utils.toIsoString(config.createdAt),\n lockedBy: current.metadata.lockedBy ?? this.getHostname(),\n lockName: current.metadata.lockName ?? config.name,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n } catch (e) {\n if (isPreconditionFailed(e)) return;\n throw e;\n }\n }\n\n override async extend(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return false;\n const lockUntil = this.parseLockUntil(current.metadata);\n const lockedBy = current.metadata.lockedBy;\n if (lockedBy !== this.getHostname()) return false;\n if (lockUntil <= ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: current.metadata.lockedAt,\n lockedBy: current.metadata.lockedBy,\n lockName: current.metadata.lockName,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n}\n","function getCode(e: unknown): number | undefined {\n if (e && typeof e === 'object') {\n const obj = e as Record<string, unknown>;\n const code = obj.code ?? obj.status;\n return typeof code === 'number' ? code : undefined;\n }\n return undefined;\n}\n\nexport function isNotFound(e: unknown): boolean {\n return getCode(e) === 404;\n}\n\nexport function isPreconditionFailed(e: unknown): boolean {\n return getCode(e) === 412;\n}\n","import { LockException, Utils } from '@tslock/core';\n\nexport interface GcsProviderConfig {\n bucket: string;\n objectPrefix: string;\n lockedBy: string;\n}\n\nexport function createGcsProviderConfig(input: {\n bucket: string;\n objectPrefix?: string;\n lockedBy?: string;\n}): GcsProviderConfig {\n if (!input.bucket) {\n throw new LockException('bucket must be a non-empty string');\n }\n return {\n bucket: input.bucket,\n objectPrefix: input.objectPrefix ?? 'shedlock/',\n lockedBy: input.lockedBy ?? Utils.getHostname(),\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,IAAAA,eAKO;;;ACLP,kBAQO;;;ACTP,SAAS,QAAQ,GAAgC;AAC/C,MAAI,KAAK,OAAO,MAAM,UAAU;AAC9B,UAAM,MAAM;AACZ,UAAM,OAAO,IAAI,QAAQ,IAAI;AAC7B,WAAO,OAAO,SAAS,WAAW,OAAO;AAAA,EAC3C;AACA,SAAO;AACT;AAEO,SAAS,WAAW,GAAqB;AAC9C,SAAO,QAAQ,CAAC,MAAM;AACxB;AAEO,SAAS,qBAAqB,GAAqB;AACxD,SAAO,QAAQ,CAAC,MAAM;AACxB;;;ADGO,IAAM,qBAAN,cAAiC,oCAAwB;AAAA,EAC9D,YACmB,SACA,QACjB;AACA,UAAM;AAHW;AACA;AAAA,EAGnB;AAAA,EAJmB;AAAA,EACA;AAAA,EAKA,cAAsB;AACvC,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEQ,UAAU,MAAsB;AACtC,WAAO,KAAK,OAAO,eAAe;AAAA,EACpC;AAAA,EAEQ,KAAK,MAAiE;AAC5E,WAAO,KAAK,QAAQ,OAAO,KAAK,OAAO,MAAM,EAAE,KAAK,KAAK,UAAU,IAAI,CAAC;AAAA,EAC1E;AAAA,EAEA,MAAc,gBAAgB,MAAkC;AAC9D,QAAI;AACF,YAAM,OAAO,KAAK,KAAK,IAAI;AAC3B,YAAM,CAAC,QAAQ,IAAI,MAAM,KAAK,YAAY;AAC1C,aAAO;AAAA,QACL,YAAY,OAAO,SAAS,cAAc,CAAC;AAAA,QAC3C,UAAW,SAAS,YAAY,CAAC;AAAA,MACnC;AAAA,IACF,SAAS,GAAG;AACV,UAAI,WAAW,CAAC,EAAG,QAAO;AAC1B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,eAAe,UAAsD;AAC3E,UAAM,MAAM,UAAU;AACtB,QAAI,CAAC,IAAK,OAAM,IAAI,0BAAc,0CAA0C;AAC5E,UAAM,KAAK,KAAK,MAAM,GAAG;AACzB,QAAI,OAAO,MAAM,EAAE,EAAG,OAAM,IAAI,0BAAc,iDAAiD,GAAG,GAAG;AACrG,WAAO;AAAA,EACT;AAAA,EAEQ,cAAc,QAAmD;AACvE,WAAO;AAAA,MACL,WAAW,kBAAM,gBAAY,6BAAgB,MAAM,CAAC;AAAA,MACpD,UAAU,kBAAM,YAAY,OAAO,SAAS;AAAA,MAC5C,UAAU,KAAK,YAAY;AAAA,MAC3B,UAAU,OAAO;AAAA,IACnB;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,UAAM,CAAC,MAAM,IAAI,MAAM,KAAK,OAAO;AACnC,QAAI,OAAQ,QAAO;AACnB,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,EAAE;AAAA,MAC3C,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,OAAM,IAAI,0BAAc,0BAA0B,OAAO,IAAI,EAAE;AACrF,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,QAAI,YAAY,0BAAc,IAAI,EAAG,QAAO;AAC5C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW;AAAA,MAC5D,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA0C;AAC9D,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM;AACtB,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,kBAAM,gBAAY,wBAAW,MAAM,CAAC;AAAA,UAC/C,UAAU,QAAQ,SAAS,YAAY,kBAAM,YAAY,OAAO,SAAS;AAAA,UACzE,UAAU,QAAQ,SAAS,YAAY,KAAK,YAAY;AAAA,UACxD,UAAU,QAAQ,SAAS,YAAY,OAAO;AAAA,QAChD;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AAAA,IACF,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG;AAC7B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA6C;AACjE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,QAAO;AAC7B,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,UAAM,WAAW,QAAQ,SAAS;AAClC,QAAI,aAAa,KAAK,YAAY,EAAG,QAAO;AAC5C,QAAI,aAAa,0BAAc,IAAI,EAAG,QAAO;AAC7C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,kBAAM,gBAAY,6BAAgB,MAAM,CAAC;AAAA,UACpD,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,QAC7B;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AACA,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AACF;;;AD3IO,IAAM,kBAAN,MAAwD;AAAA,EAC5C;AAAA,EAEjB,YAAY,SAAkB,QAA2B;AACvD,UAAM,WAAW,IAAI,mBAAmB,SAAS,MAAM;AACvD,SAAK,WAAW,IAAI,sCAAyB,QAAQ;AAAA,EACvD;AAAA,EAEA,KAAK,QAA4D;AAC/D,WAAO,KAAK,SAAS,KAAK,MAAM;AAAA,EAClC;AAAA,EAEA,WAAW,MAAoB;AAC7B,SAAK,SAAS,WAAW,IAAI;AAAA,EAC/B;AACF;;;AGzBA,IAAAC,eAAqC;AAQ9B,SAAS,wBAAwB,OAIlB;AACpB,MAAI,CAAC,MAAM,QAAQ;AACjB,UAAM,IAAI,2BAAc,mCAAmC;AAAA,EAC7D;AACA,SAAO;AAAA,IACL,QAAQ,MAAM;AAAA,IACd,cAAc,MAAM,gBAAgB;AAAA,IACpC,UAAU,MAAM,YAAY,mBAAM,YAAY;AAAA,EAChD;AACF;","names":["import_core","import_core"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/gcs-lock-provider.ts","../src/gcs-storage-accessor.ts","../src/gcs-errors.ts","../src/gcs-provider-config.ts"],"sourcesContent":["export { GcsLockProvider } from './gcs-lock-provider.js';\nexport type { GcsProviderConfig } from './gcs-provider-config.js';\nexport { createGcsProviderConfig } from './gcs-provider-config.js';\n","import type { Storage } from '@google-cloud/storage';\nimport {\n type ExtensibleLockProvider,\n type LockConfiguration,\n type SimpleLock,\n StorageBasedLockProvider,\n} from '@tslock/core';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\nimport { GcsStorageAccessor } from './gcs-storage-accessor.js';\n\nexport class GcsLockProvider implements ExtensibleLockProvider {\n private readonly delegate: StorageBasedLockProvider;\n\n constructor(storage: Storage, config: GcsProviderConfig) {\n const accessor = new GcsStorageAccessor(storage, config);\n this.delegate = new StorageBasedLockProvider(accessor);\n }\n\n lock(config: LockConfiguration): Promise<SimpleLock | undefined> {\n return this.delegate.lock(config);\n }\n\n clearCache(name: string): void {\n this.delegate.clearCache(name);\n }\n}\n","import type { FileMetadata, SaveOptions, Storage } from '@google-cloud/storage';\nimport {\n AbstractStorageAccessor,\n ClockProvider,\n type LockConfiguration,\n LockException,\n lockAtMostUntil,\n Utils,\n unlockTime,\n} from '@tslock/core';\nimport { isNotFound, isPreconditionFailed } from './gcs-errors.js';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\n\ntype GetResult = {\n generation: number;\n metadata: Record<string, string>;\n} | null;\n\nexport class GcsStorageAccessor extends AbstractStorageAccessor {\n constructor(\n private readonly storage: Storage,\n private readonly config: GcsProviderConfig,\n ) {\n super();\n }\n\n protected override getHostname(): string {\n return this.config.lockedBy;\n }\n\n private objectKey(name: string): string {\n return this.config.objectPrefix + name;\n }\n\n private file(name: string): ReturnType<ReturnType<Storage['bucket']>['file']> {\n return this.storage.bucket(this.config.bucket).file(this.objectKey(name));\n }\n\n private async getWithMetadata(name: string): Promise<GetResult> {\n try {\n const file = this.file(name);\n const [metadata] = await file.getMetadata();\n return {\n generation: Number(metadata.generation ?? 0),\n metadata: (metadata.metadata ?? {}) as Record<string, string>,\n };\n } catch (e) {\n if (isNotFound(e)) return null;\n throw e;\n }\n }\n\n private parseLockUntil(metadata: Record<string, string> | undefined): number {\n const raw = metadata?.lockUntil;\n if (!raw) throw new LockException('Corrupted lock record: missing lockUntil');\n const ms = Date.parse(raw);\n if (Number.isNaN(ms)) throw new LockException(`Corrupted lock record: unparseable lockUntil '${raw}'`);\n return ms;\n }\n\n private buildMetadata(config: LockConfiguration): Record<string, string> {\n return {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: Utils.toIsoString(config.createdAt),\n lockedBy: this.getHostname(),\n lockName: config.name,\n };\n }\n\n override async insertRecord(config: LockConfiguration): Promise<boolean> {\n const file = this.file(config.name);\n const [exists] = await file.exists();\n if (exists) return false;\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: 0 },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async updateRecord(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) throw new LockException(`Lock record not found: ${config.name}`);\n const lockUntil = this.parseLockUntil(current.metadata);\n if (lockUntil > ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: current.generation },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async unlock(config: LockConfiguration): Promise<void> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(unlockTime(config)),\n lockedAt: current.metadata.lockedAt ?? Utils.toIsoString(config.createdAt),\n lockedBy: current.metadata.lockedBy ?? this.getHostname(),\n lockName: current.metadata.lockName ?? config.name,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n } catch (e) {\n if (isPreconditionFailed(e)) return;\n throw e;\n }\n }\n\n override async extend(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return false;\n const lockUntil = this.parseLockUntil(current.metadata);\n const lockedBy = current.metadata.lockedBy;\n if (lockedBy !== this.getHostname()) return false;\n if (lockUntil <= ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: current.metadata.lockedAt,\n lockedBy: current.metadata.lockedBy,\n lockName: current.metadata.lockName,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n}\n","function getCode(e: unknown): number | undefined {\n if (e && typeof e === 'object') {\n const obj = e as Record<string, unknown>;\n const code = obj.code ?? obj.status;\n return typeof code === 'number' ? code : undefined;\n }\n return undefined;\n}\n\nexport function isNotFound(e: unknown): boolean {\n return getCode(e) === 404;\n}\n\nexport function isPreconditionFailed(e: unknown): boolean {\n return getCode(e) === 412;\n}\n","import { LockException, Utils } from '@tslock/core';\n\nexport interface GcsProviderConfig {\n bucket: string;\n objectPrefix: string;\n lockedBy: string;\n}\n\nexport function createGcsProviderConfig(input: {\n bucket: string;\n objectPrefix?: string;\n lockedBy?: string;\n}): GcsProviderConfig {\n if (!input.bucket) {\n throw new LockException('bucket must be a non-empty string');\n }\n return {\n bucket: input.bucket,\n objectPrefix: input.objectPrefix ?? 'shedlock/',\n lockedBy: input.lockedBy ?? Utils.getHostname(),\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,IAAAA,eAKO;;;ACLP,kBAQO;;;ACTP,SAAS,QAAQ,GAAgC;AAC/C,MAAI,KAAK,OAAO,MAAM,UAAU;AAC9B,UAAM,MAAM;AACZ,UAAM,OAAO,IAAI,QAAQ,IAAI;AAC7B,WAAO,OAAO,SAAS,WAAW,OAAO;AAAA,EAC3C;AACA,SAAO;AACT;AAEO,SAAS,WAAW,GAAqB;AAC9C,SAAO,QAAQ,CAAC,MAAM;AACxB;AAEO,SAAS,qBAAqB,GAAqB;AACxD,SAAO,QAAQ,CAAC,MAAM;AACxB;;;ADGO,IAAM,qBAAN,cAAiC,oCAAwB;AAAA,EAC9D,YACmB,SACA,QACjB;AACA,UAAM;AAHW;AACA;AAAA,EAGnB;AAAA,EAJmB;AAAA,EACA;AAAA,EAKA,cAAsB;AACvC,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEQ,UAAU,MAAsB;AACtC,WAAO,KAAK,OAAO,eAAe;AAAA,EACpC;AAAA,EAEQ,KAAK,MAAiE;AAC5E,WAAO,KAAK,QAAQ,OAAO,KAAK,OAAO,MAAM,EAAE,KAAK,KAAK,UAAU,IAAI,CAAC;AAAA,EAC1E;AAAA,EAEA,MAAc,gBAAgB,MAAkC;AAC9D,QAAI;AACF,YAAM,OAAO,KAAK,KAAK,IAAI;AAC3B,YAAM,CAAC,QAAQ,IAAI,MAAM,KAAK,YAAY;AAC1C,aAAO;AAAA,QACL,YAAY,OAAO,SAAS,cAAc,CAAC;AAAA,QAC3C,UAAW,SAAS,YAAY,CAAC;AAAA,MACnC;AAAA,IACF,SAAS,GAAG;AACV,UAAI,WAAW,CAAC,EAAG,QAAO;AAC1B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,eAAe,UAAsD;AAC3E,UAAM,MAAM,UAAU;AACtB,QAAI,CAAC,IAAK,OAAM,IAAI,0BAAc,0CAA0C;AAC5E,UAAM,KAAK,KAAK,MAAM,GAAG;AACzB,QAAI,OAAO,MAAM,EAAE,EAAG,OAAM,IAAI,0BAAc,iDAAiD,GAAG,GAAG;AACrG,WAAO;AAAA,EACT;AAAA,EAEQ,cAAc,QAAmD;AACvE,WAAO;AAAA,MACL,WAAW,kBAAM,gBAAY,6BAAgB,MAAM,CAAC;AAAA,MACpD,UAAU,kBAAM,YAAY,OAAO,SAAS;AAAA,MAC5C,UAAU,KAAK,YAAY;AAAA,MAC3B,UAAU,OAAO;AAAA,IACnB;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,UAAM,CAAC,MAAM,IAAI,MAAM,KAAK,OAAO;AACnC,QAAI,OAAQ,QAAO;AACnB,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,EAAE;AAAA,MAC3C,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,OAAM,IAAI,0BAAc,0BAA0B,OAAO,IAAI,EAAE;AACrF,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,QAAI,YAAY,0BAAc,IAAI,EAAG,QAAO;AAC5C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW;AAAA,MAC5D,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA0C;AAC9D,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM;AACtB,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,kBAAM,gBAAY,wBAAW,MAAM,CAAC;AAAA,UAC/C,UAAU,QAAQ,SAAS,YAAY,kBAAM,YAAY,OAAO,SAAS;AAAA,UACzE,UAAU,QAAQ,SAAS,YAAY,KAAK,YAAY;AAAA,UACxD,UAAU,QAAQ,SAAS,YAAY,OAAO;AAAA,QAChD;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AAAA,IACF,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG;AAC7B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA6C;AACjE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,QAAO;AAC7B,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,UAAM,WAAW,QAAQ,SAAS;AAClC,QAAI,aAAa,KAAK,YAAY,EAAG,QAAO;AAC5C,QAAI,aAAa,0BAAc,IAAI,EAAG,QAAO;AAC7C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,kBAAM,gBAAY,6BAAgB,MAAM,CAAC;AAAA,UACpD,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,QAC7B;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AACA,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AACF;;;AD3IO,IAAM,kBAAN,MAAwD;AAAA,EAC5C;AAAA,EAEjB,YAAY,SAAkB,QAA2B;AACvD,UAAM,WAAW,IAAI,mBAAmB,SAAS,MAAM;AACvD,SAAK,WAAW,IAAI,sCAAyB,QAAQ;AAAA,EACvD;AAAA,EAEA,KAAK,QAA4D;AAC/D,WAAO,KAAK,SAAS,KAAK,MAAM;AAAA,EAClC;AAAA,EAEA,WAAW,MAAoB;AAC7B,SAAK,SAAS,WAAW,IAAI;AAAA,EAC/B;AACF;;;AGzBA,IAAAC,eAAqC;AAQ9B,SAAS,wBAAwB,OAIlB;AACpB,MAAI,CAAC,MAAM,QAAQ;AACjB,UAAM,IAAI,2BAAc,mCAAmC;AAAA,EAC7D;AACA,SAAO;AAAA,IACL,QAAQ,MAAM;AAAA,IACd,cAAc,MAAM,gBAAgB;AAAA,IACpC,UAAU,MAAM,YAAY,mBAAM,YAAY;AAAA,EAChD;AACF;","names":["import_core","import_core"]}
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/gcs-lock-provider.ts","../src/gcs-storage-accessor.ts","../src/gcs-errors.ts","../src/gcs-provider-config.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage';\nimport {\n type ExtensibleLockProvider,\n type LockConfiguration,\n type SimpleLock,\n StorageBasedLockProvider,\n} from '@tslock/core';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\nimport { GcsStorageAccessor } from './gcs-storage-accessor.js';\n\nexport class GcsLockProvider implements ExtensibleLockProvider {\n private readonly delegate: StorageBasedLockProvider;\n\n constructor(storage: Storage, config: GcsProviderConfig) {\n const accessor = new GcsStorageAccessor(storage, config);\n this.delegate = new StorageBasedLockProvider(accessor);\n }\n\n lock(config: LockConfiguration): Promise<SimpleLock | undefined> {\n return this.delegate.lock(config);\n }\n\n clearCache(name: string): void {\n this.delegate.clearCache(name);\n }\n}\n","import type { FileMetadata, SaveOptions, Storage } from '@google-cloud/storage';\nimport {\n AbstractStorageAccessor,\n ClockProvider,\n type LockConfiguration,\n LockException,\n Utils,\n lockAtMostUntil,\n unlockTime,\n} from '@tslock/core';\nimport { isNotFound, isPreconditionFailed } from './gcs-errors.js';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\n\ntype GetResult = {\n generation: number;\n metadata: Record<string, string>;\n} | null;\n\nexport class GcsStorageAccessor extends AbstractStorageAccessor {\n constructor(\n private readonly storage: Storage,\n private readonly config: GcsProviderConfig,\n ) {\n super();\n }\n\n protected override getHostname(): string {\n return this.config.lockedBy;\n }\n\n private objectKey(name: string): string {\n return this.config.objectPrefix + name;\n }\n\n private file(name: string): ReturnType<ReturnType<Storage['bucket']>['file']> {\n return this.storage.bucket(this.config.bucket).file(this.objectKey(name));\n }\n\n private async getWithMetadata(name: string): Promise<GetResult> {\n try {\n const file = this.file(name);\n const [metadata] = await file.getMetadata();\n return {\n generation: Number(metadata.generation ?? 0),\n metadata: (metadata.metadata ?? {}) as Record<string, string>,\n };\n } catch (e) {\n if (isNotFound(e)) return null;\n throw e;\n }\n }\n\n private parseLockUntil(metadata: Record<string, string> | undefined): number {\n const raw = metadata?.lockUntil;\n if (!raw) throw new LockException('Corrupted lock record: missing lockUntil');\n const ms = Date.parse(raw);\n if (Number.isNaN(ms)) throw new LockException(`Corrupted lock record: unparseable lockUntil '${raw}'`);\n return ms;\n }\n\n private buildMetadata(config: LockConfiguration): Record<string, string> {\n return {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: Utils.toIsoString(config.createdAt),\n lockedBy: this.getHostname(),\n lockName: config.name,\n };\n }\n\n override async insertRecord(config: LockConfiguration): Promise<boolean> {\n const file = this.file(config.name);\n const [exists] = await file.exists();\n if (exists) return false;\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: 0 },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async updateRecord(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) throw new LockException(`Lock record not found: ${config.name}`);\n const lockUntil = this.parseLockUntil(current.metadata);\n if (lockUntil > ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: current.generation },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async unlock(config: LockConfiguration): Promise<void> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(unlockTime(config)),\n lockedAt: current.metadata.lockedAt ?? Utils.toIsoString(config.createdAt),\n lockedBy: current.metadata.lockedBy ?? this.getHostname(),\n lockName: current.metadata.lockName ?? config.name,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n } catch (e) {\n if (isPreconditionFailed(e)) return;\n throw e;\n }\n }\n\n override async extend(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return false;\n const lockUntil = this.parseLockUntil(current.metadata);\n const lockedBy = current.metadata.lockedBy;\n if (lockedBy !== this.getHostname()) return false;\n if (lockUntil <= ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: current.metadata.lockedAt,\n lockedBy: current.metadata.lockedBy,\n lockName: current.metadata.lockName,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n}\n","function getCode(e: unknown): number | undefined {\n if (e && typeof e === 'object') {\n const obj = e as Record<string, unknown>;\n const code = obj.code ?? obj.status;\n return typeof code === 'number' ? code : undefined;\n }\n return undefined;\n}\n\nexport function isNotFound(e: unknown): boolean {\n return getCode(e) === 404;\n}\n\nexport function isPreconditionFailed(e: unknown): boolean {\n return getCode(e) === 412;\n}\n","import { LockException, Utils } from '@tslock/core';\n\nexport interface GcsProviderConfig {\n bucket: string;\n objectPrefix: string;\n lockedBy: string;\n}\n\nexport function createGcsProviderConfig(input: {\n bucket: string;\n objectPrefix?: string;\n lockedBy?: string;\n}): GcsProviderConfig {\n if (!input.bucket) {\n throw new LockException('bucket must be a non-empty string');\n }\n return {\n bucket: input.bucket,\n objectPrefix: input.objectPrefix ?? 'shedlock/',\n lockedBy: input.lockedBy ?? Utils.getHostname(),\n };\n}\n"],"mappings":";AACA;AAAA,EAIE;AAAA,OACK;;;ACLP;AAAA,EACE;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;ACTP,SAAS,QAAQ,GAAgC;AAC/C,MAAI,KAAK,OAAO,MAAM,UAAU;AAC9B,UAAM,MAAM;AACZ,UAAM,OAAO,IAAI,QAAQ,IAAI;AAC7B,WAAO,OAAO,SAAS,WAAW,OAAO;AAAA,EAC3C;AACA,SAAO;AACT;AAEO,SAAS,WAAW,GAAqB;AAC9C,SAAO,QAAQ,CAAC,MAAM;AACxB;AAEO,SAAS,qBAAqB,GAAqB;AACxD,SAAO,QAAQ,CAAC,MAAM;AACxB;;;ADGO,IAAM,qBAAN,cAAiC,wBAAwB;AAAA,EAC9D,YACmB,SACA,QACjB;AACA,UAAM;AAHW;AACA;AAAA,EAGnB;AAAA,EAJmB;AAAA,EACA;AAAA,EAKA,cAAsB;AACvC,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEQ,UAAU,MAAsB;AACtC,WAAO,KAAK,OAAO,eAAe;AAAA,EACpC;AAAA,EAEQ,KAAK,MAAiE;AAC5E,WAAO,KAAK,QAAQ,OAAO,KAAK,OAAO,MAAM,EAAE,KAAK,KAAK,UAAU,IAAI,CAAC;AAAA,EAC1E;AAAA,EAEA,MAAc,gBAAgB,MAAkC;AAC9D,QAAI;AACF,YAAM,OAAO,KAAK,KAAK,IAAI;AAC3B,YAAM,CAAC,QAAQ,IAAI,MAAM,KAAK,YAAY;AAC1C,aAAO;AAAA,QACL,YAAY,OAAO,SAAS,cAAc,CAAC;AAAA,QAC3C,UAAW,SAAS,YAAY,CAAC;AAAA,MACnC;AAAA,IACF,SAAS,GAAG;AACV,UAAI,WAAW,CAAC,EAAG,QAAO;AAC1B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,eAAe,UAAsD;AAC3E,UAAM,MAAM,UAAU;AACtB,QAAI,CAAC,IAAK,OAAM,IAAI,cAAc,0CAA0C;AAC5E,UAAM,KAAK,KAAK,MAAM,GAAG;AACzB,QAAI,OAAO,MAAM,EAAE,EAAG,OAAM,IAAI,cAAc,iDAAiD,GAAG,GAAG;AACrG,WAAO;AAAA,EACT;AAAA,EAEQ,cAAc,QAAmD;AACvE,WAAO;AAAA,MACL,WAAW,MAAM,YAAY,gBAAgB,MAAM,CAAC;AAAA,MACpD,UAAU,MAAM,YAAY,OAAO,SAAS;AAAA,MAC5C,UAAU,KAAK,YAAY;AAAA,MAC3B,UAAU,OAAO;AAAA,IACnB;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,UAAM,CAAC,MAAM,IAAI,MAAM,KAAK,OAAO;AACnC,QAAI,OAAQ,QAAO;AACnB,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,EAAE;AAAA,MAC3C,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,OAAM,IAAI,cAAc,0BAA0B,OAAO,IAAI,EAAE;AACrF,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,QAAI,YAAY,cAAc,IAAI,EAAG,QAAO;AAC5C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW;AAAA,MAC5D,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA0C;AAC9D,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM;AACtB,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,MAAM,YAAY,WAAW,MAAM,CAAC;AAAA,UAC/C,UAAU,QAAQ,SAAS,YAAY,MAAM,YAAY,OAAO,SAAS;AAAA,UACzE,UAAU,QAAQ,SAAS,YAAY,KAAK,YAAY;AAAA,UACxD,UAAU,QAAQ,SAAS,YAAY,OAAO;AAAA,QAChD;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AAAA,IACF,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG;AAC7B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA6C;AACjE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,QAAO;AAC7B,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,UAAM,WAAW,QAAQ,SAAS;AAClC,QAAI,aAAa,KAAK,YAAY,EAAG,QAAO;AAC5C,QAAI,aAAa,cAAc,IAAI,EAAG,QAAO;AAC7C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,MAAM,YAAY,gBAAgB,MAAM,CAAC;AAAA,UACpD,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,QAC7B;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AACA,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AACF;;;AD3IO,IAAM,kBAAN,MAAwD;AAAA,EAC5C;AAAA,EAEjB,YAAY,SAAkB,QAA2B;AACvD,UAAM,WAAW,IAAI,mBAAmB,SAAS,MAAM;AACvD,SAAK,WAAW,IAAI,yBAAyB,QAAQ;AAAA,EACvD;AAAA,EAEA,KAAK,QAA4D;AAC/D,WAAO,KAAK,SAAS,KAAK,MAAM;AAAA,EAClC;AAAA,EAEA,WAAW,MAAoB;AAC7B,SAAK,SAAS,WAAW,IAAI;AAAA,EAC/B;AACF;;;AGzBA,SAAS,iBAAAA,gBAAe,SAAAC,cAAa;AAQ9B,SAAS,wBAAwB,OAIlB;AACpB,MAAI,CAAC,MAAM,QAAQ;AACjB,UAAM,IAAID,eAAc,mCAAmC;AAAA,EAC7D;AACA,SAAO;AAAA,IACL,QAAQ,MAAM;AAAA,IACd,cAAc,MAAM,gBAAgB;AAAA,IACpC,UAAU,MAAM,YAAYC,OAAM,YAAY;AAAA,EAChD;AACF;","names":["LockException","Utils"]}
|
|
1
|
+
{"version":3,"sources":["../src/gcs-lock-provider.ts","../src/gcs-storage-accessor.ts","../src/gcs-errors.ts","../src/gcs-provider-config.ts"],"sourcesContent":["import type { Storage } from '@google-cloud/storage';\nimport {\n type ExtensibleLockProvider,\n type LockConfiguration,\n type SimpleLock,\n StorageBasedLockProvider,\n} from '@tslock/core';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\nimport { GcsStorageAccessor } from './gcs-storage-accessor.js';\n\nexport class GcsLockProvider implements ExtensibleLockProvider {\n private readonly delegate: StorageBasedLockProvider;\n\n constructor(storage: Storage, config: GcsProviderConfig) {\n const accessor = new GcsStorageAccessor(storage, config);\n this.delegate = new StorageBasedLockProvider(accessor);\n }\n\n lock(config: LockConfiguration): Promise<SimpleLock | undefined> {\n return this.delegate.lock(config);\n }\n\n clearCache(name: string): void {\n this.delegate.clearCache(name);\n }\n}\n","import type { FileMetadata, SaveOptions, Storage } from '@google-cloud/storage';\nimport {\n AbstractStorageAccessor,\n ClockProvider,\n type LockConfiguration,\n LockException,\n lockAtMostUntil,\n Utils,\n unlockTime,\n} from '@tslock/core';\nimport { isNotFound, isPreconditionFailed } from './gcs-errors.js';\nimport type { GcsProviderConfig } from './gcs-provider-config.js';\n\ntype GetResult = {\n generation: number;\n metadata: Record<string, string>;\n} | null;\n\nexport class GcsStorageAccessor extends AbstractStorageAccessor {\n constructor(\n private readonly storage: Storage,\n private readonly config: GcsProviderConfig,\n ) {\n super();\n }\n\n protected override getHostname(): string {\n return this.config.lockedBy;\n }\n\n private objectKey(name: string): string {\n return this.config.objectPrefix + name;\n }\n\n private file(name: string): ReturnType<ReturnType<Storage['bucket']>['file']> {\n return this.storage.bucket(this.config.bucket).file(this.objectKey(name));\n }\n\n private async getWithMetadata(name: string): Promise<GetResult> {\n try {\n const file = this.file(name);\n const [metadata] = await file.getMetadata();\n return {\n generation: Number(metadata.generation ?? 0),\n metadata: (metadata.metadata ?? {}) as Record<string, string>,\n };\n } catch (e) {\n if (isNotFound(e)) return null;\n throw e;\n }\n }\n\n private parseLockUntil(metadata: Record<string, string> | undefined): number {\n const raw = metadata?.lockUntil;\n if (!raw) throw new LockException('Corrupted lock record: missing lockUntil');\n const ms = Date.parse(raw);\n if (Number.isNaN(ms)) throw new LockException(`Corrupted lock record: unparseable lockUntil '${raw}'`);\n return ms;\n }\n\n private buildMetadata(config: LockConfiguration): Record<string, string> {\n return {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: Utils.toIsoString(config.createdAt),\n lockedBy: this.getHostname(),\n lockName: config.name,\n };\n }\n\n override async insertRecord(config: LockConfiguration): Promise<boolean> {\n const file = this.file(config.name);\n const [exists] = await file.exists();\n if (exists) return false;\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: 0 },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async updateRecord(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) throw new LockException(`Lock record not found: ${config.name}`);\n const lockUntil = this.parseLockUntil(current.metadata);\n if (lockUntil > ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.save('', {\n metadata: this.buildMetadata(config),\n gzip: false,\n preconditionOpts: { ifGenerationMatch: current.generation },\n } as SaveOptions);\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n\n override async unlock(config: LockConfiguration): Promise<void> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(unlockTime(config)),\n lockedAt: current.metadata.lockedAt ?? Utils.toIsoString(config.createdAt),\n lockedBy: current.metadata.lockedBy ?? this.getHostname(),\n lockName: current.metadata.lockName ?? config.name,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n } catch (e) {\n if (isPreconditionFailed(e)) return;\n throw e;\n }\n }\n\n override async extend(config: LockConfiguration): Promise<boolean> {\n const current = await this.getWithMetadata(config.name);\n if (current === null) return false;\n const lockUntil = this.parseLockUntil(current.metadata);\n const lockedBy = current.metadata.lockedBy;\n if (lockedBy !== this.getHostname()) return false;\n if (lockUntil <= ClockProvider.now()) return false;\n const file = this.file(config.name);\n try {\n await file.setMetadata(\n {\n lockUntil: Utils.toIsoString(lockAtMostUntil(config)),\n lockedAt: current.metadata.lockedAt,\n lockedBy: current.metadata.lockedBy,\n lockName: current.metadata.lockName,\n } as FileMetadata,\n { preconditionOpts: { ifGenerationMatch: current.generation } },\n );\n return true;\n } catch (e) {\n if (isPreconditionFailed(e)) return false;\n throw e;\n }\n }\n}\n","function getCode(e: unknown): number | undefined {\n if (e && typeof e === 'object') {\n const obj = e as Record<string, unknown>;\n const code = obj.code ?? obj.status;\n return typeof code === 'number' ? code : undefined;\n }\n return undefined;\n}\n\nexport function isNotFound(e: unknown): boolean {\n return getCode(e) === 404;\n}\n\nexport function isPreconditionFailed(e: unknown): boolean {\n return getCode(e) === 412;\n}\n","import { LockException, Utils } from '@tslock/core';\n\nexport interface GcsProviderConfig {\n bucket: string;\n objectPrefix: string;\n lockedBy: string;\n}\n\nexport function createGcsProviderConfig(input: {\n bucket: string;\n objectPrefix?: string;\n lockedBy?: string;\n}): GcsProviderConfig {\n if (!input.bucket) {\n throw new LockException('bucket must be a non-empty string');\n }\n return {\n bucket: input.bucket,\n objectPrefix: input.objectPrefix ?? 'shedlock/',\n lockedBy: input.lockedBy ?? Utils.getHostname(),\n };\n}\n"],"mappings":";AACA;AAAA,EAIE;AAAA,OACK;;;ACLP;AAAA,EACE;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;ACTP,SAAS,QAAQ,GAAgC;AAC/C,MAAI,KAAK,OAAO,MAAM,UAAU;AAC9B,UAAM,MAAM;AACZ,UAAM,OAAO,IAAI,QAAQ,IAAI;AAC7B,WAAO,OAAO,SAAS,WAAW,OAAO;AAAA,EAC3C;AACA,SAAO;AACT;AAEO,SAAS,WAAW,GAAqB;AAC9C,SAAO,QAAQ,CAAC,MAAM;AACxB;AAEO,SAAS,qBAAqB,GAAqB;AACxD,SAAO,QAAQ,CAAC,MAAM;AACxB;;;ADGO,IAAM,qBAAN,cAAiC,wBAAwB;AAAA,EAC9D,YACmB,SACA,QACjB;AACA,UAAM;AAHW;AACA;AAAA,EAGnB;AAAA,EAJmB;AAAA,EACA;AAAA,EAKA,cAAsB;AACvC,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEQ,UAAU,MAAsB;AACtC,WAAO,KAAK,OAAO,eAAe;AAAA,EACpC;AAAA,EAEQ,KAAK,MAAiE;AAC5E,WAAO,KAAK,QAAQ,OAAO,KAAK,OAAO,MAAM,EAAE,KAAK,KAAK,UAAU,IAAI,CAAC;AAAA,EAC1E;AAAA,EAEA,MAAc,gBAAgB,MAAkC;AAC9D,QAAI;AACF,YAAM,OAAO,KAAK,KAAK,IAAI;AAC3B,YAAM,CAAC,QAAQ,IAAI,MAAM,KAAK,YAAY;AAC1C,aAAO;AAAA,QACL,YAAY,OAAO,SAAS,cAAc,CAAC;AAAA,QAC3C,UAAW,SAAS,YAAY,CAAC;AAAA,MACnC;AAAA,IACF,SAAS,GAAG;AACV,UAAI,WAAW,CAAC,EAAG,QAAO;AAC1B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEQ,eAAe,UAAsD;AAC3E,UAAM,MAAM,UAAU;AACtB,QAAI,CAAC,IAAK,OAAM,IAAI,cAAc,0CAA0C;AAC5E,UAAM,KAAK,KAAK,MAAM,GAAG;AACzB,QAAI,OAAO,MAAM,EAAE,EAAG,OAAM,IAAI,cAAc,iDAAiD,GAAG,GAAG;AACrG,WAAO;AAAA,EACT;AAAA,EAEQ,cAAc,QAAmD;AACvE,WAAO;AAAA,MACL,WAAW,MAAM,YAAY,gBAAgB,MAAM,CAAC;AAAA,MACpD,UAAU,MAAM,YAAY,OAAO,SAAS;AAAA,MAC5C,UAAU,KAAK,YAAY;AAAA,MAC3B,UAAU,OAAO;AAAA,IACnB;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,UAAM,CAAC,MAAM,IAAI,MAAM,KAAK,OAAO;AACnC,QAAI,OAAQ,QAAO;AACnB,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,EAAE;AAAA,MAC3C,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,aAAa,QAA6C;AACvE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,OAAM,IAAI,cAAc,0BAA0B,OAAO,IAAI,EAAE;AACrF,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,QAAI,YAAY,cAAc,IAAI,EAAG,QAAO;AAC5C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB,UAAU,KAAK,cAAc,MAAM;AAAA,QACnC,MAAM;AAAA,QACN,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW;AAAA,MAC5D,CAAgB;AAChB,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA0C;AAC9D,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM;AACtB,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,MAAM,YAAY,WAAW,MAAM,CAAC;AAAA,UAC/C,UAAU,QAAQ,SAAS,YAAY,MAAM,YAAY,OAAO,SAAS;AAAA,UACzE,UAAU,QAAQ,SAAS,YAAY,KAAK,YAAY;AAAA,UACxD,UAAU,QAAQ,SAAS,YAAY,OAAO;AAAA,QAChD;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AAAA,IACF,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG;AAC7B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAe,OAAO,QAA6C;AACjE,UAAM,UAAU,MAAM,KAAK,gBAAgB,OAAO,IAAI;AACtD,QAAI,YAAY,KAAM,QAAO;AAC7B,UAAM,YAAY,KAAK,eAAe,QAAQ,QAAQ;AACtD,UAAM,WAAW,QAAQ,SAAS;AAClC,QAAI,aAAa,KAAK,YAAY,EAAG,QAAO;AAC5C,QAAI,aAAa,cAAc,IAAI,EAAG,QAAO;AAC7C,UAAM,OAAO,KAAK,KAAK,OAAO,IAAI;AAClC,QAAI;AACF,YAAM,KAAK;AAAA,QACT;AAAA,UACE,WAAW,MAAM,YAAY,gBAAgB,MAAM,CAAC;AAAA,UACpD,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,UAC3B,UAAU,QAAQ,SAAS;AAAA,QAC7B;AAAA,QACA,EAAE,kBAAkB,EAAE,mBAAmB,QAAQ,WAAW,EAAE;AAAA,MAChE;AACA,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,qBAAqB,CAAC,EAAG,QAAO;AACpC,YAAM;AAAA,IACR;AAAA,EACF;AACF;;;AD3IO,IAAM,kBAAN,MAAwD;AAAA,EAC5C;AAAA,EAEjB,YAAY,SAAkB,QAA2B;AACvD,UAAM,WAAW,IAAI,mBAAmB,SAAS,MAAM;AACvD,SAAK,WAAW,IAAI,yBAAyB,QAAQ;AAAA,EACvD;AAAA,EAEA,KAAK,QAA4D;AAC/D,WAAO,KAAK,SAAS,KAAK,MAAM;AAAA,EAClC;AAAA,EAEA,WAAW,MAAoB;AAC7B,SAAK,SAAS,WAAW,IAAI;AAAA,EAC/B;AACF;;;AGzBA,SAAS,iBAAAA,gBAAe,SAAAC,cAAa;AAQ9B,SAAS,wBAAwB,OAIlB;AACpB,MAAI,CAAC,MAAM,QAAQ;AACjB,UAAM,IAAID,eAAc,mCAAmC;AAAA,EAC7D;AACA,SAAO;AAAA,IACL,QAAQ,MAAM;AAAA,IACd,cAAc,MAAM,gBAAgB;AAAA,IACpC,UAAU,MAAM,YAAYC,OAAM,YAAY;AAAA,EAChD;AACF;","names":["LockException","Utils"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tslock/gcs",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.2.0",
|
|
4
4
|
"description": "Google Cloud Storage-backed distributed lock provider for TSLock",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
},
|
|
24
24
|
"peerDependencies": {
|
|
25
25
|
"@google-cloud/storage": "^7.7.0",
|
|
26
|
-
"@tslock/core": "2.
|
|
26
|
+
"@tslock/core": "2.2.0"
|
|
27
27
|
},
|
|
28
28
|
"peerDependenciesMeta": {
|
|
29
29
|
"@tslock/core": {
|
|
@@ -39,8 +39,8 @@
|
|
|
39
39
|
"typescript": "^7.0.2",
|
|
40
40
|
"tsup": "^8.0.0",
|
|
41
41
|
"@types/node": "^26.6.3",
|
|
42
|
-
"@tslock/
|
|
43
|
-
"@tslock/
|
|
42
|
+
"@tslock/core": "2.2.0",
|
|
43
|
+
"@tslock/test-support": "2.2.0"
|
|
44
44
|
},
|
|
45
45
|
"publishConfig": {
|
|
46
46
|
"access": "public"
|