Prepare for 1.0.0

Author: sanny-io

README.md

@@ -1,7 +1,6 @@
 <div align="center">
   <h1>
     ZenStack Cache
-    <small>(beta)</small>
   </h1>
 
   Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
@@ -27,9 +26,9 @@
 </div>
 
 ## Features
-* 🌐 **Redis Caching:** Centralizes your caching to scale across different systems.
-* 🖥️ **Memory Caching:** Simplifies caching when scale is not a concern.
-* 🛟 **Type-safe:** The caching options appear in the intellisense for all read queries.
+* 🌐 **Redis Cache:** A central cache to scale across different systems.
+* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
+* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
 
 ## Requirements
 

package.json

@@ -30,7 +30,7 @@
       "packages/*"
     ],
     "catalog": {
-      "@zenstackhq/orm": "canary",
+      "@zenstackhq/orm": "^3.3.0",
       "zod": "^4.1.0",
       "kysely": "~0.28.8",
       "ioredis": "^5.0.0",

packages/cache/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@visualbravo/zenstack-cache",
   "version": "0.0.0",
-  "type": "module",
   "license": "MIT",
+  "repository": "github:visualbravo/zenstack-cache",
+  "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",
-  "repository": "github:visualbravo/zenstack-cache",
   "exports": {
     ".": {
       "@zenstack-cache/source": "./src/index.ts",
@@ -105,10 +105,10 @@
     "zod": "catalog:"
   },
   "devDependencies": {
+    "@types/better-sqlite3": "7.6.13",
     "@zenstack-cache/config": "workspace:*",
-    "kysely": "catalog:",
     "better-sqlite3": "12.6.2",
-    "@types/better-sqlite3": "7.6.13"
+    "kysely": "catalog:"
   },
   "peerDependencies": {
     "@zenstackhq/orm": "catalog:"

packages/cache/src/providers/redis.ts

@@ -11,7 +11,7 @@ export class RedisCacheProvider implements CacheProvider {
   }
 
   async get(key: string) {
-    const entryJson = await this.redis.get(formatQueryKey(key))
+    const entryJson = await this.redis.get(makeQueryKey(key))
 
     if (!entryJson) {
       return undefined
@@ -22,28 +22,27 @@ export class RedisCacheProvider implements CacheProvider {
 
   async set(key: string, entry: CacheEntry) {
     const multi = this.redis.multi()
-    const formattedKey = formatQueryKey(key)
+    const queryKey = makeQueryKey(key)
 
-    multi.set(formattedKey, superjson.stringify(entry))
+    multi.set(queryKey, superjson.stringify(entry))
 
     const totalTtl = getTotalTtl(entry)
 
     if (totalTtl > 0) {
-      multi.expire(formattedKey, totalTtl)
+      multi.expire(queryKey, totalTtl)
     }
 
     if (entry.options.tags) {
       for (const tag of entry.options.tags) {
-        const formattedTagKey = formatTagKey(tag)
+        const tagKey = makeTagKey(tag)
 
-        multi.sadd(formattedTagKey, formattedKey)
+        multi.sadd(tagKey, queryKey)
 
         if (totalTtl > 0) {
-          multi.expire(formattedTagKey, totalTtl, 'GT')
-          multi.expire(formattedTagKey, totalTtl, 'NX')
-        }
-        else {
-          multi.persist(formattedTagKey)
+          multi.expire(tagKey, totalTtl, 'GT')
+          multi.expire(tagKey, totalTtl, 'NX')
+        } else {
+          multi.persist(tagKey)
         }
       }
     }
@@ -56,7 +55,7 @@ export class RedisCacheProvider implements CacheProvider {
       await Promise.all(
         options.tags.map(tag => {
           return new Promise((resolve, reject) => {
-            const stream = this.redis.sscanStream(formatTagKey(tag), {
+            const stream = this.redis.sscanStream(makeTagKey(tag), {
               count: 100,
             })
 
@@ -97,10 +96,10 @@ export type RedisCacheProviderOptions = {
   url: string
 }
 
-function formatQueryKey(key: string) {
+function makeQueryKey(key: string) {
   return `zenstack:cache:query:${key}`
 }
 
-function formatTagKey(key: string) {
+function makeTagKey(key: string) {
   return `zenstack:cache:tag:${key}`
 }

packages/cache/src/superjson.ts

@@ -10,4 +10,4 @@ superjson.registerCustom<Decimal, string>(
   'decimal.js',
 )
 
-export { superjson }
+export { superjson }

packages/cache/tests/memory.test.ts

@@ -362,7 +362,7 @@ describe('Cache plugin (memory)', () => {
       },
     })
 
-    vi.advanceTimersByTime(60000)
+    vi.advanceTimersByTime(70000)
 
     await expect(
       extDb.user.exists({
@@ -1052,6 +1052,24 @@ describe('Cache plugin (memory)', () => {
       }),
     )
 
+    await extDb.user.findMany({
+      cache: {},
+    })
+
+    await extDb.user.create({
+      data: {
+        email: 'test@email.com',
+      },
+    })
+
+    vi.advanceTimersByTime(70000)
+
+    await expect(
+      extDb.user.findMany({
+        cache: {},
+      }),
+    ).resolves.toHaveLength(0)
+
     await expect(
       extDb.user.findMany({
         cache: {

packages/cache/tests/redis.test.ts

@@ -9,6 +9,7 @@ import { Redis, Pipeline } from 'ioredis'
 
 const expire = vi.spyOn(Pipeline.prototype, 'expire')
 const sadd = vi.spyOn(Pipeline.prototype, 'sadd')
+const set = vi.spyOn(Pipeline.prototype, 'set')
 
 describe('Cache plugin (redis)', () => {
   let db: ClientContract<typeof schema>
@@ -25,6 +26,7 @@ describe('Cache plugin (redis)', () => {
 
     expire.mockClear()
     sadd.mockClear()
+    set.mockClear()
 
     await db.$pushSchema()
     await redis.flushdb()
@@ -1014,6 +1016,13 @@ describe('Cache plugin (redis)', () => {
       }),
     )
 
+    await extDb.user.findMany({
+      cache: {},
+    })
+
+    expect(set).toHaveBeenCalled()
+    expect(expire).not.toHaveBeenCalled()
+
     await expect(
       extDb.user.findMany({
         cache: {