refactor: some naming updates

Author: Julien-R44

packages/bentocache/drivers/knex.ts

@@ -1,17 +1,17 @@
 import { KnexAdapter } from '../src/drivers/knex.js'
-import { DatabaseStore } from '../src/drivers/database.js'
+import { DatabaseDriver } from '../src/drivers/database.js'
 import type { CreateDriverResult, KnexConfig } from '../src/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<DatabaseStore> {
+export function knexDriver(options: KnexConfig): CreateDriverResult<DatabaseDriver> {
   return {
     options,
     factory: (config: KnexConfig) => {
       const adapter = new KnexAdapter(config)
-      return new DatabaseStore(adapter, config)
+      return new DatabaseDriver(adapter, config)
     },
   }
 }

packages/bentocache/drivers/kysely.ts

@@ -1,17 +1,17 @@
 import { KyselyAdapter } from '../src/drivers/kysely.js'
-import { DatabaseStore } from '../src/drivers/database.js'
+import { DatabaseDriver } from '../src/drivers/database.js'
 import type { CreateDriverResult, KyselyConfig } from '../src/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<DatabaseStore> {
+export function kyselyDriver(options: KyselyConfig): CreateDriverResult<DatabaseDriver> {
   return {
     options,
     factory: (config: KyselyConfig) => {
       const adapter = new KyselyAdapter(config)
-      return new DatabaseStore(adapter, config)
+      return new DatabaseDriver(adapter, config)
     },
   }
 }

packages/bentocache/src/drivers/database.ts

@@ -6,7 +6,7 @@ import type { DatabaseConfig, CacheDriver, DatabaseAdapter } from '../types/main
  *
  * You should provide an adapter that will handle the database interactions
  */
