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

Include function message trigger for NATS event #255

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions deploy/lib/deployTriggers.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,13 @@ module.exports = {

deletePreviousTriggersForApplication(application) {
// Delete and re-create every triggers...
const deleteTriggersPromises = application.currentTriggers.map((trigger) =>
this.deleteTrigger(trigger.id)
const deleteTriggersPromises = application.currentTriggers.map((trigger) => {
if ('schedule' in trigger) {
this.deleteCronTrigger(trigger.id)
} else {
this.deleteMessageTrigger(trigger.id)
}
}
);

return Promise.all(deleteTriggersPromises);
Expand All @@ -65,11 +70,20 @@ module.exports = {
return [];
}

const createTriggersPromises = serverlessApp.events.map((event) =>
this.createTrigger(application.id, isFunction, {
schedule: event.schedule.rate,
args: event.schedule.input || {},
})
const createTriggersPromises = serverlessApp.events.map((event) => {
if ('schedule' in event) {
this.createCronTrigger(application.id, isFunction, {
schedule: event.schedule.rate,
args: event.schedule.input || {},
})
}
if ('nats' in event) {
this.createMessageTrigger(application.id, {
name: event.nats.name,
scw_nats_config: event.nats.scw_nats_config,
})
}
}
);

return Promise.all(createTriggersPromises);
Expand Down
9 changes: 8 additions & 1 deletion docs/events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Events

With events, you can link your functions with CRON Schedule (time-based) triggers.
With events, you can link your functions with CRON Schedule (time-based) or NATS (message-based) triggers.

To do this you can add an `events` key in your function or container as follows:

Expand All @@ -17,6 +17,13 @@ functions:
input:
key: value
key2: value2
- nats:
name: my-nats-event
scw_nats_config:
subject: ">"
mnq_nats_account_id: "nats account id"
mnq_project_id: "project id"
mnq_region: "fr-par"

# Container
custom:
Expand Down
45 changes: 37 additions & 8 deletions shared/api/triggers.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,28 @@
const { manageError } = require("./utils");

module.exports = {
listTriggersForApplication(applicationId, isFunction) {
let triggersUrl = `crons?function_id=${applicationId}`;
async listTriggersForApplication(applicationId, isFunction) {
let cronTriggersUrl = `crons?function_id=${applicationId}`;
if (!isFunction) {
triggersUrl = `crons?container_id=${applicationId}`;
cronTriggersUrl = `crons?container_id=${applicationId}`;
}
return this.apiManager
.get(triggersUrl)
const cronTriggers = await this.apiManager
.get(cronTriggersUrl)
.then((response) => response.data.crons)
.catch(manageError);

const messageTriggers = await this.apiManager
.get(`triggers?function_id=${applicationId}`)
.then((response) => response.data.triggers)
.catch(manageError);

return [
...cronTriggers,
...messageTriggers
]
},

createTrigger(applicationId, isFunction, params) {
createCronTrigger(applicationId, isFunction, params) {
let payload = {
...params,
function_id: applicationId,
Expand All @@ -32,18 +42,37 @@ module.exports = {
.catch(manageError);
},

updateTrigger(triggerId, params) {
createMessageTrigger(applicationId, params) {
let payload = {
...params,
function_id: applicationId,
};

return this.apiManager
.post("triggers", payload)
.then((response) => response.data)
.catch(manageError);
},

updateCronTrigger(triggerId, params) {
const updateUrl = `crons/${triggerId}`;
return this.apiManager
.patch(updateUrl, params)
.then((response) => response.data)
.catch(manageError);
},

deleteTrigger(triggerId) {
deleteCronTrigger(triggerId) {
return this.apiManager
.delete(`crons/${triggerId}`)
.then((response) => response.data)
.catch(manageError);
},

deleteMessageTrigger(triggerId) {
return this.apiManager
.delete(`triggers/${triggerId}`)
.then((response) => response.data)
.catch(manageError);
},
};
48 changes: 48 additions & 0 deletions shared/validate.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,22 @@ const cronScheduleRegex = new RegExp(
/^((((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|\*) ?){5,7})$/
);

const triggerNameRegex = new RegExp(
/^([a-zA-Z0-9-]){2,100}$/
)

const triggerNatsAccountIdRegex = new RegExp(
/^([A-Z0-9]){56}$/
)

const triggerNatsProjectIdRegex = new RegExp(
/^([a-z0-9]){8}-([a-z0-9]){4}-([a-z0-9]){4}-([a-z0-9]){4}-([a-z0-9]){12}$/
)

const triggerNatsSubjectRegex = new RegExp(
/^(\$?[a-zA-Z0-9_*>][a-zA-Z0-9_*>.]*){1,200}$/
)

const TRIGGERS_VALIDATION = {
schedule: (trigger) => {
if (!trigger.rate || !cronScheduleRegex.test(trigger.rate)) {
Expand All @@ -37,6 +53,38 @@ const TRIGGERS_VALIDATION = {
);
}
},
nats: (trigger) => {
if (!trigger.name || !triggerNameRegex.test(trigger.name)) {
throw new Error(
`Trigger Schedule is invalid: ${trigger.name}, name is invalid, should match regex: ${triggerNameRegex.toString()}`
);
}
if (!trigger.scw_nats_config) {
throw new Error(
`Trigger Schedule is invalid: ${trigger.name}, scw_nats_config is missing`
);
}
if (!trigger.scw_nats_config.subject ||!triggerNatsSubjectRegex.test(trigger.scw_nats_config.subject)) {
throw new Error(
`Trigger Schedule is invalid: ${trigger.name}, scw_nats_config.subject is invalid, should match regex: ${triggerNatsSubjectRegex.toString()}`
);
}
if (!trigger.scw_nats_config.mnq_nats_account_id ||!triggerNatsAccountIdRegex.test(trigger.scw_nats_config.mnq_nats_account_id)) {
throw new Error(
`Trigger Schedule is invalid: ${trigger.name}, scw_nats_config.mnq_nats_account_id is invalid, should match regex: ${triggerNatsAccountIdRegex.toString()}`
);
}
if (!trigger.scw_nats_config.mnq_project_id ||!triggerNatsProjectIdRegex.test(trigger.scw_nats_config.mnq_project_id)) {
throw new Error(
`Trigger Schedule is invalid: ${trigger.name}, scw_nats_config.mnq_project_id is invalid, should match regex: ${triggerNatsProjectIdRegex.toString()}`
);
}
if (!trigger.scw_nats_config.mnq_region ||!REGION_LIST.includes(trigger.scw_nats_config.mnq_region)) {
throw new Error(
`Trigger Schedule is invalid: ${trigger.name}, scw_nats_config.region is unknown}`
);
}
}
};

module.exports = {
Expand Down
Loading