From acfeafd27676791646cfe7dd51750bd6409b922f Mon Sep 17 00:00:00 2001
From: Brian Gough <briangough@users.noreply.github.com>
Date: Wed, 10 May 2023 08:41:27 +0100
Subject: [PATCH] Merge pull request #12965 from
 overleaf/bg-improve-timeout-error

improve lock timeout error in project history

GitOrigin-RevId: fdcdacd4526e008f13c46c396fb13d07ae1b8c0f
---
 services/project-history/app/js/LockManager.js | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/services/project-history/app/js/LockManager.js b/services/project-history/app/js/LockManager.js
index 5ade60c99f..562eebb0ff 100644
--- a/services/project-history/app/js/LockManager.js
+++ b/services/project-history/app/js/LockManager.js
@@ -65,7 +65,9 @@ _mocks.tryLock = (key, callback) => {
     'NX',
     function (err, gotLock) {
       if (err != null) {
-        return callback(OError.tag(err))
+        return callback(
+          OError.tag(err, 'redis error trying to get lock', { key })
+        )
       }
       if (gotLock === 'OK') {
         metrics.inc('lock.project.try.success')
@@ -94,7 +96,9 @@ _mocks.extendLock = (key, lockValue, callback) => {
     LOCK_TTL,
     function (err, result) {
       if (err != null) {
-        return callback(OError.tag(err))
+        return callback(
+          OError.tag(err, 'redis error trying to extend lock', { key })
+        )
       }
 
       if (result != null && result !== 1) {
@@ -128,9 +132,7 @@ _mocks.getLock = (key, callback) => {
   return (attempt = function () {
     if (Date.now() - startTime > MAX_LOCK_WAIT_TIME) {
       metrics.inc('lock.project.get.failed')
-      const e = new OError('Timeout')
-      e.key = key
-      return callback(e)
+      return callback(new OError('Timeout', { key }))
     }
 
     attempts += 1