add a cache system following Julien's suggestion

package-lock.json

@@ -9,6 +9,7 @@
       "version": "1.0.0",
       "license": "Apache License",
       "dependencies": {
+        "@gorgonjs/file-provider": "^1.4.1",
         "@gorgonjs/gorgon": "^1.4.1",
         "@gradio/client": "^0.1.4",
         "@huggingface/inference": "^2.6.1",
@@ -75,6 +76,17 @@
         "node": ">=12"
       }
     },
+    "node_modules/@gorgonjs/file-provider": {
+      "version": "1.4.1",
+      "resolved": "https://registry.npmjs.org/@gorgonjs/file-provider/-/file-provider-1.4.1.tgz",
+      "integrity": "sha512-pDhD7KvFmukHkfL69AHL/hpu5GFBJX9lUlJIll7K6yUxdZmJcXW7Egy7o3XPDff7Lfn8hftKNVUngfETdTTXAw==",
+      "dependencies": {
+        "fast-glob": "^3.3.0"
+      },
+      "peerDependencies": {
+        "@gorgonjs/gorgon": "^1.4.0"
+      }
+    },
     "node_modules/@gorgonjs/gorgon": {
       "version": "1.4.1",
       "resolved": "https://registry.npmjs.org/@gorgonjs/gorgon/-/gorgon-1.4.1.tgz",
@@ -212,6 +224,38 @@
         "@jridgewell/sourcemap-codec": "^1.4.10"
       }
     },
+    "node_modules/@nodelib/fs.scandir": {
+      "version": "2.1.5",
+      "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+      "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+      "dependencies": {
+        "@nodelib/fs.stat": "2.0.5",
+        "run-parallel": "^1.1.9"
+      },
+      "engines": {
+        "node": ">= 8"
+      }
+    },
+    "node_modules/@nodelib/fs.stat": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+      "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==",
+      "engines": {
+        "node": ">= 8"
+      }
+    },
+    "node_modules/@nodelib/fs.walk": {
+      "version": "1.2.8",
+      "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+      "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+      "dependencies": {
+        "@nodelib/fs.scandir": "2.1.5",
+        "fastq": "^1.6.0"
+      },
+      "engines": {
+        "node": ">= 8"
+      }
+    },
     "node_modules/@npmcli/fs": {
       "version": "3.1.0",
       "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-3.1.0.tgz",
@@ -811,6 +855,17 @@
         "concat-map": "0.0.1"
       }
     },
+    "node_modules/braces": {
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
+      "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+      "dependencies": {
+        "fill-range": "^7.0.1"
+      },
+      "engines": {
+        "node": ">=8"
+      }
+    },
     "node_modules/buffer": {
       "version": "5.7.1",
       "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz",
@@ -1696,6 +1751,21 @@
       "resolved": "https://registry.npmjs.org/fast-fifo/-/fast-fifo-1.3.0.tgz",
       "integrity": "sha512-IgfweLvEpwyA4WgiQe9Nx6VV2QkML2NkvZnk1oKnIzXgXdWxuhF7zw4DvLTPZJn6PIUneiAXPF24QmoEqHTjyw=="
     },
+    "node_modules/fast-glob": {
+      "version": "3.3.1",
+      "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.1.tgz",
+      "integrity": "sha512-kNFPyjhh5cKjrUltxs+wFx+ZkbRaxxmZ+X0ZU31SOsxCEtP9VPgtq2teZw1DebupL5GmDaNQ6yKMMVcM41iqDg==",
+      "dependencies": {
+        "@nodelib/fs.stat": "^2.0.2",
+        "@nodelib/fs.walk": "^1.2.3",
+        "glob-parent": "^5.1.2",
+        "merge2": "^1.3.0",
+        "micromatch": "^4.0.4"
+      },
+      "engines": {
+        "node": ">=8.6.0"
+      }
+    },
     "node_modules/fast-json-stable-stringify": {
       "version": "2.1.0",
       "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz",
@@ -1706,6 +1776,14 @@
       "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz",
       "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="
     },
+    "node_modules/fastq": {
+      "version": "1.15.0",
+      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz",
+      "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==",
+      "dependencies": {
+        "reusify": "^1.0.4"
+      }
+    },
     "node_modules/fd-slicer": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/fd-slicer/-/fd-slicer-1.1.0.tgz",
@@ -1901,6 +1979,17 @@
       "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz",
       "integrity": "sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw=="
     },
