Log errors as JSON (#1532)

prosopo · Nov 20, 2024 · d4c2d24 · d4c2d24
1 parent 51fba77
commit d4c2d24
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 21 deletions.
diff --git a/packages/cli/src/cli.ts b/packages/cli/src/cli.ts
@@ -61,7 +61,7 @@ async function main() {
 		config,
 	);
 
-	log.info(`Processsed args: ${JSON.stringify(processedArgs, null, 4)}`);
+	log.info({ cliArgs: processedArgs });
 	if (processedArgs.api) {
 		if (process.env.NODE_ENV === "development") {
 			await new ReloadingAPI(envPath, config, pair, authAccount, processedArgs)

diff --git a/packages/cli/src/tests/bundle/bundle.unit.test.ts b/packages/cli/src/tests/bundle/bundle.unit.test.ts
@@ -29,6 +29,6 @@ describe("provider bundle", () => {
 		const { stdout: runOut, stderr: runErr } = await execPromise(
 			`cd ${rootDir} && node dist/bundle/provider.cli.bundle.js version`,
 		);
-		assert(runErr.includes("Version:"));
+		assert(runOut.includes("Version:"));
 	}, 120000);
 });
diff --git a/packages/common/src/error.ts b/packages/common/src/error.ts
@@ -64,18 +64,12 @@ export abstract class ProsopoBaseError<
 			this.translationKey = error;
 			this.context = options?.context;
 		}
-		if (!options?.silent) this.logError(logger, logLevel);
+		if (!options?.silent) this.logError(logger, logLevel, options?.name);
 	}
 
-	private logError(logger: Logger, logLevel: LogLevel) {
-		const errorFormatter = "\n*************** ERROR ***************\n";
-		const errorName = `Error Type: ${this.name}\n`;
-		const errorParams = JSON.stringify(
-			{ error: this.message, context: this.context },
-			null,
-			4,
-		);
-		const errorMessage = `${errorFormatter}${errorName}${errorParams}`;
+	private logError(logger: Logger, logLevel: LogLevel, errorName?: string) {
+		const errorParams = { error: this.message, context: this.context };
+		const errorMessage = { errorType: errorName || this.name, errorParams };
 		logger[logLevel](errorMessage);
 	}
 }

diff --git a/packages/common/src/logger.ts b/packages/common/src/logger.ts
@@ -14,6 +14,8 @@
 import consola, {
 	LogLevels as ConsolaLogLevels,
 	createConsola,
+	type ConsolaOptions,
+	type LogObject,
 } from "consola/browser";
 import { enum as zEnum, type infer as zInfer } from "zod";
 import { ProsopoEnvError } from "./error.js";
@@ -50,9 +52,17 @@ export function getLoggerDefault(): Logger {
 	return defaultLogger;
 }
 
-// biome-ignore lint/suspicious/noExplicitAny: we should be able to log anything we want, plus we can't control what external libraries log
-const JSONReporter = (message: any) => {
-	process.stderr.write(`${JSON.stringify(message)}\n`);
+const JSONReporter = (
+	message: LogObject,
+	context: {
+		options: ConsolaOptions;
+	},
+) => {
+	if (context.options.level === ConsolaLogLevels.error) {
+		process.stderr.write(`${JSON.stringify(message)}\n`);
+	} else {
+		process.stdout.write(`${JSON.stringify(message)}\n`);
+	}
 };
 
 const getLoggerAdapterConsola = (logLevel: LogLevel, scope: string): Logger => {

diff --git a/packages/provider/src/api/authMiddleware.ts b/packages/provider/src/api/authMiddleware.ts
@@ -102,7 +102,11 @@ export const verifySignature = (
 
 	if (!pair.verify(timestamp, u8Sig, pair.publicKey)) {
 		throw new ProsopoApiError("GENERAL.INVALID_SIGNATURE", {
-			context: { error: "Signature verification failed", code: 401 },
+			context: {
+				error: "Signature verification failed",
+				code: 401,
+				account: pair.publicKey,
+			},
 		});
 	}
 };
diff --git a/packages/provider/src/api/captcha.ts b/packages/provider/src/api/captcha.ts
@@ -267,15 +267,20 @@ export function prosopoRouter(env: ProviderEnvironment): Router {
 				if (!sessionRecord) {
 					return next(
 						new ProsopoApiError("API.BAD_REQUEST", {
-							context: { error: "Session ID not found", code: 400 },
+							context: {
+								error: "Session ID not found",
+								code: 400,
+								siteKey: dapp,
+								user,
+							},
 						}),
 					);
 				}
 			} else if (!(clientSettings?.settings?.captchaType === "pow")) {
 				// Throw an error
 				return next(
 					new ProsopoApiError("API.INCORRECT_CAPTCHA_TYPE", {
-						context: { code: 400, siteKey: dapp },
+						context: { code: 400, siteKey: dapp, user },
 					}),
 				);
 			}
@@ -285,7 +290,12 @@ export function prosopoRouter(env: ProviderEnvironment): Router {
 			if (!origin) {
 				return next(
 					new ProsopoApiError("API.BAD_REQUEST", {
-						context: { error: "Origin header not found", code: 400 },
+						context: {
+							error: "Origin header not found",
+							code: 400,
+							siteKey: dapp,
+							user,
+						},
 					}),
 				);
 			}
@@ -330,6 +340,7 @@ export function prosopoRouter(env: ProviderEnvironment): Router {
 					context: {
 						code: 500,
 						siteKey: req.body.dapp,
+						user: req.body.user,
 					},
 				}),
 			);

diff --git a/packages/provider/src/api/verify.ts b/packages/provider/src/api/verify.ts
@@ -82,7 +82,7 @@ export function prosopoVerifyRouter(env: ProviderEnvironment): Router {
 				if (!clientRecord) {
 					return next(
 						new ProsopoApiError("API.SITE_KEY_NOT_REGISTERED", {
-							context: { code: 400, siteKey: dapp },
+							context: { code: 400, siteKey: dapp, user },
 						}),
 					);
 				}
@@ -113,7 +113,7 @@ export function prosopoVerifyRouter(env: ProviderEnvironment): Router {
 				tasks.logger.error({ err, body: req.body });
 				return next(
 					new ProsopoApiError("API.BAD_REQUEST", {
-						context: { code: 500 },
+						context: { code: 500, siteKey: req.body.dapp, user: req.body.user },
 					}),
 				);
 			}