-export class DatabaseStore extends BaseDriver implements CacheDriver<true> {
+export class DatabaseDriver extends BaseDriver implements CacheDriver<true> {
   type = 'l2' as const
 
   /**

packages/bentocache/src/drivers/knex.ts

@@ -3,7 +3,7 @@ import type { Knex } from 'knex'
 import type { DatabaseAdapter, KnexConfig } from '../types/main.js'
 
 /**
- * Knex adapter for the DatabaseStore
+ * Knex adapter for the DatabaseDriver
  */
 export class KnexAdapter implements DatabaseAdapter {
   #connection: Knex

packages/bentocache/src/drivers/kysely.ts

@@ -3,7 +3,7 @@ import { SqliteAdapter, type Kysely } from 'kysely'
 import type { DatabaseAdapter, KyselyConfig } from '../types/main.js'
 
 /**
- * Kysely adapter for the DatabaseStore
+ * Kysely adapter for the DatabaseDriver
  */
 export class KyselyAdapter implements DatabaseAdapter {
   #isSqlite: boolean

packages/bentocache/src/types/driver.ts

@@ -54,7 +54,7 @@ export interface CacheDriver<Async extends boolean = true> {
 }
 
 /**
- * Interface for a DatabaseAdapter that can be used with the DatabaseStore
+ * Interface for a DatabaseAdapter that can be used with the DatabaseDriver
  */
 export interface DatabaseAdapter {
   /**

packages/bentocache/test_helpers/driver_test_suite.ts

@@ -9,7 +9,7 @@ import type { CacheDriver, CacheDriverOptions } from '../src/types/main.js'
 export function registerCacheDriverTestSuite(options: {
   test: typeof JapaTest
   group: Group
-  createStore: (options?: CacheDriverOptions) => CacheDriver<any>
+  createDriver: (options?: CacheDriverOptions) => CacheDriver<any>
   configureGroup?: (group: Group) => any
 
   /**
@@ -20,13 +20,15 @@ export function registerCacheDriverTestSuite(options: {
   const { test, group } = options
   const sleepTime = options.supportsMilliseconds ? 20 : 1000
 
-  const cache = options.createStore()
+  const cache = options.createDriver()
 
   group.tap((t) => t.disableTimeout())
   group.each.teardown(async () => {
     await cache.clear()
   })
 
+  options.configureGroup?.(group)
+
   group.teardown(async () => {
     await cache.disconnect()
   })
@@ -71,7 +73,7 @@ export function registerCacheDriverTestSuite(options: {
   })
 
   test('clear() remove only keys with prefix', async ({ assert, cleanup }) => {
-    const cache2 = options.createStore({ prefix: 'prefix' })
+    const cache2 = options.createDriver({ prefix: 'prefix' })
     cleanup(async () => {
       await cache2.clear()
     })

packages/bentocache/tests/drivers/database.spec.ts

@@ -3,7 +3,7 @@ import { test } from '@japa/runner'
 import { setTimeout } from 'node:timers/promises'
 
 import { KnexAdapter } from '../../src/drivers/knex.js'
-import { DatabaseStore } from '../../src/drivers/database.js'
+import { DatabaseDriver } from '../../src/drivers/database.js'
 
 test.group('Database', () => {
   test('should prune expired items every x seconds', async ({ assert, cleanup }) => {
@@ -15,7 +15,7 @@ test.group('Database', () => {
       }),
     })
 
-    const driver = new DatabaseStore(adapter, {
+    const driver = new DatabaseDriver(adapter, {
       tableName: 'cache',
       autoCreateTable: true,
       pruneInterval: 500,

packages/bentocache/tests/drivers/dynamodb.spec.ts

@@ -35,7 +35,7 @@ async function deleteTable() {
 }
 
 test.group('DynamoDB driver', (group) => {
-  group.each.setup(async () => {
+  group.setup(async () => {
     await createTable().catch((e) => console.error('Could not create table', e))
 
     return async () => {
@@ -47,7 +47,7 @@ test.group('DynamoDB driver', (group) => {
     test,
     group,
     supportsMilliseconds: false,
-    createStore: (options) =>
+    createDriver: (options) =>
       new DynamoDB({
         prefix: 'japa',
         region: 'eu-west-3',

packages/bentocache/tests/drivers/file.spec.ts

@@ -9,7 +9,7 @@ test.group('File driver', (group) => {
   registerCacheDriverTestSuite({
     test,
     group,
-    createStore: (options) => {
+    createDriver: (options) => {
       return new File({ prefix: 'japa', directory: fileURLToPath(BASE_URL), ...options })
     },
   })

packages/bentocache/tests/drivers/knex/helpers.ts

@@ -1,8 +1,8 @@
 import { KnexAdapter } from '../../../src/drivers/knex.js'
 import type { KnexConfig } from '../../../src/types/main.js'
-import { DatabaseStore } from '../../../src/drivers/database.js'
+import { DatabaseDriver } from '../../../src/drivers/database.js'
 
 export function createKnexStore(options: KnexConfig) {
   const adapter = new KnexAdapter(options)
-  return new DatabaseStore(adapter, options)
+  return new DatabaseDriver(adapter, options)
 }

packages/bentocache/tests/drivers/knex/mysql.spec.ts

@@ -14,6 +14,6 @@ test.group('Knex | MySQL driver', (group) => {
     test,
     group,
     supportsMilliseconds: false,
-    createStore: (options) => createKnexStore({ connection: db, prefix: 'japa', ...options }),
+    createDriver: (options) => createKnexStore({ connection: db, prefix: 'japa', ...options }),
   })
 })

packages/bentocache/tests/drivers/knex/postgres.spec.ts

@@ -14,6 +14,6 @@ test.group('Knex | MySQL driver', (group) => {
     test,
     group,
     supportsMilliseconds: false,
-    createStore: (options) => createKnexStore({ connection: db, prefix: 'japa', ...options }),
+    createDriver: (options) => createKnexStore({ connection: db, prefix: 'japa', ...options }),
   })
 })

packages/bentocache/tests/drivers/knex/sqlite.spec.ts

@@ -14,6 +14,6 @@ test.group('Knex | Better-sqlite3 driver', (group) => {
   registerCacheDriverTestSuite({
     test,
     group,
-    createStore: (options) => createKnexStore({ connection: db, prefix: 'japa', ...options }),
+    createDriver: (options) => createKnexStore({ connection: db, prefix: 'japa', ...options }),
   })
 })

packages/bentocache/tests/drivers/kysely/helpers.ts

@@ -1,8 +1,8 @@
 import type { KyselyConfig } from '../../../src/types/main.js'
 import { KyselyAdapter } from '../../../src/drivers/kysely.js'
-import { DatabaseStore } from '../../../src/drivers/database.js'
+import { DatabaseDriver } from '../../../src/drivers/database.js'
 
 export function createKyselyStore(options: KyselyConfig) {
   const adapter = new KyselyAdapter(options)
-  return new DatabaseStore(adapter, options)
+  return new DatabaseDriver(adapter, options)
 }

packages/bentocache/tests/drivers/kysely/mysql.spec.ts

@@ -16,6 +16,6 @@ test.group('Kysely | Mysql driver', (group) => {
     test,
     group,
     supportsMilliseconds: false,
-    createStore: (options) => createKyselyStore({ connection: db, prefix: 'japa', ...options }),
+    createDriver: (options) => createKyselyStore({ connection: db, prefix: 'japa', ...options }),
   })
 })

packages/bentocache/tests/drivers/kysely/postgres.spec.ts

@@ -14,6 +14,6 @@ test.group('Kysely | Postgres driver', (group) => {
     test,
     group,
     supportsMilliseconds: false,
-    createStore: (options) => createKyselyStore({ connection: db, prefix: 'japa', ...options }),
+    createDriver: (options) => createKyselyStore({ connection: db, prefix: 'japa', ...options }),
   })
 })

packages/bentocache/tests/drivers/kysely/sqlite.spec.ts

@@ -16,6 +16,6 @@ test.group('Kysely | Postgres driver', (group) => {
     test,
     group,
     supportsMilliseconds: false,
-    createStore: (options) => createKyselyStore({ connection: db, prefix: 'japa', ...options }),
+    createDriver: (options) => createKyselyStore({ connection: db, prefix: 'japa', ...options }),
   })
 })

packages/bentocache/tests/drivers/memory.spec.ts

@@ -7,7 +7,7 @@ test.group('Memory Driver', (group) => {
   registerCacheDriverTestSuite({
     test,
     group,
-    createStore: (options) => new Memory({ maxItems: 1000, prefix: 'japa', ...options }),
+    createDriver: (options) => new Memory({ maxItems: 1000, prefix: 'japa', ...options }),
   })
 
   test('should not store items exceeding maxEntrySize', async ({ assert }) => {

packages/bentocache/tests/drivers/redis.spec.ts

@@ -9,7 +9,7 @@ test.group('Redis driver', (group) => {
   registerCacheDriverTestSuite({
     test,
     group,
-    createStore: (options) =>
+    createDriver: (options) =>
       new Redis({ prefix: 'japa', connection: REDIS_CREDENTIALS, ...options }),
   })