Add stacktrace logging to debug bundle

- Add stacktrace logging
- 29.1.0

Author: latentflip

docs/api/included-bundles.md

@@ -12,6 +12,8 @@ It takes the following options (none are required):
 
 - `logSelectors` (default: true): whether or not to log out selectors and their computed value with each action dispatch
 - `logState` (default: true): whether to log state after each dispatch
+- `logStackTraces` (default: true): whether to log stack traces with each dispatch
+- `stackTraceLimit` (default: 100): stack trace limit to set when logging stack traces
 - `actionFilter` (default: null): a function to call that determines whether or not to log an action (if debug is enabled). For example, if you want hide the `APP_IDLE` actions pass this: `(action) => action.type !== 'APP_IDLE'`
 - `enabled` (default: HAS_DEBUG_FLAG): explicitly enable/disable. This is helpful in node.js where there's no localStorage flag.
 - `ignoreActions` (default: []): an array of actions to ignore when logging.

docs/misc/changelog.md

@@ -1,5 +1,6 @@
 # Change Log
 
+- `29.1.0` Log stacktraces in the debug bundle log output.
 - `29.0.0` This release has some changes that are unlikely to be breaking, but for safety releasing as a major bump:
   - Fixes a bug during `integrateBundles` calls where the new bundles' `init` functions would be called before the store reducer had been replaced; potentially causing the code in the `init` function to throw if it called a selector that depended on the new state. The `init` functions are now called as the final step in `integrateBundles` - this is unlikely to be a breaking but if you are using `integrateBundles` and `init` functions, verifying they are working as expected is advised.
   - Adds an `allowMissing` option to `subsribeToSelectors`. If passed, you can now subscribe to selectors that don't yet exist without the `subscribeToSelectors` call throwing. If the selector is added later (via `integrateBundles`) then changes to that selector will be emitted to the callback as expected.

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "redux-bundler",
   "description": "Compose a Redux store out of smaller bundles of functionality.",
-  "version": "29.0.0",
+  "version": "29.1.0",
   "author": "Henrik Joreteg <henrik@joreteg.com> (joreteg.com)",
   "bugs": {
     "url": "https://github.com/HenrikJoreteg/redux-bundler/issues"

package.json

@@ -17,12 +17,16 @@ export default spec => {
   const defaultOpts = {
     logSelectors: true,
     logState: true,
+    logStackTraces: true,
     enabled: HAS_DEBUG_FLAG,
-    actionFilter: null
+    actionFilter: null,
+    stackTraceLimit: 100
   }
 
   const opts = Object.assign({}, defaultOpts, spec)
 
+  const initialStackTraceLimit = Error.stackTraceLimit
+
   return {
     name: 'debug',
     reducer: (state = opts.enabled, { type }) => {
@@ -42,6 +46,13 @@ export default spec => {
             localStorage.debug = true
           } catch (e) {}
         }
+        if (
+          opts.logStackTraces &&
+          Error.stackTraceLimit === initialStackTraceLimit
+        ) {
+          Error.stackTraceLimit = opts.stackTraceLimit
+        }
+
         dispatch({ type: ENABLE })
       },
     doDisableDebug:
@@ -52,6 +63,12 @@ export default spec => {
             delete localStorage.debug
           } catch (e) {}
         }
+        if (
+          opts.logStackTraces &&
+          Error.stackTraceLimit === opts.stackTraceLimit
+        ) {
+          Error.stackTraceLimit = initialStackTraceLimit
+        }
         dispatch({ type: DISABLE })
       },
     selectIsDebug: state => state.debug,
@@ -70,6 +87,11 @@ export default spec => {
       opts.logState && console.debug('state:', store.getState())
       opts.logSelectors && store.doLogSelectors()
       store.doLogNextReaction && store.doLogNextReaction()
+      if (opts.logStackTraces) {
+        console.groupCollapsed('stack trace')
+        console.trace()
+        console.groupEnd('stack trace')
+      }
       console.groupEnd(action.type)
 
       return result

src/bundles/create-debug-bundle.js

@@ -19,3 +19,41 @@ test('create debug bundle basics', t => {
   t.ok(store.doLogDebugSummary, 'exists')
   t.end()
 })
+
+test('sets stack trace limit', t => {
+  const store = composeBundlesRaw(
+    createDebugBundle({
+      stackTraceLimit: 50
+    }),
+    {
+      name: 'other',
+      doSomething: () => {},
+      selectSomething: () => true,
+      reactToSomething: () => {}
+    }
+  )()
+
+  const initialStackTraceLimit = Error.stackTraceLimit
+
+  store.doEnableDebug()
+
+  t.equal(Error.stackTraceLimit, 50, 'should set stack trace limit to 50')
+
+  store.doDisableDebug()
+
+  t.equal(
+    Error.stackTraceLimit,
+    initialStackTraceLimit,
+    'should reset stack trace limit'
+  )
+
+  // Should not override the stack trace limit if it has been set elsewhere to
+  // something other than the default
+  Error.stackTraceLimit = 123
+  store.doEnableDebug()
+  t.equal(Error.stackTraceLimit, 123, 'does not override limit if has been set')
+  store.doDisableDebug()
+  t.equal(Error.stackTraceLimit, 123, 'does not override limit if has been set')
+
+  t.end()
+})