Skip to content

AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents

22.3 KB
Raw Blame
import { PieceAuth, Property } from '@activepieces/pieces-framework'
import { propsProcessor } from '../../src/lib/variables/props-processor'
describe('Property Validation', () => {
    describe('required properties', () => {
        it('should validate required string property', async () => {
            const props = {
                text: Property.ShortText({
                    displayName: 'Text',
                    required: true,
                }),
            }

            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { text: 'valid text' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validErrors).toEqual({})

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { text: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(nullErrors).toEqual({
                text: ['Expected string, received: null'],
            })

            const { errors: undefinedErrors } = await propsProcessor.applyProcessorsAndValidators(
                { text: undefined },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(undefinedErrors).toEqual({
                text: ['Expected string, received: undefined'],
            })
        })

        it('should validate required number property', async () => {
            const props = {
                number: Property.Number({
                    displayName: 'Number',
                    required: true,
                }),
            }

            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { number: 42 },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validErrors).toEqual({})

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { number: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(nullErrors).toEqual({
                number: ['Expected number, received: null'],
            })

            const { errors: typeErrors } = await propsProcessor.applyProcessorsAndValidators(
                { number: 'not a number' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(typeErrors).toEqual({
                number: ['Expected number, received: not a number'],
            })
        })

        it('should validate required datetime property', async () => {
            const props = {
                date: Property.DateTime({
                    displayName: 'DateTime',
                    required: true,
                }),
            }

            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { date: '2024-03-14T12:00:00.000Z' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validErrors).toEqual({})

            const { errors: invalidErrors } = await propsProcessor.applyProcessorsAndValidators(
                { date: 'not a date' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(invalidErrors).toEqual({
                date: ['Invalid datetime format. Expected ISO format (e.g. 2024-03-14T12:00:00.000Z), received: not a date'],
            })
        })

        it('should validate required date range property', async () => {
            const props = {
                range: Property.DateRange({
                    displayName: 'Date Range',
                    required: true,
                }),
            }

            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { range: { preset: 'last_7_days' } },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validErrors).toEqual({})

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { range: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(nullErrors).toEqual({
                range: ['Expected date range, received: null'],
            })

            const { errors: typeErrors } = await propsProcessor.applyProcessorsAndValidators(
                { range: 'not a range' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(typeErrors).toEqual({
                range: ['Expected date range, received: not a range'],
            })
        })

        it('should validate required array property', async () => {
            const props = {
                array: Property.Array({
                    displayName: 'Array',
                    required: true,
                }),
            }

            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { array: [1, 2, 3] },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validErrors).toEqual({})

            const { errors: typeErrors } = await propsProcessor.applyProcessorsAndValidators(
                { array: 'not an array' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(typeErrors).toEqual({
                array: ['Expected array, received: not an array'],
            })
        })

        it('should validate required json property', async () => {
            const props = {
                json: Property.Json({
                    displayName: 'JSON',
                    required: true,
                }),
            }

            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: { key: 'value' } },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validErrors).toEqual({})

            const { errors: validJsonStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: '{"key": "value"}' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validJsonStringErrors).toEqual({})

            const { errors: validArrayErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: [1, 2, 3] },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validArrayErrors).toEqual({})

            const { errors: validArrayStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: '[1, 2, 3]' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validArrayStringErrors).toEqual({})

            const { errors: invalidJsonErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: 'not a json object' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(invalidJsonErrors).toEqual({
                json: ['Expected JSON, received: not a json object'],
            })

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(nullErrors).toEqual({
                json: ['Expected JSON, received: null'],
            })

            const { errors: emptyStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: '' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(emptyStringErrors).toEqual({
                json: ['Expected JSON, received: '],
            })

            const { errors: invalidTextErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: 'asd' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(invalidTextErrors).toEqual({
                json: ['Expected JSON, received: asd'],
            })
        })

        it('should validate optional json property with invalid value', async () => {
            const props = {
                json: Property.Json({
                    displayName: 'JSON',
                    required: false,
                }),
            }

            const { errors: validNullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validNullErrors).toEqual({})

            const { errors: validUndefinedErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: undefined },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validUndefinedErrors).toEqual({})

            const { errors: emptyStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: '' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(emptyStringErrors).toEqual({})

            const { errors: invalidJsonErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: 'not a json object' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(invalidJsonErrors).toEqual({
                json: ['Expected JSON, received: not a json object'],
            })

            const { errors: invalidTextErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: 'asd' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(invalidTextErrors).toEqual({
                json: ['Expected JSON, received: asd'],
            })
        })
        it('should validate required object property', async () => {
            const props = {
                object: Property.Object({
                    displayName: 'Object',
                    required: true,
                }),
            }

            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: { key: 'value' } },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(validErrors).toEqual({})

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(nullErrors).toEqual({
                object: ['Expected object, received: null'],
            })

            const { errors: typeErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: 'not an object' },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(typeErrors).toEqual({
                object: ['Expected object, received: not an object'],
            })

            const { errors: jsonStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: JSON.stringify({ key: 'value' }) },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(jsonStringErrors).toEqual({})

            const { errors: undefinedErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: { key: 'value' } },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(undefinedErrors).toEqual({})
        })
    })

    describe('optional properties', () => {
        it('should validate optional properties', async () => {
            const props = {
                text: Property.ShortText({
                    displayName: 'Text',
                    required: false,
                }),
                number: Property.Number({
                    displayName: 'Number',
                    required: false,
                }),
            }

            const { errors } = await propsProcessor.applyProcessorsAndValidators(
                {
                    text: null,
                    number: undefined,
                },
                props,
                PieceAuth.None(),
                false,
                {},
            )
            expect(errors).toEqual({})
        })

        it('should convert null to undefined for unset optional properties', async () => {
            const props = {
                staticDropdown: Property.StaticDropdown({
                    displayName: 'Static Dropdown',
                    required: false,
                    options: { options: [{ label: 'A', value: 'a' }] },
                }),
                dropdown: Property.Dropdown({
                    displayName: 'Dropdown',
                    required: false,
                    refreshers: [],
                    options: async () => ({ options: [{ label: 'A', value: 'a' }] }),
                }),
                text: Property.ShortText({
                    displayName: 'Text',
                    required: false,
                }),
            }

            const { processedInput, errors } = await propsProcessor.applyProcessorsAndValidators(
                { staticDropdown: null, dropdown: null, text: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(processedInput.staticDropdown).toBeUndefined()
            expect(processedInput.dropdown).toBeUndefined()
            expect(processedInput.text).toBeUndefined()
            expect(errors).toEqual({})
        })

        it('should keep selected values and null required properties unchanged', async () => {
            const props = {
                staticDropdown: Property.StaticDropdown({
                    displayName: 'Static Dropdown',
                    required: false,
                    options: { options: [{ label: 'A', value: 'a' }] },
                }),
                requiredDropdown: Property.StaticDropdown({
                    displayName: 'Required Dropdown',
                    required: true,
                    options: { options: [{ label: 'A', value: 'a' }] },
                }),
            }

            const { processedInput } = await propsProcessor.applyProcessorsAndValidators(
                { staticDropdown: 'a', requiredDropdown: null },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(processedInput.staticDropdown).toBe('a')
            expect(processedInput.requiredDropdown).toBeNull()
        })
    })

    describe('type validation', () => {
        it('should validate property types', async () => {
            const props = {
                string: Property.ShortText({
                    displayName: 'Text',
                    required: true,
                }),
                number: Property.Number({
                    displayName: 'Number',
                    required: true,
                }),
                boolean: Property.Checkbox({
                    displayName: 'Checkbox',
                    required: true,
                }),
                array: Property.Array({
                    displayName: 'Array',
                    required: true,
                }),
                object: Property.Object({
                    displayName: 'Object',
                    required: true,
                }),
            }

            const { errors } = await propsProcessor.applyProcessorsAndValidators(
                {
                    string: 42,
                    number: 'not a number',
                    boolean: 'not a boolean',
                    array: 'not an array',
                    object: 'not an object',
                },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(errors).toEqual({
                number: ['Expected number, received: not a number'],
                boolean: ['Expected boolean, received: not a boolean'],
                array: ['Expected array, received: not an array'],
                object: ['Expected object, received: not an object'],
            })
        })
    })

    describe('multi-select dropdown processing', () => {
        const props = {
            staticMultiSelect: Property.StaticMultiSelectDropdown({
                displayName: 'Static Multi Select',
                required: false,
                options: {
                    options: [
                        { label: 'Year', value: 'year' },
                        { label: 'Month', value: 'month' },
                    ],
                },
            }),
            multiSelect: Property.MultiSelectDropdown({
                displayName: 'Multi Select',
                required: false,
                refreshers: [],
                options: async () => ({ options: [] }),
            }),
            requiredMultiSelect: Property.StaticMultiSelectDropdown({
                displayName: 'Required Multi Select',
                required: true,
                options: {
                    options: [{ label: 'Year', value: 'year' }],
                },
            }),
        }

        it.each([
            ['a stringified array', '["year","month"]', ['year', 'month']],
            ['a stringified empty array', '[]', []],
            ['an array, unchanged', ['year'], ['year']],
            ['a single option value', 'year', ['year']],
            ['a value that is not JSON', 'a,b', ['a,b']],
            ['a quoted number, keeping it a string', '5', ['5']],
            ['a number', 5, [5]],
            ['a malformed array literal', '[year, month]', ['[year, month]']],
            ['an object', { not: 'an array' }, [{ not: 'an array' }]],
        ])('should coerce %s', async (_case, input, expected) => {
            const { processedInput, errors } = await propsProcessor.applyProcessorsAndValidators(
                { staticMultiSelect: input, multiSelect: input },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(processedInput.staticMultiSelect).toEqual(expected)
            expect(processedInput.multiSelect).toEqual(expected)
            expect(errors).toEqual({})
        })

        it('should map an empty dynamic value to undefined and let validation decide', async () => {
            const { processedInput, errors } = await propsProcessor.applyProcessorsAndValidators(
                { staticMultiSelect: '', requiredMultiSelect: '' },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(processedInput.staticMultiSelect).toBeUndefined()
            expect(processedInput.requiredMultiSelect).toBeUndefined()
            expect(errors).toEqual({
                requiredMultiSelect: ['Expected array, received: '],
            })
        })

        it('should map nil to undefined on optional props, leaving required-ness to validation', async () => {
            const { processedInput, errors } = await propsProcessor.applyProcessorsAndValidators(
                {
                    staticMultiSelect: null,
                    multiSelect: undefined,
                    requiredMultiSelect: null,
                },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(processedInput.staticMultiSelect).toBeUndefined()
            expect(processedInput.multiSelect).toBeUndefined()
            expect(errors).toEqual({
                requiredMultiSelect: ['Expected array, received: null'],
            })
        })
    })

    describe('checkbox processing', () => {
        const props = {
            checkbox: Property.Checkbox({
                displayName: 'Checkbox',
                required: true,
            }),
            optionalCheckbox: Property.Checkbox({
                displayName: 'Optional Checkbox',
                required: false,
            }),
        }

        it.each([
            ['true', true, {}],
            ['false', false, {}],
            [true, true, {}],
            [1, 1, { checkbox: ['Expected boolean, received: 1'] }],
        ])('should process %p', async (input, expected, expectedErrors) => {
            const { processedInput, errors } = await propsProcessor.applyProcessorsAndValidators(
                { checkbox: input },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(processedInput.checkbox).toEqual(expected)
            expect(errors).toEqual(expectedErrors)
        })

        it('should map an empty dynamic value to undefined and let validation decide', async () => {
            const { processedInput, errors } = await propsProcessor.applyProcessorsAndValidators(
                { checkbox: '', optionalCheckbox: '' },
                props,
                PieceAuth.None(),
                false,
                {},
            )

            expect(processedInput.checkbox).toBeUndefined()
            expect(processedInput.optionalCheckbox).toBeUndefined()
            expect(errors).toEqual({
                checkbox: ['Expected boolean, received: '],
            })
        })
    })
})