fix(core): mark the correct function as errored when capturing manually

Author: skoshx

examples/with-express/rollup.config.js

@@ -3,6 +3,7 @@ import nodeResolve from '@rollup/plugin-node-resolve'
 import commonjs from '@rollup/plugin-commonjs'
 import { FlytrapTransformPlugin } from 'useflytrap/transform'
 
+/** @type import('rollup').RollupOptions */
 export default {
 	input: 'src/index.ts',
 	output: {

src/index.ts

@@ -32,6 +32,7 @@ export function useFlytrapFunction<
 				args,
 				timestamp: Date.now()
 			})
+			_executionCursor--
 
 			// Replaying code
 			if (getMode() === 'replay') {
@@ -49,17 +50,16 @@ export function useFlytrapFunction<
 
 				// Merge replay args & real args
 				const mergedArgs = fillUnserializableFlytrapValues(replayArgs, args)
-				// const realOutput = await fn(...mergedArgs)
 				// @ts-expect-error for some reason `this as any` still gives error
 				const realOutput = await executeFunctionAsync(fn, this as any, mergedArgs)
 				return fillUnserializableFlytrapValues(replayOutput, realOutput)
 			}
 			// Capturing bugs
 			try {
-				// const output = await fn(...args)
 				// @ts-expect-error for some reason `this as any` still gives error
 				const output = await executeFunctionAsync(fn, this as any, args)
 				saveOutputForFunction(opts.id, output)
+				_executionCursor++
 				return output
 			} catch (error) {
 				/**
@@ -94,6 +94,7 @@ export function useFlytrapFunction<
 			args,
 			timestamp: Date.now()
 		})
+		_executionCursor--
 
 		// Replaying code
 		if (getMode() === 'replay') {
@@ -105,14 +106,12 @@ export function useFlytrapFunction<
 						`Could not find replay input arguments for function with ID ${opts.id}, either this is a function you have added, or something has gone wrong during the capture process. If this is the case, contact us.`
 					)
 				}
-				// return fn(...args)
 				// @ts-expect-error for some reason `this as any` still gives error
 				return executeFunction(fn, this as any, args)
 			}
 
 			// Merge replay args & real args
 			const mergedArgs = fillUnserializableFlytrapValues(replayArgs, args)
-			// const realOutput = fn(...mergedArgs)
 			// @ts-expect-error for some reason `this as any` still gives error
 			const realOutput = executeFunction(fn, this as any, mergedArgs)
 			return fillUnserializableFlytrapValues(replayOutput, realOutput)
@@ -123,6 +122,7 @@ export function useFlytrapFunction<
 			// @ts-expect-error for some reason `this as any` still gives error
 			const output = executeFunction(fn, this as any, args)
 			saveOutputForFunction(opts.id, output)
+			_executionCursor++
 			return output
 		} catch (error) {
 			/**
@@ -324,12 +324,17 @@ function getReplayFunctionOutput(functionId: string): any | undefined {
 }
 
 let _executingFunctions: CapturedFunction[] = []
+let _executionCursor = 1
 let _functionCalls: CapturedCall[] = []
 let _userId: string | undefined = undefined
 
 export const getCapturedFunctions = () => _executingFunctions
 export const getCapturedCalls = () => _functionCalls
 
+export const getUserId = () => _userId
+export const getExecutingFunction = () =>
+	_executingFunctions.at(-_executionCursor) ?? _executingFunctions.at(-1)
+
 export const clearCapturedFunctions = () => {
 	_executingFunctions = []
 }
@@ -392,8 +397,6 @@ export function identify(userId: string) {
 	log.info('identify', `Identified current user as "${userId}"`)
 	_userId = userId
 }
-export const getUserId = () => _userId
-export const getExecutingFunction = () => _executingFunctions.at(-1)
 
 const addFunctionInvocation = (functionId: string, invocation: CaptureInvocation) => {
 	log.info('function-execution', `Executing function with ID "${functionId}"`)

src/transform/artifacts/cache.ts

@@ -89,9 +89,9 @@ export async function upsertArtifacts(
 	const uploadedBatches = await batchedArtifactsUpload(artifactsToUpload, secretApiKey, projectId)
 	log.info(
 		'storage',
-		`Pushed ${
-			artifactsToUpload.length
-		} artifacts in ${uploadedBatches?.length} batches to the Flytrap API. Payload Size: ${formatBytes(
+		`Pushed ${artifactsToUpload.length} artifacts in ${
+			uploadedBatches?.length
+		} batches to the Flytrap API. Payload Size: ${formatBytes(
 			JSON.stringify(artifactsToUpload).length
 		)}`
 	)

test/capture.test.ts

@@ -3,7 +3,9 @@ import {
 	useFlytrapCall,
 	clearCapturedFunctions,
 	clearCapturedCalls,
-	getCapturedCalls
+	getCapturedCalls,
+	getExecutingFunction,
+	getCapturedFunctions
 } from '../src/index'
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
@@ -90,6 +92,37 @@ describe('useFlytrapCall capture', () => {
 		expect(returnVal).toBe(2)
 	})
 
+	it('correctly marks function causing the error when manually capturing', () => {
+		const date = new Date(0)
+		vi.setSystemTime(date)
+		clearFlytrapStorage()
+
+		let caughtExecutingFunctionId: string | undefined = undefined
+
+		const GET = useFlytrapFunction(
+			function GET() {
+				const users = [1, 2, 3, 4, 5]
+				const foundUser = useFlytrapCall(users, {
+					id: '/file.js-call-_find',
+					args: [
+						useFlytrapFunction((u) => u === 13, {
+							id: '/file.js-_anonymous'
+						})
+					],
+					name: 'find'
+				})
+				if (!foundUser) {
+					// `capture` here
+					caughtExecutingFunctionId = getExecutingFunction()?.id
+				}
+			},
+			{ id: '/file.js-_GET' }
+		)
+		GET()
+
+		expect(caughtExecutingFunctionId).toEqual(`/file.js-_GET`)
+	})
+
 	it.todo('captures errors inside the function call')
 })