Merge pull request #15494 from Budibase/automation-tests-4

Refactor automation builder.
This commit is contained in:
Sam Rose 2025-02-06 16:04:04 +00:00 committed by GitHub
commit d72b40c857
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
25 changed files with 223 additions and 577 deletions

View File

@ -107,10 +107,7 @@ describe("/automations", () => {
}) })
it("Should ensure you can't have a branch as not a last step", async () => { it("Should ensure you can't have a branch as not a last step", async () => {
const automation = createAutomationBuilder({ const automation = createAutomationBuilder(config)
name: "String Equality Branching",
appId: config.getAppId(),
})
.appAction({ fields: { status: "active" } }) .appAction({ fields: { status: "active" } })
.branch({ .branch({
activeBranch: { activeBranch: {
@ -134,10 +131,7 @@ describe("/automations", () => {
}) })
it("Should check validation on an automation that has a branch step with no children", async () => { it("Should check validation on an automation that has a branch step with no children", async () => {
const automation = createAutomationBuilder({ const automation = createAutomationBuilder(config)
name: "String Equality Branching",
appId: config.getAppId(),
})
.appAction({ fields: { status: "active" } }) .appAction({ fields: { status: "active" } })
.branch({}) .branch({})
.serverLog({ text: "Inactive user" }) .serverLog({ text: "Inactive user" })
@ -153,10 +147,7 @@ describe("/automations", () => {
}) })
it("Should check validation on a branch step with empty conditions", async () => { it("Should check validation on a branch step with empty conditions", async () => {
const automation = createAutomationBuilder({ const automation = createAutomationBuilder(config)
name: "String Equality Branching",
appId: config.getAppId(),
})
.appAction({ fields: { status: "active" } }) .appAction({ fields: { status: "active" } })
.branch({ .branch({
activeBranch: { activeBranch: {
@ -177,10 +168,7 @@ describe("/automations", () => {
}) })
it("Should check validation on an branch that has a condition that is not valid", async () => { it("Should check validation on an branch that has a condition that is not valid", async () => {
const automation = createAutomationBuilder({ const automation = createAutomationBuilder(config)
name: "String Equality Branching",
appId: config.getAppId(),
})
.appAction({ fields: { status: "active" } }) .appAction({ fields: { status: "active" } })
.branch({ .branch({
activeBranch: { activeBranch: {
@ -252,12 +240,7 @@ describe("/automations", () => {
}) })
it("should be able to access platformUrl, logoUrl and company in the automation", async () => { it("should be able to access platformUrl, logoUrl and company in the automation", async () => {
const result = await createAutomationBuilder({ const result = await createAutomationBuilder(config)
name: "Test Automation",
appId: config.getAppId(),
config,
})
.appAction({ fields: {} })
.serverLog({ .serverLog({
text: "{{ settings.url }}", text: "{{ settings.url }}",
}) })

View File

@ -24,8 +24,7 @@ describe("Branching automations", () => {
const branch2LogId = "33333333-3333-3333-3333-333333333333" const branch2LogId = "33333333-3333-3333-3333-333333333333"
const branch2Id = "44444444-4444-4444-4444-444444444444" const branch2Id = "44444444-4444-4444-4444-444444444444"
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.serverLog( .serverLog(
{ text: "Starting automation" }, { text: "Starting automation" },
{ stepName: "FirstLog", stepId: firstLogId } { stepName: "FirstLog", stepId: firstLogId }
@ -83,7 +82,7 @@ describe("Branching automations", () => {
}) })
it("should execute correct branch based on string equality", async () => { it("should execute correct branch based on string equality", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "active" } }) .appAction({ fields: { status: "active" } })
.branch({ .branch({
activeBranch: { activeBranch: {
@ -108,7 +107,7 @@ describe("Branching automations", () => {
}) })
it("should handle multiple conditions with AND operator", async () => { it("should handle multiple conditions with AND operator", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "active", role: "admin" } }) .appAction({ fields: { status: "active", role: "admin" } })
.branch({ .branch({
activeAdminBranch: { activeAdminBranch: {
@ -136,7 +135,7 @@ describe("Branching automations", () => {
}) })
it("should handle multiple conditions with OR operator", async () => { it("should handle multiple conditions with OR operator", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "test", role: "user" } }) .appAction({ fields: { status: "test", role: "user" } })
.branch({ .branch({
specialBranch: { specialBranch: {
@ -168,7 +167,7 @@ describe("Branching automations", () => {
}) })
it("should stop the branch automation when no conditions are met", async () => { it("should stop the branch automation when no conditions are met", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "test", role: "user" } }) .appAction({ fields: { status: "test", role: "user" } })
.createRow({ row: { name: "Test", tableId: table._id } }) .createRow({ row: { name: "Test", tableId: table._id } })
.branch({ .branch({
@ -204,7 +203,7 @@ describe("Branching automations", () => {
}) })
it("evaluate multiple conditions", async () => { it("evaluate multiple conditions", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { test_trigger: true } }) .appAction({ fields: { test_trigger: true } })
.serverLog({ text: "Starting automation" }, { stepId: "aN6znRYHG" }) .serverLog({ text: "Starting automation" }, { stepId: "aN6znRYHG" })
.branch({ .branch({
@ -245,7 +244,7 @@ describe("Branching automations", () => {
}) })
it("evaluate multiple conditions with interpolated text", async () => { it("evaluate multiple conditions with interpolated text", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { test_trigger: true } }) .appAction({ fields: { test_trigger: true } })
.serverLog({ text: "Starting automation" }, { stepId: "aN6znRYHG" }) .serverLog({ text: "Starting automation" }, { stepId: "aN6znRYHG" })
.branch({ .branch({

View File

@ -29,7 +29,7 @@ describe("Automation Scenarios", () => {
it("should trigger an automation which then creates a row", async () => { it("should trigger an automation which then creates a row", async () => {
const table = await config.api.table.save(basicTable()) const table = await config.api.table.save(basicTable())
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.rowUpdated( .rowUpdated(
{ tableId: table._id! }, { tableId: table._id! },
{ {
@ -65,8 +65,7 @@ describe("Automation Scenarios", () => {
} }
await config.api.row.save(table._id!, row) await config.api.row.save(table._id!, row)
await config.api.row.save(table._id!, row) await config.api.row.save(table._id!, row)
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.queryRows({ .queryRows({
tableId: table._id!, tableId: table._id!,
}) })
@ -84,8 +83,7 @@ describe("Automation Scenarios", () => {
} }
await config.api.row.save(table._id!, row) await config.api.row.save(table._id!, row)
await config.api.row.save(table._id!, row) await config.api.row.save(table._id!, row)
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.queryRows({ .queryRows({
tableId: table._id!, tableId: table._id!,
}) })
@ -126,8 +124,7 @@ describe("Automation Scenarios", () => {
}, },
}) })
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.createRow( .createRow(
{ {
row: { row: {
@ -195,8 +192,7 @@ describe("Automation Scenarios", () => {
} }
await config.api.row.save(table._id!, row) await config.api.row.save(table._id!, row)
await config.api.row.save(table._id!, row) await config.api.row.save(table._id!, row)
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -245,8 +241,7 @@ describe("Automation Scenarios", () => {
}) })
it("should stop an automation if the condition is not met", async () => { it("should stop an automation if the condition is not met", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.createRow({ .createRow({
row: { row: {
name: "Equal Test", name: "Equal Test",
@ -271,8 +266,7 @@ describe("Automation Scenarios", () => {
}) })
it("should continue the automation if the condition is met", async () => { it("should continue the automation if the condition is met", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.createRow({ .createRow({
row: { row: {
name: "Not Equal Test", name: "Not Equal Test",
@ -338,8 +332,7 @@ describe("Automation Scenarios", () => {
it.each(testCases)( it.each(testCases)(
"should pass the filter when condition is $condition", "should pass the filter when condition is $condition",
async ({ condition, value, rowValue, expectPass }) => { async ({ condition, value, rowValue, expectPass }) => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.createRow({ .createRow({
row: { row: {
name: `${condition} Test`, name: `${condition} Test`,
@ -373,7 +366,7 @@ describe("Automation Scenarios", () => {
it("Check user is passed through from row trigger", async () => { it("Check user is passed through from row trigger", async () => {
const table = await config.api.table.save(basicTable()) const table = await config.api.table.save(basicTable())
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.rowUpdated( .rowUpdated(
{ tableId: table._id! }, { tableId: table._id! },
{ {
@ -388,8 +381,7 @@ describe("Automation Scenarios", () => {
}) })
it("Check user is passed through from app trigger", async () => { it("Check user is passed through from app trigger", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.serverLog({ text: "{{ [user].[email] }}" }) .serverLog({ text: "{{ [user].[email] }}" })
.run() .run()
@ -460,7 +452,7 @@ if (descriptions.length) {
queryVerb: "read", queryVerb: "read",
}) })
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ .appAction({
fields: {}, fields: {},
}) })

View File

@ -24,7 +24,7 @@ describe("Execute Bash Automations", () => {
}) })
it("should use trigger data in bash command and pass output to subsequent steps", async () => { it("should use trigger data in bash command and pass output to subsequent steps", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { command: "hello world" } }) .appAction({ fields: { command: "hello world" } })
.bash( .bash(
{ code: "echo '{{ trigger.fields.command }}'" }, { code: "echo '{{ trigger.fields.command }}'" },
@ -43,7 +43,7 @@ describe("Execute Bash Automations", () => {
}) })
it("should chain multiple bash commands using previous outputs", async () => { it("should chain multiple bash commands using previous outputs", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { filename: "testfile.txt" } }) .appAction({ fields: { filename: "testfile.txt" } })
.bash( .bash(
{ code: "echo 'initial content' > {{ trigger.fields.filename }}" }, { code: "echo 'initial content' > {{ trigger.fields.filename }}" },
@ -64,8 +64,7 @@ describe("Execute Bash Automations", () => {
}) })
it("should integrate bash output with row operations", async () => { it("should integrate bash output with row operations", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -94,7 +93,7 @@ describe("Execute Bash Automations", () => {
}) })
it("should handle bash output in conditional logic", async () => { it("should handle bash output in conditional logic", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { threshold: "5" } }) .appAction({ fields: { threshold: "5" } })
.bash( .bash(
{ code: "echo $(( {{ trigger.fields.threshold }} + 5 ))" }, { code: "echo $(( {{ trigger.fields.threshold }} + 5 ))" },
@ -121,8 +120,7 @@ describe("Execute Bash Automations", () => {
}) })
it("should handle null values gracefully", async () => { it("should handle null values gracefully", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.bash( .bash(
// @ts-expect-error - testing null input // @ts-expect-error - testing null input
{ code: null }, { code: null },

View File

@ -40,7 +40,7 @@ describe("test the create row action", () => {
}) })
it("should be able to run the action", async () => { it("should be able to run the action", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { status: "new" } }) .appAction({ fields: { status: "new" } })
.serverLog({ text: "Starting create row flow" }, { stepName: "StartLog" }) .serverLog({ text: "Starting create row flow" }, { stepName: "StartLog" })
.createRow({ row }, { stepName: "CreateRow" }) .createRow({ row }, { stepName: "CreateRow" })
@ -66,7 +66,7 @@ describe("test the create row action", () => {
}) })
it("should return an error (not throw) when bad info provided", async () => { it("should return an error (not throw) when bad info provided", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { status: "error" } }) .appAction({ fields: { status: "error" } })
.serverLog({ text: "Starting error test flow" }, { stepName: "StartLog" }) .serverLog({ text: "Starting error test flow" }, { stepName: "StartLog" })
.createRow( .createRow(
@ -84,7 +84,7 @@ describe("test the create row action", () => {
}) })
it("should check invalid inputs return an error", async () => { it("should check invalid inputs return an error", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { status: "invalid" } }) .appAction({ fields: { status: "invalid" } })
.serverLog({ text: "Testing invalid input" }, { stepName: "StartLog" }) .serverLog({ text: "Testing invalid input" }, { stepName: "StartLog" })
.createRow({ row: {} }, { stepName: "CreateRow" }) .createRow({ row: {} }, { stepName: "CreateRow" })
@ -122,7 +122,7 @@ describe("test the create row action", () => {
] ]
attachmentRow.file_attachment = attachmentObject attachmentRow.file_attachment = attachmentObject
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { type: "attachment" } }) .appAction({ fields: { type: "attachment" } })
.serverLog( .serverLog(
{ text: "Processing attachment upload" }, { text: "Processing attachment upload" },
@ -173,7 +173,7 @@ describe("test the create row action", () => {
} }
attachmentRow.single_file_attachment = attachmentObject attachmentRow.single_file_attachment = attachmentObject
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { type: "single-attachment" } }) .appAction({ fields: { type: "single-attachment" } })
.serverLog( .serverLog(
{ text: "Processing single attachment" }, { text: "Processing single attachment" },
@ -244,7 +244,7 @@ describe("test the create row action", () => {
} }
attachmentRow.single_file_attachment = attachmentObject attachmentRow.single_file_attachment = attachmentObject
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: { type: "invalid-attachment" } }) .appAction({ fields: { type: "invalid-attachment" } })
.serverLog( .serverLog(
{ text: "Testing invalid attachment keys" }, { text: "Testing invalid attachment keys" },

View File

@ -27,7 +27,7 @@ describe("cron automations", () => {
}) })
it("should initialise the automation timestamp", async () => { it("should initialise the automation timestamp", async () => {
await createAutomationBuilder({ config }).cron({ cron: "* * * * *" }).save() await createAutomationBuilder(config).cron({ cron: "* * * * *" }).save()
tk.travel(Date.now() + oneMinuteInMs) tk.travel(Date.now() + oneMinuteInMs)
await config.publish() await config.publish()

View File

@ -16,10 +16,7 @@ describe("test the delay logic", () => {
const time = 100 const time = 100
const before = performance.now() const before = performance.now()
await createAutomationBuilder({ config }) await createAutomationBuilder(config).delay({ time }).run()
.appAction({ fields: {} })
.delay({ time })
.run()
const now = performance.now() const now = performance.now()

View File

@ -20,8 +20,7 @@ describe("test the delete row action", () => {
}) })
it("should be able to run the delete row action", async () => { it("should be able to run the delete row action", async () => {
await createAutomationBuilder({ config }) await createAutomationBuilder(config)
.appAction({ fields: {} })
.deleteRow({ .deleteRow({
tableId: table._id!, tableId: table._id!,
id: row._id!, id: row._id!,
@ -35,8 +34,7 @@ describe("test the delete row action", () => {
}) })
it("should check invalid inputs return an error", async () => { it("should check invalid inputs return an error", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.deleteRow({ tableId: "", id: "", revision: "" }) .deleteRow({ tableId: "", id: "", revision: "" })
.run() .run()
@ -44,8 +42,7 @@ describe("test the delete row action", () => {
}) })
it("should return an error when table doesn't exist", async () => { it("should return an error when table doesn't exist", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.deleteRow({ .deleteRow({
tableId: "invalid", tableId: "invalid",
id: "invalid", id: "invalid",

View File

@ -19,8 +19,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action", async () => { it("should be able to run the action", async () => {
nock("http://www.example.com/").post("/").reply(200, { foo: "bar" }) nock("http://www.example.com/").post("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.discord({ .discord({
url: "http://www.example.com", url: "http://www.example.com",
username: "joe_bloggs", username: "joe_bloggs",

View File

@ -20,8 +20,7 @@ describe("Execute Script Automations", () => {
}) })
it("should execute a basic script and return the result", async () => { it("should execute a basic script and return the result", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.executeScript({ code: "return 2 + 2" }) .executeScript({ code: "return 2 + 2" })
.run() .run()
@ -29,7 +28,7 @@ describe("Execute Script Automations", () => {
}) })
it("should access bindings from previous steps", async () => { it("should access bindings from previous steps", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { data: [1, 2, 3] } }) .appAction({ fields: { data: [1, 2, 3] } })
.executeScript( .executeScript(
{ {
@ -43,8 +42,7 @@ describe("Execute Script Automations", () => {
}) })
it("should handle script execution errors gracefully", async () => { it("should handle script execution errors gracefully", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.executeScript({ code: "return nonexistentVariable.map(x => x)" }) .executeScript({ code: "return nonexistentVariable.map(x => x)" })
.run() .run()
@ -55,7 +53,7 @@ describe("Execute Script Automations", () => {
}) })
it("should handle conditional logic in scripts", async () => { it("should handle conditional logic in scripts", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: { value: 10 } }) .appAction({ fields: { value: 10 } })
.executeScript({ .executeScript({
code: ` code: `
@ -72,7 +70,7 @@ describe("Execute Script Automations", () => {
}) })
it("should use multiple steps and validate script execution", async () => { it("should use multiple steps and validate script execution", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} }) .appAction({ fields: {} })
.serverLog( .serverLog(
{ text: "Starting multi-step automation" }, { text: "Starting multi-step automation" },

View File

@ -42,8 +42,7 @@ describe("test the filter logic", () => {
[new Date().toISOString(), ">", new Date(-10000).toISOString()], [new Date().toISOString(), ">", new Date(-10000).toISOString()],
] ]
it.each(pass)("should pass %p %p %p", async (field, condition, value) => { it.each(pass)("should pass %p %p %p", async (field, condition, value) => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.filter({ field, condition: stringToFilterCondition(condition), value }) .filter({ field, condition: stringToFilterCondition(condition), value })
.run() .run()
@ -60,8 +59,7 @@ describe("test the filter logic", () => {
[{}, "==", {}], [{}, "==", {}],
] ]
it.each(fail)("should fail %p %p %p", async (field, condition, value) => { it.each(fail)("should fail %p %p %p", async (field, condition, value) => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.filter({ field, condition: stringToFilterCondition(condition), value }) .filter({ field, condition: stringToFilterCondition(condition), value })
.run() .run()

View File

@ -72,7 +72,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("should run an automation with a trigger, loop, and create row step", async () => { it("should run an automation with a trigger, loop, and create row step", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.rowSaved( .rowSaved(
{ tableId: table._id! }, { tableId: table._id! },
{ {
@ -115,7 +115,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("should run an automation where a loop step is between two normal steps to ensure context correctness", async () => { it("should run an automation where a loop step is between two normal steps to ensure context correctness", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.rowSaved( .rowSaved(
{ tableId: table._id! }, { tableId: table._id! },
{ {
@ -151,8 +151,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("if an incorrect type is passed to the loop it should return an error", async () => { it("if an incorrect type is passed to the loop it should return an error", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.loop({ .loop({
option: LoopStepType.ARRAY, option: LoopStepType.ARRAY,
binding: "1, 2, 3", binding: "1, 2, 3",
@ -167,8 +166,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("ensure the loop stops if the failure condition is reached", async () => { it("ensure the loop stops if the failure condition is reached", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.loop({ .loop({
option: LoopStepType.ARRAY, option: LoopStepType.ARRAY,
binding: ["test", "test2", "test3"], binding: ["test", "test2", "test3"],
@ -186,8 +184,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("ensure the loop stops if the max iterations are reached", async () => { it("ensure the loop stops if the max iterations are reached", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.loop({ .loop({
option: LoopStepType.ARRAY, option: LoopStepType.ARRAY,
binding: ["test", "test2", "test3"], binding: ["test", "test2", "test3"],
@ -201,8 +198,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("should run an automation with loop and max iterations to ensure context correctness further down the tree", async () => { it("should run an automation with loop and max iterations to ensure context correctness further down the tree", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.loop({ .loop({
option: LoopStepType.ARRAY, option: LoopStepType.ARRAY,
binding: ["test", "test2", "test3"], binding: ["test", "test2", "test3"],
@ -216,7 +212,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("should run an automation where a loop is successfully run twice", async () => { it("should run an automation where a loop is successfully run twice", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.rowSaved( .rowSaved(
{ tableId: table._id! }, { tableId: table._id! },
{ {
@ -278,8 +274,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("should run an automation where a loop is used twice to ensure context correctness further down the tree", async () => { it("should run an automation where a loop is used twice to ensure context correctness further down the tree", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.loop({ .loop({
option: LoopStepType.ARRAY, option: LoopStepType.ARRAY,
binding: [1, 2, 3], binding: [1, 2, 3],
@ -300,8 +295,7 @@ describe("Attempt to run a basic loop automation", () => {
}) })
it("should use automation names to loop with", async () => { it("should use automation names to loop with", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.loop( .loop(
{ {
option: LoopStepType.ARRAY, option: LoopStepType.ARRAY,
@ -352,8 +346,7 @@ describe("Attempt to run a basic loop automation", () => {
await config.api.row.bulkImport(table._id!, { rows }) await config.api.row.bulkImport(table._id!, { rows })
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.queryRows({ .queryRows({
tableId: table._id!, tableId: table._id!,
}) })
@ -432,8 +425,7 @@ describe("Attempt to run a basic loop automation", () => {
await config.api.row.bulkImport(table._id!, { rows }) await config.api.row.bulkImport(table._id!, { rows })
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -515,8 +507,7 @@ describe("Attempt to run a basic loop automation", () => {
await config.api.row.bulkImport(table._id!, { rows }) await config.api.row.bulkImport(table._id!, { rows })
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.queryRows({ .queryRows({
tableId: table._id!, tableId: table._id!,
}) })

View File

@ -19,8 +19,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action", async () => { it("should be able to run the action", async () => {
nock("http://www.example.com/").post("/").reply(200, { foo: "bar" }) nock("http://www.example.com/").post("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.make({ .make({
url: "http://www.example.com", url: "http://www.example.com",
body: null, body: null,
@ -46,8 +45,7 @@ describe("test the outgoing webhook action", () => {
.post("/", payload) .post("/", payload)
.reply(200, { foo: "bar" }) .reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.make({ .make({
body: { value: JSON.stringify(payload) }, body: { value: JSON.stringify(payload) },
url: "http://www.example.com", url: "http://www.example.com",
@ -59,8 +57,7 @@ describe("test the outgoing webhook action", () => {
}) })
it("should return a 400 if the JSON payload string is malformed", async () => { it("should return a 400 if the JSON payload string is malformed", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.make({ .make({
body: { value: "{ invalid json }" }, body: { value: "{ invalid json }" },
url: "http://www.example.com", url: "http://www.example.com",

View File

@ -20,8 +20,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action and default to 'get'", async () => { it("should be able to run the action and default to 'get'", async () => {
nock("http://www.example.com/").get("/").reply(200, { foo: "bar" }) nock("http://www.example.com/").get("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.n8n({ .n8n({
url: "http://www.example.com", url: "http://www.example.com",
body: { test: "IGNORE_ME" }, body: { test: "IGNORE_ME" },
@ -39,8 +38,7 @@ describe("test the outgoing webhook action", () => {
.post("/", { name: "Adam", age: 9 }) .post("/", { name: "Adam", age: 9 })
.reply(200) .reply(200)
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.n8n({ .n8n({
url: "http://www.example.com", url: "http://www.example.com",
body: { value: JSON.stringify({ name: "Adam", age: 9 }) }, body: { value: JSON.stringify({ name: "Adam", age: 9 }) },
@ -53,8 +51,7 @@ describe("test the outgoing webhook action", () => {
}) })
it("should return a 400 if the JSON payload string is malformed", async () => { it("should return a 400 if the JSON payload string is malformed", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.n8n({ .n8n({
url: "http://www.example.com", url: "http://www.example.com",
body: { value: "{ value1 1 }" }, body: { value: "{ value1 1 }" },
@ -73,8 +70,7 @@ describe("test the outgoing webhook action", () => {
.head("/", body => body === "") .head("/", body => body === "")
.reply(200) .reply(200)
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.n8n({ .n8n({
url: "http://www.example.com", url: "http://www.example.com",
method: HttpMethod.HEAD, method: HttpMethod.HEAD,

View File

@ -57,8 +57,7 @@ describe("test the openai action", () => {
// means it goes through the "legacy" path which requires you to set your // means it goes through the "legacy" path which requires you to set your
// own API key. We don't count this against your quota. // own API key. We don't count this against your quota.
const result = await expectAIUsage(0, () => const result = await expectAIUsage(0, () =>
createAutomationBuilder({ config }) createAutomationBuilder(config)
.appAction({ fields: {} })
.openai({ prompt: "Hello, world", model: Model.GPT_4O_MINI }) .openai({ prompt: "Hello, world", model: Model.GPT_4O_MINI })
.run() .run()
) )
@ -69,8 +68,7 @@ describe("test the openai action", () => {
it("should present the correct error message when a prompt is not provided", async () => { it("should present the correct error message when a prompt is not provided", async () => {
const result = await expectAIUsage(0, () => const result = await expectAIUsage(0, () =>
createAutomationBuilder({ config }) createAutomationBuilder(config)
.appAction({ fields: {} })
.openai({ prompt: "", model: Model.GPT_4O_MINI }) .openai({ prompt: "", model: Model.GPT_4O_MINI })
.run() .run()
) )
@ -85,8 +83,7 @@ describe("test the openai action", () => {
mockChatGPTError() mockChatGPTError()
const result = await expectAIUsage(0, () => const result = await expectAIUsage(0, () =>
createAutomationBuilder({ config }) createAutomationBuilder(config)
.appAction({ fields: {} })
.openai({ prompt: "Hello, world", model: Model.GPT_4O_MINI }) .openai({ prompt: "Hello, world", model: Model.GPT_4O_MINI })
.run() .run()
) )
@ -108,8 +105,7 @@ describe("test the openai action", () => {
// calculation we use to approximate cost. This uses Budibase's OpenAI API // calculation we use to approximate cost. This uses Budibase's OpenAI API
// key, so we charge users for it. // key, so we charge users for it.
const result = await expectAIUsage(14, () => const result = await expectAIUsage(14, () =>
createAutomationBuilder({ config }) createAutomationBuilder(config)
.appAction({ fields: {} })
.openai({ model: Model.GPT_4O_MINI, prompt: "Hello, world" }) .openai({ model: Model.GPT_4O_MINI, prompt: "Hello, world" })
.run() .run()
) )

View File

@ -23,8 +23,7 @@ describe("test the outgoing webhook action", () => {
.post("/", { a: 1 }) .post("/", { a: 1 })
.reply(200, { foo: "bar" }) .reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.outgoingWebhook({ .outgoingWebhook({
requestMethod: RequestType.POST, requestMethod: RequestType.POST,
url: "http://www.example.com", url: "http://www.example.com",
@ -39,8 +38,7 @@ describe("test the outgoing webhook action", () => {
}) })
it("should return an error if something goes wrong in fetch", async () => { it("should return an error if something goes wrong in fetch", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.outgoingWebhook({ .outgoingWebhook({
requestMethod: RequestType.GET, requestMethod: RequestType.GET,
url: "www.invalid.com", url: "www.invalid.com",

View File

@ -28,11 +28,7 @@ describe("Test a query step automation", () => {
}) })
it("should be able to run the query step", async () => { it("should be able to run the query step", async () => {
const result = await createAutomationBuilder({ const result = await createAutomationBuilder(config)
name: "Basic Query Test",
config,
})
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -56,11 +52,7 @@ describe("Test a query step automation", () => {
}) })
it("Returns all rows when onEmptyFilter has no value and no filters are passed", async () => { it("Returns all rows when onEmptyFilter has no value and no filters are passed", async () => {
const result = await createAutomationBuilder({ const result = await createAutomationBuilder(config)
name: "Empty Filter Test",
config,
})
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -80,11 +72,7 @@ describe("Test a query step automation", () => {
}) })
it("Returns no rows when onEmptyFilter is RETURN_NONE and theres no filters", async () => { it("Returns no rows when onEmptyFilter is RETURN_NONE and theres no filters", async () => {
const result = await createAutomationBuilder({ const result = await createAutomationBuilder(config)
name: "Return None Test",
config,
})
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -105,11 +93,7 @@ describe("Test a query step automation", () => {
}) })
it("Returns no rows when onEmptyFilters RETURN_NONE and a filter is passed with a null value", async () => { it("Returns no rows when onEmptyFilters RETURN_NONE and a filter is passed with a null value", async () => {
const result = await createAutomationBuilder({ const result = await createAutomationBuilder(config)
name: "Null Filter Test",
config,
})
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -134,11 +118,7 @@ describe("Test a query step automation", () => {
}) })
it("Returns rows when onEmptyFilter is RETURN_ALL and no filter is passed", async () => { it("Returns rows when onEmptyFilter is RETURN_ALL and no filter is passed", async () => {
const result = await createAutomationBuilder({ const result = await createAutomationBuilder(config)
name: "Return All Test",
config,
})
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: table._id!, tableId: table._id!,
@ -165,11 +145,7 @@ describe("Test a query step automation", () => {
await config.api.row.save(tableWithSpaces._id!, { await config.api.row.save(tableWithSpaces._id!, {
name: NAME, name: NAME,
}) })
const result = await createAutomationBuilder({ const result = await createAutomationBuilder(config)
name: "Return All Test",
config,
})
.appAction({ fields: {} })
.queryRows( .queryRows(
{ {
tableId: tableWithSpaces._id!, tableId: tableWithSpaces._id!,

View File

@ -13,8 +13,7 @@ describe("test the server log action", () => {
}) })
it("should be able to log the text", async () => { it("should be able to log the text", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.serverLog({ text: "Hello World" }) .serverLog({ text: "Hello World" })
.run() .run()
expect(result.steps[0].outputs.message).toEqual( expect(result.steps[0].outputs.message).toEqual(

View File

@ -17,13 +17,11 @@ describe("Test triggering an automation from another automation", () => {
}) })
it("should trigger an other server log automation", async () => { it("should trigger an other server log automation", async () => {
const automation = await createAutomationBuilder({ config }) const automation = await createAutomationBuilder(config)
.appAction({ fields: {} })
.serverLog({ text: "Hello World" }) .serverLog({ text: "Hello World" })
.save() .save()
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.triggerAutomationRun({ .triggerAutomationRun({
automation: { automation: {
automationId: automation._id!, automationId: automation._id!,
@ -36,8 +34,7 @@ describe("Test triggering an automation from another automation", () => {
}) })
it("should fail gracefully if the automation id is incorrect", async () => { it("should fail gracefully if the automation id is incorrect", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.triggerAutomationRun({ .triggerAutomationRun({
automation: { automation: {
// @ts-expect-error - incorrect on purpose // @ts-expect-error - incorrect on purpose

View File

@ -30,8 +30,7 @@ describe("test the update row action", () => {
}) })
it("should be able to run the update row action", async () => { it("should be able to run the update row action", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.updateRow({ .updateRow({
rowId: row._id!, rowId: row._id!,
row: { row: {
@ -53,8 +52,7 @@ describe("test the update row action", () => {
}) })
it("should check invalid inputs return an error", async () => { it("should check invalid inputs return an error", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.updateRow({ meta: {}, row: {}, rowId: "" }) .updateRow({ meta: {}, row: {}, rowId: "" })
.run() .run()
@ -62,8 +60,7 @@ describe("test the update row action", () => {
}) })
it("should return an error when table doesn't exist", async () => { it("should return an error when table doesn't exist", async () => {
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.updateRow({ .updateRow({
row: { _id: "invalid" }, row: { _id: "invalid" },
rowId: "invalid", rowId: "invalid",
@ -106,8 +103,7 @@ describe("test the update row action", () => {
user2: [{ _id: user2._id }], user2: [{ _id: user2._id }],
}) })
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.updateRow({ .updateRow({
rowId: row._id!, rowId: row._id!,
row: { row: {
@ -160,8 +156,7 @@ describe("test the update row action", () => {
user2: [{ _id: user2._id }], user2: [{ _id: user2._id }],
}) })
const results = await createAutomationBuilder({ config }) const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.updateRow({ .updateRow({
rowId: row._id!, rowId: row._id!,
row: { row: {

View File

@ -20,8 +20,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action", async () => { it("should be able to run the action", async () => {
nock("http://www.example.com/").post("/").reply(200, { foo: "bar" }) nock("http://www.example.com/").post("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.zapier({ url: "http://www.example.com", body: null }) .zapier({ url: "http://www.example.com", body: null })
.run() .run()
@ -44,8 +43,7 @@ describe("test the outgoing webhook action", () => {
.post("/", { ...payload, platform: "budibase" }) .post("/", { ...payload, platform: "budibase" })
.reply(200, { foo: "bar" }) .reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.zapier({ .zapier({
url: "http://www.example.com", url: "http://www.example.com",
body: { value: JSON.stringify(payload) }, body: { value: JSON.stringify(payload) },
@ -57,8 +55,7 @@ describe("test the outgoing webhook action", () => {
}) })
it("should return a 400 if the JSON payload string is malformed", async () => { it("should return a 400 if the JSON payload string is malformed", async () => {
const result = await createAutomationBuilder({ config }) const result = await createAutomationBuilder(config)
.appAction({ fields: {} })
.zapier({ .zapier({
url: "http://www.example.com", url: "http://www.example.com",
body: { value: "{ invalid json }" }, body: { value: "{ invalid json }" },

View File

@ -6,7 +6,7 @@ import { Job } from "bull"
describe("cron trigger", () => { describe("cron trigger", () => {
const config = new TestConfiguration() const config = new TestConfiguration()
beforeEach(async () => { beforeAll(async () => {
await config.init() await config.init()
}) })
@ -24,7 +24,7 @@ describe("cron trigger", () => {
}) })
}) })
await createAutomationBuilder({ config }) await createAutomationBuilder(config)
.cron({ cron: "* * * * *" }) .cron({ cron: "* * * * *" })
.serverLog({ .serverLog({
text: "Hello, world!", text: "Hello, world!",
@ -44,7 +44,7 @@ describe("cron trigger", () => {
}) })
it("should fail if the cron expression is invalid", async () => { it("should fail if the cron expression is invalid", async () => {
await createAutomationBuilder({ config }) await createAutomationBuilder(config)
.cron({ cron: "* * * * * *" }) .cron({ cron: "* * * * * *" })
.serverLog({ .serverLog({
text: "Hello, world!", text: "Hello, world!",

View File

@ -1,4 +1,3 @@
import * as automation from "../../index"
import { Table, Webhook, WebhookActionType } from "@budibase/types" import { Table, Webhook, WebhookActionType } from "@budibase/types"
import { createAutomationBuilder } from "../utilities/AutomationTestBuilder" import { createAutomationBuilder } from "../utilities/AutomationTestBuilder"
import { mocks } from "@budibase/backend-core/tests" import { mocks } from "@budibase/backend-core/tests"
@ -12,7 +11,7 @@ describe("Branching automations", () => {
let webhook: Webhook let webhook: Webhook
async function createWebhookAutomation() { async function createWebhookAutomation() {
const automation = await createAutomationBuilder({ config }) const automation = await createAutomationBuilder(config)
.webhook({ fields: { parameter: "string" } }) .webhook({ fields: { parameter: "string" } })
.createRow({ .createRow({
row: { tableId: table._id!, name: "{{ trigger.parameter }}" }, row: { tableId: table._id!, name: "{{ trigger.parameter }}" },
@ -37,7 +36,6 @@ describe("Branching automations", () => {
} }
beforeEach(async () => { beforeEach(async () => {
await automation.init()
await config.init() await config.init()
table = await config.createTable() table = await config.createTable()
}) })

View File

@ -2,51 +2,24 @@ import { v4 as uuidv4 } from "uuid"
import { BUILTIN_ACTION_DEFINITIONS } from "../../actions" import { BUILTIN_ACTION_DEFINITIONS } from "../../actions"
import { TRIGGER_DEFINITIONS } from "../../triggers" import { TRIGGER_DEFINITIONS } from "../../triggers"
import { import {
AppActionTriggerInputs,
AppActionTriggerOutputs, AppActionTriggerOutputs,
Automation, Automation,
AutomationActionStepId, AutomationActionStepId,
AutomationStep, AutomationStep,
AutomationStepInputs, AutomationStepInputs,
AutomationTrigger, AutomationTrigger,
AutomationTriggerDefinition,
AutomationTriggerInputs, AutomationTriggerInputs,
AutomationTriggerOutputs,
AutomationTriggerStepId, AutomationTriggerStepId,
BashStepInputs,
Branch,
BranchStepInputs, BranchStepInputs,
CollectStepInputs,
CreateRowStepInputs,
CronTriggerInputs,
CronTriggerOutputs, CronTriggerOutputs,
DelayStepInputs,
DeleteRowStepInputs,
DiscordStepInputs,
ExecuteQueryStepInputs,
ExecuteScriptStepInputs,
FilterStepInputs,
isDidNotTriggerResponse, isDidNotTriggerResponse,
LoopStepInputs,
MakeIntegrationInputs,
n8nStepInputs,
OpenAIStepInputs,
OutgoingWebhookStepInputs,
QueryRowsStepInputs,
RowCreatedTriggerInputs,
RowCreatedTriggerOutputs, RowCreatedTriggerOutputs,
RowDeletedTriggerInputs,
RowDeletedTriggerOutputs, RowDeletedTriggerOutputs,
RowUpdatedTriggerInputs,
RowUpdatedTriggerOutputs, RowUpdatedTriggerOutputs,
SearchFilters, SearchFilters,
ServerLogStepInputs,
SmtpEmailStepInputs,
TestAutomationRequest, TestAutomationRequest,
TriggerAutomationStepInputs,
UpdateRowStepInputs,
WebhookTriggerInputs,
WebhookTriggerOutputs, WebhookTriggerOutputs,
ZapierStepInputs,
} from "@budibase/types" } from "@budibase/types"
import TestConfiguration from "../../../tests/utilities/TestConfiguration" import TestConfiguration from "../../../tests/utilities/TestConfiguration"
import * as setup from "../utilities" import * as setup from "../utilities"
@ -74,28 +47,53 @@ class BaseStepBuilder {
protected steps: AutomationStep[] = [] protected steps: AutomationStep[] = []
protected stepNames: { [key: string]: string } = {} protected stepNames: { [key: string]: string } = {}
protected step<TStep extends AutomationActionStepId>( protected createStepFn<TStep extends AutomationActionStepId>(stepId: TStep) {
stepId: TStep, return (
stepSchema: Omit<AutomationStep, "id" | "stepId" | "inputs">,
inputs: AutomationStepInputs<TStep>, inputs: AutomationStepInputs<TStep>,
opts?: { stepName?: string; stepId?: string } opts?: { stepName?: string; stepId?: string }
): this { ) => {
const schema = BUILTIN_ACTION_DEFINITIONS[stepId]
const id = opts?.stepId || uuidv4() const id = opts?.stepId || uuidv4()
this.steps.push({ this.steps.push({
...stepSchema, ...schema,
inputs: inputs as any, inputs: inputs as any,
id, id,
stepId, stepId,
name: opts?.stepName || stepSchema.name, name: opts?.stepName || schema.name,
}) })
if (opts?.stepName) { if (opts?.stepName) {
this.stepNames[id] = opts.stepName this.stepNames[id] = opts.stepName
} }
return this return this
} }
}
createRow = this.createStepFn(AutomationActionStepId.CREATE_ROW)
updateRow = this.createStepFn(AutomationActionStepId.UPDATE_ROW)
deleteRow = this.createStepFn(AutomationActionStepId.DELETE_ROW)
sendSmtpEmail = this.createStepFn(AutomationActionStepId.SEND_EMAIL_SMTP)
executeQuery = this.createStepFn(AutomationActionStepId.EXECUTE_QUERY)
queryRows = this.createStepFn(AutomationActionStepId.QUERY_ROWS)
loop = this.createStepFn(AutomationActionStepId.LOOP)
serverLog = this.createStepFn(AutomationActionStepId.SERVER_LOG)
executeScript = this.createStepFn(AutomationActionStepId.EXECUTE_SCRIPT)
filter = this.createStepFn(AutomationActionStepId.FILTER)
bash = this.createStepFn(AutomationActionStepId.EXECUTE_BASH)
openai = this.createStepFn(AutomationActionStepId.OPENAI)
collect = this.createStepFn(AutomationActionStepId.COLLECT)
zapier = this.createStepFn(AutomationActionStepId.zapier)
triggerAutomationRun = this.createStepFn(
AutomationActionStepId.TRIGGER_AUTOMATION_RUN
)
outgoingWebhook = this.createStepFn(AutomationActionStepId.OUTGOING_WEBHOOK)
n8n = this.createStepFn(AutomationActionStepId.n8n)
make = this.createStepFn(AutomationActionStepId.integromat)
discord = this.createStepFn(AutomationActionStepId.discord)
delay = this.createStepFn(AutomationActionStepId.DELAY)
protected addBranchStep(branchConfig: BranchConfig): void { protected addBranchStep(branchConfig: BranchConfig): void {
const branchStepInputs: BranchStepInputs = { const branchStepInputs: BranchStepInputs = {
branches: [] as Branch[], branches: [],
children: {}, children: {},
} }
@ -118,243 +116,6 @@ class BaseStepBuilder {
} }
this.steps.push(branchStep) this.steps.push(branchStep)
} }
// STEPS
createRow(
inputs: CreateRowStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.CREATE_ROW,
BUILTIN_ACTION_DEFINITIONS.CREATE_ROW,
inputs,
opts
)
}
updateRow(
inputs: UpdateRowStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.UPDATE_ROW,
BUILTIN_ACTION_DEFINITIONS.UPDATE_ROW,
inputs,
opts
)
}
deleteRow(
inputs: DeleteRowStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.DELETE_ROW,
BUILTIN_ACTION_DEFINITIONS.DELETE_ROW,
inputs,
opts
)
}
sendSmtpEmail(
inputs: SmtpEmailStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.SEND_EMAIL_SMTP,
BUILTIN_ACTION_DEFINITIONS.SEND_EMAIL_SMTP,
inputs,
opts
)
}
executeQuery(
inputs: ExecuteQueryStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.EXECUTE_QUERY,
BUILTIN_ACTION_DEFINITIONS.EXECUTE_QUERY,
inputs,
opts
)
}
queryRows(
inputs: QueryRowsStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.QUERY_ROWS,
BUILTIN_ACTION_DEFINITIONS.QUERY_ROWS,
inputs,
opts
)
}
loop(
inputs: LoopStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.LOOP,
BUILTIN_ACTION_DEFINITIONS.LOOP,
inputs,
opts
)
}
serverLog(
input: ServerLogStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.SERVER_LOG,
BUILTIN_ACTION_DEFINITIONS.SERVER_LOG,
input,
opts
)
}
executeScript(
input: ExecuteScriptStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.EXECUTE_SCRIPT,
BUILTIN_ACTION_DEFINITIONS.EXECUTE_SCRIPT,
input,
opts
)
}
filter(input: FilterStepInputs): this {
return this.step(
AutomationActionStepId.FILTER,
BUILTIN_ACTION_DEFINITIONS.FILTER,
input
)
}
bash(
input: BashStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.EXECUTE_BASH,
BUILTIN_ACTION_DEFINITIONS.EXECUTE_BASH,
input,
opts
)
}
openai(
input: OpenAIStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.OPENAI,
BUILTIN_ACTION_DEFINITIONS.OPENAI,
input,
opts
)
}
collect(
input: CollectStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.COLLECT,
BUILTIN_ACTION_DEFINITIONS.COLLECT,
input,
opts
)
}
zapier(
input: ZapierStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.zapier,
BUILTIN_ACTION_DEFINITIONS.zapier,
input,
opts
)
}
triggerAutomationRun(
input: TriggerAutomationStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.TRIGGER_AUTOMATION_RUN,
BUILTIN_ACTION_DEFINITIONS.TRIGGER_AUTOMATION_RUN,
input,
opts
)
}
outgoingWebhook(
input: OutgoingWebhookStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.OUTGOING_WEBHOOK,
BUILTIN_ACTION_DEFINITIONS.OUTGOING_WEBHOOK,
input,
opts
)
}
n8n(
input: n8nStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.n8n,
BUILTIN_ACTION_DEFINITIONS.n8n,
input,
opts
)
}
make(
input: MakeIntegrationInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.integromat,
BUILTIN_ACTION_DEFINITIONS.integromat,
input,
opts
)
}
discord(
input: DiscordStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.discord,
BUILTIN_ACTION_DEFINITIONS.discord,
input,
opts
)
}
delay(
input: DelayStepInputs,
opts?: { stepName?: string; stepId?: string }
): this {
return this.step(
AutomationActionStepId.DELAY,
BUILTIN_ACTION_DEFINITIONS.DELAY,
input,
opts
)
}
} }
class StepBuilder extends BaseStepBuilder { class StepBuilder extends BaseStepBuilder {
@ -374,110 +135,78 @@ class AutomationBuilder extends BaseStepBuilder {
private triggerOutputs: TriggerOutputs private triggerOutputs: TriggerOutputs
private triggerSet = false private triggerSet = false
constructor( constructor(config?: TestConfiguration) {
options: { name?: string; appId?: string; config?: TestConfiguration } = {}
) {
super() super()
this.config = options.config || setup.getConfig() this.config = config || setup.getConfig()
this.triggerOutputs = { fields: {} }
this.automationConfig = { this.automationConfig = {
name: options.name || `Test Automation ${uuidv4()}`, name: `Test Automation ${uuidv4()}`,
definition: { definition: {
steps: [], steps: [],
trigger: {} as AutomationTrigger, trigger: {
...TRIGGER_DEFINITIONS[AutomationTriggerStepId.APP],
stepId: AutomationTriggerStepId.APP,
inputs: this.triggerOutputs,
id: uuidv4(),
},
stepNames: {}, stepNames: {},
}, },
type: "automation", type: "automation",
appId: options.appId ?? this.config.getAppId(), appId: this.config.getAppId(),
} }
} }
// TRIGGERS name(n: string): this {
rowSaved(inputs: RowCreatedTriggerInputs, outputs: RowCreatedTriggerOutputs) { this.automationConfig.name = n
this.triggerOutputs = outputs return this
return this.trigger(
TRIGGER_DEFINITIONS.ROW_SAVED,
AutomationTriggerStepId.ROW_SAVED,
inputs,
outputs
)
} }
rowUpdated( protected triggerInputOutput<
inputs: RowUpdatedTriggerInputs, TStep extends AutomationTriggerStepId,
outputs: RowUpdatedTriggerOutputs TInput = AutomationTriggerInputs<TStep>,
) { TOutput = AutomationTriggerOutputs<TStep>
this.triggerOutputs = outputs >(stepId: TStep) {
return this.trigger( return (inputs: TInput, outputs?: TOutput) => {
TRIGGER_DEFINITIONS.ROW_UPDATED,
AutomationTriggerStepId.ROW_UPDATED,
inputs,
outputs
)
}
rowDeleted(
inputs: RowDeletedTriggerInputs,
outputs: RowDeletedTriggerOutputs
) {
this.triggerOutputs = outputs
return this.trigger(
TRIGGER_DEFINITIONS.ROW_DELETED,
AutomationTriggerStepId.ROW_DELETED,
inputs,
outputs
)
}
appAction(outputs: AppActionTriggerOutputs, inputs?: AppActionTriggerInputs) {
this.triggerOutputs = outputs
return this.trigger(
TRIGGER_DEFINITIONS.APP,
AutomationTriggerStepId.APP,
inputs,
outputs
)
}
webhook(outputs: WebhookTriggerOutputs, inputs?: WebhookTriggerInputs) {
this.triggerOutputs = outputs
return this.trigger(
TRIGGER_DEFINITIONS.WEBHOOK,
AutomationTriggerStepId.WEBHOOK,
inputs,
outputs
)
}
cron(inputs: CronTriggerInputs, outputs?: CronTriggerOutputs) {
this.triggerOutputs = outputs
return this.trigger(
TRIGGER_DEFINITIONS.CRON,
AutomationTriggerStepId.CRON,
inputs,
outputs
)
}
private trigger<TStep extends AutomationTriggerStepId>(
triggerSchema: AutomationTriggerDefinition,
stepId: TStep,
inputs?: AutomationTriggerInputs<TStep>,
outputs?: TriggerOutputs
): this {
if (this.triggerSet) { if (this.triggerSet) {
throw new Error("Only one trigger can be set for an automation.") throw new Error("Only one trigger can be set for an automation.")
} }
this.triggerOutputs = outputs as TriggerOutputs | undefined
this.automationConfig.definition.trigger = { this.automationConfig.definition.trigger = {
...triggerSchema, ...TRIGGER_DEFINITIONS[stepId],
stepId, stepId,
inputs: inputs || ({} as any), inputs,
id: uuidv4(), id: uuidv4(),
} } as AutomationTrigger
this.triggerOutputs = outputs
this.triggerSet = true this.triggerSet = true
return this return this
} }
}
protected triggerOutputOnly<
TStep extends AutomationTriggerStepId,
TOutput = AutomationTriggerOutputs<TStep>
>(stepId: TStep) {
return (outputs: TOutput) => {
this.triggerOutputs = outputs as TriggerOutputs
this.automationConfig.definition.trigger = {
...TRIGGER_DEFINITIONS[stepId],
stepId,
id: uuidv4(),
} as AutomationTrigger
this.triggerSet = true
return this
}
}
// The input and output for appAction is identical, and we only ever seem to
// set the output, so we're ignoring the input for now.
appAction = this.triggerOutputOnly(AutomationTriggerStepId.APP)
rowSaved = this.triggerInputOutput(AutomationTriggerStepId.ROW_SAVED)
rowUpdated = this.triggerInputOutput(AutomationTriggerStepId.ROW_UPDATED)
rowDeleted = this.triggerInputOutput(AutomationTriggerStepId.ROW_DELETED)
webhook = this.triggerInputOutput(AutomationTriggerStepId.WEBHOOK)
cron = this.triggerInputOutput(AutomationTriggerStepId.CRON)
branch(branchConfig: BranchConfig): this { branch(branchConfig: BranchConfig): this {
this.addBranchStep(branchConfig) this.addBranchStep(branchConfig)
@ -491,9 +220,6 @@ class AutomationBuilder extends BaseStepBuilder {
} }
async save() { async save() {
if (!Object.keys(this.automationConfig.definition.trigger).length) {
throw new Error("Please add a trigger to this automation test")
}
this.automationConfig.definition.steps = this.steps this.automationConfig.definition.steps = this.steps
const { automation } = await this.config.api.automation.post(this.build()) const { automation } = await this.config.api.automation.post(this.build())
return automation return automation
@ -518,10 +244,6 @@ class AutomationBuilder extends BaseStepBuilder {
} }
} }
export function createAutomationBuilder(options?: { export function createAutomationBuilder(config: TestConfiguration) {
name?: string return new AutomationBuilder(config)
appId?: string
config?: TestConfiguration
}) {
return new AutomationBuilder(options)
} }

View File

@ -52,6 +52,12 @@ import {
RowDeletedTriggerInputs, RowDeletedTriggerInputs,
BranchStepInputs, BranchStepInputs,
BaseAutomationOutputs, BaseAutomationOutputs,
AppActionTriggerOutputs,
CronTriggerOutputs,
RowDeletedTriggerOutputs,
RowCreatedTriggerOutputs,
RowUpdatedTriggerOutputs,
WebhookTriggerOutputs,
} from "./StepInputsOutputs" } from "./StepInputsOutputs"
export type ActionImplementations<T extends Hosting> = { export type ActionImplementations<T extends Hosting> = {
@ -341,6 +347,23 @@ export type AutomationTriggerInputs<T extends AutomationTriggerStepId> =
? Record<string, any> ? Record<string, any>
: never : never
export type AutomationTriggerOutputs<T extends AutomationTriggerStepId> =
T extends AutomationTriggerStepId.APP
? AppActionTriggerOutputs
: T extends AutomationTriggerStepId.CRON
? CronTriggerOutputs
: T extends AutomationTriggerStepId.ROW_ACTION
? Record<string, any>
: T extends AutomationTriggerStepId.ROW_DELETED
? RowDeletedTriggerOutputs
: T extends AutomationTriggerStepId.ROW_SAVED
? RowCreatedTriggerOutputs
: T extends AutomationTriggerStepId.ROW_UPDATED
? RowUpdatedTriggerOutputs
: T extends AutomationTriggerStepId.WEBHOOK
? WebhookTriggerOutputs
: never
export interface AutomationTriggerSchema< export interface AutomationTriggerSchema<
TTrigger extends AutomationTriggerStepId TTrigger extends AutomationTriggerStepId
> extends AutomationStepSchemaBase { > extends AutomationStepSchemaBase {