Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[sinon] implement on{,First,Second,Third}Call([...]) #361

Merged
merged 3 commits into from
Aug 23, 2022
Merged

[sinon] implement on{,First,Second,Third}Call([...]) #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f69a6b
[sinon] implement on{,First,Second,Third}Call([...])
danbeam Aug 22, 2022
7d2e990
whoops, trying too hard
danbeam Aug 20, 2022
e1f57d6
add block statement
danbeam Aug 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 96 additions & 8 deletions src/transformers/sinon.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,32 +180,39 @@ describe('spies and stubs', () => {
`,
`
jest.fn().mockImplementation((...args) => {
if (args[0] === 'foo')
if (args[0] === 'foo') {
return 'something';
}
})
jest.fn().mockImplementation((...args) => {
if (args[0] === 'foo' && args[1] === 'bar')
if (args[0] === 'foo' && args[1] === 'bar') {
return 'something';
}
})
jest.fn().mockImplementation((...args) => {
if (args[0] === 'foo' && args[1] === 'bar' && args[2] === 1)
if (args[0] === 'foo' && args[1] === 'bar' && args[2] === 1) {
return 'something';
}
})
jest.spyOn(Api, 'get').mockClear().mockImplementation((...args) => {
if (args[0] === 'foo' && args[1] === 'bar' && args[2] === 1)
if (args[0] === 'foo' && args[1] === 'bar' && args[2] === 1) {
return 'something';
}
})
const stub = jest.spyOn(foo, 'bar').mockClear().mockImplementation((...args) => {
if (args[0] === 'foo' && args[1] === 1)
if (args[0] === 'foo' && args[1] === 1) {
return 'something';
}
})
jest.spyOn(foo, 'bar').mockClear().mockImplementation((...args) => {
if (args[0] === 'foo' && typeof args[1] === 'object')
if (args[0] === 'foo' && typeof args[1] === 'object') {
return 'something';
}
})
jest.fn().mockImplementation((...args) => {
if (args[0] === 'foo' && args.length >= 2)
if (args[0] === 'foo' && args.length >= 2) {
return 'something';
}
})
`
)
Expand All @@ -220,8 +227,9 @@ describe('spies and stubs', () => {
`,
`
jest.fn().mockImplementation((...args: any[]) => {
if (args[0] === 'foo')
if (args[0] === 'foo') {
return 'something';
}
})
`,
{ parser: 'tsx' }
Expand Down Expand Up @@ -356,6 +364,86 @@ describe('spies and stubs', () => {
{ parser: 'ts' }
)
})

it('handles on*Call', () => {
expectTransformation(
`
import sinon from 'sinon-sandbox'

stub.onFirstCall().returns(5)
stub.onSecondCall().returns(6, 7)

stub.onFirstCall().returnsArg(0)
stub.onSecondCall().returnsArg(1)

// invalid onCall() params
stub.onCall().returns('invalid')
`,
`
stub.mockImplementation(() => {
if (stub.mock.calls.length === 0) {
return 5;
}
})
stub.mockImplementation(() => {
if (stub.mock.calls.length === 1) {
return 6;
}
})

stub.mockImplementation((...args) => {
if (stub.mock.calls.length === 0) {
return args[0];
}
})
stub.mockImplementation((...args) => {
if (stub.mock.calls.length === 1) {
return args[1];
}
})

// invalid onCall() params
stub.onCall().mockReturnValue('invalid')
`
)
})
it('handles on*Call (parser: ts)', () => {
expectTransformation(
`
import sinon from 'sinon-sandbox'

stub.onThirdCall().returns([8, 9, 10])
stub.onCall(3).returns(biscuits)

stub.onThirdCall().returnsArg(2)
stub.onCall(3).returnsArg(biscuits)
`,
`
stub.mockImplementation(() => {
if (stub.mock.calls.length === 2) {
return [8, 9, 10];
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I find one-line statements less readable and error prone.

It would be slightly nicer with an arrow function here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @skovhus, I'm not sure I understand what you're asking for here.

do you mean braces around the if?

      stub.mockImplementation(() => {
            if (stub.mock.calls.length === 2) {
                  return [8, 9, 10];
            }

you said "arrow function" so maybe you mean this?

      stub.mockImplementation(() => stub.mock.calls.length === 2 && [8, 9, 10]);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because the second route (stub.mockImplementation(() => stub.mock.calls.length === 2 && [8, 9, 10]);) would sometimes produce false for a return value (which differs from sinon)

const sinon = require('sinon');

const s = sinon.stub();

s.onFirstCall().returns(5);

console.log(s());  // 5
console.log(s());  // undefined

i went with braces around the single-line if statements. hopefully that's what you meant.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I would prefer us to either use block statements or arrow functions instead of the one-line statements. Thanks for fixing this.

}
})
stub.mockImplementation(() => {
if (stub.mock.calls.length === 3) {
return biscuits;
}
})

stub.mockImplementation((...args: any[]) => {
if (stub.mock.calls.length === 2) {
return args[2];
}
})
stub.mockImplementation((...args: any[]) => {
if (stub.mock.calls.length === 3) {
return args[biscuits];
}
})
`,
{ parser: 'tsx' }
)
})
})

