@serve.zone/coremail 1.0.2 → 1.2.0

package/ts/classes.transfer.ts

@@ -286,8 +286,11 @@ export class CoreMailTransferService {
           throw new Error('CoreMail transfer completion fence changed.');
         }
         return new Response(null, { status: 204 });
-      } catch {
+      } catch (error) {
         operationController.abort();
+        await logCoreMailFailure('transfer', 'UPLOAD_FAILED', error, {
+          grantId: grantArg.grantId,
+        }).catch(() => undefined);
         await this.failGrant(grantArg.grantId);
         return new Response('Transfer failed', { status: 409 });
       }
@@ -341,8 +344,11 @@ export class CoreMailTransferService {
           'X-Content-Type-Options': 'nosniff',
         },
       });
-    } catch {
+    } catch (error) {
       operationController.abort();
+      await logCoreMailFailure('transfer', 'DOWNLOAD_FAILED', error, {
+        grantId: grantArg.grantId,
+      }).catch(() => undefined);
       await this.failGrant(grantArg.grantId);
       return new Response('Transfer failed', { status: 409 });
     }
@@ -371,9 +377,10 @@ export class CoreMailTransferService {
           throw new Error('CoreMail transfer failure fence changed.');
         }
       }
-    } catch {
-      await logCoreMailFailure('transfer', 'GRANT_FAILURE_PERSISTENCE_FAILED')
-        .catch(() => undefined);
+    } catch (error) {
+      await logCoreMailFailure('transfer', 'GRANT_FAILURE_PERSISTENCE_FAILED', error, {
+        grantId: grantIdArg,
+      }).catch(() => undefined);
     }
   }
 }

package/ts/coremail.log.ts

@@ -9,13 +9,51 @@ export const coreMailLogger = plugins.smartlog.Smartlog.createForCommitinfo({
 
 coreMailLogger.enableConsole();
 
+const redactUrlCredentials = (valueArg: string): string =>
+  valueArg.replace(/:\/\/[^\s/@]+@/g, '://[redacted]@');
+
+export interface ICoreMailSanitizedError {
+  name: string;
+  message: string;
+}
+
+export const sanitizeErrorForLog = (
+  errorArg: unknown,
+): ICoreMailSanitizedError => {
+  if (errorArg instanceof Error) {
+    return {
+      name: errorArg.name,
+      message: redactUrlCredentials(errorArg.message).slice(0, 500),
+    };
+  }
+  return {
+    name: 'UnknownError',
+    message: redactUrlCredentials(String(errorArg)).slice(0, 500),
+  };
+};
+
 export const logCoreMailFailure = async (
-  componentArg: 'desired-state' | 'gateway' | 'retention' | 'transfer' | 'worker',
+  componentArg:
+    | 'auth'
+    | 'desired-state'
+    | 'gateway'
+    | 'lifecycle'
+    | 'retention'
+    | 'server'
+    | 'transfer'
+    | 'worker',
   codeArg: string,
+  errorArg?: unknown,
+  contextArg?: Record<string, string | number>,
 ): Promise<void> => {
   await coreMailLogger.log(
     'warn',
-    'CoreMail background operation failed.',
-    { component: componentArg, code: codeArg },
+    'CoreMail operation failed.',
+    {
+      component: componentArg,
+      code: codeArg,
+      ...(errorArg === undefined ? {} : { error: sanitizeErrorForLog(errorArg) }),
+      ...(contextArg === undefined ? {} : { context: contextArg }),
+    },
   );
 };

package/ts/index.ts

@@ -1,4 +1,5 @@
 import { CoreMail } from './classes.coremail.js';
+import { logCoreMailFailure } from './coremail.log.js';
 
 export { CoreMail } from './classes.coremail.js';
 export { readCoreMailConfig } from './classes.config.js';
@@ -15,7 +16,9 @@ export const runCli = async (): Promise<void> => {
     try {
       await coreMail.stop();
       process.exitCode = 0;
-    } catch {
+    } catch (error) {
+      await logCoreMailFailure('lifecycle', 'SHUTDOWN_FAILED', error)
+        .catch(() => undefined);
       process.exitCode = 1;
     }
   };

package/ts/interfaces.ts

@@ -95,7 +95,8 @@ export interface ICoreMailReadiness {
 
 export interface ICoreMailAuthLimiterSnapshot {
   inFlight: number;
-  tokens: number;
+  waiting: number;
+  identities: number;
 }
 
 export interface ICoreMailPeer {