feat: capture ignores

Author: skoshx

src/core/captureIgnores.ts

@@ -0,0 +1,34 @@
+import { log } from './logging'
+import { CaptureIgnore, CapturePayload } from './types'
+
+export function shouldIgnoreCapture(
+	capturePayload: CapturePayload,
+	captureIgnores: CaptureIgnore[]
+) {
+	const stringCaptureIgnore = (capturePayload: CapturePayload, ignoreEntry: string) => {
+		if (ignoreEntry === '') return false
+		return capturePayload.functionName.includes(ignoreEntry)
+	}
+	const regexpCaptureIgnore = (capturePayload: CapturePayload, ignoreEntry: RegExp) => {
+		const matches = capturePayload.functionName.match(ignoreEntry)
+		return (matches && matches.length > 0) ?? false
+	}
+
+	for (let i = 0; i < captureIgnores.length; i++) {
+		const ignoreEntry = captureIgnores[i]
+		if (typeof ignoreEntry === 'string') {
+			return stringCaptureIgnore(capturePayload, ignoreEntry)
+		} else if (ignoreEntry instanceof RegExp) {
+			return regexpCaptureIgnore(capturePayload, ignoreEntry)
+		} else if (typeof ignoreEntry === 'function') {
+			return ignoreEntry(capturePayload)
+		} else {
+			log.warn(
+				'capture',
+				`Invalid "captureIgnores" entry value of type "${typeof ignoreEntry}". Only strings, regular expressions and functions are supported. Learn more: https://docs.useflytrap.com/config/introduction`
+			)
+			return false
+		}
+	}
+	return false
+}

src/core/storage.ts

@@ -26,6 +26,7 @@ import {
 	stringify,
 	superJsonRegisterCustom
 } from './stringify'
+import { shouldIgnoreCapture } from './captureIgnores'
 
 const loadedCaptures = new Map<string, CaptureDecryptedAndRevived | undefined>()
 
