test: replace sinon with tinyspy (#6580)

* fix: replace sinon with tinyspy

* fix: apply suggestions from review

* fix: formatting

* fix: apply suggestions from the review

---------

Co-authored-by: Mateusz Bocian <[email protected]>

Author: outslept

package-lock.json

@@ -137,7 +137,7 @@
     "moize": "^6.0.0",
     "npm-run-all2": "^6.0.0",
     "process-exists": "^5.0.0",
-    "sinon": "^21.0.0",
+    "tinyspy": "^4.0.3",
     "tmp-promise": "^3.0.2",
     "tsd": "^0.32.0",
     "vitest": "^3.0.0",

packages/build/package.json

@@ -9,7 +9,7 @@ import getNode from 'get-node'
 import moize from 'moize'
 import { pathExists } from 'path-exists'
 import semver from 'semver'
-import sinon from 'sinon'
+import { spy, spyOn } from 'tinyspy'
 import { tmpName } from 'tmp-promise'
 
 import { zipItAndShipIt } from '../../lib/plugins_core/functions/index.js'
@@ -425,8 +425,8 @@ test('Print warning when headers file is missing from publish directory', async
 })
 
 test.serial('Passes the right properties to zip-it-and-ship-it', async (t) => {
-  const mockZipFunctions = sinon.stub().resolves()
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').get(() => mockZipFunctions)
+  const mockZipFunctions = spy(() => Promise.resolve())
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', mockZipFunctions)
   const fixtureDir = join(FIXTURES_DIR, 'core')
 
   await new Fixture('./fixtures/core').runWithBuild()
@@ -439,7 +439,7 @@ test.serial('Passes the right properties to zip-it-and-ship-it', async (t) => {
 
   t.is(mockZipFunctions.callCount, 2)
 
-  const params1 = mockZipFunctions.firstCall.args[2]
+  const params1 = mockZipFunctions.calls[0][2]
 
   t.is(params1.basePath, fixtureDir)
   t.true(params1.config['*'].zipGo)
@@ -453,15 +453,15 @@ test.serial('Passes the right properties to zip-it-and-ship-it', async (t) => {
     t.is(params1.config['*'].nodeVersion, undefined)
   }
 
-  const params2 = mockZipFunctions.secondCall.args[2]
+  const params2 = mockZipFunctions.calls[1][2]
 
   t.is(params2.config['*'].nodeVersion, 'nodejs00.x')
   t.is(params2.config['*'].zipGo, undefined)
 })
 
 test.serial('Passes functions generated by build plugins to zip-it-and-ship-it', async (t) => {
-  const mockZipFunctions = sinon.stub().resolves([])
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').get(() => mockZipFunctions)
+  const mockZipFunctions = spy(() => Promise.resolve([]))
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', mockZipFunctions)
   const fixtureName = 'functions_generated_from_steps'
   const fixtureDir = join(FIXTURES_DIR, fixtureName)
 
@@ -474,7 +474,7 @@ test.serial('Passes functions generated by build plugins to zip-it-and-ship-it',
   t.true(success)
   t.is(mockZipFunctions.callCount, 1)
 
-  const { generated, user } = mockZipFunctions.firstCall.args[0]
+  const { generated, user } = mockZipFunctions.calls[0][0]
 
   t.is(generated.directories.length, 2)
   t.true(generated.directories.includes(resolve(fixtureDir, '.netlify/functions-internal')))
@@ -501,8 +501,8 @@ test.serial('Passes functions generated by build plugins to zip-it-and-ship-it',
 })
 
 test.serial('Passes the right feature flags to zip-it-and-ship-it', async (t) => {
-  const mockZipFunctions = sinon.stub().resolves()
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').get(() => mockZipFunctions)
+  const mockZipFunctions = spy(() => Promise.resolve())
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', mockZipFunctions)
 
   await new Fixture('./fixtures/schedule').runWithBuild()
   await new Fixture('./fixtures/schedule').withFlags({ featureFlags: { buildbot_zisi_trace_nft: true } }).runWithBuild()
@@ -517,16 +517,16 @@ test.serial('Passes the right feature flags to zip-it-and-ship-it', async (t) =>
 
   t.is(mockZipFunctions.callCount, 4)
 
-  t.false(mockZipFunctions.getCall(0).args[2].featureFlags.traceWithNft)
-  t.false(mockZipFunctions.getCall(0).args[2].featureFlags.parseWithEsbuild)
-  t.is(mockZipFunctions.getCall(0).args[2].config.test.schedule, '@daily')
-  t.is(mockZipFunctions.getCall(0).args[2].featureFlags.this_is_a_mock_flag, undefined)
-  t.is(mockZipFunctions.getCall(0).args[2].featureFlags.and_another_one, undefined)
+  t.false(mockZipFunctions.calls[0][2].featureFlags.traceWithNft)
+  t.false(mockZipFunctions.calls[0][2].featureFlags.parseWithEsbuild)
+  t.is(mockZipFunctions.calls[0][2].config.test.schedule, '@daily')
+  t.is(mockZipFunctions.calls[0][2].featureFlags.this_is_a_mock_flag, undefined)
+  t.is(mockZipFunctions.calls[0][2].featureFlags.and_another_one, undefined)
 
-  t.true(mockZipFunctions.getCall(1).args[2].featureFlags.traceWithNft)
-  t.true(mockZipFunctions.getCall(2).args[2].featureFlags.parseWithEsbuild)
-  t.true(mockZipFunctions.getCall(3).args[2].featureFlags.this_is_a_mock_flag)
-  t.true(mockZipFunctions.getCall(3).args[2].featureFlags.and_another_one)
+  t.true(mockZipFunctions.calls[1][2].featureFlags.traceWithNft)
+  t.true(mockZipFunctions.calls[2][2].featureFlags.parseWithEsbuild)
+  t.true(mockZipFunctions.calls[3][2].featureFlags.this_is_a_mock_flag)
+  t.true(mockZipFunctions.calls[3][2].featureFlags.and_another_one)
 })
 
 test('Print warning on lingering processes', async (t) => {
@@ -597,8 +597,8 @@ test('Removes duplicate function names from the list of processed functions', as
 
 test.serial('`rustTargetDirectory` is passed to zip-it-and-ship-it only when running in buildbot', async (t) => {
   const runCount = 4
-  const mockZipFunctions = sinon.stub().resolves()
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').get(() => mockZipFunctions)
+  const mockZipFunctions = spy(() => Promise.resolve())
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', mockZipFunctions)
 
   await new Fixture('./fixtures/functions_config_1').withFlags({ mode: 'buildbot' }).runWithBuild()
   await new Fixture('./fixtures/functions_config_1').runWithBuild()
@@ -609,10 +609,7 @@ test.serial('`rustTargetDirectory` is passed to zip-it-and-ship-it only when run
 
   t.is(mockZipFunctions.callCount, runCount)
 
-  const { args: call1Args } = mockZipFunctions.getCall(0)
-  const { args: call2Args } = mockZipFunctions.getCall(1)
-  const { args: call3Args } = mockZipFunctions.getCall(2)
-  const { args: call4Args } = mockZipFunctions.getCall(3)
+  const [call1Args, call2Args, call3Args, call4Args] = mockZipFunctions.calls
 
   t.is(
     call1Args[2].config['*'].rustTargetDirectory,
@@ -628,23 +625,23 @@ test.serial('`rustTargetDirectory` is passed to zip-it-and-ship-it only when run
 
 test.serial('configFileDirectories is passed to zip-it-and-ship-it', async (t) => {
   const runCount = 1
-  const mockZipFunctions = sinon.stub().resolves()
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').get(() => mockZipFunctions)
+  const mockZipFunctions = spy(() => Promise.resolve())
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', mockZipFunctions)
 
   await new Fixture('./fixtures/functions_config_json').withFlags({ mode: 'buildbot' }).runWithBuild()
   stub.restore()
 
   t.is(mockZipFunctions.callCount, runCount)
 
-  const { args: call1Args } = mockZipFunctions.getCall(0)
+  const call1Args = mockZipFunctions.calls[0]
 
   t.deepEqual(call1Args[2].configFileDirectories, [
     join(FIXTURES_DIR, 'functions_config_json/.netlify/functions-internal'),
   ])
 })
 
 test.serial('functions can have a config with different parameters passed to zip-it-and-ship-it', async (t) => {
-  const zipItAndShipItSpy = sinon.spy(zipItAndShipIt, 'zipFunctions')
+  const zipItAndShipItSpy = spyOn(zipItAndShipIt, 'zipFunctions')
   const output = await new Fixture('./fixtures/functions_config_json')
     .withFlags({
       mode: 'buildbot',
@@ -653,7 +650,7 @@ test.serial('functions can have a config with different parameters passed to zip
 
   zipItAndShipItSpy.restore()
 
-  const { args: call1Args } = zipItAndShipItSpy.getCall(0)
+  const call1Args = zipItAndShipItSpy.calls[0]
   const { functions: functions } = await importJsonFile(call1Args[2].manifest)
 
   t.is(functions[0].displayName, 'Function One')
@@ -664,11 +661,11 @@ test.serial('functions can have a config with different parameters passed to zip
 })
 
 test.serial('internalSrcFolder is passed to zip-it-and-ship-it and helps prefill the generator field', async (t) => {
-  const zipItAndShipItSpy = sinon.spy(zipItAndShipIt, 'zipFunctions')
+  const zipItAndShipItSpy = spyOn(zipItAndShipIt, 'zipFunctions')
 
   await new Fixture('./fixtures/functions_internal_src_folder').withFlags({ mode: 'buildbot' }).runWithBuild()
   zipItAndShipItSpy.restore()
-  const { args: call1Args } = zipItAndShipItSpy.getCall(0)
+  const call1Args = zipItAndShipItSpy.calls[0]
 
   const [paths, , options] = call1Args
 

packages/build/tests/core/tests.js

@@ -3,12 +3,14 @@ import dns from 'dns'
 import { intercept, cleanAll } from '@netlify/nock-udp'
 import { Fixture } from '@netlify/testing'
 import test from 'ava'
-import sinon from 'sinon'
+import { spyOn } from 'tinyspy'
+
+let dnsLookupSpy
 
 test.before(() => {
   const origLookup = dns.lookup
   // we have to stub dns lookup as hot-shots is caching dns and therefore calling dns.lookup directly
-  sinon.stub(dns, 'lookup').callsFake((host, options, cb = options) => {
+  dnsLookupSpy = spyOn(dns, 'lookup', (host, options, cb = options) => {
     if (options === cb) {
       options = {}
     }
@@ -21,7 +23,7 @@ test.before(() => {
 })
 
 test.after(() => {
-  dns.lookup.restore()
+  dnsLookupSpy.restore()
   cleanAll()
 })
 

packages/build/tests/error_reporting/tests.js

@@ -3,7 +3,7 @@ import { platform } from 'process'
 import { Fixture, normalizeOutput } from '@netlify/testing'
 import test from 'ava'
 import hasAnsi from 'has-ansi'
-import sinon from 'sinon'
+import { spyOn } from 'tinyspy'
 
 import { CUSTOM_ERROR_KEY } from '../../lib/error/info.js'
 import { zipItAndShipIt } from '../../lib/plugins_core/functions/index.js'
@@ -205,7 +205,9 @@ test.serial('Normalizes error messages resulting from bundling TypeScript server
     type: 'functionsBundling',
   }
 
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').throws(customError)
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', () => {
+    throw customError
+  })
 
   const output = await new Fixture('./fixtures/serverless_function')
     .withFlags({ testOpts: { errorMonitor: true }, bugsnagKey: BUGSNAG_TEST_KEY })
@@ -239,7 +241,9 @@ error: expected one of \`!\` or \`::\`, found keyword \`use\`
     type: 'functionsBundling',
   }
 
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').throws(customError)
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', () => {
+    throw customError
+  })
 
   const output = await new Fixture('./fixtures/serverless_function')
     .withFlags({ testOpts: { errorMonitor: true }, bugsnagKey: BUGSNAG_TEST_KEY })
@@ -258,7 +262,9 @@ test.serial('When an error has a `normalizedMessage` property, its value is used
     type: 'functionsBundling',
   }
 
-  const stub = sinon.stub(zipItAndShipIt, 'zipFunctions').throws(customError)
+  const stub = spyOn(zipItAndShipIt, 'zipFunctions', () => {
+    throw customError
+  })
 
   const output = await new Fixture('./fixtures/serverless_function')
     .withFlags({ testOpts: { errorMonitor: true }, bugsnagKey: BUGSNAG_TEST_KEY })