refactor: remove drivers entrypoints and move factory

Author: Julien-R44

packages/bentocache/benchmarks/mtier_get_key.ts

@@ -11,9 +11,9 @@ import { multiCaching, caching } from 'cache-manager'
 import { redisStore } from 'cache-manager-ioredis-yet'
 
 import { BentoCache } from '../index.js'
-import { redisDriver } from '../drivers/redis.js'
 import { bentostore } from '../src/bento_store.js'
-import { memoryDriver } from '../drivers/memory.js'
+import { redisDriver } from '../src/drivers/redis.js'
+import { memoryDriver } from '../src/drivers/memory.js'
 import { REDIS_CREDENTIALS } from '../test_helpers/index.js'
 
 const bench = new Bench()

packages/bentocache/benchmarks/mtier_set_key.ts

@@ -11,9 +11,9 @@ import { multiCaching, caching } from 'cache-manager'
 import { redisStore } from 'cache-manager-ioredis-yet'
 
 import { BentoCache } from '../index.js'
-import { redisDriver } from '../drivers/redis.js'
 import { bentostore } from '../src/bento_store.js'
-import { memoryDriver } from '../drivers/memory.js'
+import { redisDriver } from '../src/drivers/redis.js'
+import { memoryDriver } from '../src/drivers/memory.js'
 import { REDIS_CREDENTIALS } from '../test_helpers/index.js'
 
 const bench = new Bench()

packages/bentocache/benchmarks/onetier_get_key.ts

@@ -10,8 +10,8 @@ import { caching } from 'cache-manager'
 import { redisStore } from 'cache-manager-ioredis-yet'
 
 import { BentoCache } from '../index.js'
-import { redisDriver } from '../drivers/redis.js'
 import { bentostore } from '../src/bento_store.js'
+import { redisDriver } from '../src/drivers/redis.js'
 import { REDIS_CREDENTIALS } from '../test_helpers/index.js'
 
 const bench = new Bench()

packages/bentocache/benchmarks/onetier_set_key.ts

@@ -9,7 +9,7 @@ import { caching } from 'cache-manager'
 
 import { BentoCache } from '../index.js'
 import { bentostore } from '../src/bento_store.js'
-import { memoryDriver } from '../drivers/memory.js'
+import { memoryDriver } from '../src/drivers/memory.js'
 
 const bench = new Bench()
 

packages/bentocache/drivers/dynamodb.ts

@@ -1,6 +1,6 @@
 import { bentostore } from '../src/bento_store.js'
 import { BentoCache } from '../src/bento_cache.js'
