mentie 0.1.8 → 0.1.10

package/modules/environment.js

@@ -7,6 +7,13 @@
  * @returns {boolean} Returns true if the code is running in a web environment, otherwise returns false.
  */
 export const is_web = typeof window !== 'undefined'
+
+/**
+ * Checks if the code is running within a Cypress environment.
+ * @returns {boolean} Returns true if the code is running in a Cypress environment, otherwise returns false.
+ */
+export const is_cypress = typeof Cypress !== 'undefined'
+
 /**
  * Checks if the code is running in a Node environment.
  * @returns {boolean} Returns true if the code is running in a Node environment, otherwise returns false.

package/modules/logging.js

@@ -1,5 +1,5 @@
 // Import environment data
-import { dev, is_emulator, loglevel } from "./environment.js"
+import { dev, is_cypress, is_emulator, loglevel } from "./environment.js"
 
 const should_log = levels => {
 
@@ -13,23 +13,36 @@ const should_log = levels => {
 
 }
 
+/**
+ * Adds a stack trace IN PLACE to the provided messages array if executed in a browser context
+ * and if the URL query string contains `trace=true`.
+ * 
+ * @param {Array} messages - The array of messages to potentially add a trace to.
+ * @returns {Array} - The modified array of messages, including a stack trace if conditions were met.
+ */
 const add_trace = messages => {
 
-    // Do nothing if we are not in a browser
-    if( typeof window === 'undefined' ) return null
-
-    // Try to add stack to messages
+    // Try to add stack to messages if needed
     try {
 
+        // Do nothing if we are not in a browser
+        if( typeof window === 'undefined' ) return messages
+
+        // If there is no trace=true in the url, do nothing
+        if( !window.location?.search?.includes?.( 'trace=true' ) ) return messages
+
+
         // Get the stack trace
         let { stack } = new Error()
 
-        // Remove the first line of the stack trace as it is always the error message
+        // Remove the first line of the stack trace
         stack = stack.split( '\n' ).slice( 1 ).join( '\n' )
 
-        // Add the trace to the messages
+        // Annotate the provided messages
         messages.push( { stack } )
 
+        return messages
+
     } catch ( error ) {
 
         // This should never happen but we'll add it so we don't crash in unexpected situations
@@ -39,6 +52,27 @@ const add_trace = messages => {
 
 }
 
+/**
+ * Modifies the input messages by potentially stringifying them if in a Cypress environment,
+ * and by appending a stack trace if the conditions specified in `add_trace` are met.
+ * 
+ * @param {Array} messages - The array of messages to be annotated.
+ * @returns {void} - This function modifies the input array directly and does not return a value.
+ */
+const annotate_messages = messages => {
+
+
+    // If we are running in cypress, stringify the messages because they become unavailable in the console
+    if( is_cypress ) messages = messages.map( message => JSON.stringify( message, null, 2 ) )
+
+    // Annotate the provided messages
+    messages = add_trace( messages )
+
+    // Return the annotated messages
+    return messages
+
+}
+
 /**
  * Logs the provided messages to the console.
  * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error', 'warn', 'info'.
@@ -58,8 +92,8 @@ export function log( ...messages ) {
     // Log the messages if the loglevel matches
     if( dev || should_log( levels ) ) {
 
-        // Add the trace to the messages
-        add_trace( messages )
+        // Annotate the provided messages
+        annotate_messages( messages )
 
         // Log the messages
         console.log( ...messages )
@@ -83,8 +117,8 @@ log.info = function( ...messages ) {
     // Log the messages if the loglevel matches
     if( is_emulator || should_log( levels ) ) {
 
-        // Add the trace to the messages
-        add_trace( messages )
+        // Annotate the provided messages
+        annotate_messages( messages )
 
         // Log the messages
         console.info( ...messages )
@@ -108,8 +142,8 @@ log.warn = function( ...messages ) {
     // Log the messages if the loglevel matches
     if( dev || should_log( levels ) ) {
 
-        // Add the trace to the messages
-        add_trace( messages )
+        // Annotate the provided messages
+        annotate_messages( messages )
 
         // Log the messages
         console.warn( ...messages )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mentie",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Mentor's toolbelt",
   "type": "module",
   "main": "index.js",