@@ -178,7 +179,7 @@ export const liveFlytrapStorage: FlytrapStorage = {
 	},
 	async saveCapture(functions, calls, error?) {
 		// Here error if
-		const { publicApiKey, projectId } = (await getLoadedConfig()) ?? {}
+		const { publicApiKey, projectId, captureIgnores } = (await getLoadedConfig()) ?? {}
 
 		if (!publicApiKey || !projectId || empty(publicApiKey, projectId)) {
 			console.error(
@@ -206,7 +207,7 @@ export const liveFlytrapStorage: FlytrapStorage = {
 		const linkedCalls = addLinksToCaptures(calls, { args, outputs })
 		const linkedFunctions = addLinksToCaptures(functions, { args, outputs })
 
-		const newPayload: CapturePayload = {
+		const payload: CapturePayload = {
 			capturedUserId: getUserId(),
 			projectId,
 			functionName:
@@ -224,8 +225,16 @@ export const liveFlytrapStorage: FlytrapStorage = {
 			})
 		}
 
+		// Capture ignores
+		if (captureIgnores) {
+			if (shouldIgnoreCapture(payload, captureIgnores)) {
+				log.info('storage', `Ignored capture with name "${payload.functionName}"`)
+				return
+			}
+		}
+
 		const { data: stringifiedPayload, error: stringifyError } = tryCatchSync(() =>
-			stringify(newPayload)
+			stringify(payload)
 		)
 
 		if (stringifyError || !stringifiedPayload) {
@@ -261,7 +270,7 @@ export const liveFlytrapStorage: FlytrapStorage = {
 		} else {
 			log.info(
 				'storage',
-				`Saved capture with name "${newPayload.functionName}". Payload Size: ${formatBytes(
+				`Saved capture with name "${payload.functionName}". Payload Size: ${formatBytes(
 					stringifiedPayload.length
 				)}`
 			)

src/core/types.ts

@@ -13,6 +13,8 @@ export type LogGroup =
 	| 'transform'
 	| 'cache'
 
+export type CaptureIgnore = string | RegExp | ((payload: CapturePayload) => boolean)
+
 export type FlytrapConfig = {
 	projectId: string
 	publicApiKey: string
@@ -47,6 +49,31 @@ export type FlytrapConfig = {
 	 * [Learn more](https://docs.useflytrap.com/config/introduction)
 	 */
 	excludeDirectories?: string[]
+	/**
+	 * Prevent certain captures from being sent to the Flytrap API. Ignoring
+	 * captures is useful if there are certain errors that are expected to be
+	 * thrown, for example "UNAUTHORIZED" tRPC responses.
+	 *
+	 * Capture ignores can be defined using partial matching of the capture
+	 * name, regular expressions or a function that returns a boolean. If any
+	 * of the ignore criteria returns true, the capture is ignored.
+	 *
+	 * @example
+	 * ```typescript
+	 * defineFlytrapConfig({
+	 * 	captureIgnores: [
+	 * 		// Ignore captures whose name matches below regex
+	 * 		/Hello World/g,
+	 * 		// Ignore captures whose name contains "UNAUTHORIZED"
+	 * 		"UNAUTHORIZED",
+	 * 		// Ignore all captures
+	 * 		(capture: CapturePayload) => true
+	 * 	]
+	 * })
+	 * ```
+	 * [Learn more](https://docs.useflytrap.com/config/introduction)
+	 */
+	captureIgnores?: CaptureIgnore[]
 }
 
 export type ErrorType = {

test/excludes.test.ts

@@ -5,6 +5,8 @@ import { _babelInterop } from '../src/transform/artifacts/artifacts'
 import babelTraverse from '@babel/traverse'
 import { findIgnoredImports, shouldIgnoreCall } from '../src/transform/packageIgnores'
 import { excludeDirectoriesIncludeFilePath } from '../src/transform/excludes'
+import { CapturePayload } from '../src/exports'
+import { shouldIgnoreCapture } from '../src/core/captureIgnores'
 
 describe('excludeDirectories', () => {
 	it('excludeDirectoriesIncludeFilePath', () => {
@@ -142,3 +144,59 @@ describe('packageIgnores', () => {
 		})
 	}
 })
+
+describe('captureIgnores', () => {
+	const createMockCapturePayload = (partialPayload: Partial<CapturePayload>): CapturePayload => ({
+		functionName: 'Lorem ipsum',
+		capturedUserId: 'rasmus@useflytrap.com',
+		args: '',
+		outputs: '',
+		error: 'encrypted',
+		functions: [],
+		calls: [],
+		projectId: 'mock-project-id'
+	})
+
+	const mockCapturePayload = createMockCapturePayload({})
+
+	const fixtures = {
+		strings: [
+			['Hello World', false],
+			['Lorem ipsuM', false],
+			['', false],
+			['Lorem', true],
+			['Lorem ipsum', true]
+		],
+		funcs: [
+			[() => true, true],
+			[(c: CapturePayload) => c.functionName.includes('Lorem'), true],
+			[(c: CapturePayload) => c.capturedUserId === 'rasmus@useflytrap.com', true],
+			[() => false, false],
+			[(c: CapturePayload) => c.functionName.includes('LoRem'), false],
+			[(c: CapturePayload) => c.capturedUserId === 'max@useflytrap.com', false]
+		],
+		regexps: [
+			[/Hello World/g, false],
+			[/Lorem ipsuM/g, false],
+			[/\\/g, false],
+			[/Lorem/g, true],
+			[/Lorem ipsum/g, true],
+			[(c: CapturePayload) => c.functionName.includes('Lorem'), true],
+			[(c: CapturePayload) => c.capturedUserId === 'rasmus@useflytrap.com', true],
+			[() => false, false],
+			[(c: CapturePayload) => c.functionName.includes('LoRem'), false],
+			[(c: CapturePayload) => c.capturedUserId === 'max@useflytrap.com', false]
+		]
+	} as const
+
+	for (const [key, keyFixtures] of Object.entries(fixtures)) {
+		it(`capture ignores > ${key}`, () => {
+			for (let i = 0; i < keyFixtures.length; i++) {
+				expect(
+					shouldIgnoreCapture(mockCapturePayload, [keyFixtures[i][0]]),
+					`fixture "${keyFixtures[i][0]}"`
+				).toEqual(keyFixtures[i][1])
+			}
+		})
+	}
+})