feat: add invariant and tryCapture utils

Author: skoshx

src/core/util.ts

@@ -12,13 +12,10 @@ export function extractCallerSource(): SourceType | undefined {
 	if (!stack) return undefined
 
 	const lines = stack.split('\n')
-	// Third line contains our called file and line
-	// /Users/rasmus/Desktop/DEV/Web/flytrap-libs/test/newindex.test.ts:13:24
 	if (lines.length < 4) return undefined
 	const sourceLine = lines[3]
 	const parts = sourceLine.split('/')
 	const fileNameAndSourceLine = parts[parts.length - 1]
-	// newindex.test.ts:13:24
 	const [filePath, lineNumber] = fileNameAndSourceLine.split(':')
 	return {
 		filePath,
@@ -180,16 +177,13 @@ export function tryCatchSync<DType = unknown, EType = unknown>(
 	}
 }
 
-// function fillMissingFlytrapValues(lackingObject: any, fullObject: any) {}
-
 type ReplaceValue = any
 type InputValue = ReplaceValue | (typeof FLYTRAP_REPLACE_VALUES)[number]
 
 export function fillUnserializableFlytrapValues(
 	input: InputValue,
 	replaceValue: ReplaceValue
 ): ReplaceValue {
-	// if (input === FLYTRAP_UNSERIALIZABLE_VALUE) {
 	if (FLYTRAP_REPLACE_VALUES.includes(input)) {
 		if (replaceValue === undefined) throw new Error(`Replace value is undefined.`)
 		return replaceValue

src/index.ts

@@ -6,11 +6,12 @@ import {
 	FlytrapFunctionOptions
 } from './core/types'
 import {
+	TryCatchResponse,
 	fillUnserializableFlytrapValues,
 	getMode,
 	isAsyncFunction,
-	tryCatch,
-	tryCatchSync
+	tryCatch as utilTryCatch,
+	tryCatchSync as utilTryCatchSync
 } from './core/util'
 import { getFlytrapStorage, getLoadedCapture, loadAndPersist } from './core/storage'
 import { createHumanLog } from './core/human-logs'
@@ -68,7 +69,7 @@ export function useFlytrapFunction<
 				 */
 				saveErrorForFunction(opts.id, error)
 				log.info('capture', `Captured error in async function with ID "${opts.id}".`, { error })
-				const { error: saveError } = await tryCatch(
+				const { error: saveError } = await utilTryCatch(
 					getFlytrapStorage().saveCapture(_executingFunctions, _functionCalls, error as Error)
 				)
 				if (saveError) {
@@ -131,7 +132,7 @@ export function useFlytrapFunction<
 			 */
 			saveErrorForFunction(opts.id, error)
 			log.info('capture', `Captured error in function with ID "${opts.id}".`, { error })
-			const { error: saveError } = tryCatchSync(() =>
+			const { error: saveError } = utilTryCatchSync(() =>
 				getFlytrapStorage().saveCapture(_executingFunctions, _functionCalls, error as Error)
 			)
 			if (saveError) {
@@ -373,7 +374,7 @@ export async function capture<T extends Error>({
 	}
 
 	// Let's save it
-	const { error: saveError } = await tryCatch(
+	const { error: saveError } = await utilTryCatch(
 		getFlytrapStorage().saveCapture(_executingFunctions, _functionCalls, error)
 	)
 	if (saveError) {
@@ -490,6 +491,37 @@ function saveErrorForFunction(functionId: string, error: any) {
 	if (lastInvocation) lastInvocation.error = serializeError(error)
 }
 
+// Utility functions
+export async function tryCapture<DType = unknown, EType = any>(
+	fn: Promise<DType>
+): Promise<TryCatchResponse<DType, EType>> {
+	try {
+		return { data: await fn, error: null }
+	} catch (error) {
+		await capture({ error: error as Error })
+		return { data: null, error: error as EType }
+	}
+}
+export function tryCaptureSync<DType = unknown, EType = any>(
+	fn: () => DType
+): TryCatchResponse<DType, EType> {
+	try {
+		return { data: fn(), error: null }
+	} catch (error) {
+		capture({ error: error as Error })
+		return { data: null, error: error as EType }
+	}
+}
+
+export async function invariantAsync(condition: any, message?: string) {
+	if (condition) return
+	await capture({ error: new Error('Invariant failed'), message: message ?? 'Invariant failed.' })
+}
+export function invariant(condition: any, message?: string): asserts condition {
+	if (condition) return
+	capture({ error: new Error('Invariant failed'), message: message ?? 'Invariant failed.' })
+}
+
 // Export
 export * from './core/config'
 export * from './core/types'