@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
181 lines • 6.24 kB
JavaScript
import { DefaultAdapterNotDefinedError, KeyPrefixer, resolveOneOrMore, UnregisteredAdapterError, } from "../../../../utilities/_module-exports.js";
import { LockProvider, } from "../../../../lock/implementations/derivables/lock-provider/_module.js";
/**
* The `LockProviderFactory` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/lock"`
* @group Derivables
*/
export class LockProviderFactory {
settings;
/**
* @example
* ```ts
* import { LockProviderFactory } from "@daiso-tech/core/lock";
* import type { IDatabaseLockAdapter } from "@daiso-tech/core/lock/contracts";
* import { MemoryLockAdapter, RedisLockAdapter, SqliteLockAdapter } from "@daiso-tech/core/lock/adapters";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters";
* import { KeyPrefixer, type ISqliteDatabase, type AsyncFactoryFn } from "@daiso-tech/core/utilities";
* import Redis from "ioredis"
* import Sqlite from "better-sqlite3";
*
* function lockAdapterFactory(database: ISqliteDatabase): AsyncFactoryFn<string, IDatabaseLockAdapter> {
* return async (prefix) => {
* const lockAdapter = new SqliteLockAdapter({
* database,
* tableName: `lock_${prefix}`
* });
* await lockAdapter.init();
* return lockAdapter;
* }
* }
*
* const database = new Sqlite("local.db");
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const lockProviderFactory = new LockProviderFactory({
* serde,
* keyPrefixer: new KeyPrefixer("lock"),
* adapters: {
* sqlite: lockAdapterFactory(database),
* memory: new MemoryLockAdapter(),
* redis: new RedisLockAdapter({
* client: new Redis("YOUR_REDIS_CONNECTION"),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings) {
this.settings = settings;
}
setKeyPrefixer(keyPrefixer) {
return new LockProviderFactory({
...this.settings,
keyPrefixer,
});
}
setCreateOwnerId(createId) {
return new LockProviderFactory({
...this.settings,
createOwnerId: createId,
});
}
setEventBus(eventBus) {
return new LockProviderFactory({
...this.settings,
eventBus,
});
}
setDefaultTtl(ttl) {
return new LockProviderFactory({
...this.settings,
defaultTtl: ttl,
});
}
setDefaultBlockingInterval(interval) {
return new LockProviderFactory({
...this.settings,
defaultBlockingInterval: interval,
});
}
setDefaultBlockingTime(time) {
return new LockProviderFactory({
...this.settings,
defaultBlockingTime: time,
});
}
setDefaultRefreshTime(time) {
return new LockProviderFactory({
...this.settings,
defaultRefreshTime: time,
});
}
setLazyPromiseFactory(factory) {
return new LockProviderFactory({
...this.settings,
lazyPromiseFactory: factory,
});
}
/**
* @example
* ```ts
* import { LockProviderFactory } from "@daiso-tech/core/lock";
* import type { IDatabaseLockAdapter } from "@daiso-tech/core/lock/contracts";
* import { MemoryLockAdapter, RedisLockAdapter, SqliteLockAdapter } from "@daiso-tech/core/lock/adapters";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters";
* import { KeyPrefixer, TimeSpan, type ISqliteDatabase, type AsyncFactoryFn } from "@daiso-tech/core/utilities";
* import Redis from "ioredis"
* import Sqlite from "better-sqlite3";
*
* function lockAdapterFactory(database: ISqliteDatabase): AsyncFactoryFn<string, IDatabaseLockAdapter> {
* return async (prefix) => {
* const lockAdapter = new SqliteLockAdapter({
* database,
* tableName: `lock_${prefix}`
* });
* await lockAdapter.init();
* return lockAdapter;
* }
* }
*
* const database = new Sqlite("local.db");
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const lockProviderFactory = new LockProviderFactory({
* serde,
* keyPrefixer: new KeyPrefixer("lock"),
* adapters: {
* sqlite: lockAdapterFactory(database),
* memory: new MemoryLockAdapter(),
* redis: new RedisLockAdapter({
* client: new Redis("YOUR_REDIS_CONNECTION"),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
*
* // Will acquire key using the default adapter which is MemoryLockAdapter
* await lockProviderFactory
* .use()
* .create("a")
* .acquire();
*
* // Will acquire key using the redis adapter which is RedisLockAdapter
* await lockProviderFactory
* .use("redis")
* .create("a")
* .acquire();
*
* // You can change the default settings of the returned Lock instance.
* await lockProviderFactory
* .setDefaultTtl(TimeSpan.fromMinutes(2))
* .use("sqlite")
* .create("a")
* .acquire();
* ```
*/
use(adapterName = this.settings.defaultAdapter) {
if (adapterName === undefined) {
throw new DefaultAdapterNotDefinedError(LockProviderFactory.name);
}
const adapter = this.settings.adapters[adapterName];
if (adapter === undefined) {
throw new UnregisteredAdapterError(adapterName);
}
const { keyPrefixer } = this.settings;
return new LockProvider({
...this.settings,
adapter,
keyPrefixer: new KeyPrefixer([
...resolveOneOrMore(keyPrefixer.originalRootPrefix),
adapterName,
]),
serdeTransformerName: adapterName,
});
}
}
//# sourceMappingURL=lock-provider-factory.js.map