Addressed feedback & fixed test flake

Author: KuphJr

jest.config.js

@@ -3,7 +3,7 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testMatch: ['**/test/**/*.test.ts'],
-  testTimeout: 240 * 1000,
+  testTimeout: 60 * 1000,
 
   coverageReporters: ['html'],
   collectCoverageFrom: ['src/**/*.ts', '!src/test/*.ts', '!src/simulateScript/deno-sandbox/*.ts'],

src/localFunctionsTestnet.ts

@@ -144,7 +144,7 @@ const handleOracleRequest = async (
   admin: Wallet,
   simulationConfigPath?: string,
 ) => {
-  const requestData = await buildRequestDataObject(requestEventData.data)
+  const requestData = await buildRequestObject(requestEventData.data)
   const response = await simulateDONExecution(requestData, simulationConfigPath)
 
   const errorHexstring = response.errorString
@@ -284,34 +284,37 @@ const encodeReport = (
   return encodedReport
 }
 
-const buildRequestDataObject = async (requestData: string): Promise<FunctionsRequestParams> => {
-  const decodedRequestData = await cbor.decodeAll(Buffer.from(requestData.slice(2), 'hex'))
+const buildRequestObject = async (
+  requestDataHexString: string,
+): Promise<FunctionsRequestParams> => {
+  const decodedRequestData = await cbor.decodeAll(Buffer.from(requestDataHexString.slice(2), 'hex'))
 
   const requestDataObject = {} as FunctionsRequestParams
-
+  // The decoded request data is an array of alternating keys and values, therefore we can iterate over it in steps of 2
   for (let i = 0; i < decodedRequestData.length - 1; i += 2) {
-    const elem = decodedRequestData[i]
-    switch (elem) {
+    const requestDataKey = decodedRequestData[i]
+    const requestDataValue = decodedRequestData[i + 1]
+    switch (requestDataKey) {
       case 'codeLocation':
-        requestDataObject.codeLocation = decodedRequestData[i + 1]
+        requestDataObject.codeLocation = requestDataValue
         break
       case 'secretsLocation':
         // Unused as secrets provided as an argument to startLocalFunctionsTestnet() are used instead
         break
       case 'language':
-        requestDataObject.codeLanguage = decodedRequestData[i + 1]
+        requestDataObject.codeLanguage = requestDataValue
         break
       case 'source':
-        requestDataObject.source = decodedRequestData[i + 1]
+        requestDataObject.source = requestDataValue
         break
       case 'secrets':
         // Unused as secrets provided as an argument to startLocalFunctionsTestnet() are used instead
         break
       case 'args':
-        requestDataObject.args = decodedRequestData[i + 1]
+        requestDataObject.args = requestDataValue
         break
       case 'bytesArgs':
-        requestDataObject.bytesArgs = decodedRequestData[i + 1].map((bytesArg: Buffer) => {
+        requestDataObject.bytesArgs = requestDataValue.map((bytesArg: Buffer) => {
           return '0x' + bytesArg.toString('hex')
         })
         break

src/simulateScript/simulateScript.ts

@@ -126,7 +126,11 @@ export const simulateScript = async ({
 
   const { code, signal } = await simulationComplete
 
-  fs.rmSync(scriptPath)
+  try {
+    fs.rmSync(scriptPath)
+  } catch {
+    // The temp file may have already been deleted
+  }
 
   let capturedTerminalOutput: string
   let parsedOutput: SandboxResult = {}

test/integration/ResponseListener.test.ts

@@ -6,7 +6,7 @@ import {
   ResponseListener,
   simulatedDonId,
 } from '../../src'
-import { setupLocalTestnet } from '../utils'
+import { setupLocalTestnetFixture } from '../utils'
 
 import { Contract, Wallet, utils } from 'ethers'
 
@@ -18,7 +18,7 @@ describe('Functions toolkit classes', () => {
   let allowlistedUser_A: Wallet
 
   beforeAll(async () => {
-    const testSetup = await setupLocalTestnet(8002)
+    const testSetup = await setupLocalTestnetFixture(8002)
     linkTokenAddress = testSetup.linkTokenAddress
     functionsRouterAddress = testSetup.functionsRouterAddress
     exampleClient = testSetup.exampleConsumer
@@ -72,7 +72,7 @@ describe('Functions toolkit classes', () => {
         utils.formatBytes32String(simulatedDonId),
       )
 
-      const succReq = await succReqTx.wait(1)
+      const succReq = await succReqTx.wait()
       const succRequestId = succReq.events[0].topics[1]
 
       const succResponse = await functionsListener.listenForResponse(succRequestId)

test/integration/integration.test.ts

@@ -7,7 +7,7 @@ import {
   simulatedSecretsKeys,
 } from '../../src'
 import { mockOffchainSecretsEndpoints, mockGatewayUrl } from './apiFixture'
-import { setupLocalTestnet } from '../utils'
+import { setupLocalTestnetFixture } from '../utils'
 
 import { BigNumber, Contract, Wallet, utils } from 'ethers'
 
@@ -25,7 +25,7 @@ describe('Functions toolkit classes', () => {
   let subFunder_A: Wallet
 
   beforeAll(async () => {
-    const testSetup = await setupLocalTestnet(8001)
+    const testSetup = await setupLocalTestnetFixture(8001)
     donId = testSetup.donId
     linkTokenContract = testSetup.linkTokenContract
     linkTokenAddress = testSetup.linkTokenAddress

test/integration/localFunctionsTestnet.test.ts

@@ -5,7 +5,7 @@ import {
   ResponseListener,
   ReturnType,
 } from '../../src'
-import { setupLocalTestnet } from '../utils'
+import { setupLocalTestnetFixture } from '../utils'
 
 import { utils } from 'ethers'
 
@@ -22,7 +22,7 @@ describe('Local Functions Testnet', () => {
   let getFunds: GetFunds
 
   beforeAll(async () => {
-    const testSetup = await setupLocalTestnet(8003)
+    const testSetup = await setupLocalTestnetFixture(8003)
     linkTokenAddress = testSetup.linkTokenAddress
     functionsRouterAddress = testSetup.functionsRouterAddress
     exampleClient = testSetup.exampleConsumer
@@ -77,7 +77,7 @@ describe('Local Functions Testnet', () => {
       utils.formatBytes32String(simulatedDonId),
     )
 
-    const req = await reqTx.wait(1)
+    const req = await reqTx.wait()
     const requestId = req.events[0].topics[1]
     const response = await functionsListener.listenForResponse(requestId)
 
@@ -116,7 +116,7 @@ describe('Local Functions Testnet', () => {
         codeLocation: 0,
         secretsLocation: 1,
         language: 0,
-        source: 'return Functions.encodeUint256(Math.floor(Math.random() * 1_000_000_000))',
+        source: 'return Functions.encodeUint256(Math.floor((Math.random() + 0.1) * 1_000_000_000))',
         encryptedSecretsReference: '0xabcd',
         requestSignature: [],
         args: ['hello', 'world'],
@@ -126,7 +126,7 @@ describe('Local Functions Testnet', () => {
       utils.formatBytes32String(simulatedDonId),
     )
 
-    const req = await reqTx.wait(1)
+    const req = await reqTx.wait()
     const requestId = req.events[0].topics[1]
     const response = await functionsListener.listenForResponse(requestId)
 
@@ -164,7 +164,7 @@ describe('Local Functions Testnet', () => {
         codeLocation: 0,
         secretsLocation: 1,
         language: 0,
-        source: 'throw Error(`${Math.floor(Math.random() * 100)}`)',
+        source: 'throw Error(`${Math.floor((Math.random() + 0.1) * 100)}`)',
         encryptedSecretsReference: '0xabcd',
         requestSignature: [],
         args: ['hello', 'world'],
@@ -174,7 +174,7 @@ describe('Local Functions Testnet', () => {
       utils.formatBytes32String(simulatedDonId),
     )
 
-    const req = await reqTx.wait(1)
+    const req = await reqTx.wait()
     const requestId = req.events[0].topics[1]
     const response = await functionsListener.listenForResponse(requestId)
 

test/utils/index.ts

@@ -10,7 +10,7 @@ import type { GetFunds } from '../../src'
 import type { Contract } from 'ethers'
 import type { Server } from 'ganache'
 
-export const setupLocalTestnet = async (
+export const setupLocalTestnetFixture = async (
   port: number,
 ): Promise<{
   donId: string