sinon.stub().resolves(...) returns undefined when used with createStubInstance

[clemmy]

Describe the bug
This was working in 7.3.2, but broke in 7.4.1.
Basically, when calling sinon.stub().resolves(...) as part of the second argument of sinon.createStubInstance(), I get undefined. It works as a standalone, however.

To Reproduce
Steps to reproduce the behavior:
Run the following test:

class X {
  async test() {
    return Promise.resolve(1)
  }
}

it('is a buggy test', async () => {
  const thing = sinon.createStubInstance(X, {
    test: sinon.stub().resolves(2) as sinon.SinonStub<[], Promise<number>>
  })
  console.log(thing.test()) // undefined
}

Expected behavior
I would expect the console.log(thing.test()) to output 2

Screenshots
N/A

Context (please complete the following information):

• Library version: 7.4.1
• Environment: Mac OSX
• Example URL: n/a
• Other libraries you are using: n/a

Additional context
N/A

[fatso83]

Not sure what could cause this in the changelog ... If you could run a git bisect run to find out which commit introduced this you can use this template: https://github.com/fatso83/git-bisect-scripts/blob/master/full-template.sh

[rgroothuijsen]

git bisect reveals that createStubInstance was removed from the sinon API in this commit.

[joebowbeer]

I can verify that it was broken in 7.4.0 as well

[kevinbosman]

Also related to this, due to createStubInstance now using the (different) Sandbox implementation, it can no longer be called without explicitly specifying the Sandbox object binding.

So the following Typescript import no longer works (it worked in 7.3.2):

import { createStubInstance } from "sinon";
...
const thing = createStubInstance(X);

which results in TypeError: Cannot read property 'stub' of undefined

This could be resolved by replacing this.stub with sandbox.stub here:

sinon/lib/sinon/sandbox.js

Line 58 in 671330c

return this.stub(Object.create(constructor.prototype));

[fatso83]

This issue, and some others, has revealed to me that, while we have great unit test coverage, some integration tests for the API is missing. We should have a little test suite that just tests for and executes a base test for all of the exposed API methods. Then stuff like this wouldn't happen nilly-willy.

[fatso83]

PS. Great work on digging into this guys!

[mroderick]

This has been fixed with #2073 and released as [email protected] 🚀