feat: improve error logging

Author: mesqueeb

packages/core/src/helpers/throwFns.ts

@@ -1,8 +1,8 @@
 import type { DoOnStreamFns, StreamResponse } from '@magnetarjs/types'
-import { isCollectionModule, isDocModule } from '@magnetarjs/utils'
+import { isCollectionModule, isDocModule, logWithFlair } from '@magnetarjs/utils'
 
 export function logError(errorMessage: string): undefined {
-  console.error('[@magnetarjs error]\n', errorMessage)
+  logWithFlair(errorMessage, { error: true })
 }
 
 export function logErrorAndThrow(errorMessage: string): undefined {

packages/utils-firestore/src/batchSync.ts

@@ -47,7 +47,7 @@ const newStack = (): Stack => ({
  * @param {Record<string, unknown>} payload
  * @returns {number}
  */
-function countOperations(payload: { [key: string]: unknown }): number {
+function countOperations(_payload: { [key: string]: unknown }): number {
   const count = 1
   // todo: when actions like serverTimestamp, arrayUnion and increment are supported, count them here
   return count
@@ -111,6 +111,9 @@ export function batchSyncFactory(
     try {
       applySyncBatch(writeBatch as any, stack.batch, db as any)
     } catch (error) {
+      if (debug) {
+        logWithFlair('Error while preparing Firestore write batch', { error, batch: stack.batch })
+      }
       stack.rejects.forEach((rej) => rej(error))
       if (state.queue.length) {
         triggerSync(0)
@@ -125,7 +128,12 @@ export function batchSyncFactory(
     writeBatch
       .commit()
       .then(() => stack.resolves.forEach((res) => res()))
-      .catch((error: unknown) => stack.rejects.forEach((rej) => rej(error)))
+      .catch((error: unknown) => {
+        if (debug) {
+          logWithFlair('Firestore batch commit failed', { error, batch: stack.batch })
+        }
+        stack.rejects.forEach((rej) => rej(error))
+      })
       .finally(() => {
         if (state.queue.length) {
           triggerSync(0)

packages/utils/src/logger.ts

@@ -1,17 +1,25 @@
 import type { EventFnSuccess, QueryClause, WhereClause } from '@magnetarjs/types'
-import { isArray, isFullArray, isNumber } from 'is-what'
+import { isAnyObject, isArray, isFullArray, isNumber } from 'is-what'
 
 /**
  * `Line-height: 2` is to prevent line overlapping on Safari
  */
 const LOGGER_STYLE =
   'background: #0e0f15; color: #af98e6; border-radius: 4px; padding: 6px 10px; line-height: 2;'
 
+const LOGGER_STYLE_ERROR =
+  'background: #b91c1c; color: #ffffff; border-radius: 4px; padding: 6px 10px; line-height: 2;'
+
 /**
  * Logs to the console with `console.info` and colors.
  */
 export function logWithFlair(message: string, ...args: any[]): undefined {
-  console.info(`%c💫 [magnetar] ${message}`, LOGGER_STYLE, ...args)
+  const isError = args.some((a) => isAnyObject(a) && !!a?.['error'])
+  if (isError) {
+    console.error(`%c💫 [magnetar] ${message}`, LOGGER_STYLE_ERROR, ...args)
+  } else {
+    console.info(`%c💫 [magnetar] ${message}`, LOGGER_STYLE, ...args)
+  }
 }
 
 let lastGroupLogTime = 0
@@ -38,7 +46,7 @@ function shouldLog(params: any, preventLogFor: number) {
 export function logWithFlairGroup(
   title: string,
   nestedMessage: string,
-  options?: { preventLogFor: number }
+  options?: { preventLogFor: number },
 ): undefined {
   if (options && !shouldLog([title, nestedMessage], options.preventLogFor)) return
 
@@ -51,12 +59,12 @@ function stringifyQueryClause(q: QueryClause): string {
   return 'or' in q
     ? `or(${q.or
         .map((clause) =>
-          isArray(clause) ? stringifyWhereClause(clause) : stringifyQueryClause(clause)
+          isArray(clause) ? stringifyWhereClause(clause) : stringifyQueryClause(clause),
         )
         .join(', ')})`
     : `and(${q.and
         .map((clause) =>
-          isArray(clause) ? stringifyWhereClause(clause) : stringifyQueryClause(clause)
+          isArray(clause) ? stringifyWhereClause(clause) : stringifyQueryClause(clause),
         )
         .join(', ')})`
 }