describe('mocks', () => {
Expand Down
88 changes: 87 additions & 1 deletion src/transformers/sinon.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ const SINON_MATCHERS_WITH_ARGS = {
string: 'string',
}
const SINON_NTH_CALLS = new Set(['firstCall', 'secondCall', 'thirdCall', 'lastCall'])
const SINON_ON_NTH_CALLS = new Set(['onFirstCall', 'onSecondCall', 'onThirdCall'])
const EXPECT_PREFIXES = new Set(['to'])
const isPrefix = (name) => EXPECT_PREFIXES.has(name)

Expand Down Expand Up @@ -370,6 +371,90 @@ function transformStub(j, ast, sinonExpression, logWarning) {
})
}

/*
transform .onCall(0), .on{First,Second,Third}Call()

stub.onCall(4).return(biscuits) -> stub.mockImplementation(() => { if (stub.mock.calls.length === 3) return biscuits; })
stub.onFirstCall().returnArg(2) -> stub.mockImplementation((...args: any[]) => { if (stub.mock.calls.length === 0) return args[2]; })
*/
function transformStubOnCalls(j, ast, parser) {
ast
.find(j.CallExpression, {
callee: {
object: {
callee: {
property: {
name: (n) => n === 'onCall' || SINON_ON_NTH_CALLS.has(n),
},
},
},
property: {
name: (n) => ['returns', 'returnsArg'].includes(n),
},
},
})
.replaceWith(({ node }) => {
let index
switch (node.callee.object.callee.property.name) {
case 'onCall':
index = node.callee.object.arguments[0]
break
case 'onFirstCall':
index = j.numericLiteral(0)
break
case 'onSecondCall':
index = j.numericLiteral(1)
break
case 'onThirdCall':
index = j.numericLiteral(2)
break
}
if (!index) return node

// `jest.spyOn` or `jest.fn`
const mockFn = node.callee.object.callee.object
const callLengthConditionalExpression = j.binaryExpression(
'===',
j.memberExpression(mockFn, j.identifier('mock.calls.length')),
index
)

const isReturns = node.callee.property.name === 'returns'
const isTypescript = parser === 'ts' || parser === 'tsx'

const mockImplementationArgs = isReturns
? []
: [
j.spreadPropertyPattern(
j.identifier.from({
name: 'args',
typeAnnotation: isTypescript
? j.typeAnnotation(j.arrayTypeAnnotation(j.anyTypeAnnotation()))
: null,
})
),
]
const mockImplementationReturn = isReturns
? node.arguments[0]
: j.memberExpression(j.identifier('args'), node.arguments[0], true)

const mockImplementationFn = j.arrowFunctionExpression(
mockImplementationArgs,
j.blockStatement([
j.ifStatement(
callLengthConditionalExpression,
j.blockStatement([j.returnStatement(mockImplementationReturn)])
),
])
)

return j.callExpression(
j.memberExpression(mockFn, j.identifier('mockImplementation')),
[mockImplementationFn]
)
})
}

/*
stub.getCall(0) -> stub.mock.calls[0]
stub.getCall(0).args[1] -> stub.mock.calls[0][1]
Expand Down Expand Up @@ -547,7 +632,7 @@ function transformMock(j: core.JSCodeshift, ast, parser: string) {
j.blockStatement([
j.ifStatement(
mockImplementationConditionalExpression,
j.returnStatement(mockImplementationReturn[0])
j.blockStatement([j.returnStatement(mockImplementationReturn[0])])
),
])
)
Expand Down Expand Up @@ -804,6 +889,7 @@ export default function transformer(fileInfo: FileInfo, api: API, options) {
const logWarning = (msg, node) => logger(fileInfo, msg, node)

transformStub(j, ast, sinonExpression, logWarning)
transformStubOnCalls(j, ast, options.parser)
transformMockTimers(j, ast)
transformMock(j, ast, options.parser)
transformMockResets(j, ast)
Expand Down