MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

App events

This commit is contained in:
Rory Powell 2022-04-04 15:59:00 +01:00
parent c428ed7177
commit 7a5df9010c
35 changed files with 765 additions and 556 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/backend-core/src/events/analytics/analytics.js → packages/backend-core/src/analytics/analytics.js
View File

@ -1,5 +1,5 @@
const PosthogClient = require("./posthog") const PosthogClient = require("./posthog")
const env = require("../../environment") const env = require("../environment")
class Analytics { class Analytics {
constructor() { constructor() {

5
packages/backend-core/src/events/analytics/index.js → packages/backend-core/src/analytics/index.js
View File

@ -1,7 +1,4 @@
const Analytics = require("./analytics") const Analytics = require("./analytics")
const analytics = new Analytics() const analytics = new Analytics()
module.exports = analytics
module.exports = {
analytics,
}

0
packages/backend-core/src/events/analytics/posthog.js → packages/backend-core/src/analytics/posthog.js
View File

92
packages/backend-core/src/events/constants.js
View File

@ -1,35 +1,25 @@
exports.Events = { exports.Events = {
/** // USER
------------------
USER
------------------
*/
USER_CREATED: "user:created", USER_CREATED: "user:created",
USER_UPDATED: "user:updated", USER_UPDATED: "user:updated",
USER_DELETED: "user:deleted", USER_DELETED: "user:deleted",
USER_PASSWORD_RESET: "user:password:reset", USER_PASSWORD_FORCE_RESET: "user:password:force:reset",
// PERMISSIONS // USER / PERMISSIONS
USER_PERMISSION_ADMIN_ASSIGNED: "user:permission:admin:assigned", USER_PERMISSION_ADMIN_ASSIGNED: "user:admin:assigned",
USER_PERMISSION_ADMIN_REMOVED: "user:permission:admin:removed", USER_PERMISSION_ADMIN_REMOVED: "user:admin:removed",
USER_PERMISSION_BUILDER_ASSIGNED: "user:permission:builder:assigned", USER_PERMISSION_BUILDER_ASSIGNED: "user:builder:assigned",
USER_PERMISSION_BUILDER_REMOVED: "user:permission:builder:removed", USER_PERMISSION_BUILDER_REMOVED: "userbuilder:removed",
// INVITE // USER / INVITE
USER_INVITED: "user:invited", USER_INVITED: "user:invited",
USER_INVITED_ACCEPTED: "user:invite:accepted", USER_INVITED_ACCEPTED: "user:invite:accepted",
// SELF // USER / SELF
USER_SELF_UPDATED: "user:self:updated", USER_SELF_UPDATED: "user:self:updated",
USER_SELF_PASSWORD_UPDATED: "user:self:password:updated", USER_SELF_PASSWORD_UPDATED: "user:self:password:updated",
USER_PASSWORD_RESET_REQUESTED: "user:password:reset:requested", USER_PASSWORD_RESET_REQUESTED: "user:password:reset:requested",
USER_PASSWORD_RESET: "user:password:reset",
/**
------------------
ADMIN
------------------
*/
// EMAIL // EMAIL
EMAIL_SMTP_CREATED: "email:smtp:created", EMAIL_SMTP_CREATED: "email:smtp:created",
@ -40,49 +30,44 @@ exports.Events = {
AUTH_SSO_UPDATED: "auth:sso:updated", AUTH_SSO_UPDATED: "auth:sso:updated",
AUTH_SSO_ACTIVATED: "auth:sso:activated", AUTH_SSO_ACTIVATED: "auth:sso:activated",
AUTH_SSO_DEACTIVATED: "auth:sso:deactivated", AUTH_SSO_DEACTIVATED: "auth:sso:deactivated",
AUTH_LOGIN: "auth:login",
AUTH_LOGOUT: "auth:logout",
// ORG // ORG
ORG_NAME_UPDATED: "org:info:name:updated", ORG_NAME_UPDATED: "org:info:name:updated",
ORG_LOGO_UPDATED: "org:info:logo:updated", ORG_LOGO_UPDATED: "org:info:logo:updated",
ORG_PLATFORM_URL_UPDATED: "org:platformurl:updated", ORG_PLATFORM_URL_UPDATED: "org:platformurl:updated",
// UPDATE // ORG / NPS
NPS_SUBMITTED: "nps:submitted",
// ORG / UPDATE
UPDATE_VERSION_CHECKED: "version:checked", UPDATE_VERSION_CHECKED: "version:checked",
// ANALYTICS // ORG / ANALYTICS
ANALYTICS_OPT_OUT: "analytics:opt:out", ANALYTICS_OPT_OUT: "analytics:opt:out",
/**
------------------
APP
------------------
*/
// APP // APP
APP_CREATED: "app:created", APP_CREATED: "app:created",
APP_UPDATED: "app:updated", APP_UPDATED: "app:updated",
APP_DELETED: "app:deleted", APP_DELETED: "app:deleted",
APP_PUBLISHED: "app:published", APP_PUBLISHED: "app:published",
APP_UNPUBLISHED: "app:unpublished", APP_UNPUBLISHED: "app:unpublished",
APP_IMPORTED: "app:imported", APP_TEMPLATE_IMPORTED: "app:template:imported",
APP_FILE_IMPORTED: "app:file:imported",
APP_VERSION_UPDATED: "app:version:updated", APP_VERSION_UPDATED: "app:version:updated",
APP_VERSION_REVERTED: "app:version:reverted",
APP_REVERTED: "app:reverted", APP_REVERTED: "app:reverted",
APP_EXPORTED: "app:exported", APP_EXPORTED: "app:exported",
// ROLE // ROLE
APP_ROLE_CREATED: "app:role:created", ROLE_CREATED: "role:created",
APP_ROLE_DELETED: "app:role:deleted", ROLE_DELETED: "role:deleted",
APP_ROLE_ASSIGNED: "app:role:assigned", ROLE_ASSIGNED: "role:assigned",
// CLIENT // APP / CLIENT
CLIENT_SERVED: "client:served", CLIENT_SERVED: "client:served",
/**
------------------
DATA
------------------
*/
// DATASOURCE // DATASOURCE
DATASOURCE_CREATED: "datasource:created", DATASOURCE_CREATED: "datasource:created",
DATASOURCE_UPDATED: "datasource:updated", DATASOURCE_UPDATED: "datasource:updated",
@ -94,7 +79,7 @@ exports.Events = {
QUERY_DELETED: "query:deleted", QUERY_DELETED: "query:deleted",
QUERY_IMPORTED: "query:imported", QUERY_IMPORTED: "query:imported",
QUERY_RUN: "query:run", QUERY_RUN: "query:run",
QUERY_PREVIEW: "query:preview", QUERY_PREVIEWED: "query:previewed",
// TABLE // TABLE
TABLE_CREATED: "table:created", TABLE_CREATED: "table:created",
@ -121,12 +106,6 @@ exports.Events = {
ROW_DELETED: "row:deleted", ROW_DELETED: "row:deleted",
ROW_IMPORTED: "row:imported", ROW_IMPORTED: "row:imported",
/**
------------------
DESIGN
------------------
*/
// BUILDER // BUILDER
BUILDER_SERVED: "builder:served", BUILDER_SERVED: "builder:served",
@ -142,12 +121,7 @@ exports.Events = {
LAYOUT_CREATED: "layout:created", LAYOUT_CREATED: "layout:created",
LAYOUT_DELETED: "layout:deleted", LAYOUT_DELETED: "layout:deleted",
/** // AUTOMATION
------------------
AUTOMATE
------------------
*/
AUTOMATION_CREATED: "automation:created", AUTOMATION_CREATED: "automation:created",
AUTOMATION_DELETED: "automation:deleted", AUTOMATION_DELETED: "automation:deleted",
AUTOMATION_TESTED: "automation:tested", AUTOMATION_TESTED: "automation:tested",
@ -155,16 +129,6 @@ exports.Events = {
AUTOMATION_STEP_CREATED: "automation:step:created", AUTOMATION_STEP_CREATED: "automation:step:created",
AUTOMATION_STEP_DELETED: "automation:step:deleted", AUTOMATION_STEP_DELETED: "automation:step:deleted",
/** // LICENSING
------------------ LICENSING_QUOTA_EXCEEDED: "licensing:quota:exceeded",
MISC
------------------
*/
// NPS
NPS_SUBMITTED: "nps:submitted",
// AUTH
AUTH_LOGIN: "auth:login",
AUTH_LOGOUT: "auth:logout",
} }

482
packages/backend-core/src/events/events.js
View File

@ -1,6 +1,5 @@
const { getTenantId } = require("../context") const { getTenantId } = require("../context")
const { analytics } = require("./analytics") const analytics = require("../analytics")
const { Events } = require("./constants")
const logEvent = messsage => { const logEvent = messsage => {
const tenantId = getTenantId() const tenantId = getTenantId()
@ -8,487 +7,10 @@ const logEvent = messsage => {
console.log(`[tenant=${tenantId}] [user=${userId}] ${messsage}`) console.log(`[tenant=${tenantId}] [user=${userId}] ${messsage}`)
} }
const processEvent = (event, properties) => { exports.processEvent = (event, properties) => {
// logging // logging
logEvent(event) logEvent(event)
// analytics // analytics
analytics.captureEvent(event, properties) analytics.captureEvent(event, properties)
} }
/**
------------------
USER
------------------
*/
exports.userCreated = () => {
const properties = {}
processEvent(Events.USER_CREATED, properties)
}
exports.userUpdated = () => {
const properties = {}
processEvent(Events.USER_UPDATED, properties)
}
exports.userDeleted = () => {
const properties = {}
processEvent(Events.USER_DELETED, properties)
}
exports.userForcePasswordReset = () => {
const properties = {}
processEvent(Events.USER_PASSWORD_RESET, properties)
}
// PERMISSIONS
exports.userPermissionAdminAssigned = () => {
const properties = {}
processEvent(Events.USER_PERMISSION_ADMIN_ASSIGNED, properties)
}
exports.userPermissionAdminRemoved = () => {
const properties = {}
processEvent(Events.USER_PERMISSION_ADMIN_REMOVED, properties)
}
exports.userPermissionBuilderAssigned = () => {
const properties = {}
processEvent(Events.USER_PERMISSION_BUILDER_ASSIGNED, properties)
}
exports.userPermissionBuilderRemoved = () => {
const properties = {}
processEvent(Events.USER_PERMISSION_BUILDER_REMOVED, properties)
}
// INVITE
exports.userInvited = () => {
const properties = {}
processEvent(Events.USER_INVITED, properties)
}
exports.userInviteAccepted = () => {
const properties = {}
processEvent(Events.USER_INVITED_ACCEPTED, properties)
}
// SELF
exports.userSelfUpdated = () => {
const properties = {}
processEvent(Events.USER_SELF_UPDATED, properties)
}
exports.userSelfPasswordUpdated = () => {
const properties = {}
processEvent(Events.USER_SELF_PASSWORD_UPDATED, properties)
}
exports.userPasswordResetRequested = () => {
const properties = {}
processEvent(Events.USER_PASSWORD_RESET_REQUESTED, properties)
}
/**
------------------
ADMIN
------------------
*/
// EMAIL
exports.emailSMTPCreated = () => {
const properties = {}
processEvent(Events.EMAIL_SMTP_CREATED, properties)
}
exports.emailSMTPUpdated = () => {
const properties = {}
processEvent(Events.EMAIL_SMTP_UPDATED, properties)
}
// AUTH
exports.authSSOCreated = () => {
const properties = {}
processEvent(Events.AUTH_SSO_CREATED, properties)
}
exports.authSSOUpdated = () => {
const properties = {}
processEvent(Events.AUTH_SSO_UPDATED, properties)
}
exports.authSSOActivated = () => {
const properties = {}
processEvent(Events.AUTH_SSO_ACTIVATED, properties)
}
exports.authSSODeactivated = () => {
const properties = {}
processEvent(Events.AUTH_SSO_DEACTIVATED, properties)
}
// ORG
exports.orgNameUpdated = () => {
const properties = {}
processEvent(Events.ORG_NAME_UPDATED, properties)
}
exports.orgLogoUpdated = () => {
const properties = {}
processEvent(Events.ORG_LOGO_UPDATED, properties)
}
exports.orgPlatformURLUpdated = () => {
const properties = {}
processEvent(Events.ORG_PLATFORM_URL_UPDATED, properties)
}
// UPDATE
exports.updateVersionChecked = () => {
const properties = {}
processEvent(Events.UPDATE_VERSION_CHECKED, properties)
}
// ANALYTICS
exports.analyticsOptOut = () => {
const properties = {}
processEvent(Events.ANALYTICS_OPT_OUT, properties)
}
/**
------------------
APP
------------------
*/
// APP
exports.appCreated = () => {
const properties = {}
processEvent(Events.APP_CREATED, properties)
}
exports.appUpdated = () => {
const properties = {}
processEvent(Events.APP_UPDATED, properties)
}
exports.appDeleted = () => {
const properties = {}
processEvent(Events.APP_DELETED, properties)
}
exports.appPublished = () => {
const properties = {}
processEvent(Events.APP_PUBLISHED, properties)
}
exports.appUnpublished = () => {
const properties = {}
processEvent(Events.APP_UNPUBLISHED, properties)
}
exports.appImported = () => {
const properties = {}
processEvent(Events.APP_IMPORTED, properties)
}
exports.appVersionUpdated = () => {
const properties = {}
processEvent(Events.APP_VERSION_UPDATED, properties)
}
exports.appReverted = () => {
const properties = {}
processEvent(Events.APP_REVERTED, properties)
}
exports.appExported = () => {
const properties = {}
processEvent(Events.APP_EXPORTED, properties)
}
// ROLE
exports.appRoleCreated = () => {
const properties = {}
processEvent(Events.APP_ROLE_CREATED, properties)
}
exports.appRoleDeleted = () => {
const properties = {}
processEvent(Events.APP_ROLE_DELETED, properties)
}
exports.appRoleAssigned = () => {
const properties = {}
processEvent(Events.APP_ROLE_ASSIGNED, properties)
}
// CLIENT
exports.clientServed = () => {
const properties = {}
processEvent(Events.CLIENT_SERVED, properties)
}
/**
------------------
DATA
------------------
*/
// DATASOURCE
exports.datasourceCreated = () => {
const properties = {}
processEvent(Events.DATASOURCE_CREATED, properties)
}
exports.datasourceUpdated = () => {
const properties = {}
processEvent(Events.DATASOURCE_UPDATED, properties)
}
exports.datasourceDeleted = () => {
const properties = {}
processEvent(Events.DATASOURCE_DELETED, properties)
}
// QUERY
exports.queryCreated = () => {
const properties = {}
processEvent(Events.QUERY_CREATED, properties)
}
exports.queryUpdated = () => {
const properties = {}
processEvent(Events.QUERY_UPDATED, properties)
}
exports.queryDeleted = () => {
const properties = {}
processEvent(Events.QUERY_DELETED, properties)
}
exports.queryImported = () => {
const properties = {}
processEvent(Events.QUERY_DELETED, properties)
}
exports.queryRun = () => {
const properties = {}
processEvent(Events.QUERY_DELETED, properties)
}
exports.queryPreview = () => {
const properties = {}
processEvent(Events.QUERY_DELETED, properties)
}
// TABLE
exports.tableCreated = () => {
const properties = {}
processEvent(Events.TABLE_CREATED, properties)
}
exports.tableUpdated = () => {
const properties = {}
processEvent(Events.TABLE_UPDATED, properties)
}
exports.tableDeleted = () => {
const properties = {}
processEvent(Events.TABLE_DELETED, properties)
}
exports.tableExported = () => {
const properties = {}
processEvent(Events.TABLE_EXPORTED, properties)
}
exports.tableImported = () => {
const properties = {}
processEvent(Events.TABLE_IMPORTED, properties)
}
exports.tablePermissionUpdated = () => {
const properties = {}
processEvent(Events.TABLE_PERMISSION_UPDATED, properties)
}
// VIEW
exports.viewCreated = () => {
const properties = {}
processEvent(Events.VIEW_CREATED, properties)
}
exports.viewUpdated = () => {
const properties = {}
processEvent(Events.VIEW_UPDATED, properties)
}
exports.viewDeleted = () => {
const properties = {}
processEvent(Events.VIEW_DELETED, properties)
}
exports.viewExported = () => {
const properties = {}
processEvent(Events.VIEW_EXPORTED, properties)
}
exports.viewFilterCreated = () => {
const properties = {}
processEvent(Events.VIEW_FILTER_CREATED, properties)
}
exports.viewFilterDeleted = () => {
const properties = {}
processEvent(Events.VIEW_FILTER_DELETED, properties)
}
exports.viewCalculationCreated = () => {
const properties = {}
processEvent(Events.VIEW_CALCULATION_CREATED, properties)
}
exports.viewCalculationDeleted = () => {
const properties = {}
processEvent(Events.VIEW_CALCULATION_DELETED, properties)
}
// ROW
exports.rowCreated = () => {
const properties = {}
processEvent(Events.ROW_CREATED, properties)
}
exports.rowImported = () => {
const properties = {}
processEvent(Events.ROW_IMPORTED, properties)
exports.rowCreated()
}
exports.rowUpdated = () => {
const properties = {}
processEvent(Events.ROW_UPDATED, properties)
}
exports.rowDeleted = () => {
const properties = {}
processEvent(Events.ROW_DELETED, properties)
}
/**
------------------
DESIGN
------------------
*/
// BUILDER
exports.builderServed = () => {
const properties = {}
processEvent(Events.BUILDER_SERVED, properties)
}
// COMPONENTS - are captured in the UI only
// SCREEN
exports.screenCreated = () => {
const properties = {}
processEvent(Events.SCREEN_CREATED, properties)
}
exports.screenDeleted = () => {
const properties = {}
processEvent(Events.SCREEN_DELETED, properties)
}
// LAYOUT
exports.layoutCreated = () => {
const properties = {}
processEvent(Events.LAYOUT_CREATED, properties)
}
exports.layoutDeleted = () => {
const properties = {}
processEvent(Events.LAYOUT_DELETED, properties)
}
/**
------------------
AUTOMATE
------------------
*/
exports.automationCreated = () => {
const properties = {}
processEvent(Events.AUTOMATION_CREATED, properties)
}
exports.automationDeleted = () => {
const properties = {}
processEvent(Events.AUTOMATION_DELETED, properties)
}
exports.automationTested = () => {
const properties = {}
processEvent(Events.AUTOMATION_TESTED, properties)
}
exports.automationRun = () => {
const properties = {}
processEvent(Events.AUTOMATION_RUN, properties)
}
exports.automationStepCreated = () => {
const properties = {}
processEvent(Events.AUTOMATION_STEP_CREATED, properties)
}
exports.automationStepDeleted = () => {
const properties = {}
processEvent(Events.AUTOMATION_STEP_DELETED, properties)
}
/**
------------------
MISC
------------------
*/
// NPS
exports.npsSubmitted = () => {
const properties = {}
processEvent(Events.NPS_SUBMITTED, properties)
}
// AUTH
exports.login = () => {
const properties = {}
processEvent(Events.AUTH_LOGIN, properties)
}
exports.logout = () => {
const properties = {}
processEvent(Events.AUTH_LOGOUT, properties)
}

60
packages/backend-core/src/events/handlers/app.js Normal file
View File

@ -0,0 +1,60 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.APP_CREATED, properties)
}
exports.updated = () => {
const properties = {}
events.processEvent(Events.APP_UPDATED, properties)
}
exports.deleted = () => {
const properties = {}
events.processEvent(Events.APP_DELETED, properties)
}
exports.published = () => {
const properties = {}
events.processEvent(Events.APP_PUBLISHED, properties)
}
exports.unpublished = () => {
const properties = {}
events.processEvent(Events.APP_UNPUBLISHED, properties)
}
exports.fileImported = () => {
const properties = {}
events.processEvent(Events.APP_FILE_IMPORTED, properties)
}
exports.templateImported = templateKey => {
const properties = {
templateKey,
}
events.processEvent(Events.APP_TEMPLATE_IMPORTED, properties)
}
exports.versionUpdated = () => {
const properties = {}
events.processEvent(Events.APP_VERSION_UPDATED, properties)
}
exports.versionReverted = () => {
const properties = {}
events.processEvent(Events.APP_VERSION_REVERTED, properties)
}
exports.reverted = () => {
const properties = {}
events.processEvent(Events.APP_REVERTED, properties)
}
// TODO
exports.exported = () => {
const properties = {}
events.processEvent(Events.APP_EXPORTED, properties)
}

40
packages/backend-core/src/events/handlers/auth.js Normal file
View File

@ -0,0 +1,40 @@
const events = require("../events")
const { Events } = require("../constants")
exports.login = () => {
const properties = {}
events.processEvent(Events.AUTH_LOGIN, properties)
}
exports.logout = () => {
const properties = {}
events.processEvent(Events.AUTH_LOGOUT, properties)
}
exports.SSOCreated = type => {
const properties = {
type,
}
events.processEvent(Events.AUTH_SSO_CREATED, properties)
}
exports.SSOUpdated = type => {
const properties = {
type,
}
events.processEvent(Events.AUTH_SSO_UPDATED, properties)
}
exports.SSOActivated = type => {
const properties = {
type,
}
events.processEvent(Events.AUTH_SSO_ACTIVATED, properties)
}
exports.SSODeactivated = type => {
const properties = {
type,
}
events.processEvent(Events.AUTH_SSO_DEACTIVATED, properties)
}

37
packages/backend-core/src/events/handlers/automation.js Normal file
View File

@ -0,0 +1,37 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.AUTOMATION_CREATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.AUTOMATION_DELETED, properties)
}
// TODO
exports.tested = () => {
const properties = {}
events.processEvent(Events.AUTOMATION_TESTED, properties)
}
// TODO
exports.run = () => {
const properties = {}
events.processEvent(Events.AUTOMATION_RUN, properties)
}
// TODO
exports.stepCreated = () => {
const properties = {}
events.processEvent(Events.AUTOMATION_STEP_CREATED, properties)
}
// TODO
exports.stepDeleted = () => {
const properties = {}
events.processEvent(Events.AUTOMATION_STEP_DELETED, properties)
}

19
packages/backend-core/src/events/handlers/datasource.js Normal file
View File

@ -0,0 +1,19 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.DATASOURCE_CREATED, properties)
}
// TODO
exports.updated = () => {
const properties = {}
events.processEvent(Events.DATASOURCE_UPDATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.DATASOURCE_DELETED, properties)
}

12
packages/backend-core/src/events/handlers/email.js Normal file
View File

@ -0,0 +1,12 @@
const events = require("../events")
const { Events } = require("../constants")
exports.SMTPCreated = () => {
const properties = {}
events.processEvent(Events.EMAIL_SMTP_CREATED, properties)
}
exports.SMTPUpdated = () => {
const properties = {}
events.processEvent(Events.EMAIL_SMTP_UPDATED, properties)
}

31
packages/backend-core/src/events/handlers/index.js Normal file
View File

@ -0,0 +1,31 @@
const app = require("./app")
const auth = require("./auth")
const automation = require("./automation")
const datasource = require("./datasource")
const email = require("./email")
const licensing = require("./licensing")
const layout = require("./layout")
const org = require("./org")
const query = require("./query")
const row = require("./screen")
const table = require("./table")
const serve = require("./serve")
const user = require("./user")
const view = require("./view")
module.exports = {
app,
auth,
automation,
datasource,
email,
licensing,
layout,
org,
query,
row,
table,
serve,
user,
view,
}

16
packages/backend-core/src/events/handlers/layout.js Normal file
View File

@ -0,0 +1,16 @@
const events = require("../events")
const { Events } = require("../constants")
// LAYOUT
// TODO
exports.created = () => {
const properties = {}
events.processEvent(Events.LAYOUT_CREATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.LAYOUT_DELETED, properties)
}

10
packages/backend-core/src/events/handlers/licensing.js Normal file
View File

@ -0,0 +1,10 @@
const events = require("../events")
const { Events } = require("../constants")
exports.quotaExceeded = (quotaName, value) => {
const properties = {
name: quotaName,
value,
}
events.processEvent(Events.LICENSING_QUOTA_EXCEEDED, properties)
}

34
packages/backend-core/src/events/handlers/org.js Normal file
View File

@ -0,0 +1,34 @@
const events = require("../events")
const { Events } = require("../constants")
exports.nameUpdated = () => {
const properties = {}
events.processEvent(Events.ORG_NAME_UPDATED, properties)
}
exports.logoUpdated = () => {
const properties = {}
events.processEvent(Events.ORG_LOGO_UPDATED, properties)
}
exports.platformURLUpdated = () => {
const properties = {}
events.processEvent(Events.ORG_PLATFORM_URL_UPDATED, properties)
}
exports.versionChecked = version => {
const properties = {
version,
}
events.processEvent(Events.UPDATE_VERSION_CHECKED, properties)
}
exports.analyticsOptOut = () => {
const properties = {}
events.processEvent(Events.ANALYTICS_OPT_OUT, properties)
}
exports.npsSubmitted = () => {
const properties = {}
events.processEvent(Events.NPS_SUBMITTED, properties)
}

37
packages/backend-core/src/events/handlers/query.js Normal file
View File

@ -0,0 +1,37 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.QUERY_CREATED, properties)
}
// TODO
exports.updated = () => {
const properties = {}
events.processEvent(Events.QUERY_UPDATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.QUERY_DELETED, properties)
}
// TODO
exports.imported = () => {
const properties = {}
events.processEvent(Events.QUERY_IMPORTED, properties)
}
// TODO
exports.run = () => {
const properties = {}
events.processEvent(Events.QUERY_RUN, properties)
}
// TODO
exports.previewed = () => {
const properties = {}
events.processEvent(Events.QUERY_PREVIEWED, properties)
}

19
packages/backend-core/src/events/handlers/role.js Normal file
View File

@ -0,0 +1,19 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.ROLE_CREATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.ROLE_DELETED, properties)
}
// TODO
exports.assigned = () => {
const properties = {}
events.processEvent(Events.ROLE_ASSIGNED, properties)
}

