Use structuredClone for deep cloning

cubap · cubap · commit d6e17ceecf4c · 2026-05-06T11:12:13.000-05:00
Replace numerous JSON.parse(JSON.stringify(...)) and utils.cloneObject calls with native structuredClone across controllers and utils for safer, more reliable deep copies. Remove the now-unused cloneObject helper from utils.js and update configureRerumOptions to use structuredClone. Also tweak clampNonNegativeInt to treat non-positive values (&lt;= 0) as fallback, switch history HEAD handling to res.status(200).end(), and add safeBody usage in delete to avoid re-parsing request body.
diff --git a/controllers/bulk.js b/controllers/bulk.js
@@ -33,7 +33,7 @@ const bulkCreate = async function (req, res, next) {
         // Each item must be valid JSON, but can't be an array.
         if(Array.isArray(d) || typeof d !== "object") return d
         try {
-            JSON.parse(JSON.stringify(d))
+            structuredClone(d)
         } catch (err) {
             return d
         }
@@ -120,7 +120,7 @@ const bulkUpdate = async function (req, res, next) {
         // Each item must be valid JSON, but can't be an array.
         if(Array.isArray(d) || typeof d !== "object") return d
         try {
-            JSON.parse(JSON.stringify(d))
+            structuredClone(d)
         } catch (err) {
             return d
         }
diff --git a/controllers/crud.js b/controllers/crud.js
@@ -37,7 +37,7 @@ const create = async function (req, res, next) {
     let generatorAgent = getAgentClaim(req, next)
     if (!generatorAgent) return
     let context = req.body["@context"] ? { "@context": req.body["@context"] } : {}
-    let provided = utils.cloneObject(req.body)
+    let provided = structuredClone(req.body)
     let rerumProp = { "__rerum": utils.configureRerumOptions(generatorAgent, provided, false, false)["__rerum"] }
     if(slug){
         rerumProp.__rerum.slug = slug
@@ -55,7 +55,7 @@ const create = async function (req, res, next) {
         let result = await db.insertOne(newObject)
         res.set(utils.configureWebAnnoHeadersFor(newObject))
         newObject = idNegotiation(newObject)
-        newObject.new_obj_state = utils.cloneObject(newObject)
+        newObject.new_obj_state = structuredClone(newObject)
         res.location(newObject[_contextid(newObject["@context"]) ? "id":"@id"])
         res.status(201)
         res.json(newObject)
diff --git a/controllers/delete.js b/controllers/delete.js
@@ -23,8 +23,9 @@ import { getAgentClaim, parseDocumentID, getAllVersions, getAllDescendants } fro
 const deleteObj = async function(req, res, next) {
     let id
     let err = { message: `` }
+    const safeBody = structuredClone(req.body)
     try {
-        id = req.params["_id"] ?? parseDocumentID(JSON.parse(JSON.stringify(req.body))["@id"]) ?? parseDocumentID(JSON.parse(JSON.stringify(req.body))["id"])
+        id = req.params["_id"] ?? parseDocumentID(safeBody?.["@id"]) ?? parseDocumentID(safeBody?.["id"])
     } catch(error){
         return next(utils.createExpressError(error))
     }
@@ -37,7 +38,7 @@ const deleteObj = async function(req, res, next) {
         return next(utils.createExpressError(error))
     }
     if (null !== originalObject) {
-        let safe_original = JSON.parse(JSON.stringify(originalObject))
+        let safe_original = structuredClone(originalObject)
         if (utils.isDeleted(safe_original)) {
             err = Object.assign(err, {
                 message: `The object you are trying to delete is already deleted. ${err.message}`,
@@ -61,7 +62,7 @@ const deleteObj = async function(req, res, next) {
         }
         let preserveID = safe_original["@id"]
         let deletedFlag = {} //The __deleted flag is a JSONObject
-        deletedFlag["object"] = JSON.parse(JSON.stringify(originalObject))
+        deletedFlag["object"] = structuredClone(originalObject)
         deletedFlag["deletor"] = agentRequestingDelete
         deletedFlag["time"] = new Date(Date.now()).toISOString().replace("Z", "")
         let deletedObject = {
@@ -125,7 +126,7 @@ async function healHistoryTree(obj) {
             const nextIdForQuery = parseDocumentID(nextID)
             const objToUpdate = await db.findOne({"$or":[{"_id": nextIdForQuery}, {"__rerum.slug": nextIdForQuery}]})
             if (null !== objToUpdate) {
-                let fixHistory = JSON.parse(JSON.stringify(objToUpdate))
+                let fixHistory = structuredClone(objToUpdate)
                 if (objToDeleteisRoot) {
                     //This means this next object must become root. 
                     //Strictly, all history trees must have num(root) > 0.  
@@ -158,7 +159,7 @@ async function healHistoryTree(obj) {
             let previousIdForQuery = parseDocumentID(previous_id)
             const objToUpdate2 = await db.findOne({"$or":[{"_id": previousIdForQuery}, {"__rerum.slug": previousIdForQuery}]})
             if (null !== objToUpdate2) {
-                let fixHistory2 = JSON.parse(JSON.stringify(objToUpdate2))
+                let fixHistory2 = structuredClone(objToUpdate2)
                 let origNextArray = fixHistory2["__rerum"]["history"]["next"]
                 let newNextArray = [...origNextArray]
                 newNextArray = newNextArray.filter(id => id !== obj["@id"])
@@ -197,7 +198,7 @@ async function newTreePrime(obj) {
             // fail silently
         }
         for (const d of descendants) {
-            let objWithUpdate = JSON.parse(JSON.stringify(d))
+            let objWithUpdate = structuredClone(d)
             objWithUpdate["__rerum"]["history"]["prime"] = primeID
             let result = await db.replaceOne({ "_id": d["_id"] }, objWithUpdate)
             if (result.modifiedCount === 0) {
diff --git a/controllers/gog.js b/controllers/gog.js
@@ -387,7 +387,7 @@ const expand = async function(primitiveEntity, GENERATOR=undefined, CREATOR=unde
     })
 
     // Combine the Annotation bodies with the primitive object
-    let expandedEntity = JSON.parse(JSON.stringify(primitiveEntity))
+    let expandedEntity = structuredClone(primitiveEntity)
     for(const anno of matches){
         const body = anno.body
         let keys = Object.keys(body)
diff --git a/controllers/history.js b/controllers/history.js
@@ -118,7 +118,7 @@ const queryHeadRequest = async function (req, res, next) {
         if (matches.length) {
             const size = Buffer.byteLength(JSON.stringify(matches))
             res.set("Content-Length", size)
-            res.sendStatus(200)
+            res.status(200).end()
             return
         }
         let err = {
diff --git a/controllers/overwrite.js b/controllers/overwrite.js
@@ -19,7 +19,7 @@ import { _contextid, ObjectID, getAgentClaim, parseDocumentID, idNegotiation } f
 const overwrite = async function (req, res, next) {
     let err = { message: `` }
     res.set("Content-Type", "application/json; charset=utf-8")
-    let objectReceived = JSON.parse(JSON.stringify(req.body))
+    let objectReceived = structuredClone(req.body)
     let agentRequestingOverwrite = getAgentClaim(req, next)
     if (!agentRequestingOverwrite) return
     const receivedID = objectReceived["@id"] ?? objectReceived.id
@@ -93,7 +93,7 @@ const overwrite = async function (req, res, next) {
                 res.set('Current-Overwritten-Version', rerumProp["__rerum"].isOverwritten)
                 res.set(utils.configureWebAnnoHeadersFor(newObject))
                 newObject = idNegotiation(newObject)
-                newObject.new_obj_state = JSON.parse(JSON.stringify(newObject))
+                newObject.new_obj_state = structuredClone(newObject)
                 res.location(newObject[_contextid(newObject["@context"]) ? "id":"@id"])
                 res.json(newObject)
                 return
diff --git a/controllers/patchSet.js b/controllers/patchSet.js
@@ -21,7 +21,7 @@ import { _contextid, ObjectID, getAgentClaim, parseDocumentID, idNegotiation, al
 const patchSet = async function (req, res, next) {
     let err = { message: `` }
     res.set("Content-Type", "application/json; charset=utf-8")
-    let objectReceived = utils.cloneObject(req.body)
+    let objectReceived = structuredClone(req.body)
     let originalContext
     let patchedObject = {}
     let generatorAgent = getAgentClaim(req, next)
@@ -50,7 +50,7 @@ const patchSet = async function (req, res, next) {
             })
         }
         else {
-            patchedObject = utils.cloneObject(originalObject)
+            patchedObject = structuredClone(originalObject)
             if(_contextid(originalObject["@context"])) {
                 // If the original object has a context that needs id protected, make sure you don't set it.
                 delete objectReceived.id
@@ -73,7 +73,7 @@ const patchSet = async function (req, res, next) {
                 //Just hand back the object.  The resulting of setting nothing is the object from the request body.
                 res.set(utils.configureWebAnnoHeadersFor(originalObject))
                 originalObject = idNegotiation(originalObject)
-                originalObject.new_obj_state = utils.cloneObject(originalObject)
+                originalObject.new_obj_state = structuredClone(originalObject)
                 res.location(originalObject[_contextid(originalObject["@context"]) ? "id":"@id"])
                 res.status(200)
                 res.json(originalObject)
@@ -93,7 +93,7 @@ const patchSet = async function (req, res, next) {
                     //Success, the original object has been updated.
                     res.set(utils.configureWebAnnoHeadersFor(newObject))
                     newObject = idNegotiation(newObject)
-                    newObject.new_obj_state = utils.cloneObject(newObject)
+                    newObject.new_obj_state = structuredClone(newObject)
                     res.location(newObject[_contextid(newObject["@context"]) ? "id":"@id"])
                     res.status(200)
                     res.json(newObject)
diff --git a/controllers/patchUnset.js b/controllers/patchUnset.js
@@ -21,7 +21,7 @@ import { _contextid, ObjectID, getAgentClaim, parseDocumentID, idNegotiation, al
 const patchUnset = async function (req, res, next) {
     let err = { message: `` }
     res.set("Content-Type", "application/json; charset=utf-8")
-    let objectReceived = utils.cloneObject(req.body)
+    let objectReceived = structuredClone(req.body)
     let patchedObject = {}
     let generatorAgent = getAgentClaim(req, next)
     if (!generatorAgent) return
@@ -49,7 +49,7 @@ const patchUnset = async function (req, res, next) {
             })
         }
         else {
-            patchedObject = utils.cloneObject(originalObject)
+            patchedObject = structuredClone(originalObject)
             delete objectReceived._id //can't unset this
             delete objectReceived.__rerum //can't unset this
             delete objectReceived["@id"] //can't unset this
@@ -75,7 +75,7 @@ const patchUnset = async function (req, res, next) {
                 //Just hand back the object.  The resulting of unsetting nothing is the object.
                 res.set(utils.configureWebAnnoHeadersFor(originalObject))
                 originalObject = idNegotiation(originalObject)
-                originalObject.new_obj_state = utils.cloneObject(originalObject)
+                originalObject.new_obj_state = structuredClone(originalObject)
                 res.location(originalObject[_contextid(originalObject["@context"]) ? "id":"@id"])
                 res.status(200)
                 res.json(originalObject)
@@ -97,7 +97,7 @@ const patchUnset = async function (req, res, next) {
                     //Success, the original object has been updated.
                     res.set(utils.configureWebAnnoHeadersFor(newObject))
                     newObject = idNegotiation(newObject)
-                    newObject.new_obj_state = utils.cloneObject(newObject)
+                    newObject.new_obj_state = structuredClone(newObject)
                     res.location(newObject[_contextid(newObject["@context"]) ? "id":"@id"])
                     res.status(200)
                     res.json(newObject)
diff --git a/controllers/patchUpdate.js b/controllers/patchUpdate.js
@@ -20,7 +20,7 @@ import { _contextid, ObjectID, getAgentClaim, parseDocumentID, idNegotiation, al
 const patchUpdate = async function (req, res, next) {
     let err = { message: `` }
     res.set("Content-Type", "application/json; charset=utf-8")
-    let objectReceived = utils.cloneObject(req.body)
+    let objectReceived = structuredClone(req.body)
     let patchedObject = {}
     let generatorAgent = getAgentClaim(req, next)
     if (!generatorAgent) return
@@ -48,7 +48,7 @@ const patchUpdate = async function (req, res, next) {
             })
         }
         else {
-            patchedObject = utils.cloneObject(originalObject)
+            patchedObject = structuredClone(originalObject)
             delete objectReceived.__rerum //can't patch this
             delete objectReceived._id //can't patch this
             delete objectReceived["@id"] //can't patch this
@@ -74,7 +74,7 @@ const patchUpdate = async function (req, res, next) {
                 //Just hand back the object.  The resulting of patching nothing is the object unchanged.
                 res.set(utils.configureWebAnnoHeadersFor(originalObject))
                 originalObject = idNegotiation(originalObject)
-                originalObject.new_obj_state = utils.cloneObject(originalObject)
+                originalObject.new_obj_state = structuredClone(originalObject)
                 res.location(originalObject[_contextid(originalObject["@context"]) ? "id":"@id"])
                 res.status(200)
                 res.json(originalObject)
@@ -96,7 +96,7 @@ const patchUpdate = async function (req, res, next) {
                     //Success, the original object has been updated.
                     res.set(utils.configureWebAnnoHeadersFor(newObject))
                     newObject = idNegotiation(newObject)
-                    newObject.new_obj_state = utils.cloneObject(newObject)
+                    newObject.new_obj_state = structuredClone(newObject)
                     res.location(newObject[_contextid(newObject["@context"]) ? "id":"@id"])
                     res.status(200)
                     res.json(newObject)
diff --git a/controllers/putUpdate.js b/controllers/putUpdate.js
@@ -22,7 +22,7 @@ import { _contextid, ObjectID, getAgentClaim, parseDocumentID, idNegotiation, al
 const putUpdate = async function (req, res, next) {
     let err = { message: `` }
     res.set("Content-Type", "application/json; charset=utf-8")
-    let objectReceived = utils.cloneObject(req.body)
+    let objectReceived = structuredClone(req.body)
     let generatorAgent = getAgentClaim(req, next)
     if (!generatorAgent) return
     const idReceived = objectReceived["@id"] ?? objectReceived.id
@@ -69,7 +69,7 @@ const putUpdate = async function (req, res, next) {
                     //Success, the original object has been updated.
                     res.set(utils.configureWebAnnoHeadersFor(newObject))
                     newObject = idNegotiation(newObject)
-                    newObject.new_obj_state = utils.cloneObject(newObject)
+                    newObject.new_obj_state = structuredClone(newObject)
                     res.location(newObject[_contextid(newObject["@context"]) ? "id":"@id"])
                     res.status(200)
                     res.json(newObject)
@@ -107,7 +107,7 @@ const putUpdate = async function (req, res, next) {
 async function _import(req, res, next) {
     let err = { message: `` }
     res.set("Content-Type", "application/json; charset=utf-8")
-    let objectReceived = utils.cloneObject(req.body)
+    let objectReceived = structuredClone(req.body)
     let generatorAgent = getAgentClaim(req, next)
     if (!generatorAgent) return
     const id = ObjectID()
@@ -125,7 +125,7 @@ async function _import(req, res, next) {
         let result = await db.insertOne(newObject)
         res.set(utils.configureWebAnnoHeadersFor(newObject))
         newObject = idNegotiation(newObject)
-        newObject.new_obj_state = utils.cloneObject(newObject)
+        newObject.new_obj_state = structuredClone(newObject)
         res.location(newObject[_contextid(newObject["@context"]) ? "id":"@id"])
         res.status(200)
         res.json(newObject)
diff --git a/controllers/release.js b/controllers/release.js
@@ -44,7 +44,7 @@ const release = async function (req, res, next) {
         catch (error) {
             return next(utils.createExpressError(error))
         }
-        let safe_original = JSON.parse(JSON.stringify(originalObject))
+        let safe_original = structuredClone(originalObject)
         let previousReleasedID = safe_original.__rerum.releases.previous
         let nextReleases = safe_original.__rerum.releases.next
         
@@ -108,7 +108,7 @@ const release = async function (req, res, next) {
                 res.set(utils.configureWebAnnoHeadersFor(releasedObject))
                 console.log(releasedObject._id+" has been released")
                 releasedObject = idNegotiation(releasedObject)
-                releasedObject.new_obj_state = JSON.parse(JSON.stringify(releasedObject))
+                releasedObject.new_obj_state = structuredClone(releasedObject)
                 res.location(releasedObject[_contextid(releasedObject["@context"]) ? "id":"@id"])
                 res.json(releasedObject)
                 return
diff --git a/controllers/utils.js b/controllers/utils.js
@@ -14,7 +14,7 @@ const MAX_QUERY_SKIP = Number.parseInt(process.env.RERUM_MAX_QUERY_SKIP ?? 10000
 
 function clampNonNegativeInt(value, fallback, max) {
     const parsed = Number.parseInt(value, 10)
-    if (!Number.isFinite(parsed) || parsed < 0) return fallback
+    if (!Number.isFinite(parsed) || parsed <= 0) return fallback
     return parsed > max ? max : parsed
 }
 
@@ -70,7 +70,7 @@ const idNegotiation = function (resBody) {
     const _id = resBody._id
     delete resBody._id
     if(!resBody["@context"]) return resBody
-    let modifiedResBody = utils.cloneObject(resBody)
+    let modifiedResBody = structuredClone(resBody)
     const context = { "@context": resBody["@context"] }
     if(_contextid(resBody["@context"])) {
         delete resBody["@id"]
@@ -200,7 +200,7 @@ async function getAllVersions(obj) {
     let rootObj
     if (primeID === "root") {
         //The obj passed in is root.  So it is the rootObj we need.
-        rootObj = utils.cloneObject(obj)
+        rootObj = structuredClone(obj)
     } else if (primeID) {
         //The obj passed in knows the ID of root, grab it from Mongo
         //Use _id for indexed query performance instead of @id
@@ -317,7 +317,7 @@ async function establishReleasesTree(releasing) {
     const descendants = getAllDescendants(all, releasing, [])
     const ancestors = getAllAncestors(all, releasing, [])
     for(const d of descendants){
-        let safe_descendant = JSON.parse(JSON.stringify(d))
+        let safe_descendant = structuredClone(d)
         let d_id = safe_descendant._id
         safe_descendant.__rerum.releases.previous = releasing["@id"]
         let result
@@ -335,7 +335,7 @@ async function establishReleasesTree(releasing) {
         }  
     }
     for(const a of ancestors){
-        let safe_ancestor = JSON.parse(JSON.stringify(a))
+        let safe_ancestor = structuredClone(a)
         let a_id = safe_ancestor._id
         if(safe_ancestor.__rerum.releases.next.indexOf(releasing["@id"]) === -1){
             safe_ancestor.__rerum.releases.next.push(releasing["@id"])    
@@ -377,7 +377,7 @@ async function healReleasesTree(releasing) {
     const descendants = getAllDescendants(all, releasing, [])
     const ancestors = getAllAncestors(all, releasing, [])
     for(const d of descendants){
-        let safe_descendant = JSON.parse(JSON.stringify(d))
+        let safe_descendant = structuredClone(d)
         let d_id = safe_descendant._id
         if(d.__rerum.releases.previous === releasing.__rerum.releases.previous){
             // If the descendant's previous matches the node I am releasing's
@@ -405,7 +405,7 @@ async function healReleasesTree(releasing) {
     }
     let origNextArray = releasing.__rerum.releases.next
     for (const a of ancestors){
-        let safe_ancestor = JSON.parse(JSON.stringify(a))
+        let safe_ancestor = structuredClone(a)
         let a_id = safe_ancestor._id
         let ancestorNextArray = safe_ancestor.__rerum.releases.next
         if (ancestorNextArray.length == 0) {
diff --git a/utils.js b/utils.js
@@ -25,16 +25,10 @@ isReleased        —always ""
  * @param update A trigger for special handling from update actions
  * @return configuredObject The same object that was recieved but with the proper __rerum options.  This object is intended to be saved as a new object (@see versioning)
  */
-const cloneObject = function(value){
-    if(typeof globalThis.structuredClone === "function"){
-        return globalThis.structuredClone(value)
-    }
-    return JSON.parse(JSON.stringify(value))
-}
 
 const configureRerumOptions = function(generator, received, update, extUpdate){
-    let configuredObject = cloneObject(received)
-    let received_options = received.__rerum ? cloneObject(received.__rerum) : {}
+    let configuredObject = structuredClone(received)
+    let received_options = received.__rerum ? structuredClone(received.__rerum) : {}
     let history = {}
     let releases = {}
     let rerumOptions = {}
@@ -266,7 +260,6 @@ function createExpressError(err) {
 }
 
 export default {
-    cloneObject,
     configureRerumOptions,
     createExpressError,
     isDeleted,

Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ const queryHeadRequest = async function (req, res, next) {`
`118`	`118`	`if (matches.length) {`
`119`	`119`	`const size = Buffer.byteLength(JSON.stringify(matches))`
`120`	`120`	`res.set("Content-Length", size)`
`121`		`- res.sendStatus(200)`
	`121`	`+ res.status(200).end()`
`122`	`122`	`return`
`123`	`123`	`}`
`124`	`124`	`let err = {`