+    "node_modules/fill-range": {
+      "version": "7.0.1",
+      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
+      "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+      "dependencies": {
+        "to-regex-range": "^5.0.1"
+      },
+      "engines": {
+        "node": ">=8"
+      }
+    },
     "node_modules/finalhandler": {
       "version": "1.2.0",
       "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.2.0.tgz",
@@ -2386,6 +2475,17 @@
       "resolved": "https://registry.npmjs.org/glob-option-error/-/glob-option-error-1.0.0.tgz",
       "integrity": "sha512-AD7lbWbwF2Ii9gBQsQIOEzwuqP/jsnyvK27/3JDq1kn/JyfDtYI6AWz3ZQwcPuQdHSBcFh+A2yT/SEep27LOGg=="
     },
+    "node_modules/glob-parent": {
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+      "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+      "dependencies": {
+        "is-glob": "^4.0.1"
+      },
+      "engines": {
+        "node": ">= 6"
+      }
+    },
     "node_modules/glsl-shader-name": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/glsl-shader-name/-/glsl-shader-name-1.0.0.tgz",
@@ -2733,6 +2833,14 @@
         "node": ">=8"
       }
     },
+    "node_modules/is-extglob": {
+      "version": "2.1.1",
+      "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+      "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/is-fullwidth-code-point": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
@@ -2741,11 +2849,30 @@
         "node": ">=8"
       }
     },
+    "node_modules/is-glob": {
+      "version": "4.0.3",
+      "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+      "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+      "dependencies": {
+        "is-extglob": "^2.1.1"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/is-lambda": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/is-lambda/-/is-lambda-1.0.1.tgz",
       "integrity": "sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ=="
     },
+    "node_modules/is-number": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+      "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+      "engines": {
+        "node": ">=0.12.0"
+      }
+    },
     "node_modules/is-plain-obj": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz",
@@ -3035,6 +3162,14 @@
       "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz",
       "integrity": "sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w=="
     },
+    "node_modules/merge2": {
+      "version": "1.4.1",
+      "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+      "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==",
+      "engines": {
+        "node": ">= 8"
+      }
+    },
     "node_modules/methods": {
       "version": "1.1.2",
       "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz",
@@ -3043,6 +3178,18 @@
         "node": ">= 0.6"
       }
     },
+    "node_modules/micromatch": {
+      "version": "4.0.5",
+      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz",
+      "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+      "dependencies": {
+        "braces": "^3.0.2",
+        "picomatch": "^2.3.1"
+      },
+      "engines": {
+        "node": ">=8.6"
+      }
+    },
     "node_modules/mime": {
       "version": "1.6.0",
       "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
@@ -3806,6 +3953,17 @@
       "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz",
       "integrity": "sha512-7EAHlyLHI56VEIdK57uwHdHKIaAGbnXPiw0yWbarQZOKaKpvUIgW0jWRVLiatnM+XXlSwsanIBH/hzGMJulMow=="
     },
+    "node_modules/picomatch": {
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+      "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==",
+      "engines": {
+        "node": ">=8.6"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/jonschlinkert"
+      }
+    },
     "node_modules/pngjs": {
       "version": "3.4.0",
       "resolved": "https://registry.npmjs.org/pngjs/-/pngjs-3.4.0.tgz",
@@ -4054,6 +4212,25 @@
       "resolved": "https://registry.npmjs.org/querystringify/-/querystringify-2.2.0.tgz",
       "integrity": "sha512-FIqgj2EUvTa7R50u0rGsyTftzjYmv/a3hO345bZNrqabNqjtgiDMgmo4mkUjd+nzU5oF3dClKqFIPUKybUyqoQ=="
     },
+    "node_modules/queue-microtask": {
+      "version": "1.2.3",
+      "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+      "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/feross"
+        },
+        {
+          "type": "patreon",
+          "url": "https://www.patreon.com/feross"
+        },
+        {
+          "type": "consulting",
+          "url": "https://feross.org/support"
+        }
+      ]
+    },
     "node_modules/queue-tick": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/queue-tick/-/queue-tick-1.0.1.tgz",
@@ -4209,6 +4386,15 @@
         "node": ">= 4"
       }
     },
+    "node_modules/reusify": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz",
+      "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==",
+      "engines": {
+        "iojs": ">=1.0.0",
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/rimraf": {
       "version": "3.0.2",
       "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz",
@@ -4246,6 +4432,28 @@
         "rimraf": "bin.js"
       }
     },