26
packages/backend-core/src/events/handlers/row.js Normal file
View File

@ -0,0 +1,26 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.ROW_CREATED, properties)
}
// TODO
exports.imported = () => {
const properties = {}
events.processEvent(Events.ROW_IMPORTED, properties)
exports.rowCreated()
}
// TODO
exports.updated = () => {
const properties = {}
events.processEvent(Events.ROW_UPDATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.ROW_DELETED, properties)
}

14
packages/backend-core/src/events/handlers/screen.js Normal file
View File

@ -0,0 +1,14 @@
const events = require("../events")
const { Events } = require("../constants")
// TODO
exports.created = () => {
const properties = {}
events.processEvent(Events.SCREEN_CREATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.SCREEN_DELETED, properties)
}

14
packages/backend-core/src/events/handlers/serve.js Normal file
View File

@ -0,0 +1,14 @@
const events = require("../events")
const { Events } = require("../constants")
// TODO
exports.builderServed = () => {
const properties = {}
events.processEvent(Events.BUILDER_SERVED, properties)
}
// TODO
exports.clientServed = () => {
const properties = {}
events.processEvent(Events.CLIENT_SERVED, properties)
}

37
packages/backend-core/src/events/handlers/table.js Normal file
View File

@ -0,0 +1,37 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.TABLE_CREATED, properties)
}
// TODO
exports.updated = () => {
const properties = {}
events.processEvent(Events.TABLE_UPDATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.TABLE_DELETED, properties)
}
// TODO
exports.exported = () => {
const properties = {}
events.processEvent(Events.TABLE_EXPORTED, properties)
}
// TODO
exports.imported = () => {
const properties = {}
events.processEvent(Events.TABLE_IMPORTED, properties)
}
// TODO
exports.permissionUpdated = () => {
const properties = {}
events.processEvent(Events.TABLE_PERMISSION_UPDATED, properties)
}

