Storyshots: Fix support for test failures in async tests

[kahirokunn]

What I did

some times I wanna reject test like this.
jestjs/jest#6121 (comment)

[shilman]

Sorry for the slow turnaround on this. Shouldn't this be done with the done(error) API instead?

https://jestjs.io/docs/en/asynchronous#callbacks

[kahirokunn]

Yeah, I wanna write code like it.
So, I tried this code but I got success all test in storyshots. 😢

import initStoryshots from '@storybook/addon-storyshots'
import path from 'path'

initStoryshots({
  asyncJest: true,
  test: async ({ done }) => {
    try {
      expect(1).toEqual(2)
      done()
    } catch (error) {
      done(error)
    }
  },
})

[kahirokunn]

Is there any done(error) test code?

[shilman]

@kahirokunn i see. then WDYT about something more like:

        new Promise((done, reject) =>
          testMethod({
            done: (err) => (err ? reject(err) : done())
            ...

[kahirokunn]

@shilman I tried it and that worked for me.

[shilman]

💯

[kahirokunn]

@shilman
Thanks for the quick reply!

One more thing.
I want to do this kind of thing with storyshots-puppeteer too, can I remove this assertion expect.assertions(1);? (I feel like these assertions should be in the test code and not in the runtime code.

https://github.com/kahirokunn/storybook/blob/e48ad84e1b1f9872a5e0c31e35583341aa37d684/addons/storyshots/storyshots-puppeteer/src/imageSnapshot.ts#L14

[shilman]

@kahirokunn i don't have enough context on that to respond. maybe a separate PR and we can figure that out?

[kahirokunn]

Thanks a lot.
I tried like it.
#12657

[kahirokunn]

Why CI is failed? 🤔
Is there anything I can do to?

[shilman]

@kahirokunn ignore it! 😁