Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add run method to webhook triggers #1332

Merged
merged 3 commits into from
Oct 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import Crypto from 'crypto';
import isEmpty from 'lodash/isEmpty';
import defineTrigger from '../../../../helpers/define-trigger';
import webhookFilters from '../../common/webhook-filters';
Expand All @@ -19,6 +20,17 @@ export default defineTrigger({
},
],

async run($) {
const dataItem = {
raw: $.request.body,
meta: {
internalId: Crypto.randomUUID(),
},
};

$.pushTriggerItem(dataItem);
},

async testRun($) {
const lastExecutionStep = await $.getLastExecutionStep();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -19,6 +20,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.confidential_issues_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.confidential_issues_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -19,6 +20,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.confidential_note_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.confidential_note_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.deployment_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.deployment_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.feature_flag_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.feature_flag_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.issues_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.issues_events),
unregisterHook,
Expand Down
2 changes: 2 additions & 0 deletions packages/backend/src/apps/gitlab/triggers/job-event/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -17,6 +18,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.job_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.job_events),
unregisterHook,
Expand Down
11 changes: 11 additions & 0 deletions packages/backend/src/apps/gitlab/triggers/lib.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@ export const projectArgumentDescriptor = {
},
};

export const getRunFn = async ($: IGlobalVariable) => {
const dataItem = {
raw: $.request.body,
meta: {
internalId: Crypto.randomUUID(),
},
};

$.pushTriggerItem(dataItem);
};

export const getTestRunFn =
(eventData: IJSONObject) => ($: IGlobalVariable) => {
/*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.merge_requests_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.merge_requests_events),
unregisterHook,
Expand Down
2 changes: 2 additions & 0 deletions packages/backend/src/apps/gitlab/triggers/note-event/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.note_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.note_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.pipeline_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.pipeline_events),
unregisterHook,
Expand Down
2 changes: 2 additions & 0 deletions packages/backend/src/apps/gitlab/triggers/push-event/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand Down Expand Up @@ -54,6 +55,7 @@ export const triggerDescriptor: IRawTrigger = {
branchFilterStrategyArgumentDescriptor,
pushEventsBranchFilterArgumentDescriptor,
],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.push_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -17,6 +18,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.releases_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.releases_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.tag_push_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.tag_push_events),
unregisterHook,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import defineTrigger from '../../../../helpers/define-trigger';
import { GITLAB_EVENT_TYPE } from '../types';
import {
getRegisterHookFn,
getRunFn,
getTestRunFn,
projectArgumentDescriptor,
unregisterHook,
Expand All @@ -18,6 +19,7 @@ export const triggerDescriptor: IRawTrigger = {
key: GITLAB_EVENT_TYPE.wiki_page_events,
type: 'webhook',
arguments: [projectArgumentDescriptor],
run: ($) => getRunFn($),
testRun: getTestRunFn(data),
registerHook: getRegisterHookFn(GITLAB_EVENT_TYPE.wiki_page_events),
unregisterHook,
Expand Down
12 changes: 12 additions & 0 deletions packages/backend/src/apps/twilio/triggers/receive-sms/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { URLSearchParams } from 'node:url';
import Crypto from 'crypto';
import isEmpty from 'lodash/isEmpty';
import defineTrigger from '../../../../helpers/define-trigger';
import fetchMessages from './fetch-messages';
Expand Down Expand Up @@ -37,6 +38,17 @@ export default defineTrigger({
useSingletonWebhook: true,
singletonWebhookRefValueParameter: 'phoneNumberSid',

async run($) {
const dataItem = {
raw: $.request.body,
meta: {
internalId: Crypto.randomUUID(),
},
};

$.pushTriggerItem(dataItem);
},

async testRun($) {
await fetchMessages($);

Expand Down
12 changes: 12 additions & 0 deletions packages/backend/src/apps/typeform/triggers/new-entry/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import Crypto from 'crypto';
import appConfig from '../../../../config/app';
import defineTrigger from '../../../../helpers/define-trigger';

Expand Down Expand Up @@ -27,6 +28,17 @@ export default defineTrigger({
},
],

async run($) {
const dataItem = {
raw: $.request.body,
meta: {
internalId: Crypto.randomUUID(),
},
};

$.pushTriggerItem(dataItem);
},

async testRun($) {
const { data: form } = await $.http.get(
`/forms/${$.step.parameters.formId}`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import Crypto from 'crypto';
import isEmpty from 'lodash/isEmpty';
import defineTrigger from '../../../../helpers/define-trigger';

Expand All @@ -8,6 +9,21 @@ export default defineTrigger({
showWebhookUrl: true,
description: 'Triggers when the webhook receives a request.',

async run($) {
const dataItem = {
raw: {
headers: $.request.headers,
body: $.request.body,
query: $.request.query,
},
meta: {
internalId: Crypto.randomUUID(),
},
};

$.pushTriggerItem(dataItem);
},

async testRun($) {
const lastExecutionStep = await $.getLastExecutionStep();

Expand Down
8 changes: 6 additions & 2 deletions packages/backend/src/helpers/global-variable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,9 @@ const globalVariable = async (

$.triggerOutput.data.push(triggerItem);

if ($.execution.testRun) {
const isWebhookApp = app.key === 'webhook';

if ($.execution.testRun && !isWebhookApp) {
// early exit after receiving one item as it is enough for test execution
throw new EarlyExitError();
}
Expand Down Expand Up @@ -145,7 +147,9 @@ const globalVariable = async (
}

const lastInternalIds =
testRun || (flow && step?.isAction) ? [] : await flow?.lastInternalIds(2000);
testRun || (flow && step?.isAction)
? []
: await flow?.lastInternalIds(2000);

const isAlreadyProcessed = (internalId: string) => {
return lastInternalIds?.includes(internalId);
Expand Down