Files
sim/apps/sim/executor/variables/resolvers/loop.test.ts
Waleed b7f6bab282 feat(tests): added testing package, overhauled tests (#2586)
* feat(tests): added testing package, overhauled tests

* fix build
2025-12-25 16:06:47 -08:00

281 lines
10 KiB
TypeScript

import { loggerMock } from '@sim/testing'
import { describe, expect, it, vi } from 'vitest'
import type { LoopScope } from '@/executor/execution/state'
import { LoopResolver } from './loop'
import type { ResolutionContext } from './reference'
vi.mock('@/lib/logs/console/logger', () => loggerMock)
/**
* Creates a minimal workflow for testing.
*/
function createTestWorkflow(
loops: Record<string, { nodes: string[]; id?: string; iterations?: number }> = {}
) {
// Ensure each loop has required fields
const normalizedLoops: Record<string, { id: string; nodes: string[]; iterations: number }> = {}
for (const [key, loop] of Object.entries(loops)) {
normalizedLoops[key] = {
id: loop.id ?? key,
nodes: loop.nodes,
iterations: loop.iterations ?? 1,
}
}
return {
version: '1.0',
blocks: [],
connections: [],
loops: normalizedLoops,
parallels: {},
}
}
/**
* Creates a test loop scope.
*/
function createLoopScope(overrides: Partial<LoopScope> = {}): LoopScope {
return {
iteration: 0,
currentIterationOutputs: new Map(),
allIterationOutputs: [],
...overrides,
}
}
/**
* Creates a minimal ResolutionContext for testing.
*/
function createTestContext(
currentNodeId: string,
loopScope?: LoopScope,
loopExecutions?: Map<string, LoopScope>
): ResolutionContext {
return {
executionContext: {
loopExecutions: loopExecutions ?? new Map(),
},
executionState: {},
currentNodeId,
loopScope,
} as ResolutionContext
}
describe('LoopResolver', () => {
describe('canResolve', () => {
it.concurrent('should return true for loop references', () => {
const resolver = new LoopResolver(createTestWorkflow())
expect(resolver.canResolve('<loop.index>')).toBe(true)
expect(resolver.canResolve('<loop.iteration>')).toBe(true)
expect(resolver.canResolve('<loop.item>')).toBe(true)
expect(resolver.canResolve('<loop.currentItem>')).toBe(true)
expect(resolver.canResolve('<loop.items>')).toBe(true)
})
it.concurrent('should return true for loop references with nested paths', () => {
const resolver = new LoopResolver(createTestWorkflow())
expect(resolver.canResolve('<loop.item.name>')).toBe(true)
expect(resolver.canResolve('<loop.currentItem.data.value>')).toBe(true)
expect(resolver.canResolve('<loop.items.0>')).toBe(true)
})
it.concurrent('should return false for non-loop references', () => {
const resolver = new LoopResolver(createTestWorkflow())
expect(resolver.canResolve('<block.output>')).toBe(false)
expect(resolver.canResolve('<variable.myvar>')).toBe(false)
expect(resolver.canResolve('<parallel.index>')).toBe(false)
expect(resolver.canResolve('plain text')).toBe(false)
expect(resolver.canResolve('{{ENV_VAR}}')).toBe(false)
})
it.concurrent('should return false for malformed references', () => {
const resolver = new LoopResolver(createTestWorkflow())
expect(resolver.canResolve('loop.index')).toBe(false)
expect(resolver.canResolve('<loop.index')).toBe(false)
expect(resolver.canResolve('loop.index>')).toBe(false)
})
})
describe('resolve with explicit loopScope', () => {
it.concurrent('should resolve iteration/index property', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ iteration: 5 })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.iteration>', ctx)).toBe(5)
expect(resolver.resolve('<loop.index>', ctx)).toBe(5)
})
it.concurrent('should resolve item/currentItem property', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ item: { name: 'test', value: 42 } })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item>', ctx)).toEqual({ name: 'test', value: 42 })
expect(resolver.resolve('<loop.currentItem>', ctx)).toEqual({ name: 'test', value: 42 })
})
it.concurrent('should resolve items property', () => {
const resolver = new LoopResolver(createTestWorkflow())
const items = ['a', 'b', 'c']
const loopScope = createLoopScope({ items })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.items>', ctx)).toEqual(items)
})
it.concurrent('should resolve nested path in item', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({
item: { user: { name: 'Alice', address: { city: 'NYC' } } },
})
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item.user.name>', ctx)).toBe('Alice')
expect(resolver.resolve('<loop.item.user.address.city>', ctx)).toBe('NYC')
})
it.concurrent('should resolve array index in items', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({
items: [{ id: 1 }, { id: 2 }, { id: 3 }],
})
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.items.0>', ctx)).toEqual({ id: 1 })
expect(resolver.resolve('<loop.items.1.id>', ctx)).toBe(2)
})
})
describe('resolve without explicit loopScope (discovery)', () => {
it.concurrent('should find loop scope from workflow config', () => {
const workflow = createTestWorkflow({
'loop-1': { nodes: ['block-1', 'block-2'] },
})
const resolver = new LoopResolver(workflow)
const loopScope = createLoopScope({ iteration: 3 })
const loopExecutions = new Map([['loop-1', loopScope]])
const ctx = createTestContext('block-1', undefined, loopExecutions)
expect(resolver.resolve('<loop.iteration>', ctx)).toBe(3)
})
it.concurrent('should return undefined when block is not in any loop', () => {
const workflow = createTestWorkflow({
'loop-1': { nodes: ['other-block'] },
})
const resolver = new LoopResolver(workflow)
const ctx = createTestContext('block-1', undefined)
expect(resolver.resolve('<loop.iteration>', ctx)).toBeUndefined()
})
it.concurrent('should return undefined when loop scope not found in executions', () => {
const workflow = createTestWorkflow({
'loop-1': { nodes: ['block-1'] },
})
const resolver = new LoopResolver(workflow)
const ctx = createTestContext('block-1', undefined, new Map())
expect(resolver.resolve('<loop.iteration>', ctx)).toBeUndefined()
})
})
describe('edge cases', () => {
it.concurrent('should return undefined for invalid loop reference (missing property)', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ iteration: 0 })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop>', ctx)).toBeUndefined()
})
it.concurrent('should return undefined for unknown loop property', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ iteration: 0 })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.unknownProperty>', ctx)).toBeUndefined()
})
it.concurrent('should handle iteration index 0 correctly', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ iteration: 0 })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.index>', ctx)).toBe(0)
})
it.concurrent('should handle null item value', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ item: null })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item>', ctx)).toBeNull()
})
it.concurrent('should handle undefined item value', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ item: undefined })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item>', ctx)).toBeUndefined()
})
it.concurrent('should handle empty items array', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ items: [] })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.items>', ctx)).toEqual([])
})
it.concurrent('should handle primitive item value', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ item: 'simple string' })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item>', ctx)).toBe('simple string')
})
it.concurrent('should handle numeric item value', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ item: 42 })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item>', ctx)).toBe(42)
})
it.concurrent('should handle boolean item value', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ item: true })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item>', ctx)).toBe(true)
})
it.concurrent('should handle item with array value', () => {
const resolver = new LoopResolver(createTestWorkflow())
const loopScope = createLoopScope({ item: [1, 2, 3] })
const ctx = createTestContext('block-1', loopScope)
expect(resolver.resolve('<loop.item>', ctx)).toEqual([1, 2, 3])
expect(resolver.resolve('<loop.item.0>', ctx)).toBe(1)
expect(resolver.resolve('<loop.item.2>', ctx)).toBe(3)
})
})
describe('block ID with branch suffix', () => {
it.concurrent('should handle block ID with branch suffix in loop lookup', () => {
const workflow = createTestWorkflow({
'loop-1': { nodes: ['block-1'] },
})
const resolver = new LoopResolver(workflow)
const loopScope = createLoopScope({ iteration: 2 })
const loopExecutions = new Map([['loop-1', loopScope]])
const ctx = createTestContext('block-1₍0₎', undefined, loopExecutions)
expect(resolver.resolve('<loop.iteration>', ctx)).toBe(2)
})
})
})