85
packages/backend-core/src/events/handlers/user.js Normal file
View File

@ -0,0 +1,85 @@
const events = require("../events")
const { Events } = require("../constants")
// TODO
exports.created = () => {
const properties = {}
events.processEvent(Events.USER_CREATED, properties)
}
// TODO
exports.updated = () => {
const properties = {}
events.processEvent(Events.USER_UPDATED, properties)
}
exports.deleted = () => {
const properties = {}
events.processEvent(Events.USER_DELETED, properties)
}
// TODO
exports.passwordForceReset = () => {
const properties = {}
events.processEvent(Events.USER_PASSWORD_FORCE_RESET, properties)
}
// PERMISSIONS
// TODO
exports.permissionAdminAssigned = () => {
const properties = {}
events.processEvent(Events.USER_PERMISSION_ADMIN_ASSIGNED, properties)
}
// TODO
exports.permissionAdminRemoved = () => {
const properties = {}
events.processEvent(Events.USER_PERMISSION_ADMIN_REMOVED, properties)
}
// TODO
exports.permissionBuilderAssigned = () => {
const properties = {}
events.processEvent(Events.USER_PERMISSION_BUILDER_ASSIGNED, properties)
}
// TODO
exports.permissionBuilderRemoved = () => {
const properties = {}
events.processEvent(Events.USER_PERMISSION_BUILDER_REMOVED, properties)
}
// INVITE
exports.invited = () => {
const properties = {}
events.processEvent(Events.USER_INVITED, properties)
}
exports.inviteAccepted = () => {
const properties = {}
events.processEvent(Events.USER_INVITED_ACCEPTED, properties)
}
// SELF
exports.selfUpdated = () => {
const properties = {}
events.processEvent(Events.USER_SELF_UPDATED, properties)
}
exports.selfPasswordUpdated = () => {
const properties = {}
events.processEvent(Events.USER_SELF_PASSWORD_UPDATED, properties)
}
exports.passwordResetRequested = () => {
const properties = {}
events.processEvent(Events.USER_PASSWORD_RESET_REQUESTED, properties)
}
exports.passwordReset = () => {
const properties = {}
events.processEvent(Events.USER_PASSWORD_RESET, properties)
}

