fix .toThrow for promises #4884

lstkz · 2017-11-13T16:19:25Z

From docs

return expect(Promise.reject('octopus')).rejects.toBe('octopus');

In real app, an Error object must be rejected.
Fixed to

return expect(Promise.reject(new Error('octopus'))).rejects.toThrow('octopus');

fixes #3601 Signed-off-by: Łukasz Sentkiewicz <[email protected]>

Signed-off-by: Łukasz Sentkiewicz <[email protected]>

codecov-io · 2017-11-13T16:36:41Z

Codecov Report

Merging #4884 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4884   +/-   ##
=======================================
  Coverage   59.75%   59.75%           
=======================================
  Files         195      195           
  Lines        6533     6533           
  Branches        4        3    -1     
=======================================
  Hits         3904     3904           
  Misses       2629     2629

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 757f163...b492b59. Read the comment docs.

SimenB

This is awesome! Thanks for tackling it.

Could you update the changelog as well?

SimenB · 2017-11-13T20:25:54Z

docs/ExpectAPI.md

@@ -416,15 +416,15 @@ For example, this code tests that the promise rejects with reason `'octopus'`:
 ```js
 test('rejects to octopus', () => {
  // make sure to add a return statement
-  return expect(Promise.reject('octopus')).rejects.toBe('octopus');
+  return expect(Promise.reject(new Error('octopus'))).rejects.toThrow('octopus');


This old example is still valid, right?

(although it's not recommended to reject with a non-error)

yes, it still works

Signed-off-by: Łukasz Sentkiewicz <[email protected]>

lstkz · 2017-11-14T07:12:09Z

@SimenB
changelog updated

SimenB · 2017-11-14T07:29:35Z

docs/ExpectAPI.md

 });
 ```

 Alternatively, you can use `async/await` in combination with `.rejects`.

 ```js
 test('rejects to octopus', async () => {
-  await expect(Promise.reject('octopus')).rejects.toBe('octopus');
+  await expect(Promise.reject(new Error('octopus'))).rejects.toThrow('octopus');


I'm wondering if we should say that toThrow only works in jest 21.3.0+. People copy-paste examples, and having them not working is not a good UX

currently, it mentions

### `.rejects` ##### available in Jest **20.0.0+**

Change it to 21.3.0+?

Or a separate line describing rejecting promises and toThrow.

@lsentkiewicz this came up in #4945, mind sending a PR with clarification? 🙂

really painful way to discover why rejects.toThrow was not working on my [email protected] setup

@SimenB you were right, it is probably a good idea to have a mention to it in the docs

Can you send a PR fixing the docs?

cpojer · 2017-11-14T12:52:55Z

Nice!

Turbo87 · 2017-11-22T13:06:23Z

is there a new release planned including this fix? it seems impossible currently to correctly test for Promise rejections 🤔

rraziel · 2017-11-22T16:36:22Z

Shouldn't it be toThrowError rather than toThrow?
Or would both work with this pull request?

lstkz · 2017-11-22T20:02:34Z

both methods work

SimenB · 2017-11-22T21:01:27Z

@Turbo87 it's out as jest@test (beta 9, I believe)

* Beta version because it has a bug fix for testing rejected promises: * jestjs/jest#4884 * Needed for upcoming unit tests for events/schedules API

According to jestjs#4884

github-actions · 2021-05-12T23:07:22Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

lstkz added 2 commits November 13, 2017 17:00

fix .toThrow for promises

5915f91

fixes #3601 Signed-off-by: Łukasz Sentkiewicz <[email protected]>

keep original matcherName

4bbccfd

Signed-off-by: Łukasz Sentkiewicz <[email protected]>

facebook-github-bot added the CLA Signed ✔️ label Nov 13, 2017

fix flow

b778d5d

Signed-off-by: Łukasz Sentkiewicz <[email protected]>

SimenB approved these changes Nov 13, 2017

View reviewed changes

SimenB reviewed Nov 13, 2017

View reviewed changes

update changelog

b492b59

Signed-off-by: Łukasz Sentkiewicz <[email protected]>

SimenB reviewed Nov 14, 2017

View reviewed changes

cpojer merged commit 38c2cf7 into jestjs:master Nov 14, 2017

eric4545 mentioned this pull request Nov 24, 2017

example expect().rejects.toThrow not working as expected #4945

Closed

SimenB mentioned this pull request Nov 24, 2017

toThrowErrorMatchingSnapshot does not work with promises #4946

Closed

sdunster added a commit to NSWSESMembers/availability-poc that referenced this pull request Dec 3, 2017

Upgrade jest

d2c4884

* Beta version because it has a bug fix for testing rejected promises: * jestjs/jest#4884 * Needed for upcoming unit tests for events/schedules API

sdunster mentioned this pull request Dec 3, 2017

Upgrade jest NSWSESMembers/availability-poc#100

Merged

sdunster added a commit to NSWSESMembers/availability-poc that referenced this pull request Dec 3, 2017

Upgrade jest

eafd13c

* Beta version because it has a bug fix for testing rejected promises: * jestjs/jest#4884 * Needed for upcoming unit tests for events/schedules API

julienw mentioned this pull request Dec 5, 2017

rejects.toThrowError #3601

Closed

SimenB mentioned this pull request Dec 13, 2017

Expect rejects async/await documentation example fails #5076

Closed

reficul31 mentioned this pull request Dec 22, 2017

Tests for Util Module WorldBrain/Memex#233

Merged

kimjoar mentioned this pull request Jan 15, 2018

Remove syncify elastic/eui#306

Merged

renovate-tests mentioned this pull request Feb 6, 2018

Update dependency jest to v22 - autoclosed renovate-tests/changelog-md#3

Closed

renovate bot mentioned this pull request Feb 14, 2018

fix(deps): update dependency jest to ^22.0.0 manekinekko/devoxx-assistant#3

Open

peterdanis mentioned this pull request Feb 26, 2018

[WIP] Make toThrow matcher pass only if Error-like object is returned from promises #5670

Merged

SimenB mentioned this pull request Jun 16, 2018

Correct erroneous rejects test example #6421

Closed

nodkz added a commit to nodkz/jest that referenced this pull request Sep 19, 2018

docs: fix rejects.toMatch on rejects.toThrow

ddb0c26

According to jestjs#4884

nodkz mentioned this pull request Sep 19, 2018

docs: fix rejects.toMatch on rejects.toThrow #6999

Merged

SimenB mentioned this pull request Nov 29, 2018

Correct example usage of expect().rejects #7431

Closed

nshaikhinurov mentioned this pull request Mar 17, 2019

rejects.toThrowError again #8140

Closed

outofambit mentioned this pull request May 1, 2019

Standardize on awaiting expect statements for functions that throw errors in tests desktop/desktop#7442

Closed

github-actions bot locked as resolved and limited conversation to collaborators May 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix .toThrow for promises #4884

fix .toThrow for promises #4884

lstkz commented Nov 13, 2017

codecov-io commented Nov 13, 2017 •

edited

Loading

SimenB left a comment

SimenB Nov 13, 2017

SimenB Nov 13, 2017

lstkz Nov 14, 2017

lstkz commented Nov 14, 2017

SimenB Nov 14, 2017

lstkz Nov 14, 2017

SimenB Nov 14, 2017

SimenB Nov 24, 2017

ruyadorno Jan 12, 2018

SimenB Jan 13, 2018

cpojer commented Nov 14, 2017

Turbo87 commented Nov 22, 2017

rraziel commented Nov 22, 2017

lstkz commented Nov 22, 2017

SimenB commented Nov 22, 2017

github-actions bot commented May 12, 2021

fix .toThrow for promises #4884

fix .toThrow for promises #4884

Conversation

lstkz commented Nov 13, 2017

codecov-io commented Nov 13, 2017 • edited Loading

Codecov Report

SimenB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lstkz commented Nov 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cpojer commented Nov 14, 2017

Turbo87 commented Nov 22, 2017

rraziel commented Nov 22, 2017

lstkz commented Nov 22, 2017

SimenB commented Nov 22, 2017

github-actions bot commented May 12, 2021

codecov-io commented Nov 13, 2017 •

edited

Loading