refactor: add Driver suffix to all drivers

Julien-R44 · Julien-R44 · commit b718b954f5f2 · 2024-04-06T15:57:11.000+02:00
diff --git a/packages/bentocache/factories/cache_factory.ts b/packages/bentocache/factories/cache_factory.ts
@@ -2,8 +2,8 @@ import lodash from '@poppinss/utils/lodash'
 import { getActiveTest } from '@japa/runner'
 
 import { Cache } from '../src/cache/cache.js'
-import { Redis } from '../src/drivers/redis.js'
-import { Memory } from '../src/drivers/memory.js'
+import { RedisDriver } from '../src/drivers/redis.js'
+import { MemoryDriver } from '../src/drivers/memory.js'
 import { MemoryBus } from '../src/bus/drivers/memory_bus.js'
 import type { CacheStackDrivers } from '../src/types/main.js'
 import { CacheStack } from '../src/cache/stack/cache_stack.js'
@@ -62,24 +62,24 @@ export class CacheFactory {
    * Adds a Memory L1 driver to the cache stack
    */
   withMemoryL1() {
-    this.#parameters.l1Driver = new Memory({ maxSize: 100, prefix: 'test' })
+    this.#parameters.l1Driver = new MemoryDriver({ maxSize: 100, prefix: 'test' })
     return this
   }
 
   /**
    * Adds a Redis L2 driver to the cache stack
    */
   withRedisL2() {
-    this.#parameters.l2Driver = new Redis({ connection: { host: '127.0.0.1', port: 6379 } })
+    this.#parameters.l2Driver = new RedisDriver({ connection: { host: '127.0.0.1', port: 6379 } })
     return this
   }
 
   /**
    * Adds a cache stack preset with Memory + Redis + Memory Bus
    */
   withL1L2Config() {
-    this.#parameters.l1Driver ??= new Memory({ maxSize: 100, prefix: 'test' })
-    this.#parameters.l2Driver ??= new Redis({ connection: { host: '127.0.0.1', port: 6379 } })
+    this.#parameters.l1Driver ??= new MemoryDriver({ maxSize: 100, prefix: 'test' })
+    this.#parameters.l2Driver ??= new RedisDriver({ connection: { host: '127.0.0.1', port: 6379 } })
     this.#parameters.busDriver ??= new MemoryBus()
 
     return this
diff --git a/packages/bentocache/src/drivers/dynamodb.ts b/packages/bentocache/src/drivers/dynamodb.ts
@@ -16,17 +16,17 @@ import type { CacheDriver, CreateDriverResult, DynamoDBConfig } from '../types/m
 /**
  * Create a new DynamoDB driver
  */
-export function dynamoDbDriver(options: DynamoDBConfig): CreateDriverResult<DynamoDB> {
+export function dynamoDbDriver(options: DynamoDBConfig): CreateDriverResult<DynamoDbDriver> {
   return {
     options,
-    factory: (config: DynamoDBConfig) => new DynamoDB(config),
+    factory: (config: DynamoDBConfig) => new DynamoDbDriver(config),
   }
 }
 
 /**
  * Caching driver for DynamoDB
  */
-export class DynamoDB extends BaseDriver implements CacheDriver {
+export class DynamoDbDriver extends BaseDriver implements CacheDriver {
   type = 'l2' as const
 
   /**
@@ -144,7 +144,7 @@ export class DynamoDB extends BaseDriver implements CacheDriver {
    * Returns a new instance of the driver with the given namespace.
    */
   namespace(namespace: string) {
-    return new DynamoDB({
+    return new DynamoDbDriver({
       ...this.config,
       client: this.#client,
       prefix: this.createNamespacePrefix(namespace),
diff --git a/packages/bentocache/src/drivers/file.ts b/packages/bentocache/src/drivers/file.ts
@@ -7,10 +7,10 @@ import type { CacheDriver, CreateDriverResult, FileConfig } from '../types/main.
 /**
  * Create a new file driver
  */
-export function fileDriver(options: FileConfig): CreateDriverResult<File> {
+export function fileDriver(options: FileConfig): CreateDriverResult<FileDriver> {
   return {
     options,
-    factory: (config: FileConfig) => new File(config),
+    factory: (config: FileConfig) => new FileDriver(config),
   }
 }
 
@@ -22,7 +22,7 @@ export function fileDriver(options: FileConfig): CreateDriverResult<File> {
  * - Files are stored in the following format: [stringifiedValue, expireTimestamp]
  * - If the expireTimestamp is -1, the value should never expire
  */
-export class File extends BaseDriver implements CacheDriver {
+export class FileDriver extends BaseDriver implements CacheDriver {
   type = 'l2' as const
 
   /**
@@ -95,7 +95,7 @@ export class File extends BaseDriver implements CacheDriver {
    * Returns a new instance of the driver namespaced
    */
   namespace(namespace: string) {
-    return new File({
+    return new FileDriver({
       ...this.config,
       prefix: this.createNamespacePrefix(namespace),
     })
diff --git a/packages/bentocache/src/drivers/memory.ts b/packages/bentocache/src/drivers/memory.ts
@@ -10,17 +10,17 @@ import type {
 /**
  * Create a new memory driver
  */
-export function memoryDriver(options: MemoryConfig = {}): CreateDriverResult<Memory> {
+export function memoryDriver(options: MemoryConfig = {}): CreateDriverResult<MemoryDriver> {
   return {
     options,
-    factory: (config: MemoryConfig) => new Memory(config),
+    factory: (config: MemoryConfig) => new MemoryDriver(config),
   }
 }
 
 /**
  * A memory caching driver
  */
-export class Memory extends BaseDriver implements L1CacheDriver {
+export class MemoryDriver extends BaseDriver implements L1CacheDriver {
   type = 'l1' as const
   #cache: LRUCache<string, string>
   declare config: MemoryConfig
@@ -50,7 +50,7 @@ export class Memory extends BaseDriver implements L1CacheDriver {
    * Returns a new instance of the driver namespaced
    */
   namespace(namespace: string) {
-    return new Memory({
+    return new MemoryDriver({
       ...this.config,
       cacheInstance: this.#cache,
       prefix: this.createNamespacePrefix(namespace),
diff --git a/packages/bentocache/src/drivers/redis.ts b/packages/bentocache/src/drivers/redis.ts
@@ -14,8 +14,8 @@ import type {
 /**
  * Create a new cache redis driver
  */
-export function redisDriver(options: RedisConfig): CreateDriverResult<Redis> {
-  return { options, factory: (config: RedisConfig) => new Redis(config) }
+export function redisDriver(options: RedisConfig): CreateDriverResult<RedisDriver> {
+  return { options, factory: (config: RedisConfig) => new RedisDriver(config) }
 }
 
 /**
@@ -31,7 +31,7 @@ export function redisBusDriver(
 /**
  * Caching driver for Redis
  */
-export class Redis extends BaseDriver implements L2CacheDriver {
+export class RedisDriver extends BaseDriver implements L2CacheDriver {
   type = 'l2' as const
   #connection: IoRedis
   declare config: RedisConfig
@@ -55,7 +55,7 @@ export class Redis extends BaseDriver implements L2CacheDriver {
    * Returns a new instance of the driver namespaced
    */
   namespace(namespace: string) {
-    return new Redis({
+    return new RedisDriver({
       ...this.config,
       connection: this.#connection,
       prefix: this.createNamespacePrefix(namespace),
diff --git a/packages/bentocache/tests/bus/bus.spec.ts b/packages/bentocache/tests/bus/bus.spec.ts
@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { setTimeout } from 'node:timers/promises'
 
-import { Redis } from '../../src/drivers/redis.js'
+import { RedisDriver } from '../../src/drivers/redis.js'
 import { CacheFactory } from '../../factories/cache_factory.js'
 import { MemoryBus } from '../../src/bus/drivers/memory_bus.js'
 import { ChaosBus } from '../../test_helpers/chaos/chaos_bus.js'
@@ -138,7 +138,7 @@ test.group('Bus synchronization', () => {
     assert,
     cleanup,
   }) => {
-    const remoteDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const remoteDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
 
     cleanup(() => remoteDriver.disconnect().catch(() => {}))
 
diff --git a/packages/bentocache/tests/cache/local_cache.spec.ts b/packages/bentocache/tests/cache/local_cache.spec.ts
@@ -1,13 +1,13 @@
 import { test } from '@japa/runner'
 
-import { Memory } from '../../src/drivers/memory.js'
+import { MemoryDriver } from '../../src/drivers/memory.js'
 import { TestLogger } from '../../test_helpers/test_logger.js'
 import { LocalCache } from '../../src/cache/facades/local_cache.js'
 import { CacheEntryOptions } from '../../src/cache/cache_entry/cache_entry_options.js'
 
 test.group('Local Cache', () => {
   test('logically expire should works', ({ assert }) => {
-    const localCache = new LocalCache(new Memory(), new TestLogger())
+    const localCache = new LocalCache(new MemoryDriver(), new TestLogger())
     const options = new CacheEntryOptions({ ttl: '30m' })
 
     const logicalExpiration = Date.now() + 1000 * 60 * 30
@@ -25,7 +25,7 @@ test.group('Local Cache', () => {
   })
 
   test('logically expire should keep the same physical ttl', ({ assert }) => {
-    const driver = new Memory()
+    const driver = new MemoryDriver()
     const localCache = new LocalCache(driver, new TestLogger())
     const options = new CacheEntryOptions({ ttl: '30m' })
 
diff --git a/packages/bentocache/tests/cache/remote_cache.spec.ts b/packages/bentocache/tests/cache/remote_cache.spec.ts
@@ -1,6 +1,6 @@
 import { test } from '@japa/runner'
 
-import { Redis } from '../../src/drivers/redis.js'
+import { RedisDriver } from '../../src/drivers/redis.js'
 import { TestLogger } from '../../test_helpers/test_logger.js'
 import { REDIS_CREDENTIALS } from '../../test_helpers/index.js'
 import { ChaosCache } from '../../test_helpers/chaos/chaos_cache.js'
@@ -10,7 +10,7 @@ import { CacheEntryOptions } from '../../src/cache/cache_entry/cache_entry_optio
 test.group('Remote Cache', () => {
   test('should rethrows errors if suppressL2Errors is disabled', async ({ assert, cleanup }) => {
     const logger = new TestLogger()
-    const chaosCacheDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const chaosCacheDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
     const cache = new RemoteCache(chaosCacheDriver, logger)
 
     cleanup(() => chaosCacheDriver.disconnect())
@@ -30,7 +30,7 @@ test.group('Remote Cache', () => {
 
   test('should ignore errors if suppressL2Errors is enabled', async ({ assert, cleanup }) => {
     const logger = new TestLogger()
-    const chaosCacheDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const chaosCacheDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
     const cache = new RemoteCache(chaosCacheDriver, logger)
 
     cleanup(() => chaosCacheDriver.disconnect())
diff --git a/packages/bentocache/tests/cache/stampede_protection.spec.ts b/packages/bentocache/tests/cache/stampede_protection.spec.ts
@@ -1,8 +1,8 @@
 import { test } from '@japa/runner'
 import { setTimeout } from 'node:timers/promises'
 
-import { Redis } from '../../src/drivers/redis.js'
-import { Memory } from '../../src/drivers/memory.js'
+import { RedisDriver } from '../../src/drivers/redis.js'
+import { MemoryDriver } from '../../src/drivers/memory.js'
 import { CacheFactory } from '../../factories/cache_factory.js'
 import { REDIS_CREDENTIALS, throwingFactory } from '../../test_helpers/index.js'
 
@@ -39,7 +39,7 @@ test.group('Cache | Stampede protection', () => {
   })
 
   test('multiple concurrent calls should ask remote only once', async ({ assert }) => {
-    class RemoteDriver extends Memory {
+    class RemoteDriver extends MemoryDriver {
       askedKeys: string[] = []
 
       get(key: string) {
@@ -145,7 +145,7 @@ test.group('Cache | Stampede protection', () => {
     .with([100, 1000, 10_000])
     .run(async ({ assert }, concurrency) => {
       const { cache } = new CacheFactory()
-        .merge({ l1Driver: new Memory({ maxSize: 100, prefix: 'test' }) })
+        .merge({ l1Driver: new MemoryDriver({ maxSize: 100, prefix: 'test' }) })
         .create()
 
       let factoryCalls = 0
@@ -169,7 +169,7 @@ test.group('Cache | Stampede protection', () => {
     .disableTimeout()
     .run(async ({ assert }, concurrency) => {
       const { cache } = new CacheFactory()
-        .merge({ l2Driver: new Redis({ connection: REDIS_CREDENTIALS }) })
+        .merge({ l2Driver: new RedisDriver({ connection: REDIS_CREDENTIALS }) })
         .create()
 
       let factoryCalls = 0
diff --git a/packages/bentocache/tests/cache/two_tier.spec.ts b/packages/bentocache/tests/cache/two_tier.spec.ts
@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { setTimeout } from 'node:timers/promises'
 
-import { Redis } from '../../src/drivers/redis.js'
+import { RedisDriver } from '../../src/drivers/redis.js'
 import { TestLogger } from '../../test_helpers/test_logger.js'
 import { CacheFactory } from '../../factories/cache_factory.js'
 import { MemoryBus } from '../../src/bus/drivers/memory_bus.js'
@@ -418,7 +418,7 @@ test.group('Cache', () => {
   })
 
   test('rethrows error when suppressL2Errors is false', async ({ assert }) => {
-    const remoteDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const remoteDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
 
     const { cache } = new CacheFactory()
       .merge({ l2Driver: remoteDriver, gracePeriod: { enabled: true, duration: '2h' } })
@@ -537,7 +537,7 @@ test.group('Cache', () => {
   })
 
   test('deleteMany should throw if remote fail and suppressL2Errors is on', async ({ assert }) => {
-    const remoteDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const remoteDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
     const { cache, local, stack } = new CacheFactory()
       .merge({ l2Driver: remoteDriver })
       .withL1L2Config()
@@ -580,7 +580,7 @@ test.group('Cache', () => {
   })
 
   test('a deleteMany should delete others local cache even if remote fail', async ({ assert }) => {
-    const remoteDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const remoteDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
 
     const [cache1, local1, , stack] = new CacheFactory()
       .merge({ l2Driver: remoteDriver })
@@ -631,7 +631,7 @@ test.group('Cache', () => {
   })
 
   test('delete should throw if remote fail and suppressL2Errors is on', async ({ assert }) => {
-    const remoteDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const remoteDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
 
     const { cache, local, stack } = new CacheFactory()
       .merge({ l2Driver: remoteDriver })
@@ -676,7 +676,7 @@ test.group('Cache', () => {
   })
 
   test('a delete should delete others local cache even if remote fail', async ({ assert }) => {
-    const remoteDriver = new ChaosCache(new Redis({ connection: REDIS_CREDENTIALS }))
+    const remoteDriver = new ChaosCache(new RedisDriver({ connection: REDIS_CREDENTIALS }))
 
     const [cache1, local1, , stack] = new CacheFactory()
       .merge({ l2Driver: remoteDriver })
diff --git a/packages/bentocache/tests/drivers/dynamodb.spec.ts b/packages/bentocache/tests/drivers/dynamodb.spec.ts
@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { DeleteTableCommand, CreateTableCommand, DynamoDBClient } from '@aws-sdk/client-dynamodb'
 
-import { DynamoDB } from '../../src/drivers/dynamodb.js'
+import { DynamoDbDriver } from '../../src/drivers/dynamodb.js'
 import { registerCacheDriverTestSuite } from '../../test_helpers/driver_test_suite.js'
 
 const dynamoClient = new DynamoDBClient({
@@ -48,7 +48,7 @@ test.group('DynamoDB driver', (group) => {
     group,
     supportsMilliseconds: false,
     createDriver: (options) => {
-      return new DynamoDB({
+      return new DynamoDbDriver({
         prefix: 'japa',
         region: 'eu-west-3',
         endpoint: process.env.DYNAMODB_ENDPOINT,
diff --git a/packages/bentocache/tests/drivers/file.spec.ts b/packages/bentocache/tests/drivers/file.spec.ts
@@ -1,7 +1,7 @@
 import { test } from '@japa/runner'
 import { fileURLToPath } from 'node:url'
 
-import { File } from '../../src/drivers/file.js'
+import { FileDriver } from '../../src/drivers/file.js'
 import { BASE_URL } from '../../test_helpers/index.js'
 import { registerCacheDriverTestSuite } from '../../test_helpers/driver_test_suite.js'
 
@@ -10,7 +10,7 @@ test.group('File driver', (group) => {
     test,
     group,
     createDriver: (options) => {
-      return new File({ prefix: 'japa', directory: fileURLToPath(BASE_URL), ...options })
+      return new FileDriver({ prefix: 'japa', directory: fileURLToPath(BASE_URL), ...options })
     },
   })
 })
diff --git a/packages/bentocache/tests/drivers/memory.spec.ts b/packages/bentocache/tests/drivers/memory.spec.ts
@@ -1,17 +1,17 @@
 import { test } from '@japa/runner'
 
-import { Memory } from '../../src/drivers/memory.js'
+import { MemoryDriver } from '../../src/drivers/memory.js'
 import { registerCacheDriverTestSuite } from '../../test_helpers/driver_test_suite.js'
 
 test.group('Memory Driver', (group) => {
   registerCacheDriverTestSuite({
     test,
     group,
-    createDriver: (options) => new Memory({ maxItems: 1000, prefix: 'japa', ...options }),
+    createDriver: (options) => new MemoryDriver({ maxItems: 1000, prefix: 'japa', ...options }),
   })
 
   test('should not store items exceeding maxEntrySize', async ({ assert }) => {
-    const cache = new Memory({
+    const cache = new MemoryDriver({
       maxSize: 1024,
       maxEntrySize: 100,
     })
@@ -30,7 +30,7 @@ test.group('Memory Driver', (group) => {
   })
 
   test('should not exceed the store maxSize', async ({ assert }) => {
-    const cache = new Memory({
+    const cache = new MemoryDriver({
       maxSize: 200,
     })
 
diff --git a/packages/bentocache/tests/drivers/redis.spec.ts b/packages/bentocache/tests/drivers/redis.spec.ts