49
packages/backend-core/src/events/handlers/view.js Normal file
View File

@ -0,0 +1,49 @@
const events = require("../events")
const { Events } = require("../constants")
exports.created = () => {
const properties = {}
events.processEvent(Events.VIEW_CREATED, properties)
}
// TODO
exports.updated = () => {
const properties = {}
events.processEvent(Events.VIEW_UPDATED, properties)
}
// TODO
exports.deleted = () => {
const properties = {}
events.processEvent(Events.VIEW_DELETED, properties)
}
// TODO
exports.exported = () => {
const properties = {}
events.processEvent(Events.VIEW_EXPORTED, properties)
}
// TODO
exports.filterCreated = () => {
const properties = {}
events.processEvent(Events.VIEW_FILTER_CREATED, properties)
}
// TODO
exports.filterDeleted = () => {
const properties = {}
events.processEvent(Events.VIEW_FILTER_DELETED, properties)
}
// TODO
exports.calculationCreated = () => {
const properties = {}
events.processEvent(Events.VIEW_CALCULATION_CREATED, properties)
}
// TODO
exports.calculationDeleted = () => {
const properties = {}
events.processEvent(Events.VIEW_CALCULATION_DELETED, properties)
}

7
packages/backend-core/src/events/index.js
View File

@ -1,2 +1,5 @@
const events = require("./events") const handlers = require("./handlers")
module.exports = events
module.exports = {
...handlers,
}

