Cannot stub Array.prototype.sort

[artyhedgehog]

Describe the bug
Applying stub to Array.prototype.sort results in RangeError: Maximum call stack size exceeded.

To Reproduce
Run test like this:

const sinon = require('sinon');

describe('Cannot stub Array.prototype.sort', () => {
  it('should not fall with call stack size exceeded error', () => {
    // Even making it always call through would not help:
    const stub = sinon.stub(Array.prototype, 'sort').callThrough();
    [1, 2, 3].sort();
    stub.restore();
  });
});

Expected behavior
Test should pass.

Actual behavior
Falls with error:

     RangeError: Maximum call stack size exceeded
      at Function.invoke (node_modules/sinon/lib/sinon/spy.js:1:1)
      at Array.proxy (node_modules/sinon/lib/sinon/spy.js:78:54)
      at Array.functionStub (node_modules/sinon/lib/sinon/stub.js:101:36)
      at Function.invoke (node_modules/sinon/lib/sinon/spy.js:209:51)
      at Array.proxy (node_modules/sinon/lib/sinon/spy.js:78:54)
      at Array.functionStub (node_modules/sinon/lib/sinon/stub.js:101:36)
      at Function.invoke (node_modules/sinon/lib/sinon/spy.js:209:51)
      at Array.proxy (node_modules/sinon/lib/sinon/spy.js:78:54)
      ...

Context:

• Library version: 5.0.7
• Environment: nodejs v8.11.1
• Command: /usr/bin/node ./node_modules/mocha/bin/_mocha sinon.spec.js | head -n20
• Other libraries you are using: [email protected]

Additional context
Looks similar to: #1521

[fatso83]

I am sure the fix to this is very similar to #1521. If you grep the source for '.sort()' you should find it quickly. A PR is most welcome ;-)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[fatso83]

I think Phred fixed this in in #1826. Could you verify?

[fatso83]

Verified. Still present :(

[mroderick]

@fatso83 this was fixed in c2c7814, which hasn't been released yet. I've created #1876 to show that this issue has been fixed.

[mroderick]

This was fixed in #1826, a test to verify it was added in #1876

[mroderick]

The fix for this has been published to NPM in [email protected]