+    "node_modules/run-parallel": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+      "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/feross"
+        },
+        {
+          "type": "patreon",
+          "url": "https://www.patreon.com/feross"
+        },
+        {
+          "type": "consulting",
+          "url": "https://feross.org/support"
+        }
+      ],
+      "dependencies": {
+        "queue-microtask": "^1.2.2"
+      }
+    },
     "node_modules/safe-buffer": {
       "version": "5.2.1",
       "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
@@ -4816,6 +5024,17 @@
       "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz",
       "integrity": "sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ=="
     },
+    "node_modules/to-regex-range": {
+      "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+      "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+      "dependencies": {
+        "is-number": "^7.0.0"
+      },
+      "engines": {
+        "node": ">=8.0"
+      }
+    },
     "node_modules/toidentifier": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz",

package.json

@@ -16,6 +16,7 @@
   "author": "Julian Bilcke <[email protected]>",
   "license": "Apache License",
   "dependencies": {
+    "@gorgonjs/file-provider": "^1.4.1",
     "@gorgonjs/gorgon": "^1.4.1",
     "@gradio/client": "^0.1.4",
     "@huggingface/inference": "^2.6.1",

src/config.mts

@@ -2,6 +2,7 @@ import path from "node:path"
 
 export const storagePath = `${process.env.VC_STORAGE_PATH || './sandbox'}`
 
+// those are persistent storage (we want to keep the data for months/years)
 export const metadataDirPath = path.join(storagePath, "metadata")
 export const pendingMetadataDirFilePath = path.join(metadataDirPath, "pending")
 export const completedMetadataDirFilePath =  path.join(metadataDirPath, "completed")
@@ -10,5 +11,9 @@ export const filesDirPath = path.join(storagePath, "files")
 export const pendingFilesDirFilePath = path.join(filesDirPath, "pending")
 export const completedFilesDirFilePath =  path.join(filesDirPath, "completed")
 
+// this is a semi-persistent storage (we want to renew it from time to time)
+export const cacheDirPath = path.join(storagePath, "cache")
+export const renderedDirFilePath = path.join(filesDirPath, "rendered")
+
 export const shotFormatVersion = 1
 export const sequenceFormatVersion = 1

src/index.mts

@@ -1,10 +1,11 @@
 import { createReadStream, existsSync } from "node:fs"
 import path from "node:path"
 
-import { v4 as uuidv4, validate as uuidValidate } from "uuid"
+import { validate as uuidValidate } from "uuid"
 import express from "express"
 
 import { Video, VideoStatus, VideoAPIRequest, RenderRequest, RenderedScene } from "./types.mts"
+
 import { parseVideoRequest } from "./utils/parseVideoRequest.mts"
 import { savePendingVideo } from "./scheduler/savePendingVideo.mts"
 import { getVideo } from "./scheduler/getVideo.mts"
@@ -19,9 +20,9 @@ import { hasValidAuthorization } from "./utils/hasValidAuthorization.mts"
 import { getAllVideosForOwner } from "./scheduler/getAllVideosForOwner.mts"
 import { initFolders } from "./initFolders.mts"
 import { sortVideosByYoungestFirst } from "./utils/sortVideosByYoungestFirst.mts"
-import { generateVideo } from "./production/generateVideo.mts"
-import { generateSeed } from "./utils/generateSeed.mts"
 import { getRenderedScene, renderScene } from "./production/renderScene.mts"
+import { parseRenderRequest } from "./utils/parseRenderRequest.mts"
+import { loadRenderedSceneFromCache } from "./utils/loadRenderedSceneFromCache.mts"
 
 initFolders()
 // to disable all processing (eg. to debug)
@@ -38,8 +39,10 @@ let isRendering = false
 // a "fast track" pipeline
 app.post("/render", async (req, res) => {
 
-  const request = req.body as RenderRequest
   console.log(req.body)
+
+  const request = parseRenderRequest(req.body as RenderRequest)
+
   if (!request.prompt) {
     console.log("Invalid prompt")
     res.status(400)
@@ -48,6 +51,16 @@ app.post("/render", async (req, res) => {
     return
   }
 
+  try {
+    const cached = await loadRenderedSceneFromCache(request)
+    const cachedJson = JSON.stringify(cached)
+    res.status(200)
+    res.write(cachedJson)
+    res.end()
+  } catch (err) {
+    // move along
+  }
+
   let response: RenderedScene = {
     renderId: "",
     status: "pending",
@@ -56,7 +69,7 @@ app.post("/render", async (req, res) => {
     error: "",
     segments: []
   }
-  
+
   try {
     response = await renderScene(request)
   } catch (err) {
@@ -98,6 +111,16 @@ app.get("/render/:renderId", async (req, res) => {
     return
   }
 
+  try {
+    const cached = await loadRenderedSceneFromCache(undefined, renderId)
+    const cachedJson = JSON.stringify(cached)
+    res.status(200)
+    res.write(cachedJson)
+    res.end()
+  } catch (err) {
+    // move along
+  }
+
   let response: RenderedScene = {
     renderId: "",
     status: "pending",
@@ -135,52 +158,6 @@ app.get("/render/:renderId", async (req, res) => {
   }
 })
 
-
-// a "fast track" pipeline
-/*
-app.post("/segment", async (req, res) => {
-
-  const request = req.body as RenderRequest
-  console.log(req.body)
-
-  let result: RenderedScene = {
-    assetUrl: "",
-    maskUrl: "",
-    error: "",
-    segments: []
-  }
-  
-  try {
-    result = await renderScene(request)
-  } catch (err) {
-    // console.log("failed to render scene!")
-    result.error = `failed to render scene: ${err}`
-  }
-
-  if (result.error === "already rendering") {
-    console.log("server busy")
-    res.status(200)
-    res.write(JSON.stringify({ url: "", error: result.error }))
-    res.end()
-    return
-  } else if (result.error.length > 0) {
-    // console.log("server error")
-    res.status(500)
-    res.write(JSON.stringify({ url: "", error: result.error }))
-    res.end()
-    return
-  } else {
-    // console.log("all good")
-    res.status(200)
-    res.write(JSON.stringify(result))
-    res.end()
-    return
-  }
-})
-*/
-
-
-
 app.post("/:ownerId", async (req, res) => {
   const request = req.body as VideoAPIRequest
 

src/production/renderScene.mts

@@ -4,6 +4,7 @@ import { RenderedScene, RenderRequest } from "../types.mts"
 import { generateSeed } from "../utils/generateSeed.mts"
 import { getValidNumber } from "../utils/getValidNumber.mts"
 import { renderPipeline } from "./renderPipeline.mts"
+import { getValidBoolean } from "../utils/getValidBoolean.mts"
 
 const cache: Record<string, RenderedScene> = {}
 const cacheQueue: string[] = []
@@ -11,23 +12,8 @@ const maxCacheSize = 1000
 
 export async function renderScene(request: RenderRequest): Promise<RenderedScene> {
   // const key = getCacheKey(scene)
-  const renderId = uuidv4()
-
-  request.nbFrames = getValidNumber(request.nbFrames, 1, 24, 16)
-
-  const isVideo = request?.nbFrames === 1
-
-  // important: we need a consistent seed for our multiple rendering passes
-  request.seed = getValidNumber(request.seed, 0, 2147483647, generateSeed())
-  request.nbSteps = getValidNumber(request.nbSteps, 5, 50, 10)
 
-  if (isVideo) {
-    request.width = getValidNumber(request.width, 256, 1024, 1024)
-    request.height = getValidNumber(request.height, 256, 1024, 512)
-  } else {
-    request.width = getValidNumber(request.width, 256, 1280, 576)
-    request.height = getValidNumber(request.height, 256, 720, 320)
-  }
+  const renderId = uuidv4()
 
   const response: RenderedScene = {
     renderId,
@@ -59,4 +45,5 @@ export async function getRenderedScene(renderId: string): Promise<RenderedScene>
     throw new Error(`couldn't find any rendered scene with renderId ${renderId}`)
   }
   return cache[renderId]
-}
+}
+

src/types.mts

@@ -299,6 +299,8 @@ export interface RenderRequest {
   height: number
 
   projection: ProjectionMode
+
+  useCache: boolean
 }
 
 export interface ImageSegmentationRequest {
@@ -325,6 +327,12 @@ export interface RenderedScene {
   segments: ImageSegment[]
 }
 
+export interface RenderCache {
+  id: string
+  hash: string
+  scene: RenderedScene
+}
+
 // note: for video generation we are always going to have slow jobs,
 // because we need multiple seconds, minutes, hours.. of video + audio
 // but for rendering we aim at shorter delays, less than 45 seconds

src/utils/computeSha256.mts

@@ -0,0 +1,14 @@
+import { createHash } from 'node:crypto'
+
+/**
+ * Returns a SHA256 hash using SHA-3 for the given `content`.
+ *
+ * @see https://en.wikipedia.org/wiki/SHA-3
+ *
+ * @param {String} content
+ *
+ * @returns {String}
+ */
+export function computeSha256(strContent: string) {
+  return createHash('sha3-256').update(strContent).digest('hex')
+}

src/utils/getValidBoolean.mts

@@ -0,0 +1,9 @@
+export const getValidBoolean = (something: any, defaultValue: boolean) => {
+  if (typeof something === "boolean") {
+    return something
+  }
+
+  const strValue = `${something || defaultValue}`.toLowerCase()
+  
+  return strValue === "true" || strValue === "1" || strValue === "on"
+}

src/utils/loadRenderedSceneFromCache.mts

@@ -0,0 +1,50 @@
+import { promises as fs } from "node:fs"
+import path from "node:path"
+
+import { RenderRequest, RenderedScene } from "../types.mts"
+import { renderedDirFilePath } from "../config.mts"
+import { computeSha256 } from "./computeSha256.mts"
+
+export async function loadRenderedSceneFromCache(request?: RenderRequest, id?: string): Promise<RenderedScene> {
+  
+  let pattern = ""
+
+  if (request?.prompt) {
+    try {
+      const requestJson = JSON.stringify(request)
+      const hash = computeSha256(requestJson)
+      pattern = `hash_${hash}`
+    } catch (err) {
+    }
+  } else if (id) {
+   pattern = `id_${id}` 
+  }
+
+  if (!pattern) {
+    throw new Error("invalid request or id")
+  }
+
+  for (const cachedFile of await fs.readdir(renderedDirFilePath)) {
+
+    if (cachedFile.includes(pattern)) {
+
+      const cacheFilePath = path.join(renderedDirFilePath, cachedFile)
+
+      const scene = JSON.parse(
+        await fs.readFile(cacheFilePath, 'utf8')
+      ) as RenderedScene
+    
+      if (!scene.assetUrl) {
+        throw new Error("there is something wrong with the cached rendered scene (url is empty)")
+      }
+    
+      if (!scene.assetUrl) {
+        throw new Error("there is something wrong with the cached rendered scene (statis is not completed)")
+      }
+
+      return scene
+    }
+  }
+
+  throw new Error("couldn't find a cached scene with id entry")
+}

src/utils/parseRenderRequest.mts

@@ -0,0 +1,30 @@
+import { RenderRequest } from "../types.mts"
+import { generateSeed } from "./generateSeed.mts"
+import { getValidBoolean } from "./getValidBoolean.mts"
+import { getValidNumber } from "./getValidNumber.mts"
+
+export function parseRenderRequest(request: RenderRequest) {
+
+  try {
+    request.nbFrames = getValidNumber(request.nbFrames, 1, 24, 16)
+
+    const isVideo = request?.nbFrames === 1
+
+    // important: we need a consistent seed for our multiple rendering passes
+    request.seed = getValidNumber(request.seed, 0, 2147483647, generateSeed())
+    request.nbSteps = getValidNumber(request.nbSteps, 5, 50, 10)
+
+    if (isVideo) {
+      request.width = getValidNumber(request.width, 256, 1024, 1024)
+      request.height = getValidNumber(request.height, 256, 1024, 512)
+    } else {
+      request.width = getValidNumber(request.width, 256, 1280, 576)
+      request.height = getValidNumber(request.height, 256, 720, 320)
+    }
+
+    request.useCache = getValidBoolean(request.useCache, false)
+  } catch (err) {
+    console.error(`failed to parse the render request: ${err}`)
+  }
+  return request
+}

src/utils/saveRenderedSceneToCache.mts

@@ -0,0 +1,29 @@
+import { promises as fs } from "node:fs"
+import path from "node:path"
+
+import { RenderRequest, RenderedScene } from "../types.mts"
+import { renderedDirFilePath } from "../config.mts"
+
+import { computeSha256 } from "./computeSha256.mts"
+
+export async function saveRenderedSceneToCache(
+  request: RenderRequest,
+  scene: RenderedScene
+): Promise<RenderedScene> {
+  if (scene.status !== "completed") {
+    throw new Error("sorry, it only makes sense to cache a *completed* scene, not a pending or failed one.")
+  }
+
+  const requestJson = JSON.stringify(request)
+  const hash = computeSha256(requestJson)
+  const id = scene.renderId
+
+  const cacheFileName = `hash_${hash}_id_${id}.json`
+  const cacheFilePath = path.join(renderedDirFilePath, cacheFileName)
+
+  const renderedSceneJson = JSON.stringify(scene)
+
+  await fs.writeFile(cacheFilePath, renderedSceneJson, "utf8")
+
+  return scene
+}