1
packages/backend-core/src/index.js
View File

@ -21,4 +21,5 @@ module.exports = {
tenancy: require("./tenancy"), tenancy: require("./tenancy"),
featureFlags: require("./featureFlags"), featureFlags: require("./featureFlags"),
events: require("./events"), events: require("./events"),
analytics: require("./analytics"),
} }

33
packages/server/src/api/controllers/application.ts
View File

@ -51,7 +51,7 @@ const {
} = require("@budibase/backend-core/context") } = require("@budibase/backend-core/context")
import { getUniqueRows } from "../../utilities/usageQuota/rows" import { getUniqueRows } from "../../utilities/usageQuota/rows"
import { quotas } from "@budibase/pro" import { quotas } from "@budibase/pro"
import { errors } from "@budibase/backend-core" import { errors, events } from "@budibase/backend-core"
const URL_REGEX_SLASH = /\/|\\/g const URL_REGEX_SLASH = /\/|\\/g
@ -291,7 +291,33 @@ const performAppCreate = async (ctx: any) => {
return newApplication return newApplication
} }
const creationEvents = (request: any) => {
let creationFns = []
const body = request.body
if (body.useTemplate === "true") {
// from template
if (body.templateKey) {
creationFns.push(() => events.app.templateImported(body.templateKey))
}
// from file
else if (request.files?.templateFile) {
creationFns.push(events.app.fileImported)
}
// unknown
else {
console.error("Could not determine template creation event")
}
}
creationFns.push(events.app.created)
for (let fn of creationFns) {
fn()
}
}
const appPostCreate = async (ctx: any, appId: string) => { const appPostCreate = async (ctx: any, appId: string) => {
creationEvents(ctx.request)
// app import & template creation // app import & template creation
if (ctx.request.body.useTemplate === "true") { if (ctx.request.body.useTemplate === "true") {
const rows = await getUniqueRows([appId]) const rows = await getUniqueRows([appId])
@ -336,6 +362,7 @@ export const update = async (ctx: any) => {
} }
const data = await updateAppPackage(ctx.request.body, ctx.params.appId) const data = await updateAppPackage(ctx.request.body, ctx.params.appId)
events.app.updated()
ctx.status = 200 ctx.status = 200
ctx.body = data ctx.body = data
} }
@ -358,6 +385,7 @@ export const updateClient = async (ctx: any) => {
revertableVersion: currentVersion, revertableVersion: currentVersion,
} }
const data = await updateAppPackage(appPackageUpdates, ctx.params.appId) const data = await updateAppPackage(appPackageUpdates, ctx.params.appId)
events.app.versionUpdated()
ctx.status = 200 ctx.status = 200
ctx.body = data ctx.body = data
} }
@ -381,6 +409,7 @@ export const revertClient = async (ctx: any) => {
revertableVersion: null, revertableVersion: null,
} }
const data = await updateAppPackage(appPackageUpdates, ctx.params.appId) const data = await updateAppPackage(appPackageUpdates, ctx.params.appId)
events.app.versionReverted()
ctx.status = 200 ctx.status = 200
ctx.body = data ctx.body = data
} }
@ -391,8 +420,10 @@ const destroyApp = async (ctx: any) => {
const result = await db.destroy() const result = await db.destroy()
if (ctx.query?.unpublish) { if (ctx.query?.unpublish) {
await quotas.removePublishedApp() await quotas.removePublishedApp()
events.app.unpublished()
} else { } else {
await quotas.removeApp() await quotas.removeApp()
events.app.deleted()
} }
/* istanbul ignore next */ /* istanbul ignore next */
if (!env.isTest() && !ctx.query.unpublish) { if (!env.isTest() && !ctx.query.unpublish) {

2
packages/server/src/api/controllers/backup.js
View File

@ -1,4 +1,5 @@
const { streamBackup } = require("../../utilities/fileSystem") const { streamBackup } = require("../../utilities/fileSystem")
const { events } = require("@budibase/backend-core")
exports.exportAppDump = async function (ctx) { exports.exportAppDump = async function (ctx) {
const { appId } = ctx.query const { appId } = ctx.query
@ -6,4 +7,5 @@ exports.exportAppDump = async function (ctx) {
const backupIdentifier = `${appName}-export-${new Date().getTime()}.txt` const backupIdentifier = `${appName}-export-${new Date().getTime()}.txt`
ctx.attachment(backupIdentifier) ctx.attachment(backupIdentifier)
ctx.body = await streamBackup(appId) ctx.body = await streamBackup(appId)
events.app.exported()
} }

2
packages/server/src/api/controllers/deploy/index.ts
View File

@ -13,6 +13,7 @@ import {
getProdAppDB, getProdAppDB,
} from "@budibase/backend-core/context" } from "@budibase/backend-core/context"
import { quotas } from "@budibase/pro" import { quotas } from "@budibase/pro"
import { events } from "@budibase/backend-core"
// the max time we can wait for an invalidation to complete before considering it failed // the max time we can wait for an invalidation to complete before considering it failed
const MAX_PENDING_TIME_MS = 30 * 60000 const MAX_PENDING_TIME_MS = 30 * 60000
@ -185,6 +186,7 @@ const _deployApp = async function (ctx: any) {
await deployApp(deployment) await deployApp(deployment)
} }
events.app.published()
ctx.body = deployment ctx.body = deployment
} }

