Skip to content

Runtime Improvements #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
thehabes wants to merge 3 commits into from
Closed

Runtime Improvements #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d40907
Thinking and testing
Dec 9, 2025
486e83b
Merge branch 'main' into investigate-optimistic-locking-overwrite
Dec 9, 2025
52dfd16
Merge main into this branch to deploy to dev for testing.
thehabes Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions controllers/overwrite.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ import { _contextid, ObjectID, createExpressError, getAgentClaim, parseDocumentI
* Respond RESTfully
* */
const overwrite = async function (req, res, next) {
const perfStart = Date.now()
console.log(`\x1b[36m[PERF] RERUM overwrite started for ${req.body?.["@id"] || req.body?.id}\x1b[0m`)

let err = { message: `` }
res.set("Content-Type", "application/json; charset=utf-8")
let objectReceived = JSON.parse(JSON.stringify(req.body))
Expand All @@ -27,7 +30,11 @@ const overwrite = async function (req, res, next) {
let id = parseDocumentID(receivedID)
let originalObject
try {
originalObject = await db.findOne({"$or":[{"_id": id}, {"__rerum.slug": id}]})
const findStart = Date.now()
const query = {"$or":[{"_id": id}, {"__rerum.slug": id}]}
console.log(`\x1b[90m[DEBUG] RERUM findOne query: ${JSON.stringify(query)}\x1b[0m`)
originalObject = await db.findOne(query)
console.log(`\x1b[34m[PERF] RERUM overwrite: db.findOne took ${Date.now() - findStart}ms\x1b[0m`)
} catch (error) {
next(createExpressError(error))
return
Expand Down Expand Up @@ -60,8 +67,9 @@ const overwrite = async function (req, res, next) {
// Optimistic locking check - no expected version is a brutal overwrite
const expectedVersion = req.get('If-Overwritten-Version') ?? req.body.__rerum?.isOverwritten
const currentVersionTS = originalObject.__rerum?.isOverwritten ?? ""

if (expectedVersion !== undefined && expectedVersion !== currentVersionTS) {
console.log(`\x1b[33m[PERF] RERUM overwrite: VERSION CONFLICT (409) - expected ${expectedVersion}, got ${currentVersionTS}\x1b[0m`)
res.status(409)
res.json({
currentVersion: originalObject
Expand All @@ -83,14 +91,18 @@ const overwrite = async function (req, res, next) {
let newObject = Object.assign(context, { "@id": originalObject["@id"] }, objectReceived, rerumProp, { "_id": id })
let result
try {
const replaceStart = Date.now()
result = await db.replaceOne({ "_id": id }, newObject)
console.log(`\x1b[34m[PERF] RERUM overwrite: db.replaceOne took ${Date.now() - replaceStart}ms\x1b[0m`)
} catch (error) {
next(createExpressError(error))
return
}
if (result.modifiedCount == 0) {
//result didn't error out, the action was not performed. Sometimes, this is a neutral thing. Sometimes it is indicative of an error.
}
console.log(`\x1b[32m[PERF] RERUM overwrite total: ${Date.now() - perfStart}ms\x1b[0m`)

// Include current version in response headers for future optimistic locking
res.set('Current-Overwritten-Version', rerumProp["__rerum"].isOverwritten)
res.set(utils.configureWebAnnoHeadersFor(newObject))
Expand Down
12 changes: 12 additions & 0 deletions controllers/patchUpdate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ import { _contextid, ObjectID, createExpressError, getAgentClaim, parseDocumentI
* Respond RESTfully
* */
const patchUpdate = async function (req, res, next) {
const perfStart = Date.now()
console.log(`\x1b[36m[PERF] RERUM patchUpdate started for ${req.body?.["@id"] || req.body?.id}\x1b[0m`)

let err = { message: `` }
res.set("Content-Type", "application/json; charset=utf-8")
let objectReceived = JSON.parse(JSON.stringify(req.body))
Expand All @@ -28,7 +31,9 @@ const patchUpdate = async function (req, res, next) {
let id = parseDocumentID(receivedID)
let originalObject
try {
const findStart = Date.now()
originalObject = await db.findOne({"$or":[{"_id": id}, {"__rerum.slug": id}]})
console.log(`\x1b[35m[PERF] RERUM patchUpdate: db.findOne took ${Date.now() - findStart}ms\x1b[0m`)
} catch (error) {
next(createExpressError(error))
return
Expand Down Expand Up @@ -92,8 +97,15 @@ const patchUpdate = async function (req, res, next) {
let newObject = Object.assign(context, { "@id": process.env.RERUM_ID_PREFIX + id }, patchedObject, rerumProp, { "_id": id })
console.log("PATCH UPDATE")
try {
const insertStart = Date.now()
let result = await db.insertOne(newObject)
console.log(`\x1b[35m[PERF] RERUM patchUpdate: db.insertOne took ${Date.now() - insertStart}ms\x1b[0m`)

const historyStart = Date.now()
if (alterHistoryNext(originalObject, newObject["@id"])) {
console.log(`\x1b[35m[PERF] RERUM patchUpdate: alterHistoryNext took ${Date.now() - historyStart}ms\x1b[0m`)
console.log(`\x1b[32m[PERF] RERUM patchUpdate total: ${Date.now() - perfStart}ms\x1b[0m`)

//Success, the original object has been updated.
res.set(utils.configureWebAnnoHeadersFor(newObject))
newObject = idNegotiation(newObject)
Expand Down