add comment about ttl unit

Author: dustin deus

src/http-data-source.ts

@@ -16,9 +16,9 @@ type AbortSignal = unknown
 
 export type CacheTTLOptions = {
   requestCache?: {
-    // The maximum time an item is cached
+    // The maximum time an item is cached (seconds)
     maxTtl: number
-    // The maximum time an item fetched from the cache is case of an error. This value must be greater than `maxTtl`.
+    // The maximum time an item fetched from the cache is case of an error (seconds). This value must be greater than `maxTtl`
     maxTtlIfError: number
   }
 }
@@ -44,6 +44,7 @@ export type Response<TResult> = {
   body: TResult
   memoized: boolean
   isFromCache: boolean
+  // maximum ttl (seconds)
   maxTtl?: number
 } & Omit<ResponseData, 'body'>
 
@@ -77,6 +78,7 @@ function apolloKeyValueCacheToKeyv(cache: KeyValueCache): Store<string> {
       return true
     },
     set(key: string, value: string, ttl?: number) {
+      // apollo works with seconds
       return cache.set(key, value, {
         ttl,
       })

test/http-data-source.test.ts

@@ -611,8 +611,8 @@ test('Response is cached', async (t) => {
     getFoo() {
       return this.get(path, {
         requestCache: {
-          maxTtl: 100,
-          maxTtlIfError: 200,
+          maxTtl: 10,
+          maxTtlIfError: 20,
         },
       })
     }
@@ -641,13 +641,13 @@ test('Response is cached', async (t) => {
   let response = await dataSource.getFoo()
   t.false(response.isFromCache)
   t.false(response.memoized)
-  t.is(response.maxTtl, 200)
+  t.is(response.maxTtl, 20)
   t.deepEqual(response.body, { name: 'foo' })
 
   response = await dataSource.getFoo()
   t.false(response.isFromCache)
   t.true(response.memoized)
-  t.is(response.maxTtl, 200)
+  t.is(response.maxTtl, 20)
   t.deepEqual(response.body, { name: 'foo' })
 
   dataSource = new (class extends HTTPDataSource {
@@ -657,8 +657,8 @@ test('Response is cached', async (t) => {
     getFoo() {
       return this.get(path, {
         requestCache: {
-          maxTtl: 100,
-          maxTtlIfError: 200,
+          maxTtl: 10,
+          maxTtlIfError: 20,
         },
       })
     }
@@ -669,7 +669,7 @@ test('Response is cached', async (t) => {
   response = await dataSource.getFoo()
   t.true(response.isFromCache)
   t.false(response.memoized)
-  t.is(response.maxTtl, 200)
+  t.is(response.maxTtl, 20)
   t.deepEqual(response.body, { name: 'foo' })
 
   const cached = JSON.parse(map.get('keyv:' + baseURL + path)!)
@@ -725,8 +725,8 @@ test('Fallback from cache on origin error', async (t) => {
     getFoo() {
       return this.get(path, {
         requestCache: {
-          maxTtl: 100,
-          maxTtlIfError: 200,
+          maxTtl: 10,
+          maxTtlIfError: 20,
         },
       })
     }
@@ -755,7 +755,7 @@ test('Fallback from cache on origin error', async (t) => {
   let response = await dataSource.getFoo()
   t.false(response.isFromCache)
   t.false(response.memoized)
-  t.is(response.maxTtl, 200)
+  t.is(response.maxTtl, 20)
 
   t.deepEqual(response.body, { name: 'foo' })
 
@@ -770,8 +770,8 @@ test('Fallback from cache on origin error', async (t) => {
     getFoo() {
       return this.get(path, {
         requestCache: {
-          maxTtl: 100,
-          maxTtlIfError: 200,
+          maxTtl: 10,
+          maxTtlIfError: 20,
         },
       })
     }
@@ -782,7 +782,7 @@ test('Fallback from cache on origin error', async (t) => {
   response = await dataSource.getFoo()
   t.true(response.isFromCache)
   t.false(response.memoized)
-  t.is(response.maxTtl, 200)
+  t.is(response.maxTtl, 20)
 
   t.deepEqual(response.body, { name: 'foo' })
 
@@ -816,8 +816,8 @@ test('Should not cache POST requests', async (t) => {
     postFoo() {
       return this.post(path, {
         requestCache: {
-          maxTtl: 100,
-          maxTtlIfError: 200,
+          maxTtl: 10,
+          maxTtlIfError: 20,
         },
       })
     }
@@ -837,7 +837,7 @@ test('Should not cache POST requests', async (t) => {
         return map.get(key)
       },
       async set(key: string, value: string, options: KeyValueCacheSetOptions) {
-        t.deepEqual(options, { ttl: 100 })
+        t.deepEqual(options, { ttl: 10 })
         map.set(key, value)
       },
     },
@@ -876,8 +876,8 @@ test('Response is not cached due to origin error', async (t) => {
     getFoo() {
       return this.get(path, {
         requestCache: {
-          maxTtl: 100,
-          maxTtlIfError: 200,
+          maxTtl: 10,
+          maxTtlIfError: 20,
         },
       })
     }