Updated the config flag based on the feedback

Author: rahulchavan30

src/__tests__/wait-for.js

@@ -34,6 +34,17 @@ test('uses generic error if there was no last error', async () => {
   expect(result).toMatchInlineSnapshot(`[Error: Timed out in waitFor.]`)
 })
 
+test('uses full stack error trace when showOriginalStackTrace present', async () => {
+  const error = new Error('Throws the full stack trace')
+  const result = await waitFor(
+    () => {
+      throw error
+    },
+    {timeout: 8, interval: 5, showOriginalStackTrace: true},
+  ).catch(e => e)
+  expect(result).toBe(error)
+})
+
 test('throws nice error if provided callback is not a function', () => {
   const {queryByTestId} = renderIntoDocument(`
     <div data-testid="div"></div>

src/config.js

@@ -16,6 +16,8 @@ let config = {
   asyncWrapper: cb => cb(),
   // default value for the `hidden` option in `ByRole` queries
   defaultHidden: false,
+  //showOriginalStackTrace flag to show the full error stack traces for async errors
+  showOriginalStackTrace: false,
 
   // called when getBy* queries fail. (message, container) => Error
   getElementError(message, container) {

src/wait-for.js

@@ -13,6 +13,7 @@ function waitFor(
   {
     container = getDocument(),
     timeout = getConfig().asyncUtilTimeout,
+    showOriginalStackTrace = getConfig().showOriginalStackTrace,
     interval = 50,
     mutationObserverOptions = {
       subtree: true,
@@ -66,11 +67,13 @@ function waitFor(
       let error = timedOutError
       if (lastError) {
         error = lastError
-        const userStackTrace = timedOutError.stack
-          .split('\n')
-          .slice(1)
-          .join('\n')
-        error.stack = `${error.stack.split('\n')[0]}\n${userStackTrace}`
+        if (showOriginalStackTrace) {
+          const userStackTrace = timedOutError.stack
+            .split('\n')
+            .slice(1)
+            .join('\n')
+          error.stack = `${error.stack.split('\n')[0]}\n${userStackTrace}`
+        }
       }
       onDone(error, null)
     }