-import { memoryDriver } from '../drivers/memory.js'
+import { memoryDriver } from '../src/drivers/memory.js'
 import type { RawBentoCacheOptions } from '../src/types/main.js'
 
 /**

packages/bentocache/drivers/file.ts

@@ -15,7 +15,7 @@
   ],
   "exports": {
     ".": "./build/index.js",
-    "./drivers/*": "./build/drivers/*.js",
+    "./drivers/*": "./build/src/drivers/*.js",
     "./types": "./build/src/types/main.js",
     "./plugins/*": "./build/plugins/*.js",
     "./test_suite": "./build/src/test_suite.js"
@@ -112,7 +112,7 @@
     "entry": [
       "./index.ts",
       "./src/types/main.ts",
-      "./drivers/*.ts",
+      "./src/drivers/*.ts",
       "./plugins/*.ts",
       "./src/test_suite.ts"
     ],

packages/bentocache/drivers/knex.ts

@@ -11,7 +11,17 @@ import {
 } from '@aws-sdk/client-dynamodb'
 
 import { BaseDriver } from './base_driver.js'
-import type { CacheDriver, DynamoDBConfig } from '../types/main.js'
+import type { CacheDriver, CreateDriverResult, DynamoDBConfig } from '../types/main.js'
+
+/**
+ * Create a new DynamoDB driver
+ */
+export function dynamoDbDriver(options: DynamoDBConfig): CreateDriverResult<DynamoDB> {
+  return {
+    options,
+    factory: (config: DynamoDBConfig) => new DynamoDB(config),
+  }
+}
 
 /**
  * Caching driver for DynamoDB

packages/bentocache/drivers/kysely.ts

@@ -2,7 +2,17 @@ import { dirname, join } from 'node:path'
 import { access, mkdir, readFile, writeFile, rm } from 'node:fs/promises'
 
 import { BaseDriver } from './base_driver.js'
-import type { CacheDriver, FileConfig } from '../types/main.js'
+import type { CacheDriver, CreateDriverResult, FileConfig } from '../types/main.js'
+
+/**
+ * Create a new file driver
+ */
+export function fileDriver(options: FileConfig): CreateDriverResult<File> {
+  return {
+    options,
+    factory: (config: FileConfig) => new File(config),
+  }
+}
 
 /**
  * Caching driver for the filesystem

packages/bentocache/drivers/memory.ts

@@ -1,6 +1,21 @@
 import type { Knex } from 'knex'
 
-import type { DatabaseAdapter, KnexConfig } from '../types/main.js'
+import { DatabaseDriver } from './database.js'
+import type { CreateDriverResult, DatabaseAdapter, KnexConfig } from '../types/main.js'
+
+/**
+ * Create a knex driver
+ * You will need to install the underlying database package (mysql2, pg, sqlite3, etc)
+ */
+export function knexDriver(options: KnexConfig): CreateDriverResult<DatabaseDriver> {
+  return {
+    options,
+    factory: (config: KnexConfig) => {
+      const adapter = new KnexAdapter(config)
+      return new DatabaseDriver(adapter, config)
+    },
+  }
+}
 
 /**
  * Knex adapter for the DatabaseDriver

packages/bentocache/drivers/redis.ts

@@ -1,6 +1,21 @@
 import { SqliteAdapter, type Kysely, MysqlAdapter } from 'kysely'
 
-import type { DatabaseAdapter, KyselyConfig } from '../types/main.js'
+import { DatabaseDriver } from './database.js'
+import type { CreateDriverResult, DatabaseAdapter, KyselyConfig } from '../types/main.js'
+
+/**
+ * Create a kysely driver
+ * You will need to install the underlying database package (mysql2, pg, sqlite3, etc)
+ */
+export function kyselyDriver(options: KyselyConfig): CreateDriverResult<DatabaseDriver> {
+  return {
+    options,
+    factory: (config: KyselyConfig) => {
+      const adapter = new KyselyAdapter(config)
+      return new DatabaseDriver(adapter, config)
+    },
+  }
+}
 
 /**
  * Kysely adapter for the DatabaseDriver

packages/bentocache/factories/bentocache_factory.ts

@@ -1,7 +1,21 @@
 import { LRUCache } from 'lru-cache'
 
 import { BaseDriver } from './base_driver.js'
-import type { L1CacheDriver, MemoryConfig as MemoryConfig } from '../types/main.js'
+import type {
+  CreateDriverResult,
+  L1CacheDriver,
+  MemoryConfig as MemoryConfig,
+} from '../types/main.js'
+
+/**
+ * Create a new memory driver
+ */
+export function memoryDriver(options: MemoryConfig = {}): CreateDriverResult<Memory> {
+  return {
+    options,
+    factory: (config: MemoryConfig) => new Memory(config),
+  }
+}
 
 /**
  * A memory caching driver

packages/bentocache/package.json

@@ -1,7 +1,32 @@
 import { Redis as IoRedis } from 'ioredis'
+import type { RedisOptions as IoRedisOptions } from 'ioredis'
 
 import { BaseDriver } from './base_driver.js'
-import type { L2CacheDriver, RedisConfig } from '../types/main.js'
+import { RedisBus } from '../bus/drivers/redis_bus.js'
+import type {
+  BusOptions,
+  CreateBusDriverResult,
+  CreateDriverResult,
+  L2CacheDriver,
+  RedisConfig,
+} from '../types/main.js'
+
+/**
+ * Create a new cache redis driver
+ */
+export function redisDriver(options: RedisConfig): CreateDriverResult<Redis> {
+  return { options, factory: (config: RedisConfig) => new Redis(config) }
+}
+
+/**
+ * Create a new bus redis driver. It leverages the Pub/sub capabilities of Redis
+ * to sending messages between your different processes.
+ */
+export function redisBusDriver(
+  options: { connection: IoRedisOptions } & BusOptions,
+): CreateBusDriverResult {
+  return { options, factory: (config: IoRedisOptions) => new RedisBus(config) }
+}
 
 /**
  * Caching driver for Redis

packages/bentocache/src/drivers/dynamodb.ts

@@ -5,9 +5,9 @@ import EventEmitter from 'node:events'
 
 import { bentostore } from '../src/bento_store.js'
 import { BentoCache } from '../src/bento_cache.js'
-import { memoryDriver } from '../drivers/memory.js'
+import { memoryDriver } from '../src/drivers/memory.js'
 import { REDIS_CREDENTIALS } from '../test_helpers/index.js'
-import { redisBusDriver, redisDriver } from '../drivers/redis.js'
+import { redisBusDriver, redisDriver } from '../src/drivers/redis.js'
 import { BentoCacheFactory } from '../factories/bentocache_factory.js'
 
 test.group('Bento Cache', () => {

packages/bentocache/src/drivers/file.ts

@@ -2,7 +2,7 @@ import { test } from '@japa/runner'
 
 import { bentostore } from '../src/bento_store.js'
 import { BentoCache } from '../src/bento_cache.js'
-import { memoryDriver } from '../drivers/memory.js'
+import { memoryDriver } from '../src/drivers/memory.js'
 import type { Duration } from '../src/types/helpers.js'
 import type { CacheEvents } from '../src/types/events.js'
 import { CacheFactory } from '../factories/cache_factory.js'