refactor: wording

Author: LouisHaftmann

docs/content/1.getting-started/1.index.md

@@ -102,15 +102,15 @@ variant: subtle
 ---
 ::
 
-#### `CACHE_CLEANUP_UNTOUCHED_TTL_DAYS`
+#### `CACHE_CLEANUP_UNUSED_TTL_DAYS`
 
 - Default: `30`
 
-Cache entries which have not been accessed for `CACHE_CLEANUP_UNTOUCHED_TTL_DAYS` days will be automatically deleted. Set to `0` to disable.
+Cache entries which have not been accessed for `CACHE_CLEANUP_UNUSED_TTL_DAYS` days will be automatically deleted. Set to `0` to disable.
 
 #### `CACHE_CLEANUP_TTL_DAYS`
 
-Cache entries which have been created `CACHE_CLEANUP_TTL_DAYS` days ago will be automatically deleted. Set to `0` to disable.
+Cache entries which have been created `CACHE_CLEANUP_TTL_DAYS` days ago will be automatically deleted, regardless of when it was last accessed.
 
 #### `CACHE_CLEANUP_CRON`
 

lib/db/index.ts

@@ -193,7 +193,7 @@ export async function touchKey(
 export async function findStaleKeys(
   db: DB,
   opts?: {
-    untouchedTTLDays?: number
+    unusedTTLDays?: number
     ttlDays?: number
     date?: Date
   },
@@ -206,9 +206,9 @@ export async function findStaleKeys(
     query = query.where('created_at', '<', threshold.toISOString())
   }
 
-  if (opts?.untouchedTTLDays !== undefined) {
-    const untouchedThreshold = new Date(now.getTime() - opts.untouchedTTLDays * 24 * 60 * 60 * 1000)
-    query = query.where('accessed_at', '<', untouchedThreshold.toISOString())
+  if (opts?.unusedTTLDays !== undefined) {
+    const threshold = new Date(now.getTime() - opts.unusedTTLDays * 24 * 60 * 60 * 1000)
+    query = query.where('accessed_at', '<', threshold.toISOString())
   }
 
   return query.selectAll().execute()

lib/env.ts

@@ -7,10 +7,10 @@ const portSchema = z.coerce.number().int().min(1).max(65_535)
 const envSchema = z.object({
   ENABLE_DIRECT_DOWNLOADS: booleanSchema.default('false'),
   /**
-   * @deprecated use `CACHE_CLEANUP_UNTOUCHED_TTL_DAYS` or `CACHE_CLEANUP_TTL_DAYS` instead
+   * @deprecated use `CACHE_CLEANUP_UNUSED_TTL_DAYS` or `CACHE_CLEANUP_TTL_DAYS` instead
    */
   CACHE_CLEANUP_OLDER_THAN_DAYS: z.coerce.number().int().min(0).default(90),
-  CACHE_CLEANUP_UNTOUCHED_TTL_DAYS: z.coerce.number().int().min(0).default(30),
+  CACHE_CLEANUP_UNUSED_TTL_DAYS: z.coerce.number().int().min(0).default(30),
   CACHE_CLEANUP_TTL_DAYS: z.coerce.number().int().min(0).optional(),
   CACHE_CLEANUP_CRON: z.string().default('0 0 * * *'),
   UPLOAD_CLEANUP_CRON: z.string().default('*/10 * * * *'),

lib/storage/index.ts

@@ -184,7 +184,7 @@ export const useStorageAdapter = createSingletonPromise(async () => {
         logger.debug('Download:', objectName)
         return driver.createReadStream(objectName)
       },
-      async pruneCaches(opts?: { untouchedTTLDays?: number; ttlDays?: number }) {
+      async pruneCaches(opts?: { unusedTTLDays?: number; ttlDays?: number }) {
         logger.debug('Prune:', opts)
 
         const keys = await findStaleKeys(db, opts)

plugins/cleanup.ts

@@ -14,7 +14,7 @@ export default defineNitroPlugin(() => {
   if (
     ENV.CACHE_CLEANUP_OLDER_THAN_DAYS ||
     ENV.CACHE_CLEANUP_TTL_DAYS ||
-    ENV.CACHE_CLEANUP_UNTOUCHED_TTL_DAYS
+    ENV.CACHE_CLEANUP_UNUSED_TTL_DAYS
   ) {
     const job = new Cron(ENV.CACHE_CLEANUP_CRON)
     const nextRun = job.nextRun()
@@ -25,7 +25,7 @@ export default defineNitroPlugin(() => {
       const adapter = await useStorageAdapter()
       await adapter.pruneCaches({
         ttlDays: ENV.CACHE_CLEANUP_TTL_DAYS,
-        untouchedTTLDays: ENV.CACHE_CLEANUP_UNTOUCHED_TTL_DAYS ?? ENV.CACHE_CLEANUP_OLDER_THAN_DAYS,
+        unusedTTLDays: ENV.CACHE_CLEANUP_UNUSED_TTL_DAYS ?? ENV.CACHE_CLEANUP_OLDER_THAN_DAYS,
       })
     })
   }

tests/cleanup.test.ts

@@ -61,14 +61,14 @@ describe('getting stale keys', async () => {
   beforeEach(() => pruneKeys(db))
 
   const version = '0577ec58bee6d5415625'
-  test('returns untouched stale keys if threshold is passed', async () => {
+  test('returns unused stale keys if threshold is passed', async () => {
     const referenceDate = new Date('2024-04-01T00:00:00Z')
     await updateOrCreateKey(db, { key: 'cache-a', version, date: new Date('2024-01-01T00:00:00Z') })
     await updateOrCreateKey(db, { key: 'cache-b', version, date: new Date('2024-02-01T00:00:00Z') })
     await updateOrCreateKey(db, { key: 'cache-c', version, date: new Date('2024-03-15T00:00:00Z') })
     await updateOrCreateKey(db, { key: 'cache-d', version, date: new Date('2024-03-20T00:00:00Z') })
 
-    const match = await findStaleKeys(db, { untouchedTTLDays: 30, date: referenceDate })
+    const match = await findStaleKeys(db, { unusedTTLDays: 30, date: referenceDate })
     expect(match.length).toBe(2)
 
     const matchA = match.find((m) => m.key === 'cache-a')