@budibase/worker 1.2.6 → 1.2.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "1.2.6",
+  "version": "1.2.9",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -35,10 +35,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "^1.2.6",
-    "@budibase/pro": "1.2.5",
-    "@budibase/string-templates": "^1.2.6",
-    "@budibase/types": "^1.2.6",
+    "@budibase/backend-core": "^1.2.9",
+    "@budibase/pro": "1.2.8",
+    "@budibase/string-templates": "^1.2.9",
+    "@budibase/types": "^1.2.9",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -101,5 +101,5 @@
       "./scripts/jestSetup.js"
     ]
   },
-  "gitHead": "7aa3a20ecc0f6d0f4617c6e703bf4f6f1998071e"
+  "gitHead": "c6e737e509e3e9651e726dbb4569252b8b355a17"
 }

package/src/api/controllers/system/migrations.ts

@@ -0,0 +1,13 @@
+const { migrate, MIGRATIONS } = require("../../../migrations")
+
+export const runMigrations = async (ctx: any) => {
+  const options = ctx.request.body
+  // don't await as can take a while, just return
+  migrate(options)
+  ctx.status = 200
+}
+
+export const fetchDefinitions = async (ctx: any) => {
+  ctx.body = MIGRATIONS
+  ctx.status = 200
+}

package/src/api/index.js

@@ -106,7 +106,10 @@ router
     if (ctx.publicEndpoint) {
       return next()
     }
-    if ((!ctx.isAuthenticated || !ctx.user.budibaseAccess) && !ctx.internal) {
+    if (
+      (!ctx.isAuthenticated || (ctx.user && !ctx.user.budibaseAccess)) &&
+      !ctx.internal
+    ) {
       ctx.throw(403, "Unauthorized - no public worker access")
     }
     return next()

package/src/api/routes/index.js

@@ -12,6 +12,7 @@ const tenantsRoutes = require("./system/tenants")
 const statusRoutes = require("./system/status")
 const selfRoutes = require("./global/self")
 const licenseRoutes = require("./global/license")
+const migrationRoutes = require("./system/migrations")
 
 let userGroupRoutes = api.groups
 exports.routes = [
@@ -29,4 +30,5 @@ exports.routes = [
   selfRoutes,
   licenseRoutes,
   userGroupRoutes,
+  migrationRoutes,
 ]

package/src/api/routes/system/migrations.ts

@@ -0,0 +1,19 @@
+import Router from "@koa/router"
+import * as migrationsController from "../../controllers/system/migrations"
+import { auth } from "@budibase/backend-core"
+
+const router = new Router()
+
+router
+  .post(
+    "/api/system/migrations/run",
+    auth.internalApi,
+    migrationsController.runMigrations
+  )
+  .get(
+    "/api/system/migrations/definitions",
+    auth.internalApi,
+    migrationsController.fetchDefinitions
+  )
+
+export = router

package/src/migrations/functions/globalInfoSyncUsers.ts

@@ -0,0 +1,20 @@
+import { User } from "@budibase/types"
+import * as sdk from "../../sdk"
+
+/**
+ * Date:
+ * Aug 2022
+ *
+ * Description:
+ * Re-sync the global-db users to the global-info db users
+ */
+export const run = async (globalDb: any) => {
+  const users = (await sdk.users.allUsers()) as User[]
+  const promises = []
+  for (let user of users) {
+    promises.push(
+      sdk.users.addTenant(user.tenantId, user._id as string, user.email)
+    )
+  }
+  await Promise.all(promises)
+}

package/src/migrations/index.ts

@@ -0,0 +1,74 @@
+import { migrations, redis } from "@budibase/backend-core"
+import { Migration, MigrationOptions, MigrationName } from "@budibase/types"
+import env from "../environment"
+
+// migration functions
+import * as syncUserInfo from "./functions/globalInfoSyncUsers"
+
+/**
+ * Populate the migration function and additional configuration from
+ * the static migration definitions.
+ */
+export const buildMigrations = () => {
+  const definitions = migrations.DEFINITIONS
+  const workerMigrations: Migration[] = []
+
+  for (const definition of definitions) {
+    switch (definition.name) {
+      case MigrationName.GLOBAL_INFO_SYNC_USERS: {
+        // only needed in cloud
+        if (!env.SELF_HOSTED) {
+          workerMigrations.push({
+            ...definition,
+            fn: syncUserInfo.run,
+          })
+        }
+        break
+      }
+    }
+  }
+
+  return workerMigrations
+}
+
+export const MIGRATIONS = buildMigrations()
+
+export const migrate = async (options?: MigrationOptions) => {
+  if (env.SELF_HOSTED) {
+    await migrateWithLock(options)
+  } else {
+    await migrations.runMigrations(MIGRATIONS, options)
+  }
+}
+
+const migrateWithLock = async (options?: MigrationOptions) => {
+  // get a new lock client
+  const redlock = await redis.clients.getMigrationsRedlock()
+  // lock for 15 minutes
+  const ttl = 1000 * 60 * 15
+
+  let migrationLock
+
+  // acquire lock
+  try {
+    migrationLock = await redlock.lock("migrations", ttl)
+  } catch (e: any) {
+    if (e.name === "LockError") {
+      return
+    } else {
+      throw e
+    }
+  }
+
+  // run migrations
+  try {
+    await migrations.runMigrations(MIGRATIONS, options)
+  } finally {
+    // release lock
+    try {
+      await migrationLock.unlock()
+    } catch (e) {
+      console.error("unable to release migration lock")
+    }
+  }
+}

package/src/sdk/users/users.ts

@@ -101,12 +101,11 @@ interface SaveUserOpts {
   bulkCreate?: boolean
 }
 
-export const buildUser = async (
+const buildUser = async (
   user: any,
   opts: SaveUserOpts = {
     hashPassword: true,
     requirePassword: true,
-    bulkCreate: false,
   },
   tenantId: string,
   dbUser?: any
@@ -185,15 +184,12 @@ export const save = async (
     dbUser = await db.get(_id)
   }
 
-  let builtUser = await buildUser(
-    user,
-    {
-      hashPassword: true,
-      requirePassword: user.requirePassword,
-    },
-    tenantId,
-    dbUser
-  )
+  let builtUser = await buildUser(user, opts, tenantId, dbUser)
+
+  // make sure we set the _id field for a new user
+  if (!_id) {
+    _id = builtUser._id
+  }
 
   try {
     const putOpts = {
@@ -220,7 +216,7 @@ export const save = async (
     await addTenant(tenantId, _id, email)
     await cache.user.invalidateUser(response.id)
     // let server know to sync user
-    await apps.syncUserInApps(builtUser._id)
+    await apps.syncUserInApps(_id)
 
     return {
       _id: response.id,
@@ -293,7 +289,6 @@ export const bulkCreate = async (
         {
           hashPassword: true,
           requirePassword: user.requirePassword,
-          bulkCreate: false,
         },
         tenantId
       )
@@ -305,6 +300,9 @@ export const bulkCreate = async (
 
   // Post processing of bulk added users, i.e events and cache operations
   for (const user of usersToBulkSave) {
+    // TODO: Refactor to bulk insert users into the info db
+    // instead of relying on looping tenant creation
+    await addTenant(tenantId, user._id, user.email)
     await eventHelpers.handleSaveEvents(user, null)
     await apps.syncUserInApps(user._id)
   }