11
packages/server/src/api/controllers/dev.js
View File

@ -7,6 +7,7 @@ const { Replication, getProdAppID } = require("@budibase/backend-core/db")
const { DocumentTypes } = require("../../db/utils") const { DocumentTypes } = require("../../db/utils")
const { app: appCache } = require("@budibase/backend-core/cache") const { app: appCache } = require("@budibase/backend-core/cache")
const { getProdAppDB, getAppDB } = require("@budibase/backend-core/context") const { getProdAppDB, getAppDB } = require("@budibase/backend-core/context")
const { events } = require("@budibase/backend-core")
async function redirect(ctx, method, path = "global") { async function redirect(ctx, method, path = "global") {
const { devPath } = ctx.params const { devPath } = ctx.params
@ -101,7 +102,10 @@ exports.revert = async ctx => {
target: appId, target: appId,
}) })
await replication.rollback() if (!env.isTest()) {
// in-memory db stalls on rollback
await replication.rollback()
}
// update appID in reverted app to be dev version again // update appID in reverted app to be dev version again
const db = getAppDB() const db = getAppDB()
const appDoc = await db.get(DocumentTypes.APP_METADATA) const appDoc = await db.get(DocumentTypes.APP_METADATA)
@ -112,13 +116,16 @@ exports.revert = async ctx => {
ctx.body = { ctx.body = {
message: "Reverted changes successfully.", message: "Reverted changes successfully.",
} }
events.app.reverted()
} catch (err) { } catch (err) {
ctx.throw(400, `Unable to revert. ${err}`) ctx.throw(400, `Unable to revert. ${err}`)
} }
} }
exports.getBudibaseVersion = async ctx => { exports.getBudibaseVersion = async ctx => {
const version = require("../../../package.json").version
ctx.body = { ctx.body = {
version: require("../../../package.json").version, version,
} }
events.org.versionChecked(version)
} }

