feat: add schemaVersion and accessCounter to paste metadata

Author: SharzyL

.github/workflows/deploy.yml

@@ -3,7 +3,6 @@ on:
   push:
     branches:
       - goshujin
-      - dev
 
 jobs:
   deploy:
@@ -26,7 +25,6 @@ jobs:
           yarn test
 
       - name: "Deploy"
-        if: github.ref == 'refs/heads/main'
         env:
           CLOUDFLARE_API_TOKEN: ${{ secrets.CF_API_TOKEN }}
           CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}

src/handlers/handleDelete.ts

@@ -1,14 +1,14 @@
 import { parsePath, WorkerError } from "../common.js"
-import { deletePaste, getPaste } from "../storage/storage.js"
+import {deletePaste, getPasteMetadata} from "../storage/storage.js"
 
 export async function handleDelete(request: Request, env: Env, _: ExecutionContext) {
   const url = new URL(request.url)
   const { nameFromPath, passwd } = parsePath(url.pathname)
-  const item = await getPaste(env, nameFromPath)
-  if (item === null) {
+  const metadata = await getPasteMetadata(env, nameFromPath)
+  if (metadata === null) {
     throw new WorkerError(404, `paste of name '${nameFromPath}' not found`)
   } else {
-    if (passwd !== item.metadata.passwd) {
+    if (passwd !== metadata.passwd) {
       throw new WorkerError(403, `incorrect password for paste '${nameFromPath}`)
     } else {
       await deletePaste(env, nameFromPath)

src/handlers/handleWrite.ts

@@ -9,7 +9,7 @@ import {
   parsePath,
   WorkerError,
 } from "../common.js"
-import {createPaste, getPaste, pasteNameAvailable, updatePaste} from "../storage/storage.js";
+import {createPaste, getPasteMetadata, pasteNameAvailable, updatePaste} from "../storage/storage.js";
 
 type PasteResponse = {
   url: string,
@@ -106,18 +106,18 @@ export async function handlePostOrPut(request: Request, env: Env, ctx: Execution
   let now = new Date()
   if (isPut) {
     const { nameFromPath, passwd } = parsePath(url.pathname)
-    const item = await getPaste(env, nameFromPath)
+    const originalMetadata = await getPasteMetadata(env, nameFromPath)
 
-    if (item === null) {
+    if (originalMetadata === null) {
       throw new WorkerError(404, `paste of name '${nameFromPath}' is not found`)
     } else if (passwd === undefined) {
       throw new WorkerError(403, `no password for paste '${nameFromPath}`)
-    } else if (passwd !== item.metadata.passwd) {
+    } else if (passwd !== originalMetadata.passwd) {
         throw new WorkerError(403, `incorrect password for paste '${nameFromPath}`)
     } else {
       let pasteName = nameFromPath || genRandStr(isPrivate ? params.PRIVATE_PASTE_NAME_LEN : params.PASTE_NAME_LEN)
       let newPasswd = passwdFromForm || passwd
-      await updatePaste(env, pasteName, content, item.metadata, {
+      await updatePaste(env, pasteName, content, originalMetadata, {
         expirationSeconds,
         now,
         passwd: newPasswd,

src/storage/storage.ts

@@ -1,12 +1,14 @@
-import {dateToUnix, genRandStr, params, WorkerError} from "../common.js";
+import {dateToUnix, WorkerError} from "../common.js";
 
 export type PasteMetadata = {
+    schemaVersion: number,
     passwd: string,
 
     lastModifiedAtUnix: number,
     createdAtUnix: number,
     willExpireAtUnix: number,
 
+    accessCounter: number,  // a counter representing how frequent it is accessed, to administration usage
     filename?: string,
 }
 
@@ -19,17 +21,50 @@ export async function getPaste(env: Env, short: string): Promise<PasteWithMetada
     let item = await env.PB.getWithMetadata<PasteMetadata>(short, {type: "arrayBuffer"});
 
     if (item.value === null) {
-        throw new WorkerError(404, `paste of name '${short}' not found`)
+        return null
     } else if (item.metadata === null) {
         throw new WorkerError(500, `paste of name '${short}' has no metadata`)
     } else {
         if (item.metadata.willExpireAtUnix < new Date().getTime() / 1000) {
-            throw new WorkerError(404, `paste of name '${short}' not found`)
+            return null
         }
+
+        // update counter with probability 1%
+        if (Math.random() < 0.01) {
+            item.metadata.accessCounter += 1
+            try {
+                env.PB.put(short, item.value, {
+                    metadata: item.metadata,
+                    expiration: item.metadata.willExpireAtUnix,
+                })
+            } catch (e) {
+                // ignore rate limit message
+                if (!(e as Error).message.includes( "KV PUT failed: 429 Too Many Requests")) {
+                    throw e
+                }
+            }
+        }
+
         return {paste: item.value, metadata: item.metadata}
     }
 }
 
+// we separate usage of getPasteMetadata and getPaste to make access metric more reliable
+export async function getPasteMetadata(env: Env, short: string): Promise<PasteMetadata | null> {
+    let item = await env.PB.getWithMetadata<PasteMetadata>(short, {type: "stream"});
+
+    if (item.value === null) {
+        return null
+    } else if (item.metadata === null) {
+        throw new WorkerError(500, `paste of name '${short}' has no metadata`)
+    } else {
+        if (item.metadata.willExpireAtUnix < new Date().getTime() / 1000) {
+            return null
+        }
+        return item.metadata
+    }
+}
+
 export async function updatePaste(
     env: Env,
     pasteName: string,
@@ -41,16 +76,19 @@ export async function updatePaste(
         passwd: string,
         filename?: string,
     }) {
-    const putOptions: { metadata: PasteMetadata, expirationTtl: number } = {
+    const expirationUnix = dateToUnix(options.now) + options.expirationSeconds
+    const putOptions: KVNamespacePutOptions = {
         metadata: {
+            schemaVersion: 0,
             filename: options.filename || originalMetadata.filename,
             passwd: options.passwd,
 
             lastModifiedAtUnix: dateToUnix(options.now),
             createdAtUnix: originalMetadata.createdAtUnix,
-            willExpireAtUnix: dateToUnix(options.now) + options.expirationSeconds,
+            willExpireAtUnix: expirationUnix,
+            accessCounter: originalMetadata.accessCounter,
         },
-        expirationTtl: options.expirationSeconds,
+        expiration: expirationUnix,
     }
 
     await env.PB.put(pasteName, content, putOptions)
@@ -66,16 +104,19 @@ export async function createPaste(
         passwd: string,
         filename?: string,
     }) {
-    const putOptions: { metadata: PasteMetadata, expirationTtl: number } = {
+    const expirationUnix = dateToUnix(options.now) + options.expirationSeconds
+    const putOptions: KVNamespacePutOptions = {
         metadata: {
+            schemaVersion: 0,
             filename: options.filename,
             passwd: options.passwd,
 
             lastModifiedAtUnix: dateToUnix(options.now),
             createdAtUnix: dateToUnix(options.now),
-            willExpireAtUnix: dateToUnix(options.now) + options.expirationSeconds,
+            willExpireAtUnix: expirationUnix,
+            accessCounter: 0,
         },
-        expirationTtl: options.expirationSeconds,
+        expiration: expirationUnix,
     }
 
     await env.PB.put(pasteName, content, putOptions)