Merge branch 'master' of github.com:Budibase/budibase into new-data-ui
This commit is contained in:
commit
65af0a7352
|
@ -71,7 +71,7 @@ export function getQueryIndex(viewName: ViewName) {
|
||||||
export const isTableId = (id: string) => {
|
export const isTableId = (id: string) => {
|
||||||
// this includes datasource plus tables
|
// this includes datasource plus tables
|
||||||
return (
|
return (
|
||||||
id &&
|
!!id &&
|
||||||
(id.startsWith(`${DocumentType.TABLE}${SEPARATOR}`) ||
|
(id.startsWith(`${DocumentType.TABLE}${SEPARATOR}`) ||
|
||||||
id.startsWith(`${DocumentType.DATASOURCE_PLUS}${SEPARATOR}`))
|
id.startsWith(`${DocumentType.DATASOURCE_PLUS}${SEPARATOR}`))
|
||||||
)
|
)
|
||||||
|
|
|
@ -26,7 +26,7 @@ export async function find(ctx: Ctx<void, RowActionsResponse>) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
const { actions } = await sdk.rowActions.get(table._id!)
|
const { actions } = await sdk.rowActions.getAll(table._id!)
|
||||||
const result: RowActionsResponse = {
|
const result: RowActionsResponse = {
|
||||||
actions: Object.entries(actions).reduce<Record<string, RowActionResponse>>(
|
actions: Object.entries(actions).reduce<Record<string, RowActionResponse>>(
|
||||||
(acc, [key, action]) => ({
|
(acc, [key, action]) => ({
|
||||||
|
@ -36,6 +36,7 @@ export async function find(ctx: Ctx<void, RowActionsResponse>) {
|
||||||
tableId: table._id!,
|
tableId: table._id!,
|
||||||
name: action.name,
|
name: action.name,
|
||||||
automationId: action.automationId,
|
automationId: action.automationId,
|
||||||
|
allowedViews: flattenAllowedViews(action.permissions.views),
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
{}
|
{}
|
||||||
|
@ -58,6 +59,7 @@ export async function create(
|
||||||
id: createdAction.id,
|
id: createdAction.id,
|
||||||
name: createdAction.name,
|
name: createdAction.name,
|
||||||
automationId: createdAction.automationId,
|
automationId: createdAction.automationId,
|
||||||
|
allowedViews: undefined,
|
||||||
}
|
}
|
||||||
ctx.status = 201
|
ctx.status = 201
|
||||||
}
|
}
|
||||||
|
@ -77,6 +79,7 @@ export async function update(
|
||||||
id: action.id,
|
id: action.id,
|
||||||
name: action.name,
|
name: action.name,
|
||||||
automationId: action.automationId,
|
automationId: action.automationId,
|
||||||
|
allowedViews: undefined,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -87,3 +90,53 @@ export async function remove(ctx: Ctx<void, void>) {
|
||||||
await sdk.rowActions.remove(table._id!, actionId)
|
await sdk.rowActions.remove(table._id!, actionId)
|
||||||
ctx.status = 204
|
ctx.status = 204
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export async function setViewPermission(ctx: Ctx<void, RowActionResponse>) {
|
||||||
|
const table = await getTable(ctx)
|
||||||
|
const { actionId, viewId } = ctx.params
|
||||||
|
|
||||||
|
const action = await sdk.rowActions.setViewPermission(
|
||||||
|
table._id!,
|
||||||
|
actionId,
|
||||||
|
viewId
|
||||||
|
)
|
||||||
|
ctx.body = {
|
||||||
|
tableId: table._id!,
|
||||||
|
id: action.id,
|
||||||
|
name: action.name,
|
||||||
|
automationId: action.automationId,
|
||||||
|
allowedViews: flattenAllowedViews(action.permissions.views),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function unsetViewPermission(ctx: Ctx<void, RowActionResponse>) {
|
||||||
|
const table = await getTable(ctx)
|
||||||
|
const { actionId, viewId } = ctx.params
|
||||||
|
|
||||||
|
const action = await sdk.rowActions.unsetViewPermission(
|
||||||
|
table._id!,
|
||||||
|
actionId,
|
||||||
|
viewId
|
||||||
|
)
|
||||||
|
|
||||||
|
ctx.body = {
|
||||||
|
tableId: table._id!,
|
||||||
|
id: action.id,
|
||||||
|
name: action.name,
|
||||||
|
automationId: action.automationId,
|
||||||
|
allowedViews: flattenAllowedViews(action.permissions.views),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function flattenAllowedViews(
|
||||||
|
permissions: Record<string, { runAllowed: boolean }>
|
||||||
|
) {
|
||||||
|
const allowedPermissions = Object.entries(permissions || {})
|
||||||
|
.filter(([_, p]) => p.runAllowed)
|
||||||
|
.map(([viewId]) => viewId)
|
||||||
|
if (!allowedPermissions.length) {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
|
||||||
|
return allowedPermissions
|
||||||
|
}
|
||||||
|
|
|
@ -2,9 +2,10 @@ import Router from "@koa/router"
|
||||||
import Joi from "joi"
|
import Joi from "joi"
|
||||||
import { middleware, permissions } from "@budibase/backend-core"
|
import { middleware, permissions } from "@budibase/backend-core"
|
||||||
import * as rowActionController from "../controllers/rowAction"
|
import * as rowActionController from "../controllers/rowAction"
|
||||||
import { authorizedResource } from "../../middleware/authorized"
|
import authorized from "../../middleware/authorized"
|
||||||
|
import { triggerRowActionAuthorised } from "../../middleware/triggerRowActionAuthorised"
|
||||||
|
|
||||||
const { PermissionLevel, PermissionType } = permissions
|
const { BUILDER } = permissions
|
||||||
|
|
||||||
function rowActionValidator() {
|
function rowActionValidator() {
|
||||||
return middleware.joiValidator.body(
|
return middleware.joiValidator.body(
|
||||||
|
@ -30,32 +31,42 @@ const router: Router = new Router()
|
||||||
router
|
router
|
||||||
.get(
|
.get(
|
||||||
"/api/tables/:tableId/actions",
|
"/api/tables/:tableId/actions",
|
||||||
authorizedResource(PermissionType.TABLE, PermissionLevel.READ, "tableId"),
|
authorized(BUILDER),
|
||||||
rowActionController.find
|
rowActionController.find
|
||||||
)
|
)
|
||||||
.post(
|
.post(
|
||||||
"/api/tables/:tableId/actions",
|
"/api/tables/:tableId/actions",
|
||||||
authorizedResource(PermissionType.TABLE, PermissionLevel.READ, "tableId"),
|
authorized(BUILDER),
|
||||||
rowActionValidator(),
|
rowActionValidator(),
|
||||||
rowActionController.create
|
rowActionController.create
|
||||||
)
|
)
|
||||||
.put(
|
.put(
|
||||||
"/api/tables/:tableId/actions/:actionId",
|
"/api/tables/:tableId/actions/:actionId",
|
||||||
authorizedResource(PermissionType.TABLE, PermissionLevel.READ, "tableId"),
|
authorized(BUILDER),
|
||||||
rowActionValidator(),
|
rowActionValidator(),
|
||||||
rowActionController.update
|
rowActionController.update
|
||||||
)
|
)
|
||||||
.delete(
|
.delete(
|
||||||
"/api/tables/:tableId/actions/:actionId",
|
"/api/tables/:tableId/actions/:actionId",
|
||||||
authorizedResource(PermissionType.TABLE, PermissionLevel.READ, "tableId"),
|
authorized(BUILDER),
|
||||||
rowActionController.remove
|
rowActionController.remove
|
||||||
)
|
)
|
||||||
|
.post(
|
||||||
|
"/api/tables/:tableId/actions/:actionId/permissions/:viewId",
|
||||||
|
authorized(BUILDER),
|
||||||
|
rowActionController.setViewPermission
|
||||||
|
)
|
||||||
|
.delete(
|
||||||
|
"/api/tables/:tableId/actions/:actionId/permissions/:viewId",
|
||||||
|
authorized(BUILDER),
|
||||||
|
rowActionController.unsetViewPermission
|
||||||
|
)
|
||||||
|
|
||||||
// Other endpoints
|
// Other endpoints
|
||||||
.post(
|
.post(
|
||||||
"/api/tables/:tableId/actions/:actionId/trigger",
|
"/api/tables/:sourceId/actions/:actionId/trigger",
|
||||||
rowTriggerValidator(),
|
rowTriggerValidator(),
|
||||||
authorizedResource(PermissionType.TABLE, PermissionLevel.READ, "tableId"),
|
triggerRowActionAuthorised("sourceId", "actionId"),
|
||||||
rowActionController.run
|
rowActionController.run
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
|
@ -4,10 +4,15 @@ import tk from "timekeeper"
|
||||||
import {
|
import {
|
||||||
CreateRowActionRequest,
|
CreateRowActionRequest,
|
||||||
DocumentType,
|
DocumentType,
|
||||||
|
PermissionLevel,
|
||||||
|
Row,
|
||||||
RowActionResponse,
|
RowActionResponse,
|
||||||
} from "@budibase/types"
|
} from "@budibase/types"
|
||||||
import * as setup from "./utilities"
|
import * as setup from "./utilities"
|
||||||
import { generator } from "@budibase/backend-core/tests"
|
import { generator } from "@budibase/backend-core/tests"
|
||||||
|
import { Expectations } from "../../../tests/utilities/api/base"
|
||||||
|
import { roles } from "@budibase/backend-core"
|
||||||
|
import { automations } from "@budibase/pro"
|
||||||
|
|
||||||
const expectAutomationId = () =>
|
const expectAutomationId = () =>
|
||||||
expect.stringMatching(`^${DocumentType.AUTOMATION}_.+`)
|
expect.stringMatching(`^${DocumentType.AUTOMATION}_.+`)
|
||||||
|
@ -43,11 +48,14 @@ describe("/rowsActions", () => {
|
||||||
.map(name => ({ name }))
|
.map(name => ({ name }))
|
||||||
}
|
}
|
||||||
|
|
||||||
function unauthorisedTests() {
|
function unauthorisedTests(
|
||||||
|
apiDelegate: (
|
||||||
|
expectations: Expectations,
|
||||||
|
testConfig?: { publicUser?: boolean }
|
||||||
|
) => Promise<any>
|
||||||
|
) {
|
||||||
it("returns unauthorised (401) for unauthenticated requests", async () => {
|
it("returns unauthorised (401) for unauthenticated requests", async () => {
|
||||||
await createRowAction(
|
await apiDelegate(
|
||||||
tableId,
|
|
||||||
createRowActionRequest(),
|
|
||||||
{
|
{
|
||||||
status: 401,
|
status: 401,
|
||||||
body: {
|
body: {
|
||||||
|
@ -65,6 +73,35 @@ describe("/rowsActions", () => {
|
||||||
await config.withUser(user, async () => {
|
await config.withUser(user, async () => {
|
||||||
await createRowAction(generator.guid(), createRowActionRequest(), {
|
await createRowAction(generator.guid(), createRowActionRequest(), {
|
||||||
status: 403,
|
status: 403,
|
||||||
|
body: {
|
||||||
|
message: "Not Authorized",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it("returns forbidden (403) for non-builder users even if they have table write permissions", async () => {
|
||||||
|
const user = await config.createUser({
|
||||||
|
builder: {},
|
||||||
|
})
|
||||||
|
const tableId = generator.guid()
|
||||||
|
for (const role of Object.values(roles.BUILTIN_ROLE_IDS)) {
|
||||||
|
await config.api.permission.add({
|
||||||
|
roleId: role,
|
||||||
|
resourceId: tableId,
|
||||||
|
level: PermissionLevel.EXECUTE,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// replicate changes before checking permissions
|
||||||
|
await config.publish()
|
||||||
|
|
||||||
|
await config.withUser(user, async () => {
|
||||||
|
await createRowAction(tableId, createRowActionRequest(), {
|
||||||
|
status: 403,
|
||||||
|
body: {
|
||||||
|
message: "Not Authorized",
|
||||||
|
},
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
@ -77,7 +114,14 @@ describe("/rowsActions", () => {
|
||||||
}
|
}
|
||||||
|
|
||||||
describe("create", () => {
|
describe("create", () => {
|
||||||
unauthorisedTests()
|
unauthorisedTests((expectations, testConfig) =>
|
||||||
|
createRowAction(
|
||||||
|
tableId,
|
||||||
|
createRowActionRequest(),
|
||||||
|
expectations,
|
||||||
|
testConfig
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
it("creates new row actions for tables without existing actions", async () => {
|
it("creates new row actions for tables without existing actions", async () => {
|
||||||
const rowAction = createRowActionRequest()
|
const rowAction = createRowActionRequest()
|
||||||
|
@ -106,7 +150,7 @@ describe("/rowsActions", () => {
|
||||||
|
|
||||||
it("trims row action names", async () => {
|
it("trims row action names", async () => {
|
||||||
const name = " action name "
|
const name = " action name "
|
||||||
const res = await createRowAction(tableId, { name }, { status: 201 })
|
const res = await createRowAction(tableId, { name })
|
||||||
|
|
||||||
expect(res).toEqual(
|
expect(res).toEqual(
|
||||||
expect.objectContaining({
|
expect.objectContaining({
|
||||||
|
@ -174,9 +218,7 @@ describe("/rowsActions", () => {
|
||||||
id: generator.guid(),
|
id: generator.guid(),
|
||||||
valueToIgnore: generator.string(),
|
valueToIgnore: generator.string(),
|
||||||
}
|
}
|
||||||
const res = await createRowAction(tableId, dirtyRowAction, {
|
const res = await createRowAction(tableId, dirtyRowAction)
|
||||||
status: 201,
|
|
||||||
})
|
|
||||||
|
|
||||||
expect(res).toEqual({
|
expect(res).toEqual({
|
||||||
name: rowAction.name,
|
name: rowAction.name,
|
||||||
|
@ -239,15 +281,17 @@ describe("/rowsActions", () => {
|
||||||
const action2 = await createRowAction(tableId, createRowActionRequest())
|
const action2 = await createRowAction(tableId, createRowActionRequest())
|
||||||
|
|
||||||
for (const automationId of [action1.automationId, action2.automationId]) {
|
for (const automationId of [action1.automationId, action2.automationId]) {
|
||||||
expect(
|
expect(await config.api.automation.get(automationId)).toEqual(
|
||||||
await config.api.automation.get(automationId, { status: 200 })
|
expect.objectContaining({ _id: automationId })
|
||||||
).toEqual(expect.objectContaining({ _id: automationId }))
|
)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
describe("find", () => {
|
describe("find", () => {
|
||||||
unauthorisedTests()
|
unauthorisedTests((expectations, testConfig) =>
|
||||||
|
config.api.rowAction.find(tableId, expectations, testConfig)
|
||||||
|
)
|
||||||
|
|
||||||
it("returns only the actions for the requested table", async () => {
|
it("returns only the actions for the requested table", async () => {
|
||||||
const rowActions: RowActionResponse[] = []
|
const rowActions: RowActionResponse[] = []
|
||||||
|
@ -279,7 +323,15 @@ describe("/rowsActions", () => {
|
||||||
})
|
})
|
||||||
|
|
||||||
describe("update", () => {
|
describe("update", () => {
|
||||||
unauthorisedTests()
|
unauthorisedTests((expectations, testConfig) =>
|
||||||
|
config.api.rowAction.update(
|
||||||
|
tableId,
|
||||||
|
generator.guid(),
|
||||||
|
createRowActionRequest(),
|
||||||
|
expectations,
|
||||||
|
testConfig
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
it("can update existing actions", async () => {
|
it("can update existing actions", async () => {
|
||||||
for (const rowAction of createRowActionRequests(3)) {
|
for (const rowAction of createRowActionRequests(3)) {
|
||||||
|
@ -320,13 +372,7 @@ describe("/rowsActions", () => {
|
||||||
})
|
})
|
||||||
|
|
||||||
it("trims row action names", async () => {
|
it("trims row action names", async () => {
|
||||||
const rowAction = await createRowAction(
|
const rowAction = await createRowAction(tableId, createRowActionRequest())
|
||||||
tableId,
|
|
||||||
createRowActionRequest(),
|
|
||||||
{
|
|
||||||
status: 201,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
const res = await config.api.rowAction.update(tableId, rowAction.id, {
|
const res = await config.api.rowAction.update(tableId, rowAction.id, {
|
||||||
name: " action name ",
|
name: " action name ",
|
||||||
|
@ -398,7 +444,14 @@ describe("/rowsActions", () => {
|
||||||
})
|
})
|
||||||
|
|
||||||
describe("delete", () => {
|
describe("delete", () => {
|
||||||
unauthorisedTests()
|
unauthorisedTests((expectations, testConfig) =>
|
||||||
|
config.api.rowAction.delete(
|
||||||
|
tableId,
|
||||||
|
generator.guid(),
|
||||||
|
expectations,
|
||||||
|
testConfig
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
it("can delete existing actions", async () => {
|
it("can delete existing actions", async () => {
|
||||||
const actions: RowActionResponse[] = []
|
const actions: RowActionResponse[] = []
|
||||||
|
@ -462,4 +515,232 @@ describe("/rowsActions", () => {
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
describe("set/unsetViewPermission", () => {
|
||||||
|
describe.each([
|
||||||
|
["setViewPermission", config.api.rowAction.setViewPermission],
|
||||||
|
["unsetViewPermission", config.api.rowAction.unsetViewPermission],
|
||||||
|
])("unauthorisedTests for %s", (__, delegateTest) => {
|
||||||
|
unauthorisedTests((expectations, testConfig) =>
|
||||||
|
delegateTest(
|
||||||
|
tableId,
|
||||||
|
generator.guid(),
|
||||||
|
generator.guid(),
|
||||||
|
expectations,
|
||||||
|
testConfig
|
||||||
|
)
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
let tableIdForDescribe: string
|
||||||
|
let actionId1: string, actionId2: string
|
||||||
|
let viewId1: string, viewId2: string
|
||||||
|
beforeAll(async () => {
|
||||||
|
tableIdForDescribe = tableId
|
||||||
|
for (const rowAction of createRowActionRequests(3)) {
|
||||||
|
await createRowAction(tableId, rowAction)
|
||||||
|
}
|
||||||
|
const persisted = await config.api.rowAction.find(tableId)
|
||||||
|
|
||||||
|
const actions = _.sampleSize(Object.keys(persisted.actions), 2)
|
||||||
|
actionId1 = actions[0]
|
||||||
|
actionId2 = actions[1]
|
||||||
|
|
||||||
|
viewId1 = (
|
||||||
|
await config.api.viewV2.create(
|
||||||
|
setup.structures.viewV2.createRequest(tableId)
|
||||||
|
)
|
||||||
|
).id
|
||||||
|
viewId2 = (
|
||||||
|
await config.api.viewV2.create(
|
||||||
|
setup.structures.viewV2.createRequest(tableId)
|
||||||
|
)
|
||||||
|
).id
|
||||||
|
})
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
// Hack to reuse tables for these given tests
|
||||||
|
tableId = tableIdForDescribe
|
||||||
|
})
|
||||||
|
|
||||||
|
it("can set permission views", async () => {
|
||||||
|
await config.api.rowAction.setViewPermission(tableId, viewId1, actionId1)
|
||||||
|
const action1Result = await config.api.rowAction.setViewPermission(
|
||||||
|
tableId,
|
||||||
|
viewId2,
|
||||||
|
actionId1
|
||||||
|
)
|
||||||
|
const action2Result = await config.api.rowAction.setViewPermission(
|
||||||
|
tableId,
|
||||||
|
viewId1,
|
||||||
|
actionId2
|
||||||
|
)
|
||||||
|
|
||||||
|
const expectedAction1 = expect.objectContaining({
|
||||||
|
allowedViews: [viewId1, viewId2],
|
||||||
|
})
|
||||||
|
const expectedAction2 = expect.objectContaining({
|
||||||
|
allowedViews: [viewId1],
|
||||||
|
})
|
||||||
|
|
||||||
|
const expectedActions = expect.objectContaining({
|
||||||
|
[actionId1]: expectedAction1,
|
||||||
|
[actionId2]: expectedAction2,
|
||||||
|
})
|
||||||
|
expect(action1Result).toEqual(expectedAction1)
|
||||||
|
expect(action2Result).toEqual(expectedAction2)
|
||||||
|
expect((await config.api.rowAction.find(tableId)).actions).toEqual(
|
||||||
|
expectedActions
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("can unset permission views", async () => {
|
||||||
|
const actionResult = await config.api.rowAction.unsetViewPermission(
|
||||||
|
tableId,
|
||||||
|
viewId1,
|
||||||
|
actionId1
|
||||||
|
)
|
||||||
|
|
||||||
|
const expectedAction = expect.objectContaining({
|
||||||
|
allowedViews: [viewId2],
|
||||||
|
})
|
||||||
|
expect(actionResult).toEqual(expectedAction)
|
||||||
|
expect(
|
||||||
|
(await config.api.rowAction.find(tableId)).actions[actionId1]
|
||||||
|
).toEqual(expectedAction)
|
||||||
|
})
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
["setViewPermission", config.api.rowAction.setViewPermission],
|
||||||
|
["unsetViewPermission", config.api.rowAction.unsetViewPermission],
|
||||||
|
])(
|
||||||
|
"cannot update permission views for unexisting views (%s)",
|
||||||
|
async (__, delegateTest) => {
|
||||||
|
const viewId = generator.guid()
|
||||||
|
|
||||||
|
await delegateTest(tableId, viewId, actionId1, {
|
||||||
|
status: 400,
|
||||||
|
body: {
|
||||||
|
message: `View '${viewId}' not found in '${tableId}'`,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
["setViewPermission", config.api.rowAction.setViewPermission],
|
||||||
|
["unsetViewPermission", config.api.rowAction.unsetViewPermission],
|
||||||
|
])(
|
||||||
|
"cannot update permission views crossing table views (%s)",
|
||||||
|
async (__, delegateTest) => {
|
||||||
|
const anotherTable = await config.api.table.save(
|
||||||
|
setup.structures.basicTable()
|
||||||
|
)
|
||||||
|
const { id: viewId } = await config.api.viewV2.create(
|
||||||
|
setup.structures.viewV2.createRequest(anotherTable._id!)
|
||||||
|
)
|
||||||
|
|
||||||
|
await delegateTest(tableId, viewId, actionId1, {
|
||||||
|
status: 400,
|
||||||
|
body: {
|
||||||
|
message: `View '${viewId}' not found in '${tableId}'`,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("trigger", () => {
|
||||||
|
let row: Row
|
||||||
|
let rowAction: RowActionResponse
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
row = await config.api.row.save(tableId, {})
|
||||||
|
rowAction = await createRowAction(tableId, createRowActionRequest())
|
||||||
|
|
||||||
|
await config.publish()
|
||||||
|
tk.travel(Date.now() + 100)
|
||||||
|
})
|
||||||
|
|
||||||
|
async function getAutomationLogs() {
|
||||||
|
const { data: automationLogs } = await config.doInContext(
|
||||||
|
config.getProdAppId(),
|
||||||
|
async () =>
|
||||||
|
automations.logs.logSearch({ startDate: new Date().toISOString() })
|
||||||
|
)
|
||||||
|
return automationLogs
|
||||||
|
}
|
||||||
|
|
||||||
|
it("can trigger an automation given valid data", async () => {
|
||||||
|
await config.api.rowAction.trigger(tableId, rowAction.id, {
|
||||||
|
rowId: row._id!,
|
||||||
|
})
|
||||||
|
|
||||||
|
const automationLogs = await getAutomationLogs()
|
||||||
|
expect(automationLogs).toEqual([
|
||||||
|
expect.objectContaining({
|
||||||
|
automationId: rowAction.automationId,
|
||||||
|
trigger: expect.objectContaining({
|
||||||
|
outputs: {
|
||||||
|
fields: {},
|
||||||
|
row: await config.api.row.get(tableId, row._id!),
|
||||||
|
table: await config.api.table.get(tableId),
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
}),
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it("rejects triggering from a non-allowed view", async () => {
|
||||||
|
const viewId = (
|
||||||
|
await config.api.viewV2.create(
|
||||||
|
setup.structures.viewV2.createRequest(tableId)
|
||||||
|
)
|
||||||
|
).id
|
||||||
|
|
||||||
|
await config.publish()
|
||||||
|
await config.api.rowAction.trigger(
|
||||||
|
viewId,
|
||||||
|
rowAction.id,
|
||||||
|
{
|
||||||
|
rowId: row._id!,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
status: 403,
|
||||||
|
body: {
|
||||||
|
message: `Row action '${rowAction.id}' is not enabled for view '${viewId}'`,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
const automationLogs = await getAutomationLogs()
|
||||||
|
expect(automationLogs).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it("triggers from an allowed view", async () => {
|
||||||
|
const viewId = (
|
||||||
|
await config.api.viewV2.create(
|
||||||
|
setup.structures.viewV2.createRequest(tableId)
|
||||||
|
)
|
||||||
|
).id
|
||||||
|
|
||||||
|
await config.api.rowAction.setViewPermission(
|
||||||
|
tableId,
|
||||||
|
viewId,
|
||||||
|
rowAction.id
|
||||||
|
)
|
||||||
|
|
||||||
|
await config.publish()
|
||||||
|
await config.api.rowAction.trigger(viewId, rowAction.id, {
|
||||||
|
rowId: row._id!,
|
||||||
|
})
|
||||||
|
|
||||||
|
const automationLogs = await getAutomationLogs()
|
||||||
|
expect(automationLogs).toEqual([
|
||||||
|
expect.objectContaining({
|
||||||
|
automationId: rowAction.automationId,
|
||||||
|
}),
|
||||||
|
])
|
||||||
|
})
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
|
@ -294,3 +294,13 @@ export function typecastForLooping(input: LoopStepInputs) {
|
||||||
}
|
}
|
||||||
return input.binding
|
return input.binding
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function ensureMaxIterationsAsNumber(
|
||||||
|
value: number | string | undefined
|
||||||
|
): number | undefined {
|
||||||
|
if (typeof value === "number") return value
|
||||||
|
if (typeof value === "string") {
|
||||||
|
return parseInt(value)
|
||||||
|
}
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
|
|
@ -23,42 +23,148 @@ describe("Automation Scenarios", () => {
|
||||||
|
|
||||||
afterAll(setup.afterAll)
|
afterAll(setup.afterAll)
|
||||||
|
|
||||||
// eslint-disable-next-line jest/no-commented-out-tests
|
describe("Branching automations", () => {
|
||||||
// describe("Branching automations", () => {
|
it("should run a multiple nested branching automation", async () => {
|
||||||
// eslint-disable-next-line jest/no-commented-out-tests
|
const builder = createAutomationBuilder({
|
||||||
// it("should run an automation with a trigger, loop, and create row step", async () => {
|
name: "Test Trigger with Loop and Create Row",
|
||||||
// const builder = createAutomationBuilder({
|
})
|
||||||
// name: "Test Trigger with Loop and Create Row",
|
|
||||||
// })
|
|
||||||
|
|
||||||
// builder
|
const results = await builder
|
||||||
// .serverLog({ text: "Starting automation" })
|
.appAction({ fields: {} })
|
||||||
// .branch({
|
.serverLog({ text: "Starting automation" })
|
||||||
// topLevelBranch1: {
|
.branch({
|
||||||
// steps: stepBuilder =>
|
topLevelBranch1: {
|
||||||
// stepBuilder.serverLog({ text: "Branch 1" }).branch({
|
steps: stepBuilder =>
|
||||||
// branch1: {
|
stepBuilder.serverLog({ text: "Branch 1" }).branch({
|
||||||
// steps: stepBuilder =>
|
branch1: {
|
||||||
// stepBuilder.serverLog({ text: "Branch 1.1" }),
|
steps: stepBuilder =>
|
||||||
// condition: { notEmpty: { column: 10 } },
|
stepBuilder.serverLog({ text: "Branch 1.1" }),
|
||||||
// },
|
condition: {
|
||||||
// branch2: {
|
equal: { "steps.1.success": true },
|
||||||
// steps: stepBuilder =>
|
},
|
||||||
// stepBuilder.serverLog({ text: "Branch 1.2" }),
|
},
|
||||||
// condition: { fuzzy: { column: "sadsd" } },
|
branch2: {
|
||||||
// },
|
steps: stepBuilder =>
|
||||||
// }),
|
stepBuilder.serverLog({ text: "Branch 1.2" }),
|
||||||
// condition: { equal: { column: 10 } },
|
condition: {
|
||||||
// },
|
equal: { "steps.1.success": false },
|
||||||
// topLevelBranch2: {
|
},
|
||||||
// steps: stepBuilder => stepBuilder.serverLog({ text: "Branch 2" }),
|
},
|
||||||
// condition: { equal: { column: 20 } },
|
}),
|
||||||
// },
|
condition: {
|
||||||
// })
|
equal: { "steps.1.success": true },
|
||||||
// .run()
|
},
|
||||||
// })
|
},
|
||||||
|
topLevelBranch2: {
|
||||||
|
steps: stepBuilder => stepBuilder.serverLog({ text: "Branch 2" }),
|
||||||
|
condition: {
|
||||||
|
equal: { "steps.1.success": false },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.run()
|
||||||
|
|
||||||
// })
|
expect(results.steps[2].outputs.message).toContain("Branch 1.1")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("should execute correct branch based on string equality", async () => {
|
||||||
|
const builder = createAutomationBuilder({
|
||||||
|
name: "String Equality Branching",
|
||||||
|
})
|
||||||
|
|
||||||
|
const results = await builder
|
||||||
|
.appAction({ fields: { status: "active" } })
|
||||||
|
.branch({
|
||||||
|
activeBranch: {
|
||||||
|
steps: stepBuilder =>
|
||||||
|
stepBuilder.serverLog({ text: "Active user" }),
|
||||||
|
condition: {
|
||||||
|
equal: { "trigger.fields.status": "active" },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
inactiveBranch: {
|
||||||
|
steps: stepBuilder =>
|
||||||
|
stepBuilder.serverLog({ text: "Inactive user" }),
|
||||||
|
condition: {
|
||||||
|
equal: { "trigger.fields.status": "inactive" },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.run()
|
||||||
|
|
||||||
|
expect(results.steps[0].outputs.message).toContain("Active user")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("should handle multiple conditions with AND operator", async () => {
|
||||||
|
const builder = createAutomationBuilder({
|
||||||
|
name: "Multiple AND Conditions Branching",
|
||||||
|
})
|
||||||
|
|
||||||
|
const results = await builder
|
||||||
|
.appAction({ fields: { status: "active", role: "admin" } })
|
||||||
|
.branch({
|
||||||
|
activeAdminBranch: {
|
||||||
|
steps: stepBuilder =>
|
||||||
|
stepBuilder.serverLog({ text: "Active admin user" }),
|
||||||
|
condition: {
|
||||||
|
$and: {
|
||||||
|
conditions: [
|
||||||
|
{ equal: { "trigger.fields.status": "active" } },
|
||||||
|
{ equal: { "trigger.fields.role": "admin" } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
otherBranch: {
|
||||||
|
steps: stepBuilder => stepBuilder.serverLog({ text: "Other user" }),
|
||||||
|
condition: {
|
||||||
|
notEqual: { "trigger.fields.status": "active" },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.run()
|
||||||
|
|
||||||
|
expect(results.steps[0].outputs.message).toContain("Active admin user")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("should handle multiple conditions with OR operator", async () => {
|
||||||
|
const builder = createAutomationBuilder({
|
||||||
|
name: "Multiple OR Conditions Branching",
|
||||||
|
})
|
||||||
|
|
||||||
|
const results = await builder
|
||||||
|
.appAction({ fields: { status: "test", role: "user" } })
|
||||||
|
.branch({
|
||||||
|
specialBranch: {
|
||||||
|
steps: stepBuilder =>
|
||||||
|
stepBuilder.serverLog({ text: "Special user" }),
|
||||||
|
condition: {
|
||||||
|
$or: {
|
||||||
|
conditions: [
|
||||||
|
{ equal: { "trigger.fields.status": "test" } },
|
||||||
|
{ equal: { "trigger.fields.role": "admin" } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
regularBranch: {
|
||||||
|
steps: stepBuilder =>
|
||||||
|
stepBuilder.serverLog({ text: "Regular user" }),
|
||||||
|
condition: {
|
||||||
|
$and: {
|
||||||
|
conditions: [
|
||||||
|
{ notEqual: { "trigger.fields.status": "active" } },
|
||||||
|
{ notEqual: { "trigger.fields.role": "admin" } },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
.run()
|
||||||
|
|
||||||
|
expect(results.steps[0].outputs.message).toContain("Special user")
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
describe("Loop automations", () => {
|
describe("Loop automations", () => {
|
||||||
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 () => {
|
||||||
|
@ -108,6 +214,89 @@ describe("Automation Scenarios", () => {
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it("should run an automation where a loop step is between two normal steps to ensure context correctness", async () => {
|
||||||
|
const builder = createAutomationBuilder({
|
||||||
|
name: "Test Trigger with Loop and Create Row",
|
||||||
|
})
|
||||||
|
|
||||||
|
const results = await builder
|
||||||
|
.rowSaved(
|
||||||
|
{ tableId: table._id! },
|
||||||
|
{
|
||||||
|
row: {
|
||||||
|
name: "Trigger Row",
|
||||||
|
description: "This row triggers the automation",
|
||||||
|
},
|
||||||
|
id: "1234",
|
||||||
|
revision: "1",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
.queryRows({
|
||||||
|
tableId: table._id!,
|
||||||
|
})
|
||||||
|
.loop({
|
||||||
|
option: LoopStepType.ARRAY,
|
||||||
|
binding: [1, 2, 3],
|
||||||
|
})
|
||||||
|
.serverLog({ text: "Message {{loop.currentItem}}" })
|
||||||
|
.serverLog({ text: "{{steps.1.rows.0._id}}" })
|
||||||
|
.run()
|
||||||
|
|
||||||
|
results.steps[1].outputs.items.forEach(
|
||||||
|
(output: ServerLogStepOutputs, index: number) => {
|
||||||
|
expect(output).toMatchObject({
|
||||||
|
success: true,
|
||||||
|
})
|
||||||
|
expect(output.message).toContain(`Message ${index + 1}`)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(results.steps[2].outputs.message).toContain("ro_ta")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("if an incorrect type is passed to the loop it should return an error", async () => {
|
||||||
|
const builder = createAutomationBuilder({
|
||||||
|
name: "Test Loop error",
|
||||||
|
})
|
||||||
|
|
||||||
|
const results = await builder
|
||||||
|
.appAction({ fields: {} })
|
||||||
|
.loop({
|
||||||
|
option: LoopStepType.ARRAY,
|
||||||
|
binding: "1, 2, 3",
|
||||||
|
})
|
||||||
|
.serverLog({ text: "Message {{loop.currentItem}}" })
|
||||||
|
.run()
|
||||||
|
|
||||||
|
expect(results.steps[0].outputs).toEqual({
|
||||||
|
success: false,
|
||||||
|
status: "INCORRECT_TYPE",
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it("ensure the loop stops if the failure condition is reached", async () => {
|
||||||
|
const builder = createAutomationBuilder({
|
||||||
|
name: "Test Loop error",
|
||||||
|
})
|
||||||
|
|
||||||
|
const results = await builder
|
||||||
|
.appAction({ fields: {} })
|
||||||
|
.loop({
|
||||||
|
option: LoopStepType.ARRAY,
|
||||||
|
binding: ["test", "test2", "test3"],
|
||||||
|
failure: "test2",
|
||||||
|
})
|
||||||
|
.serverLog({ text: "Message {{loop.currentItem}}" })
|
||||||
|
.run()
|
||||||
|
|
||||||
|
expect(results.steps[0].outputs).toEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
status: "FAILURE_CONDITION_MET",
|
||||||
|
success: false,
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
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 builder = createAutomationBuilder({
|
const builder = createAutomationBuilder({
|
||||||
name: "Test Trigger with Loop and Create Row",
|
name: "Test Trigger with Loop and Create Row",
|
||||||
|
|
|
@ -0,0 +1,45 @@
|
||||||
|
import { Next } from "koa"
|
||||||
|
import { Ctx } from "@budibase/types"
|
||||||
|
import { paramSubResource } from "./resourceId"
|
||||||
|
import { docIds } from "@budibase/backend-core"
|
||||||
|
import * as utils from "../db/utils"
|
||||||
|
import sdk from "../sdk"
|
||||||
|
|
||||||
|
export function triggerRowActionAuthorised(
|
||||||
|
sourcePath: string,
|
||||||
|
actionPath: string
|
||||||
|
) {
|
||||||
|
return async (ctx: Ctx, next: Next) => {
|
||||||
|
// Reusing the existing middleware to extract the value
|
||||||
|
paramSubResource(sourcePath, actionPath)(ctx, () => {})
|
||||||
|
const { resourceId: sourceId, subResourceId: rowActionId } = ctx
|
||||||
|
|
||||||
|
const isTableId = docIds.isTableId(sourceId)
|
||||||
|
const isViewId = utils.isViewID(sourceId)
|
||||||
|
if (!isTableId && !isViewId) {
|
||||||
|
ctx.throw(400, `'${sourceId}' is not a valid source id`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const tableId = isTableId
|
||||||
|
? sourceId
|
||||||
|
: utils.extractViewInfoFromID(sourceId).tableId
|
||||||
|
|
||||||
|
const rowAction = await sdk.rowActions.get(tableId, rowActionId)
|
||||||
|
|
||||||
|
if (isTableId && !rowAction.permissions.table.runAllowed) {
|
||||||
|
ctx.throw(
|
||||||
|
403,
|
||||||
|
`Row action '${rowActionId}' is not enabled for table '${sourceId}'`
|
||||||
|
)
|
||||||
|
} else if (isViewId && !rowAction.permissions.views[sourceId]?.runAllowed) {
|
||||||
|
ctx.throw(
|
||||||
|
403,
|
||||||
|
`Row action '${rowActionId}' is not enabled for view '${sourceId}'`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enrich tableId
|
||||||
|
ctx.params.tableId = tableId
|
||||||
|
return next()
|
||||||
|
}
|
||||||
|
}
|
|
@ -29,7 +29,7 @@ export async function getBuilderData(
|
||||||
const rowActionNameCache: Record<string, TableRowActions> = {}
|
const rowActionNameCache: Record<string, TableRowActions> = {}
|
||||||
async function getRowActionName(tableId: string, rowActionId: string) {
|
async function getRowActionName(tableId: string, rowActionId: string) {
|
||||||
if (!rowActionNameCache[tableId]) {
|
if (!rowActionNameCache[tableId]) {
|
||||||
rowActionNameCache[tableId] = await sdk.rowActions.get(tableId)
|
rowActionNameCache[tableId] = await sdk.rowActions.getAll(tableId)
|
||||||
}
|
}
|
||||||
|
|
||||||
return rowActionNameCache[tableId].actions[rowActionId]?.name
|
return rowActionNameCache[tableId].actions[rowActionId]?.name
|
||||||
|
|
|
@ -1,12 +1,11 @@
|
||||||
import { context, HTTPError, utils } from "@budibase/backend-core"
|
import { context, HTTPError, utils } from "@budibase/backend-core"
|
||||||
|
|
||||||
import {
|
import {
|
||||||
AutomationTriggerStepId,
|
AutomationTriggerStepId,
|
||||||
SEPARATOR,
|
SEPARATOR,
|
||||||
TableRowActions,
|
TableRowActions,
|
||||||
VirtualDocumentType,
|
VirtualDocumentType,
|
||||||
} from "@budibase/types"
|
} from "@budibase/types"
|
||||||
import { generateRowActionsID } from "../../db/utils"
|
import { generateRowActionsID, isViewID } from "../../db/utils"
|
||||||
import automations from "./automations"
|
import automations from "./automations"
|
||||||
import { definitions as TRIGGER_DEFINITIONS } from "../../automations/triggerInfo"
|
import { definitions as TRIGGER_DEFINITIONS } from "../../automations/triggerInfo"
|
||||||
import * as triggers from "../../automations/triggers"
|
import * as triggers from "../../automations/triggers"
|
||||||
|
@ -75,6 +74,10 @@ export async function create(tableId: string, rowAction: { name: string }) {
|
||||||
doc.actions[newRowActionId] = {
|
doc.actions[newRowActionId] = {
|
||||||
name: action.name,
|
name: action.name,
|
||||||
automationId: automation._id!,
|
automationId: automation._id!,
|
||||||
|
permissions: {
|
||||||
|
table: { runAllowed: true },
|
||||||
|
views: {},
|
||||||
|
},
|
||||||
}
|
}
|
||||||
await db.put(doc)
|
await db.put(doc)
|
||||||
|
|
||||||
|
@ -84,7 +87,19 @@ export async function create(tableId: string, rowAction: { name: string }) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function get(tableId: string) {
|
export async function get(tableId: string, rowActionId: string) {
|
||||||
|
const actionsDoc = await getAll(tableId)
|
||||||
|
const rowAction = actionsDoc?.actions[rowActionId]
|
||||||
|
if (!rowAction) {
|
||||||
|
throw new HTTPError(
|
||||||
|
`Row action '${rowActionId}' not found in '${tableId}'`,
|
||||||
|
400
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return rowAction
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getAll(tableId: string) {
|
||||||
const db = context.getAppDB()
|
const db = context.getAppDB()
|
||||||
const rowActionsId = generateRowActionsID(tableId)
|
const rowActionsId = generateRowActionsID(tableId)
|
||||||
return await db.get<TableRowActions>(rowActionsId)
|
return await db.get<TableRowActions>(rowActionsId)
|
||||||
|
@ -97,41 +112,15 @@ export async function docExists(tableId: string) {
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function update(
|
async function updateDoc(
|
||||||
tableId: string,
|
tableId: string,
|
||||||
rowActionId: string,
|
rowActionId: string,
|
||||||
rowAction: { name: string }
|
transformer: (
|
||||||
|
tableRowActions: TableRowActions
|
||||||
|
) => TableRowActions | Promise<TableRowActions>
|
||||||
) {
|
) {
|
||||||
const action = { name: rowAction.name.trim() }
|
const actionsDoc = await getAll(tableId)
|
||||||
const actionsDoc = await get(tableId)
|
const rowAction = actionsDoc?.actions[rowActionId]
|
||||||
|
|
||||||
if (!actionsDoc.actions[rowActionId]) {
|
|
||||||
throw new HTTPError(
|
|
||||||
`Row action '${rowActionId}' not found in '${tableId}'`,
|
|
||||||
400
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
ensureUniqueAndThrow(actionsDoc, action.name, rowActionId)
|
|
||||||
|
|
||||||
actionsDoc.actions[rowActionId] = {
|
|
||||||
automationId: actionsDoc.actions[rowActionId].automationId,
|
|
||||||
...action,
|
|
||||||
}
|
|
||||||
|
|
||||||
const db = context.getAppDB()
|
|
||||||
await db.put(actionsDoc)
|
|
||||||
|
|
||||||
return {
|
|
||||||
id: rowActionId,
|
|
||||||
...actionsDoc.actions[rowActionId],
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function remove(tableId: string, rowActionId: string) {
|
|
||||||
const actionsDoc = await get(tableId)
|
|
||||||
|
|
||||||
const rowAction = actionsDoc.actions[rowActionId]
|
|
||||||
if (!rowAction) {
|
if (!rowAction) {
|
||||||
throw new HTTPError(
|
throw new HTTPError(
|
||||||
`Row action '${rowActionId}' not found in '${tableId}'`,
|
`Row action '${rowActionId}' not found in '${tableId}'`,
|
||||||
|
@ -139,13 +128,76 @@ export async function remove(tableId: string, rowActionId: string) {
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
const { automationId } = rowAction
|
const updated = await transformer(actionsDoc)
|
||||||
const automation = await automations.get(automationId)
|
|
||||||
await automations.remove(automation._id, automation._rev)
|
|
||||||
delete actionsDoc.actions[rowActionId]
|
|
||||||
|
|
||||||
const db = context.getAppDB()
|
const db = context.getAppDB()
|
||||||
await db.put(actionsDoc)
|
await db.put(updated)
|
||||||
|
|
||||||
|
return {
|
||||||
|
id: rowActionId,
|
||||||
|
...updated.actions[rowActionId],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function update(
|
||||||
|
tableId: string,
|
||||||
|
rowActionId: string,
|
||||||
|
rowActionData: { name: string }
|
||||||
|
) {
|
||||||
|
const newName = rowActionData.name.trim()
|
||||||
|
|
||||||
|
return await updateDoc(tableId, rowActionId, actionsDoc => {
|
||||||
|
ensureUniqueAndThrow(actionsDoc, newName, rowActionId)
|
||||||
|
actionsDoc.actions[rowActionId].name = newName
|
||||||
|
return actionsDoc
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
async function guardView(tableId: string, viewId: string) {
|
||||||
|
let view
|
||||||
|
if (isViewID(viewId)) {
|
||||||
|
view = await sdk.views.get(viewId)
|
||||||
|
}
|
||||||
|
if (!view || view.tableId !== tableId) {
|
||||||
|
throw new HTTPError(`View '${viewId}' not found in '${tableId}'`, 400)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function setViewPermission(
|
||||||
|
tableId: string,
|
||||||
|
rowActionId: string,
|
||||||
|
viewId: string
|
||||||
|
) {
|
||||||
|
await guardView(tableId, viewId)
|
||||||
|
return await updateDoc(tableId, rowActionId, async actionsDoc => {
|
||||||
|
actionsDoc.actions[rowActionId].permissions.views[viewId] = {
|
||||||
|
runAllowed: true,
|
||||||
|
}
|
||||||
|
return actionsDoc
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function unsetViewPermission(
|
||||||
|
tableId: string,
|
||||||
|
rowActionId: string,
|
||||||
|
viewId: string
|
||||||
|
) {
|
||||||
|
await guardView(tableId, viewId)
|
||||||
|
return await updateDoc(tableId, rowActionId, async actionsDoc => {
|
||||||
|
delete actionsDoc.actions[rowActionId].permissions.views[viewId]
|
||||||
|
return actionsDoc
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function remove(tableId: string, rowActionId: string) {
|
||||||
|
return await updateDoc(tableId, rowActionId, async actionsDoc => {
|
||||||
|
const { automationId } = actionsDoc.actions[rowActionId]
|
||||||
|
const automation = await automations.get(automationId)
|
||||||
|
await automations.remove(automation._id, automation._rev)
|
||||||
|
|
||||||
|
delete actionsDoc.actions[rowActionId]
|
||||||
|
return actionsDoc
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function run(tableId: any, rowActionId: any, rowId: string) {
|
export async function run(tableId: any, rowActionId: any, rowId: string) {
|
||||||
|
@ -154,7 +206,7 @@ export async function run(tableId: any, rowActionId: any, rowId: string) {
|
||||||
throw new HTTPError("Table not found", 404)
|
throw new HTTPError("Table not found", 404)
|
||||||
}
|
}
|
||||||
|
|
||||||
const { actions } = await get(tableId)
|
const { actions } = await getAll(tableId)
|
||||||
|
|
||||||
const rowAction = actions[rowActionId]
|
const rowAction = actions[rowActionId]
|
||||||
if (!rowAction) {
|
if (!rowAction) {
|
||||||
|
|
|
@ -40,6 +40,7 @@ export interface RequestOpts {
|
||||||
>
|
>
|
||||||
expectations?: Expectations
|
expectations?: Expectations
|
||||||
publicUser?: boolean
|
publicUser?: boolean
|
||||||
|
useProdApp?: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
export abstract class TestAPI {
|
export abstract class TestAPI {
|
||||||
|
@ -107,8 +108,12 @@ export abstract class TestAPI {
|
||||||
}
|
}
|
||||||
|
|
||||||
const headersFn = publicUser
|
const headersFn = publicUser
|
||||||
? this.config.publicHeaders.bind(this.config)
|
? (_extras = {}) =>
|
||||||
: this.config.defaultHeaders.bind(this.config)
|
this.config.publicHeaders.bind(this.config)({
|
||||||
|
prodApp: opts?.useProdApp,
|
||||||
|
})
|
||||||
|
: (extras = {}) =>
|
||||||
|
this.config.defaultHeaders.bind(this.config)(extras, opts?.useProdApp)
|
||||||
|
|
||||||
const app = getServer()
|
const app = getServer()
|
||||||
let req = request(app)[method](url)
|
let req = request(app)[method](url)
|
||||||
|
|
|
@ -2,6 +2,7 @@ import {
|
||||||
CreateRowActionRequest,
|
CreateRowActionRequest,
|
||||||
RowActionResponse,
|
RowActionResponse,
|
||||||
RowActionsResponse,
|
RowActionsResponse,
|
||||||
|
RowActionTriggerRequest,
|
||||||
} from "@budibase/types"
|
} from "@budibase/types"
|
||||||
import { Expectations, TestAPI } from "./base"
|
import { Expectations, TestAPI } from "./base"
|
||||||
|
|
||||||
|
@ -17,8 +18,8 @@ export class RowActionAPI extends TestAPI {
|
||||||
{
|
{
|
||||||
body: rowAction,
|
body: rowAction,
|
||||||
expectations: {
|
expectations: {
|
||||||
|
status: 201,
|
||||||
...expectations,
|
...expectations,
|
||||||
status: expectations?.status || 201,
|
|
||||||
},
|
},
|
||||||
...config,
|
...config,
|
||||||
}
|
}
|
||||||
|
@ -70,4 +71,59 @@ export class RowActionAPI extends TestAPI {
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setViewPermission = async (
|
||||||
|
tableId: string,
|
||||||
|
viewId: string,
|
||||||
|
rowActionId: string,
|
||||||
|
expectations?: Expectations,
|
||||||
|
config?: { publicUser?: boolean }
|
||||||
|
) => {
|
||||||
|
return await this._post<RowActionResponse>(
|
||||||
|
`/api/tables/${tableId}/actions/${rowActionId}/permissions/${viewId}`,
|
||||||
|
{
|
||||||
|
expectations: {
|
||||||
|
status: 200,
|
||||||
|
...expectations,
|
||||||
|
},
|
||||||
|
...config,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
unsetViewPermission = async (
|
||||||
|
tableId: string,
|
||||||
|
viewId: string,
|
||||||
|
rowActionId: string,
|
||||||
|
expectations?: Expectations,
|
||||||
|
config?: { publicUser?: boolean }
|
||||||
|
) => {
|
||||||
|
return await this._delete<RowActionResponse>(
|
||||||
|
`/api/tables/${tableId}/actions/${rowActionId}/permissions/${viewId}`,
|
||||||
|
{
|
||||||
|
expectations: {
|
||||||
|
status: 200,
|
||||||
|
...expectations,
|
||||||
|
},
|
||||||
|
...config,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
trigger = async (
|
||||||
|
tableId: string,
|
||||||
|
rowActionId: string,
|
||||||
|
body: RowActionTriggerRequest,
|
||||||
|
expectations?: Expectations,
|
||||||
|
config?: { publicUser?: boolean; useProdApp?: boolean }
|
||||||
|
) => {
|
||||||
|
return await this._post<RowActionResponse>(
|
||||||
|
`/api/tables/${tableId}/actions/${rowActionId}/trigger`,
|
||||||
|
{
|
||||||
|
body,
|
||||||
|
expectations,
|
||||||
|
...{ ...config, useProdApp: config?.useProdApp ?? true },
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -30,6 +30,7 @@ import {
|
||||||
BBReferenceFieldSubType,
|
BBReferenceFieldSubType,
|
||||||
JsonFieldSubType,
|
JsonFieldSubType,
|
||||||
AutoFieldSubType,
|
AutoFieldSubType,
|
||||||
|
CreateViewRequest,
|
||||||
} from "@budibase/types"
|
} from "@budibase/types"
|
||||||
import { LoopInput } from "../../definitions/automations"
|
import { LoopInput } from "../../definitions/automations"
|
||||||
import { merge } from "lodash"
|
import { merge } from "lodash"
|
||||||
|
@ -145,6 +146,17 @@ export function view(tableId: string) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function viewV2CreateRequest(tableId: string): CreateViewRequest {
|
||||||
|
return {
|
||||||
|
tableId,
|
||||||
|
name: generator.guid(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const viewV2 = {
|
||||||
|
createRequest: viewV2CreateRequest,
|
||||||
|
}
|
||||||
|
|
||||||
export function automationStep(
|
export function automationStep(
|
||||||
actionDefinition = BUILTIN_ACTION_DEFINITIONS.CREATE_ROW
|
actionDefinition = BUILTIN_ACTION_DEFINITIONS.CREATE_ROW
|
||||||
): AutomationStep {
|
): AutomationStep {
|
||||||
|
|
|
@ -8,7 +8,7 @@ import {
|
||||||
import * as actions from "../automations/actions"
|
import * as actions from "../automations/actions"
|
||||||
import * as automationUtils from "../automations/automationUtils"
|
import * as automationUtils from "../automations/automationUtils"
|
||||||
import { replaceFakeBindings } from "../automations/loopUtils"
|
import { replaceFakeBindings } from "../automations/loopUtils"
|
||||||
|
import { dataFilters, helpers } from "@budibase/shared-core"
|
||||||
import { default as AutomationEmitter } from "../events/AutomationEmitter"
|
import { default as AutomationEmitter } from "../events/AutomationEmitter"
|
||||||
import { generateAutomationMetadataID, isProdAppID } from "../db/utils"
|
import { generateAutomationMetadataID, isProdAppID } from "../db/utils"
|
||||||
import { definitions as triggerDefs } from "../automations/triggerInfo"
|
import { definitions as triggerDefs } from "../automations/triggerInfo"
|
||||||
|
@ -23,12 +23,14 @@ import {
|
||||||
AutomationStatus,
|
AutomationStatus,
|
||||||
AutomationStep,
|
AutomationStep,
|
||||||
AutomationStepStatus,
|
AutomationStepStatus,
|
||||||
|
BranchStep,
|
||||||
LoopStep,
|
LoopStep,
|
||||||
|
SearchFilters,
|
||||||
} from "@budibase/types"
|
} from "@budibase/types"
|
||||||
import { AutomationContext, TriggerOutput } from "../definitions/automations"
|
import { AutomationContext, TriggerOutput } from "../definitions/automations"
|
||||||
import { WorkerCallback } from "./definitions"
|
import { WorkerCallback } from "./definitions"
|
||||||
import { context, logging } from "@budibase/backend-core"
|
import { context, logging } from "@budibase/backend-core"
|
||||||
import { processObject } from "@budibase/string-templates"
|
import { processObject, processStringSync } from "@budibase/string-templates"
|
||||||
import { cloneDeep } from "lodash/fp"
|
import { cloneDeep } from "lodash/fp"
|
||||||
import { performance } from "perf_hooks"
|
import { performance } from "perf_hooks"
|
||||||
import * as sdkUtils from "../sdk/utils"
|
import * as sdkUtils from "../sdk/utils"
|
||||||
|
@ -64,36 +66,40 @@ function getLoopIterations(loopStep: LoopStep) {
|
||||||
* inputs and handles any outputs.
|
* inputs and handles any outputs.
|
||||||
*/
|
*/
|
||||||
class Orchestrator {
|
class Orchestrator {
|
||||||
_chainCount: number
|
private chainCount: number
|
||||||
_appId: string
|
private appId: string
|
||||||
_automation: Automation
|
private automation: Automation
|
||||||
_emitter: any
|
private emitter: any
|
||||||
_context: AutomationContext
|
private context: AutomationContext
|
||||||
_job: Job
|
private job: Job
|
||||||
executionOutput: AutomationContext
|
private loopStepOutputs: LoopStep[]
|
||||||
|
private stopped: boolean
|
||||||
|
private executionOutput: AutomationContext
|
||||||
|
|
||||||
constructor(job: AutomationJob) {
|
constructor(job: AutomationJob) {
|
||||||
let automation = job.data.automation
|
let automation = job.data.automation
|
||||||
let triggerOutput = job.data.event
|
let triggerOutput = job.data.event
|
||||||
const metadata = triggerOutput.metadata
|
const metadata = triggerOutput.metadata
|
||||||
this._chainCount = metadata ? metadata.automationChainCount! : 0
|
this.chainCount = metadata ? metadata.automationChainCount! : 0
|
||||||
this._appId = triggerOutput.appId as string
|
this.appId = triggerOutput.appId as string
|
||||||
this._job = job
|
this.job = job
|
||||||
const triggerStepId = automation.definition.trigger.stepId
|
const triggerStepId = automation.definition.trigger.stepId
|
||||||
triggerOutput = this.cleanupTriggerOutputs(triggerStepId, triggerOutput)
|
triggerOutput = this.cleanupTriggerOutputs(triggerStepId, triggerOutput)
|
||||||
// remove from context
|
// remove from context
|
||||||
delete triggerOutput.appId
|
delete triggerOutput.appId
|
||||||
delete triggerOutput.metadata
|
delete triggerOutput.metadata
|
||||||
// step zero is never used as the template string is zero indexed for customer facing
|
// step zero is never used as the template string is zero indexed for customer facing
|
||||||
this._context = { steps: [{}], trigger: triggerOutput }
|
this.context = { steps: [{}], trigger: triggerOutput }
|
||||||
this._automation = automation
|
this.automation = automation
|
||||||
// create an emitter which has the chain count for this automation run in it, so it can block
|
// create an emitter which has the chain count for this automation run in it, so it can block
|
||||||
// excessive chaining if required
|
// excessive chaining if required
|
||||||
this._emitter = new AutomationEmitter(this._chainCount + 1)
|
this.emitter = new AutomationEmitter(this.chainCount + 1)
|
||||||
this.executionOutput = { trigger: {}, steps: [] }
|
this.executionOutput = { trigger: {}, steps: [] }
|
||||||
// setup the execution output
|
// setup the execution output
|
||||||
const triggerId = automation.definition.trigger.id
|
const triggerId = automation.definition.trigger.id
|
||||||
this.updateExecutionOutput(triggerId, triggerStepId, null, triggerOutput)
|
this.updateExecutionOutput(triggerId, triggerStepId, null, triggerOutput)
|
||||||
|
this.loopStepOutputs = []
|
||||||
|
this.stopped = false
|
||||||
}
|
}
|
||||||
|
|
||||||
cleanupTriggerOutputs(stepId: string, triggerOutput: TriggerOutput) {
|
cleanupTriggerOutputs(stepId: string, triggerOutput: TriggerOutput) {
|
||||||
|
@ -112,7 +118,7 @@ class Orchestrator {
|
||||||
}
|
}
|
||||||
|
|
||||||
async getMetadata(): Promise<AutomationMetadata> {
|
async getMetadata(): Promise<AutomationMetadata> {
|
||||||
const metadataId = generateAutomationMetadataID(this._automation._id!)
|
const metadataId = generateAutomationMetadataID(this.automation._id!)
|
||||||
const db = context.getAppDB()
|
const db = context.getAppDB()
|
||||||
let metadata: AutomationMetadata
|
let metadata: AutomationMetadata
|
||||||
try {
|
try {
|
||||||
|
@ -127,15 +133,15 @@ class Orchestrator {
|
||||||
}
|
}
|
||||||
|
|
||||||
async stopCron(reason: string) {
|
async stopCron(reason: string) {
|
||||||
if (!this._job.opts.repeat) {
|
if (!this.job.opts.repeat) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
logging.logWarn(
|
logging.logWarn(
|
||||||
`CRON disabled reason=${reason} - ${this._appId}/${this._automation._id}`
|
`CRON disabled reason=${reason} - ${this.appId}/${this.automation._id}`
|
||||||
)
|
)
|
||||||
const automation = this._automation
|
const automation = this.automation
|
||||||
const trigger = automation.definition.trigger
|
const trigger = automation.definition.trigger
|
||||||
await disableCronById(this._job.id)
|
await disableCronById(this.job.id)
|
||||||
this.updateExecutionOutput(
|
this.updateExecutionOutput(
|
||||||
trigger.id,
|
trigger.id,
|
||||||
trigger.stepId,
|
trigger.stepId,
|
||||||
|
@ -149,7 +155,7 @@ class Orchestrator {
|
||||||
}
|
}
|
||||||
|
|
||||||
async checkIfShouldStop(metadata: AutomationMetadata): Promise<boolean> {
|
async checkIfShouldStop(metadata: AutomationMetadata): Promise<boolean> {
|
||||||
if (!metadata.errorCount || !this._job.opts.repeat) {
|
if (!metadata.errorCount || !this.job.opts.repeat) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
if (metadata.errorCount >= MAX_AUTOMATION_RECURRING_ERRORS) {
|
if (metadata.errorCount >= MAX_AUTOMATION_RECURRING_ERRORS) {
|
||||||
|
@ -161,7 +167,7 @@ class Orchestrator {
|
||||||
|
|
||||||
async updateMetadata(metadata: AutomationMetadata) {
|
async updateMetadata(metadata: AutomationMetadata) {
|
||||||
const output = this.executionOutput,
|
const output = this.executionOutput,
|
||||||
automation = this._automation
|
automation = this.automation
|
||||||
if (!output || !isRecurring(automation)) {
|
if (!output || !isRecurring(automation)) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -216,7 +222,7 @@ class Orchestrator {
|
||||||
output: any,
|
output: any,
|
||||||
result: { success: boolean; status: string }
|
result: { success: boolean; status: string }
|
||||||
) {
|
) {
|
||||||
if (!currentLoopStepIndex) {
|
if (currentLoopStepIndex === undefined) {
|
||||||
throw new Error("No loop step number provided.")
|
throw new Error("No loop step number provided.")
|
||||||
}
|
}
|
||||||
this.executionOutput.steps.splice(currentLoopStepIndex, 0, {
|
this.executionOutput.steps.splice(currentLoopStepIndex, 0, {
|
||||||
|
@ -229,7 +235,7 @@ class Orchestrator {
|
||||||
},
|
},
|
||||||
inputs: step.inputs,
|
inputs: step.inputs,
|
||||||
})
|
})
|
||||||
this._context.steps.splice(currentLoopStepIndex, 0, {
|
this.context.steps.splice(currentLoopStepIndex, 0, {
|
||||||
...output,
|
...output,
|
||||||
success: result.success,
|
success: result.success,
|
||||||
status: result.status,
|
status: result.status,
|
||||||
|
@ -242,25 +248,15 @@ class Orchestrator {
|
||||||
{ resource: "automation" },
|
{ resource: "automation" },
|
||||||
async span => {
|
async span => {
|
||||||
span?.addTags({
|
span?.addTags({
|
||||||
appId: this._appId,
|
appId: this.appId,
|
||||||
automationId: this._automation._id,
|
automationId: this.automation._id,
|
||||||
})
|
})
|
||||||
|
this.context.env = await sdkUtils.getEnvironmentVariables()
|
||||||
|
|
||||||
// this will retrieve from context created at start of thread
|
|
||||||
this._context.env = await sdkUtils.getEnvironmentVariables()
|
|
||||||
let automation = this._automation
|
|
||||||
let stopped = false
|
|
||||||
let loopStep: LoopStep | undefined
|
|
||||||
|
|
||||||
let stepCount = 0
|
|
||||||
let currentLoopStepIndex: number = 0
|
|
||||||
let loopSteps: LoopStep[] | undefined = []
|
|
||||||
let metadata
|
let metadata
|
||||||
let timeoutFlag = false
|
|
||||||
let wasLoopStep = false
|
|
||||||
let timeout = this._job.data.event.timeout
|
|
||||||
// check if this is a recurring automation,
|
// check if this is a recurring automation,
|
||||||
if (isProdAppID(this._appId) && isRecurring(automation)) {
|
if (isProdAppID(this.appId) && isRecurring(this.automation)) {
|
||||||
span?.addTags({ recurring: true })
|
span?.addTags({ recurring: true })
|
||||||
metadata = await this.getMetadata()
|
metadata = await this.getMetadata()
|
||||||
const shouldStop = await this.checkIfShouldStop(metadata)
|
const shouldStop = await this.checkIfShouldStop(metadata)
|
||||||
|
@ -270,11 +266,241 @@ class Orchestrator {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const start = performance.now()
|
const start = performance.now()
|
||||||
for (const step of automation.definition.steps) {
|
|
||||||
const stepSpan = tracer.startSpan("Orchestrator.execute.step", {
|
await this.executeSteps(this.automation.definition.steps)
|
||||||
childOf: span,
|
|
||||||
|
const end = performance.now()
|
||||||
|
const executionTime = end - start
|
||||||
|
|
||||||
|
console.info(
|
||||||
|
`Automation ID: ${this.automation._id} Execution time: ${executionTime} milliseconds`,
|
||||||
|
{
|
||||||
|
_logKey: "automation",
|
||||||
|
executionTime,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
try {
|
||||||
|
await storeLog(this.automation, this.executionOutput)
|
||||||
|
} catch (e: any) {
|
||||||
|
if (e.status === 413 && e.request?.data) {
|
||||||
|
// if content is too large we shouldn't log it
|
||||||
|
delete e.request.data
|
||||||
|
e.request.data = { message: "removed due to large size" }
|
||||||
|
}
|
||||||
|
logging.logAlert("Error writing automation log", e)
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
isProdAppID(this.appId) &&
|
||||||
|
isRecurring(this.automation) &&
|
||||||
|
metadata
|
||||||
|
) {
|
||||||
|
await this.updateMetadata(metadata)
|
||||||
|
}
|
||||||
|
return this.executionOutput
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private async executeSteps(steps: AutomationStep[]): Promise<void> {
|
||||||
|
return tracer.trace(
|
||||||
|
"Orchestrator.executeSteps",
|
||||||
|
{ resource: "automation" },
|
||||||
|
async span => {
|
||||||
|
let stepIndex = 0
|
||||||
|
const timeout =
|
||||||
|
this.job.data.event.timeout || env.AUTOMATION_THREAD_TIMEOUT
|
||||||
|
|
||||||
|
try {
|
||||||
|
await helpers.withTimeout(
|
||||||
|
timeout,
|
||||||
|
(async () => {
|
||||||
|
while (stepIndex < steps.length) {
|
||||||
|
const step = steps[stepIndex]
|
||||||
|
if (step.stepId === AutomationActionStepId.BRANCH) {
|
||||||
|
await this.executeBranchStep(step)
|
||||||
|
stepIndex++
|
||||||
|
} else if (step.stepId === AutomationActionStepId.LOOP) {
|
||||||
|
stepIndex = await this.executeLoopStep(step, steps, stepIndex)
|
||||||
|
} else {
|
||||||
|
await this.executeStep(step)
|
||||||
|
stepIndex++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})()
|
||||||
|
)
|
||||||
|
} catch (error: any) {
|
||||||
|
if (error.errno === "ETIME") {
|
||||||
|
span?.addTags({ timedOut: true })
|
||||||
|
console.warn(`Automation execution timed out after ${timeout}ms`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private async executeLoopStep(
|
||||||
|
loopStep: LoopStep,
|
||||||
|
steps: AutomationStep[],
|
||||||
|
currentIndex: number
|
||||||
|
): Promise<number> {
|
||||||
|
await processObject(loopStep.inputs, this.context)
|
||||||
|
const iterations = getLoopIterations(loopStep)
|
||||||
|
let stepToLoopIndex = currentIndex + 1
|
||||||
|
let iterationCount = 0
|
||||||
|
let shouldCleanup = true
|
||||||
|
|
||||||
|
for (let loopStepIndex = 0; loopStepIndex < iterations; loopStepIndex++) {
|
||||||
|
try {
|
||||||
|
loopStep.inputs.binding = automationUtils.typecastForLooping(
|
||||||
|
loopStep.inputs
|
||||||
|
)
|
||||||
|
} catch (err) {
|
||||||
|
this.updateContextAndOutput(
|
||||||
|
stepToLoopIndex,
|
||||||
|
steps[stepToLoopIndex],
|
||||||
|
{},
|
||||||
|
{
|
||||||
|
status: AutomationErrors.INCORRECT_TYPE,
|
||||||
|
success: false,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
shouldCleanup = false
|
||||||
|
break
|
||||||
|
}
|
||||||
|
const maxIterations = automationUtils.ensureMaxIterationsAsNumber(
|
||||||
|
loopStep.inputs.iterations
|
||||||
|
)
|
||||||
|
|
||||||
|
if (
|
||||||
|
loopStepIndex === env.AUTOMATION_MAX_ITERATIONS ||
|
||||||
|
(loopStep.inputs.iterations && loopStepIndex === maxIterations)
|
||||||
|
) {
|
||||||
|
this.updateContextAndOutput(
|
||||||
|
stepToLoopIndex,
|
||||||
|
steps[stepToLoopIndex],
|
||||||
|
{
|
||||||
|
items: this.loopStepOutputs,
|
||||||
|
iterations: loopStepIndex,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
status: AutomationErrors.MAX_ITERATIONS,
|
||||||
|
success: true,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
shouldCleanup = false
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
let isFailure = false
|
||||||
|
const currentItem = this.getCurrentLoopItem(loopStep, loopStepIndex)
|
||||||
|
if (currentItem && typeof currentItem === "object") {
|
||||||
|
isFailure = Object.keys(currentItem).some(value => {
|
||||||
|
return currentItem[value] === loopStep?.inputs.failure
|
||||||
})
|
})
|
||||||
stepSpan.addTags({
|
} else {
|
||||||
|
isFailure = currentItem && currentItem === loopStep.inputs.failure
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isFailure) {
|
||||||
|
this.updateContextAndOutput(
|
||||||
|
loopStepIndex,
|
||||||
|
steps[stepToLoopIndex],
|
||||||
|
{
|
||||||
|
items: this.loopStepOutputs,
|
||||||
|
iterations: loopStepIndex,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
status: AutomationErrors.FAILURE_CONDITION,
|
||||||
|
success: false,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
shouldCleanup = false
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
this.context.steps[currentIndex + 1] = {
|
||||||
|
currentItem: this.getCurrentLoopItem(loopStep, loopStepIndex),
|
||||||
|
}
|
||||||
|
|
||||||
|
stepToLoopIndex = currentIndex + 1
|
||||||
|
|
||||||
|
await this.executeStep(steps[stepToLoopIndex], stepToLoopIndex)
|
||||||
|
iterationCount++
|
||||||
|
}
|
||||||
|
|
||||||
|
if (shouldCleanup) {
|
||||||
|
let tempOutput =
|
||||||
|
iterations === 0
|
||||||
|
? {
|
||||||
|
status: AutomationStepStatus.NO_ITERATIONS,
|
||||||
|
success: true,
|
||||||
|
}
|
||||||
|
: {
|
||||||
|
success: true,
|
||||||
|
items: this.loopStepOutputs,
|
||||||
|
iterations: iterationCount,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Loop Step clean up
|
||||||
|
this.executionOutput.steps.splice(currentIndex + 1, 0, {
|
||||||
|
id: steps[stepToLoopIndex].id,
|
||||||
|
stepId: steps[stepToLoopIndex].stepId,
|
||||||
|
outputs: tempOutput,
|
||||||
|
inputs: steps[stepToLoopIndex].inputs,
|
||||||
|
})
|
||||||
|
this.context.steps[currentIndex + 1] = tempOutput
|
||||||
|
this.loopStepOutputs = []
|
||||||
|
}
|
||||||
|
|
||||||
|
return stepToLoopIndex + 1
|
||||||
|
}
|
||||||
|
private async executeBranchStep(branchStep: BranchStep): Promise<void> {
|
||||||
|
const { branches, children } = branchStep.inputs
|
||||||
|
|
||||||
|
for (const branch of branches) {
|
||||||
|
const condition = await this.evaluateBranchCondition(branch.condition)
|
||||||
|
if (condition) {
|
||||||
|
const branchSteps = children?.[branch.name] || []
|
||||||
|
await this.executeSteps(branchSteps)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private async evaluateBranchCondition(
|
||||||
|
conditions: SearchFilters
|
||||||
|
): Promise<boolean> {
|
||||||
|
const toFilter: Record<string, any> = {}
|
||||||
|
|
||||||
|
const processedConditions = dataFilters.recurseSearchFilters(
|
||||||
|
conditions,
|
||||||
|
filter => {
|
||||||
|
Object.entries(filter).forEach(([_, value]) => {
|
||||||
|
Object.entries(value).forEach(([field, _]) => {
|
||||||
|
const fromContext = processStringSync(
|
||||||
|
`{{ literal ${field} }}`,
|
||||||
|
this.context
|
||||||
|
)
|
||||||
|
toFilter[field] = fromContext
|
||||||
|
})
|
||||||
|
})
|
||||||
|
return filter
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
const result = dataFilters.runQuery([toFilter], processedConditions)
|
||||||
|
return result.length > 0
|
||||||
|
}
|
||||||
|
private async executeStep(
|
||||||
|
step: AutomationStep,
|
||||||
|
loopIteration?: number
|
||||||
|
): Promise<void> {
|
||||||
|
return tracer.trace(
|
||||||
|
"Orchestrator.execute.step",
|
||||||
|
{ resource: "automation" },
|
||||||
|
async span => {
|
||||||
|
span?.addTags({
|
||||||
resource: "automation",
|
resource: "automation",
|
||||||
step: {
|
step: {
|
||||||
stepId: step.stepId,
|
stepId: step.stepId,
|
||||||
|
@ -287,269 +513,64 @@ class Orchestrator {
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|
||||||
let input,
|
if (this.stopped) {
|
||||||
iterations = 1,
|
this.updateExecutionOutput(step.id, step.stepId, {}, STOPPED_STATUS)
|
||||||
iterationCount = 0
|
return
|
||||||
|
|
||||||
try {
|
|
||||||
if (timeoutFlag) {
|
|
||||||
span?.addTags({ timedOut: true })
|
|
||||||
break
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (timeout) {
|
|
||||||
setTimeout(() => {
|
|
||||||
timeoutFlag = true
|
|
||||||
}, timeout || env.AUTOMATION_THREAD_TIMEOUT)
|
|
||||||
}
|
|
||||||
|
|
||||||
stepCount++
|
|
||||||
if (step.stepId === AutomationActionStepId.LOOP) {
|
|
||||||
loopStep = step
|
|
||||||
currentLoopStepIndex = stepCount
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if (loopStep) {
|
|
||||||
input = await processObject(loopStep.inputs, this._context)
|
|
||||||
iterations = getLoopIterations(loopStep)
|
|
||||||
stepSpan?.addTags({ step: { iterations } })
|
|
||||||
}
|
|
||||||
|
|
||||||
for (let stepIndex = 0; stepIndex < iterations; stepIndex++) {
|
|
||||||
let originalStepInput = cloneDeep(step.inputs)
|
let originalStepInput = cloneDeep(step.inputs)
|
||||||
if (loopStep && input?.binding) {
|
if (loopIteration !== undefined) {
|
||||||
let tempOutput = {
|
originalStepInput = replaceFakeBindings(
|
||||||
items: loopSteps,
|
originalStepInput,
|
||||||
iterations: iterationCount,
|
loopIteration
|
||||||
}
|
|
||||||
try {
|
|
||||||
loopStep.inputs.binding = automationUtils.typecastForLooping(
|
|
||||||
loopStep.inputs
|
|
||||||
)
|
)
|
||||||
} catch (err) {
|
}
|
||||||
this.updateContextAndOutput(
|
const stepFn = await this.getStepFunctionality(step.stepId)
|
||||||
currentLoopStepIndex,
|
let inputs = await processObject(originalStepInput, this.context)
|
||||||
step,
|
inputs = automationUtils.cleanInputValues(inputs, step.schema.inputs)
|
||||||
tempOutput,
|
|
||||||
{
|
const outputs = await stepFn({
|
||||||
status: AutomationErrors.INCORRECT_TYPE,
|
inputs: inputs,
|
||||||
success: false,
|
appId: this.appId,
|
||||||
|
emitter: this.emitter,
|
||||||
|
context: this.context,
|
||||||
|
})
|
||||||
|
this.handleStepOutput(step, outputs, loopIteration)
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
loopSteps = undefined
|
|
||||||
loopStep = undefined
|
|
||||||
break
|
|
||||||
}
|
}
|
||||||
let item: any[] = []
|
|
||||||
|
private getCurrentLoopItem(loopStep: LoopStep, index: number): any {
|
||||||
|
if (!loopStep) return null
|
||||||
if (
|
if (
|
||||||
typeof loopStep.inputs.binding === "string" &&
|
typeof loopStep.inputs.binding === "string" &&
|
||||||
loopStep.inputs.option === "String"
|
loopStep.inputs.option === "String"
|
||||||
) {
|
) {
|
||||||
item = automationUtils.stringSplit(loopStep.inputs.binding)
|
return automationUtils.stringSplit(loopStep.inputs.binding)[index]
|
||||||
} else if (Array.isArray(loopStep.inputs.binding)) {
|
} else if (Array.isArray(loopStep.inputs.binding)) {
|
||||||
item = loopStep.inputs.binding
|
return loopStep.inputs.binding[index]
|
||||||
}
|
}
|
||||||
this._context.steps[currentLoopStepIndex] = {
|
return null
|
||||||
currentItem: item[stepIndex],
|
|
||||||
}
|
}
|
||||||
|
|
||||||
originalStepInput = replaceFakeBindings(
|
private handleStepOutput(
|
||||||
originalStepInput,
|
step: AutomationStep,
|
||||||
currentLoopStepIndex
|
outputs: any,
|
||||||
)
|
loopIteration: number | undefined
|
||||||
|
): void {
|
||||||
if (
|
if (step.stepId === AutomationActionStepId.FILTER && !outputs.result) {
|
||||||
stepIndex === env.AUTOMATION_MAX_ITERATIONS ||
|
this.stopped = true
|
||||||
(loopStep.inputs.iterations &&
|
this.updateExecutionOutput(step.id, step.stepId, step.inputs, {
|
||||||
stepIndex === loopStep.inputs.iterations)
|
|
||||||
) {
|
|
||||||
this.updateContextAndOutput(
|
|
||||||
currentLoopStepIndex,
|
|
||||||
step,
|
|
||||||
tempOutput,
|
|
||||||
{
|
|
||||||
status: AutomationErrors.MAX_ITERATIONS,
|
|
||||||
success: true,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
loopSteps = undefined
|
|
||||||
loopStep = undefined
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
let isFailure = false
|
|
||||||
const currentItem =
|
|
||||||
this._context.steps[currentLoopStepIndex]?.currentItem
|
|
||||||
if (currentItem && typeof currentItem === "object") {
|
|
||||||
isFailure = Object.keys(currentItem).some(value => {
|
|
||||||
return currentItem[value] === loopStep?.inputs.failure
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
isFailure =
|
|
||||||
currentItem && currentItem === loopStep.inputs.failure
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isFailure) {
|
|
||||||
this.updateContextAndOutput(
|
|
||||||
currentLoopStepIndex,
|
|
||||||
step,
|
|
||||||
tempOutput,
|
|
||||||
{
|
|
||||||
status: AutomationErrors.FAILURE_CONDITION,
|
|
||||||
success: false,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
loopSteps = undefined
|
|
||||||
loopStep = undefined
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// execution stopped, record state for that
|
|
||||||
if (stopped) {
|
|
||||||
this.updateExecutionOutput(
|
|
||||||
step.id,
|
|
||||||
step.stepId,
|
|
||||||
{},
|
|
||||||
STOPPED_STATUS
|
|
||||||
)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
let stepFn = await this.getStepFunctionality(
|
|
||||||
step.stepId as AutomationActionStepId
|
|
||||||
)
|
|
||||||
let inputs = await processObject(originalStepInput, this._context)
|
|
||||||
inputs = automationUtils.cleanInputValues(
|
|
||||||
inputs,
|
|
||||||
step.schema.inputs
|
|
||||||
)
|
|
||||||
try {
|
|
||||||
// appId is always passed
|
|
||||||
const outputs = await stepFn({
|
|
||||||
inputs: inputs,
|
|
||||||
appId: this._appId,
|
|
||||||
emitter: this._emitter,
|
|
||||||
context: this._context,
|
|
||||||
})
|
|
||||||
|
|
||||||
this._context.steps[stepCount] = outputs
|
|
||||||
// if filter causes us to stop execution don't break the loop, set a var
|
|
||||||
// so that we can finish iterating through the steps and record that it stopped
|
|
||||||
if (
|
|
||||||
step.stepId === AutomationActionStepId.FILTER &&
|
|
||||||
!outputs.result
|
|
||||||
) {
|
|
||||||
stopped = true
|
|
||||||
this.updateExecutionOutput(
|
|
||||||
step.id,
|
|
||||||
step.stepId,
|
|
||||||
step.inputs,
|
|
||||||
{
|
|
||||||
...outputs,
|
...outputs,
|
||||||
...STOPPED_STATUS,
|
...STOPPED_STATUS,
|
||||||
}
|
})
|
||||||
)
|
} else if (loopIteration !== undefined) {
|
||||||
continue
|
this.loopStepOutputs = this.loopStepOutputs || []
|
||||||
}
|
this.loopStepOutputs.push(outputs)
|
||||||
if (loopStep && loopSteps) {
|
|
||||||
loopSteps.push(outputs)
|
|
||||||
} else {
|
} else {
|
||||||
this.updateExecutionOutput(
|
this.updateExecutionOutput(step.id, step.stepId, step.inputs, outputs)
|
||||||
step.id,
|
|
||||||
step.stepId,
|
|
||||||
step.inputs,
|
|
||||||
outputs
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
} catch (err) {
|
this.context.steps[this.context.steps.length] = outputs
|
||||||
console.error(`Automation error - ${step.stepId} - ${err}`)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if (loopStep) {
|
|
||||||
iterationCount++
|
|
||||||
if (stepIndex === iterations - 1) {
|
|
||||||
loopStep = undefined
|
|
||||||
this._context.steps.splice(currentLoopStepIndex, 1)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
stepSpan?.finish()
|
|
||||||
}
|
|
||||||
|
|
||||||
if (loopStep && iterations === 0) {
|
|
||||||
loopStep = undefined
|
|
||||||
this.executionOutput.steps.splice(currentLoopStepIndex + 1, 0, {
|
|
||||||
id: step.id,
|
|
||||||
stepId: step.stepId,
|
|
||||||
outputs: {
|
|
||||||
status: AutomationStepStatus.NO_ITERATIONS,
|
|
||||||
success: true,
|
|
||||||
},
|
|
||||||
inputs: {},
|
|
||||||
})
|
|
||||||
|
|
||||||
this._context.steps.splice(currentLoopStepIndex, 1)
|
|
||||||
iterations = 1
|
|
||||||
}
|
|
||||||
|
|
||||||
// Delete the step after the loop step as it's irrelevant, since information is included
|
|
||||||
// in the loop step
|
|
||||||
if (wasLoopStep && !loopStep) {
|
|
||||||
this._context.steps.splice(currentLoopStepIndex + 1, 1)
|
|
||||||
wasLoopStep = false
|
|
||||||
}
|
|
||||||
if (loopSteps && loopSteps.length) {
|
|
||||||
let tempOutput = {
|
|
||||||
success: true,
|
|
||||||
items: loopSteps,
|
|
||||||
iterations: iterationCount,
|
|
||||||
}
|
|
||||||
this.executionOutput.steps.splice(currentLoopStepIndex + 1, 0, {
|
|
||||||
id: step.id,
|
|
||||||
stepId: step.stepId,
|
|
||||||
outputs: tempOutput,
|
|
||||||
inputs: step.inputs,
|
|
||||||
})
|
|
||||||
this._context.steps[currentLoopStepIndex] = tempOutput
|
|
||||||
|
|
||||||
wasLoopStep = true
|
|
||||||
loopSteps = []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const end = performance.now()
|
|
||||||
const executionTime = end - start
|
|
||||||
|
|
||||||
console.info(
|
|
||||||
`Automation ID: ${automation._id} Execution time: ${executionTime} milliseconds`,
|
|
||||||
{
|
|
||||||
_logKey: "automation",
|
|
||||||
executionTime,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
// store the logs for the automation run
|
|
||||||
try {
|
|
||||||
await storeLog(this._automation, this.executionOutput)
|
|
||||||
} catch (e: any) {
|
|
||||||
if (e.status === 413 && e.request?.data) {
|
|
||||||
// if content is too large we shouldn't log it
|
|
||||||
delete e.request.data
|
|
||||||
e.request.data = { message: "removed due to large size" }
|
|
||||||
}
|
|
||||||
logging.logAlert("Error writing automation log", e)
|
|
||||||
}
|
|
||||||
if (isProdAppID(this._appId) && isRecurring(automation) && metadata) {
|
|
||||||
await this.updateMetadata(metadata)
|
|
||||||
}
|
|
||||||
return this.executionOutput
|
|
||||||
}
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -127,6 +127,25 @@ export function recurseLogicalOperators(
|
||||||
return filters
|
return filters
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function recurseSearchFilters(
|
||||||
|
filters: SearchFilters,
|
||||||
|
processFn: (filter: SearchFilters) => SearchFilters
|
||||||
|
): SearchFilters {
|
||||||
|
// Process the current level
|
||||||
|
filters = processFn(filters)
|
||||||
|
|
||||||
|
// Recurse through logical operators
|
||||||
|
for (const logical of Object.values(LogicalOperator)) {
|
||||||
|
if (filters[logical]) {
|
||||||
|
filters[logical]!.conditions = filters[logical]!.conditions.map(
|
||||||
|
condition => recurseSearchFilters(condition, processFn)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return filters
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes any fields that contain empty strings that would cause inconsistent
|
* Removes any fields that contain empty strings that would cause inconsistent
|
||||||
* behaviour with how backend tables are filtered (no value means no filter).
|
* behaviour with how backend tables are filtered (no value means no filter).
|
||||||
|
|
|
@ -83,3 +83,32 @@ export const getUserLabel = (user: User) => {
|
||||||
return email
|
return email
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function cancelableTimeout(
|
||||||
|
timeout: number
|
||||||
|
): [Promise<unknown>, () => void] {
|
||||||
|
let timeoutId: NodeJS.Timeout
|
||||||
|
return [
|
||||||
|
new Promise((resolve, reject) => {
|
||||||
|
timeoutId = setTimeout(() => {
|
||||||
|
reject({
|
||||||
|
status: 301,
|
||||||
|
errno: "ETIME",
|
||||||
|
})
|
||||||
|
}, timeout)
|
||||||
|
}),
|
||||||
|
() => {
|
||||||
|
clearTimeout(timeoutId)
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function withTimeout<T>(
|
||||||
|
timeout: number,
|
||||||
|
promise: Promise<T>
|
||||||
|
): Promise<T> {
|
||||||
|
const [timeoutPromise, cancel] = cancelableTimeout(timeout)
|
||||||
|
const result = (await Promise.race([promise, timeoutPromise])) as T
|
||||||
|
cancel()
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
|
@ -8,6 +8,7 @@ export interface RowActionResponse extends RowActionData {
|
||||||
id: string
|
id: string
|
||||||
tableId: string
|
tableId: string
|
||||||
automationId: string
|
automationId: string
|
||||||
|
allowedViews: string[] | undefined
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RowActionsResponse {
|
export interface RowActionsResponse {
|
||||||
|
|
|
@ -2,11 +2,14 @@ import { Document } from "../document"
|
||||||
|
|
||||||
export interface TableRowActions extends Document {
|
export interface TableRowActions extends Document {
|
||||||
_id: string
|
_id: string
|
||||||
actions: Record<
|
actions: Record<string, RowActionData>
|
||||||
string,
|
}
|
||||||
{
|
|
||||||
|
export interface RowActionData {
|
||||||
name: string
|
name: string
|
||||||
automationId: string
|
automationId: string
|
||||||
|
permissions: {
|
||||||
|
table: { runAllowed: boolean }
|
||||||
|
views: Record<string, { runAllowed: boolean }>
|
||||||
}
|
}
|
||||||
>
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -2,6 +2,8 @@ jest.unmock("node-fetch")
|
||||||
import { TestConfiguration } from "../../../../tests"
|
import { TestConfiguration } from "../../../../tests"
|
||||||
import { EmailTemplatePurpose } from "../../../../constants"
|
import { EmailTemplatePurpose } from "../../../../constants"
|
||||||
import { objectStore } from "@budibase/backend-core"
|
import { objectStore } from "@budibase/backend-core"
|
||||||
|
import { helpers } from "@budibase/shared-core"
|
||||||
|
|
||||||
import tk from "timekeeper"
|
import tk from "timekeeper"
|
||||||
import { EmailAttachment } from "@budibase/types"
|
import { EmailAttachment } from "@budibase/types"
|
||||||
|
|
||||||
|
@ -12,33 +14,6 @@ const nodemailer = require("nodemailer")
|
||||||
// for the real email tests give them a long time to try complete/fail
|
// for the real email tests give them a long time to try complete/fail
|
||||||
jest.setTimeout(30000)
|
jest.setTimeout(30000)
|
||||||
|
|
||||||
function cancelableTimeout(timeout: number): [Promise<unknown>, () => void] {
|
|
||||||
let timeoutId: NodeJS.Timeout
|
|
||||||
return [
|
|
||||||
new Promise((resolve, reject) => {
|
|
||||||
timeoutId = setTimeout(() => {
|
|
||||||
reject({
|
|
||||||
status: 301,
|
|
||||||
errno: "ETIME",
|
|
||||||
})
|
|
||||||
}, timeout)
|
|
||||||
}),
|
|
||||||
() => {
|
|
||||||
clearTimeout(timeoutId)
|
|
||||||
},
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
async function withTimeout<T>(
|
|
||||||
timeout: number,
|
|
||||||
promise: Promise<T>
|
|
||||||
): Promise<T> {
|
|
||||||
const [timeoutPromise, cancel] = cancelableTimeout(timeout)
|
|
||||||
const result = (await Promise.race([promise, timeoutPromise])) as T
|
|
||||||
cancel()
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("/api/global/email", () => {
|
describe("/api/global/email", () => {
|
||||||
const config = new TestConfiguration()
|
const config = new TestConfiguration()
|
||||||
|
|
||||||
|
@ -57,8 +32,8 @@ describe("/api/global/email", () => {
|
||||||
) {
|
) {
|
||||||
let response, text
|
let response, text
|
||||||
try {
|
try {
|
||||||
await withTimeout(20000, config.saveEtherealSmtpConfig())
|
await helpers.withTimeout(20000, config.saveEtherealSmtpConfig())
|
||||||
await withTimeout(20000, config.saveSettingsConfig())
|
await helpers.withTimeout(20000, config.saveSettingsConfig())
|
||||||
let res
|
let res
|
||||||
if (attachments) {
|
if (attachments) {
|
||||||
res = await config.api.emails
|
res = await config.api.emails
|
||||||
|
|
Loading…
Reference in New Issue