@budibase/worker 2.2.12-alpha.7 → 2.2.12-alpha.71

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.2.12-alpha.7",
+  "version": "2.2.12-alpha.71",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -36,10 +36,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.2.12-alpha.7",
-    "@budibase/pro": "2.2.12-alpha.6",
-    "@budibase/string-templates": "2.2.12-alpha.7",
-    "@budibase/types": "2.2.12-alpha.7",
+    "@budibase/backend-core": "2.2.12-alpha.71",
+    "@budibase/pro": "2.2.12-alpha.70",
+    "@budibase/string-templates": "2.2.12-alpha.71",
+    "@budibase/types": "2.2.12-alpha.71",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -97,5 +97,5 @@
     "typescript": "4.7.3",
     "update-dotenv": "1.1.1"
   },
-  "gitHead": "8c7bf5732e843eb43cd1f1590b38f2087d1e0b1c"
+  "gitHead": "4d79e749ea9a2c6ce499123b2b6df778e3641e68"
 }

package/scripts/dev/manage.js

@@ -21,14 +21,14 @@ async function init() {
       COUCH_DB_PASSWORD: "budibase",
       // empty string is false
       MULTI_TENANCY: "",
-      DISABLE_ACCOUNT_PORTAL: "",
+      DISABLE_ACCOUNT_PORTAL: 1,
       ACCOUNT_PORTAL_URL: "http://localhost:10001",
       ACCOUNT_PORTAL_API_KEY: "budibase",
       PLATFORM_URL: "http://localhost:10000",
       APPS_URL: "http://localhost:4001",
       SERVICE: "worker-service",
       DEPLOYMENT_ENVIRONMENT: "development",
-      TENANT_FEATURE_FLAGS: "*:LICENSING,*:USER_GROUPS",
+      TENANT_FEATURE_FLAGS: "*:LICENSING,*:USER_GROUPS,*:ONBOARDING_TOUR",
     }
     let envFile = ""
     Object.keys(envFileJson).forEach(key => {

package/src/api/controllers/global/configs.ts

@@ -267,7 +267,7 @@ export async function publicSettings(ctx: Ctx) {
 
     // enrich the logo url
     // empty url means deleted
-    if (config.config.logoUrl !== "") {
+    if (config.config.logoUrl && config.config.logoUrl !== "") {
       config.config.logoUrl = objectStore.getGlobalFileUrl(
         "settings",
         "logoUrl",

package/src/api/controllers/global/events.ts

@@ -0,0 +1,17 @@
+import {
+  UserCtx,
+  PostEventPublishRequest,
+  EventPublishType,
+} from "@budibase/types"
+import { events } from "@budibase/backend-core"
+
+export async function publish(ctx: UserCtx<PostEventPublishRequest, void>) {
+  switch (ctx.request.body.type) {
+    case EventPublishType.ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED:
+      await events.environmentVariable.upgradePanelOpened(ctx.user._id!)
+      break
+    default:
+      ctx.throw(400, "Invalid publish event type.")
+  }
+  ctx.status = 200
+}

package/src/api/controllers/global/users.ts

@@ -210,6 +210,19 @@ export const inviteMultiple = async (ctx: any) => {
   ctx.body = await sdk.users.invite(request)
 }
 
+export const checkInvite = async (ctx: any) => {
+  const { code } = ctx.params
+  let invite
+  try {
+    invite = await checkInviteCode(code, false)
+  } catch (e) {
+    ctx.throw(400, "There was a problem with the invite")
+  }
+  ctx.body = {
+    email: invite.email,
+  }
+}
+
 export const inviteAccept = async (ctx: any) => {
   const { inviteCode, password, firstName, lastName } = ctx.request.body
   try {

package/src/api/index.ts

@@ -62,6 +62,10 @@ const PUBLIC_ENDPOINTS = [
     route: "/api/system/restored",
     method: "POST",
   },
+  {
+    route: "/api/global/users/invite",
+    method: "GET",
+  },
 ]
 
 const NO_TENANCY_ENDPOINTS = [

package/src/api/routes/global/configs.ts

@@ -34,8 +34,8 @@ function settingValidation() {
 function googleValidation() {
   // prettier-ignore
   return Joi.object({
-    clientID: Joi.string().required(),
-    clientSecret: Joi.string().required(),
+    clientID: Joi.when('activated', { is: true, then: Joi.string().required() }),
+    clientSecret: Joi.when('activated', { is: true, then: Joi.string().required() }),
     activated: Joi.boolean().required(),
   }).unknown(true)
 }
@@ -45,12 +45,12 @@ function oidcValidation() {
   return Joi.object({
     configs: Joi.array().items(
       Joi.object({
-        clientID: Joi.string().required(),
-        clientSecret: Joi.string().required(),
-        configUrl: Joi.string().required(),
+        clientID: Joi.when('activated', { is: true, then: Joi.string().required() }),
+        clientSecret: Joi.when('activated', { is: true, then: Joi.string().required() }),
+        configUrl: Joi.when('activated', { is: true, then: Joi.string().required() }),
         logo: Joi.string().allow("", null),
         name: Joi.string().allow("", null),
-        uuid: Joi.string().required(),
+        uuid: Joi.when('activated', { is: true, then: Joi.string().required() }),
         activated: Joi.boolean().required(),
         scopes: Joi.array().optional()
       })

package/src/api/routes/global/events.ts

@@ -0,0 +1,8 @@
+import Router from "@koa/router"
+import * as controller from "../../controllers/global/events"
+
+const router: Router = new Router()
+
+router.post("/api/global/event/publish", controller.publish)
+
+export default router

package/src/api/routes/global/users.ts

@@ -38,6 +38,13 @@ function buildInviteMultipleValidation() {
   ))
 }
 
+function buildInviteLookupValidation() {
+  // prettier-ignore
+  return auth.joiValidator.params(Joi.object({
+    code: Joi.string().required()
+  }).unknown(true))
+}
+
 const createUserAdminOnly = (ctx: any, next: any) => {
   if (!ctx.request.body._id) {
     return auth.adminOnly(ctx, next)
@@ -51,6 +58,8 @@ function buildInviteAcceptValidation() {
   return auth.joiValidator.body(Joi.object({
     inviteCode: Joi.string().required(),
     password: Joi.string().required(),
+    firstName: Joi.string().required(),
+    lastName: Joi.string().optional(),
   }).required().unknown(true))
 }
 
@@ -91,6 +100,11 @@ router
   )
 
   // non-global endpoints
+  .get(
+    "/api/global/users/invite/:code",
+    buildInviteLookupValidation(),
+    controller.checkInvite
+  )
   .post(
     "/api/global/users/invite/accept",
     buildInviteAcceptValidation(),

package/src/api/routes/index.ts

@@ -7,6 +7,7 @@ import templateRoutes from "./global/templates"
 import emailRoutes from "./global/email"
 import authRoutes from "./global/auth"
 import roleRoutes from "./global/roles"
+import eventRoutes from "./global/events"
 import environmentRoutes from "./system/environment"
 import tenantsRoutes from "./system/tenants"
 import statusRoutes from "./system/status"
@@ -34,4 +35,5 @@ export const routes: Router[] = [
   migrationRoutes,
   accountRoutes,
   restoreRoutes,
+  eventRoutes,
 ]

package/src/index.ts

@@ -14,7 +14,7 @@ import { Event } from "@sentry/types/dist/event"
 import Application from "koa"
 import { bootstrap } from "global-agent"
 import * as db from "./db"
-import { auth, logging, events } from "@budibase/backend-core"
+import { auth, logging, events, middleware } from "@budibase/backend-core"
 db.init()
 import Koa from "koa"
 import koaBody from "koa-body"
@@ -36,6 +36,7 @@ app.keys = ["secret", "key"]
 // set up top level koa middleware
 app.use(koaBody({ multipart: true }))
 app.use(koaSession(app))
+app.use(middleware.logging)
 app.use(logger(logging.pinoSettings()))
 
 // authentication

package/src/sdk/users/events.ts

@@ -73,6 +73,10 @@ export const handleSaveEvents = async (
       await events.user.permissionAdminRemoved(user)
     }
 
+    if (isOnboardingComplete(user, existingUser)) {
+      await events.user.onboardingComplete(user)
+    }
+
     if (
       !existingUser.forceResetPassword &&
       user.forceResetPassword &&
@@ -114,6 +118,10 @@ const isRemovingAdmin = (user: any, existingUser: any) => {
   return isRemovingPermission(user, existingUser, isAdmin)
 }
 
+const isOnboardingComplete = (user: any, existingUser: any) => {
+  return !existingUser?.onboardedAt && typeof user.onboardedAt === "string"
+}
+
 /**
  * Check if a permission is being added to a new or existing user.
  */

package/src/sdk/users/users.ts

@@ -31,6 +31,7 @@ import {
   SearchUsersRequest,
   User,
   ThirdPartyUser,
+  isUser,
 } from "@budibase/types"
 import { sendEmail } from "../../utilities/email"
 import { EmailTemplatePurpose } from "../../constants"
@@ -265,8 +266,9 @@ export const save = async (
     await eventHelpers.handleSaveEvents(builtUser, dbUser)
     await addTenant(tenantId, _id, email)
     await cache.user.invalidateUser(response.id)
+
     // let server know to sync user
-    await apps.syncUserInApps(_id)
+    await apps.syncUserInApps(_id, dbUser)
 
     await Promise.all(groupPromises)
 
@@ -572,7 +574,7 @@ export const destroy = async (id: string, currentUser: any) => {
   await cache.user.invalidateUser(userId)
   await sessions.invalidateSessions(userId, { reason: "deletion" })
   // let server know to sync user
-  await apps.syncUserInApps(userId)
+  await apps.syncUserInApps(userId, dbUser)
 }
 
 const bulkDeleteProcessing = async (dbUser: User) => {
@@ -582,7 +584,7 @@ const bulkDeleteProcessing = async (dbUser: User) => {
   await cache.user.invalidateUser(userId)
   await sessions.invalidateSessions(userId, { reason: "bulk-deletion" })
   // let server know to sync user
-  await apps.syncUserInApps(userId)
+  await apps.syncUserInApps(userId, dbUser)
 }
 
 export const invite = async (

package/src/tests/api/users.ts

@@ -48,6 +48,7 @@ export class UserAPI extends TestAPI {
       .send({
         password: "newpassword",
         inviteCode: code,
+        firstName: "Ted",
       })
       .expect("Content-Type", /json/)
       .expect(200)

package/src/utilities/appService.ts

@@ -1,7 +1,8 @@
 import fetch from "node-fetch"
-import { constants, tenancy } from "@budibase/backend-core"
+import { constants, tenancy, logging } from "@budibase/backend-core"
 import { checkSlashesInUrl } from "../utilities"
 import env from "../environment"
+import { SyncUserRequest, User } from "@budibase/types"
 
 async function makeAppRequest(url: string, method: string, body: any) {
   if (env.isTest()) {
@@ -17,14 +18,22 @@ async function makeAppRequest(url: string, method: string, body: any) {
     request.body = JSON.stringify(body)
   }
   request.method = method
+
+  // add x-budibase-correlation-id header
+  logging.correlation.setHeader(request.headers)
+
   return fetch(checkSlashesInUrl(env.APPS_URL + url), request)
 }
 
-export async function syncUserInApps(userId: string) {
+export async function syncUserInApps(userId: string, previousUser?: User) {
+  const body: SyncUserRequest = {
+    previousUser,
+  }
+
   const response = await makeAppRequest(
     `/api/users/metadata/sync/${userId}`,
     "POST",
-    {}
+    body
   )
   if (response && response.status !== 200) {
     throw "Unable to sync user."

package/tsconfig.json

@@ -13,7 +13,8 @@
     }
   },
   "ts-node": {
-    "require": ["tsconfig-paths/register"]
+    "require": ["tsconfig-paths/register"],
+    "swc": true
   },
   "references": [
     { "path": "../types" },