From 4f09c6c4fe2631b9e8b71c963e5fd02ce3137c48 Mon Sep 17 00:00:00 2001
From: Kishore <42832651+kishore03109@users.noreply.github.com>
Date: Thu, 14 Mar 2024 08:24:39 +0800
Subject: [PATCH] chore(commitService): add logging (#1211)

## Problem

we lack observability here. we experienced a silent failure in terms of divergence, and not a clue on how to debug since we cannot replicate this + no unusual errors around that time.
this is a last ditch effort to see if we can get more info on this issue, but personally am not too optimistic about this pr since by right the top level handlers should log errors
---
 src/services/db/GitFileCommitService.ts | 42 +++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/src/services/db/GitFileCommitService.ts b/src/services/db/GitFileCommitService.ts
index bb2d7e9e8..65c9be299 100644
--- a/src/services/db/GitFileCommitService.ts
+++ b/src/services/db/GitFileCommitService.ts
@@ -83,12 +83,18 @@ export default class GitFileCommitService {
     }
 
     if (stagingCreateResult.isErr()) {
+      logger.error(
+        `CommitServiceError: ${stagingCreateResult.error} when creating commit to staging for ${sessionData.siteName} for file ${fileName} in directory ${directoryName}`
+      )
       throw stagingCreateResult.error
     } else if (
       shouldUpdateStagingLite &&
       stagingLiteCreateResult &&
       stagingLiteCreateResult.isErr()
     ) {
+      logger.error(
+        `CommitServiceError: ${stagingLiteCreateResult.error} when creating commit to staging-lite for ${sessionData.siteName} for file ${fileName} in directory ${directoryName}`
+      )
       throw stagingLiteCreateResult.error
     }
 
@@ -140,12 +146,18 @@ export default class GitFileCommitService {
     }
 
     if (stagingUpdateResult.isErr()) {
+      logger.error(
+        `CommitServiceError: ${stagingUpdateResult.error} when updating in staging for ${sessionData.siteName} for file ${fileName} in directory ${directoryName}`
+      )
       throw stagingUpdateResult.error
     } else if (
       shouldUpdateStagingLite &&
       stagingLiteUpdateResult &&
       stagingLiteUpdateResult.isErr()
     ) {
+      logger.error(
+        `CommitServiceError: ${stagingLiteUpdateResult.error} when updating to staging-lite for ${sessionData.siteName} for file ${fileName} in directory ${directoryName}`
+      )
       throw stagingLiteUpdateResult.error
     }
 
@@ -190,12 +202,18 @@ export default class GitFileCommitService {
     }
 
     if (stagingDeleteResult.isErr()) {
+      logger.error(
+        `CommitServiceError: ${stagingDeleteResult.error} when deleting in staging for ${sessionData.siteName} for directory ${directoryName}`
+      )
       throw stagingDeleteResult.error
     } else if (
       shouldUpdateStagingLite &&
       stagingLiteDeleteResult &&
       stagingLiteDeleteResult.isErr()
     ) {
+      logger.error(
+        `CommitServiceError: ${stagingLiteDeleteResult.error} when deleting in staging-lite for ${sessionData.siteName} for directory ${directoryName}`
+      )
       throw stagingLiteDeleteResult.error
     }
 
@@ -246,12 +264,18 @@ export default class GitFileCommitService {
     }
 
     if (stagingDeleteResult.isErr()) {
+      logger.error(
+        `CommitServiceError: ${stagingDeleteResult.error} when deleting in staging for ${sessionData.siteName} for file ${fileName} in directory ${directoryName}`
+      )
       throw stagingDeleteResult.error
     } else if (
       shouldUpdateStagingLite &&
       stagingLiteDeleteResult &&
       stagingLiteDeleteResult.isErr()
     ) {
+      logger.error(
+        `CommitServiceError: ${stagingLiteDeleteResult.error} when deleting in staging-lite for ${sessionData.siteName} for file ${fileName} in directory ${directoryName}`
+      )
       throw stagingLiteDeleteResult.error
     }
 
@@ -289,12 +313,18 @@ export default class GitFileCommitService {
     }
 
     if (stagingDeleteResult.isErr()) {
+      logger.error(
+        `CommitServiceError: ${stagingDeleteResult.error} when deleting in staging for ${sessionData.siteName} for multiple files ${items}`
+      )
       throw stagingDeleteResult.error
     } else if (
       shouldUpdateStagingLite &&
       stagingLiteDeleteResult &&
       stagingLiteDeleteResult.isErr()
     ) {
+      logger.error(
+        `CommitServiceError: ${stagingLiteDeleteResult.error} when deleting in staging-lite for ${sessionData.siteName} for multiple files ${items}`
+      )
       throw stagingLiteDeleteResult.error
     }
 
@@ -321,6 +351,9 @@ export default class GitFileCommitService {
     )
 
     if (stagingRenameResult.isErr()) {
+      logger.error(
+        `CommitServiceError: ${stagingRenameResult.error} when renaming in staging for ${sessionData.siteName} for directory ${oldPath} to ${newPath}`
+      )
       throw stagingRenameResult.error
     }
 
@@ -338,6 +371,9 @@ export default class GitFileCommitService {
         message
       )
       if (stagingLiteRenameResult.isErr()) {
+        logger.error(
+          `CommitServiceError: ${stagingLiteRenameResult.error} when renaming in staging-lite for ${sessionData.siteName} for directory ${oldPath} to ${newPath}`
+        )
         throw stagingLiteRenameResult.error
       }
     }
@@ -366,6 +402,9 @@ export default class GitFileCommitService {
       message
     )
     if (stagingMvFilesResult.isErr()) {
+      logger.error(
+        `CommitServiceError: ${stagingMvFilesResult.error} when moving in staging for ${sessionData.siteName} for directory ${oldPath} to ${newPath}`
+      )
       throw stagingMvFilesResult.error
     }
 
@@ -384,6 +423,9 @@ export default class GitFileCommitService {
         message
       )
       if (stagingLiteMvFilesResult.isErr()) {
+        logger.error(
+          `CommitServiceError: ${stagingLiteMvFilesResult.error} when moving in staging-lite for ${sessionData.siteName} for directory ${oldPath} to ${newPath}`
+        )
         throw stagingLiteMvFilesResult.error
       }
     }