63
packages/server/src/api/routes/tests/application.spec.js
View File

@ -28,17 +28,49 @@ describe("/applications", () => {
beforeEach(async () => { beforeEach(async () => {
await clearAllApps() await clearAllApps()
await config.init() await config.init()
jest.clearAllMocks()
}) })
describe("create", () => { describe("create", () => {
it("returns a success message when the application is successfully created", async () => { it("creates empty app", async () => {
const res = await request const res = await request
.post("/api/applications") .post("/api/applications")
.send({ name: "My App" }) .field("name", "My App")
.set(config.defaultHeaders()) .set(config.defaultHeaders())
.expect("Content-Type", /json/) .expect("Content-Type", /json/)
.expect(200) .expect(200)
expect(res.body._id).toBeDefined() expect(res.body._id).toBeDefined()
expect(config.getEvents().app.created.mock.calls.length).toBe(1)
})
it("creates app from template", async () => {
const res = await request
.post("/api/applications")
.field("name", "My App")
.field("useTemplate", "true")
.field("templateKey", "test")
.field("templateString", "{}") // override the file download
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(200)
expect(res.body._id).toBeDefined()
expect(config.getEvents().app.created.mock.calls.length).toBe(1)
expect(config.getEvents().app.templateImported.mock.calls.length).toBe(1)
})
it("creates app from file", async () => {
const res = await request
.post("/api/applications")
.field("name", "My App")
.field("useTemplate", "true")
.set(config.defaultHeaders())
.attach('templateFile', 'src/api/routes/tests/data/export.txt')
.expect("Content-Type", /json/)
.expect(200)
expect(res.body._id).toBeDefined()
expect(config.getEvents().app.created.mock.calls.length).toBe(1)
expect(config.getEvents().app.fileImported.mock.calls.length).toBe(1)
}) })
it("should apply authorization to endpoint", async () => { it("should apply authorization to endpoint", async () => {
@ -102,6 +134,31 @@ describe("/applications", () => {
.expect("Content-Type", /json/) .expect("Content-Type", /json/)
.expect(200) .expect(200)
expect(res.body.rev).toBeDefined() expect(res.body.rev).toBeDefined()
expect(config.getEvents().app.updated.mock.calls.length).toBe(1)
})
})
describe("delete", () => {
it("should delete app", async () => {
await config.createApp("to-delete")
const appId = config.getAppId()
await request
.delete(`/api/applications/${appId}`)
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(200)
expect(config.getEvents().app.deleted.mock.calls.length).toBe(1)
})
it("should unpublish app", async () => {
await config.createApp("to-unpublish")
const appId = config.getProdAppId()
await request
.delete(`/api/applications/${appId}?unpublish=true`)
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(200)
expect(config.getEvents().app.unpublished.mock.calls.length).toBe(1)
}) })
}) })
@ -113,6 +170,7 @@ describe("/applications", () => {
.set(config.defaultHeaders()) .set(config.defaultHeaders())
.expect("Content-Type", /json/) .expect("Content-Type", /json/)
.expect(200) .expect(200)
expect(config.getEvents().app.versionUpdated.mock.calls.length).toBe(1)
}) })
it("should be able to revert the app client library version", async () => { it("should be able to revert the app client library version", async () => {
// We need to first update the version so that we can then revert // We need to first update the version so that we can then revert
@ -126,6 +184,7 @@ describe("/applications", () => {
.set(config.defaultHeaders()) .set(config.defaultHeaders())
.expect("Content-Type", /json/) .expect("Content-Type", /json/)
.expect(200) .expect(200)
expect(config.getEvents().app.versionReverted.mock.calls.length).toBe(1)
}) })
}) })

