From 8b8307a3802a0fb3e256541cbf1d4ae4f8d9eb56 Mon Sep 17 00:00:00 2001
From: davidsa <alec.davidson@adp.com>
Date: Tue, 3 Mar 2020 17:04:01 -0500
Subject: [PATCH] feat(config): Add customGetElementError config option

closes #360
---
 .../__snapshots__/get-by-errors.js.snap       |  5 +++++
 src/__tests__/get-by-errors.js                | 20 +++++++++++++++++++
 src/config.js                                 |  3 +++
 src/query-helpers.js                          |  5 +++++
 4 files changed, 33 insertions(+)
 create mode 100644 src/__tests__/__snapshots__/get-by-errors.js.snap

diff --git a/src/__tests__/__snapshots__/get-by-errors.js.snap b/src/__tests__/__snapshots__/get-by-errors.js.snap
new file mode 100644
index 00000000..1cc79a39
--- /dev/null
+++ b/src/__tests__/__snapshots__/get-by-errors.js.snap
@@ -0,0 +1,5 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getByLabelText query will throw the custom error returned by config.customGetElementError 1`] = `"My custom error: Unable to find a label with the text of: TEST QUERY"`;
+
+exports[`getByText query will throw the custom error returned by config.customGetElementError 1`] = `"My custom error: Unable to find an element with the text: TEST QUERY. This could be because the text is broken up by multiple elements. In this case, you can provide a function for your text matcher to make your matcher more flexible."`;
diff --git a/src/__tests__/get-by-errors.js b/src/__tests__/get-by-errors.js
index 6069caec..62f529b6 100644
--- a/src/__tests__/get-by-errors.js
+++ b/src/__tests__/get-by-errors.js
@@ -1,6 +1,13 @@
 import cases from 'jest-in-case'
+import {screen} from '../'
+import {configure, getConfig} from '../config'
 import {render} from './helpers/test-utils'
 
+const originalConfig = getConfig()
+beforeEach(() => {
+  configure(originalConfig)
+})
+
 cases(
   'getBy* queries throw an error when there are multiple elements returned',
   ({name, query, html}) => {
@@ -39,6 +46,19 @@ cases(
   },
 )
 
+test.each([['getByText'], ['getByLabelText']])(
+  '%s query will throw the custom error returned by config.customGetElementError',
+  query => {
+    const customGetElementError = jest.fn(
+      (message, _container) => new Error(`My custom error: ${message}`),
+    )
+    configure({customGetElementError})
+    document.body.innerHTML = '<div>Hello</div>'
+    expect(() => screen[query]('TEST QUERY')).toThrowErrorMatchingSnapshot()
+    expect(customGetElementError).toBeCalledTimes(1)
+  },
+)
+
 cases(
   'queryBy* queries throw an error when there are multiple elements returned',
   ({name, query, html}) => {
diff --git a/src/config.js b/src/config.js
index f8109352..f00042e9 100644
--- a/src/config.js
+++ b/src/config.js
@@ -14,6 +14,9 @@ let config = {
   asyncWrapper: cb => cb(),
   // default value for the `hidden` option in `ByRole` queries
   defaultHidden: false,
+
+  // called when getBy* queries fail. (message, container) => Error
+  customGetElementError: null,
 }
 
 export function configure(newConfig) {
diff --git a/src/query-helpers.js b/src/query-helpers.js
index 062e9df9..08c7d9ba 100644
--- a/src/query-helpers.js
+++ b/src/query-helpers.js
@@ -1,8 +1,13 @@
 import {prettyDOM} from './pretty-dom'
 import {fuzzyMatches, matches, makeNormalizer} from './matches'
 import {waitForElement} from './wait-for-element'
+import {getConfig} from './config'
 
 function getElementError(message, container) {
+  const customGetElementError = getConfig().customGetElementError
+  if (customGetElementError) {
+    return customGetElementError(message, container)
+  }
   return new Error([message, prettyDOM(container)].filter(Boolean).join('\n\n'))
 }