1
packages/server/src/api/routes/tests/backup.spec.js
View File

@ -21,6 +21,7 @@ describe("/backups", () => {
.expect(200) .expect(200)
expect(res.text).toBeDefined() expect(res.text).toBeDefined()
expect(res.text.includes(`"db_name":"${config.getAppId()}"`)).toEqual(true) expect(res.text.includes(`"db_name":"${config.getAppId()}"`)).toEqual(true)
expect(config.getEvents().app.exported.mock.calls.length).toBe(1)
}) })
it("should apply authorization to endpoint", async () => { it("should apply authorization to endpoint", async () => {

1
packages/server/src/api/routes/tests/data/export.txt Normal file
View File

@ -0,0 +1 @@
{}

24
packages/server/src/api/routes/tests/deployment.spec.js Normal file
View File

@ -0,0 +1,24 @@
const setup = require("./utilities")
describe("/deployments", () => {
let request = setup.getRequest()
let config = setup.getConfig()
afterAll(setup.afterAll)
beforeEach(async () => {
await config.init()
jest.clearAllMocks()
})
describe("deploy", () => {
it("should deploy the application", async () => {
await request
.post(`/api/deploy`)
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(200)
expect(config.getEvents().app.published.mock.calls.length).toBe(1)
})
})
})

24
packages/server/src/api/routes/tests/dev.spec.js Normal file
View File

@ -0,0 +1,24 @@
const setup = require("./utilities")
describe("/dev", () => {
let request = setup.getRequest()
let config = setup.getConfig()
afterAll(setup.afterAll)
beforeEach(async () => {
await config.init()
jest.clearAllMocks()
})
describe("revert", () => {
it("should revert the application", async () => {
await request
.post(`/api/dev/${config.getAppId()}/revert`)
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(200)
expect(config.getEvents().app.reverted.mock.calls.length).toBe(1)
})
})
})

9
packages/server/src/tests/utilities/TestConfiguration.js
View File

@ -25,6 +25,7 @@ const newid = require("../../db/newid")
const context = require("@budibase/backend-core/context") const context = require("@budibase/backend-core/context")
const { generateDevInfoID, SEPARATOR } = require("@budibase/backend-core/db") const { generateDevInfoID, SEPARATOR } = require("@budibase/backend-core/db")
const { encrypt } = require("@budibase/backend-core/encryption") const { encrypt } = require("@budibase/backend-core/encryption")
const { events } = require("./mockEvents")
const GLOBAL_USER_ID = "us_uuid1" const GLOBAL_USER_ID = "us_uuid1"
const EMAIL = "babs@babs.com" const EMAIL = "babs@babs.com"
@ -55,6 +56,14 @@ class TestConfiguration {
return this.appId return this.appId
} }
getProdAppId() {
return this.prodAppId
}
getEvents() {
return events
}
async _req(config, params, controlFunc) { async _req(config, params, controlFunc) {
const request = {} const request = {}
// fake cookies, we don't need them // fake cookies, we don't need them

22
packages/server/src/tests/utilities/mockEvents.js Normal file
View File

@ -0,0 +1,22 @@
const core = require("@budibase/backend-core")
const events = {
app: {
created: jest.fn(),
updated: jest.fn(),
deleted: jest.fn(),
published: jest.fn(),
unpublished: jest.fn(),
templateImported: jest.fn(),
fileImported: jest.fn(),
versionUpdated: jest.fn(),
versionReverted: jest.fn(),
reverted: jest.fn(),
exported: jest.fn(),
},
}
core.events = events
module.exports = {
events,
}