@budibase/worker 3.2.27 → 3.2.29

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.2.27",
+  "version": "3.2.29",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -114,5 +114,5 @@
       }
     }
   },
-  "gitHead": "1ea577227cec7d169dfc3e13f4b7eced8fdbc53c"
+  "gitHead": "047c20252062a6f96aa2028bc4f9c5c882cd6860"
 }

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

@@ -22,6 +22,8 @@ import {
   GetInitInfoResponse,
   PasswordResetResponse,
   PasswordResetUpdateResponse,
+  SetInitInfoResponse,
+  LoginResponse,
 } from "@budibase/types"
 import env from "../../../environment"
 import { Next } from "koa"
@@ -59,7 +61,10 @@ async function passportCallback(
   ctx.set(Header.TOKEN, token)
 }
 
-export const login = async (ctx: Ctx<LoginRequest, void>, next: Next) => {
+export const login = async (
+  ctx: Ctx<LoginRequest, LoginResponse>,
+  next: Next
+) => {
   const email = ctx.request.body.username
 
   const user = await userSdk.db.getUserByEmail(email)
@@ -74,7 +79,10 @@ export const login = async (ctx: Ctx<LoginRequest, void>, next: Next) => {
       await context.identity.doInUserContext(user, ctx, async () => {
         await events.auth.login("local", user.email)
       })
-      ctx.status = 200
+      ctx.body = {
+        message: "Login successful",
+        userId: user.userId,
+      }
     }
   )(ctx, next)
 }
@@ -88,10 +96,14 @@ export const logout = async (ctx: UserCtx<void, LogoutResponse>) => {
 
 // INIT
 
-export const setInitInfo = (ctx: UserCtx<SetInitInfoRequest, void>) => {
+export const setInitInfo = (
+  ctx: UserCtx<SetInitInfoRequest, SetInitInfoResponse>
+) => {
   const initInfo = ctx.request.body
   setCookie(ctx, initInfo, Cookie.Init)
-  ctx.status = 200
+  ctx.body = {
+    message: "Init info updated.",
+  }
 }
 
 export const getInitInfo = (ctx: UserCtx<void, GetInitInfoResponse>) => {

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

@@ -2,10 +2,13 @@ import {
   UserCtx,
   PostEventPublishRequest,
   EventPublishType,
+  PostEventPublishResponse,
 } from "@budibase/types"
 import { events } from "@budibase/backend-core"
 
-export async function publish(ctx: UserCtx<PostEventPublishRequest, void>) {
+export async function publish(
+  ctx: UserCtx<PostEventPublishRequest, PostEventPublishResponse>
+) {
   switch (ctx.request.body.type) {
     case EventPublishType.ENVIRONMENT_VARIABLE_UPGRADE_PANEL_OPENED:
       await events.environmentVariable.upgradePanelOpened(ctx.user._id!)
@@ -13,5 +16,5 @@ export async function publish(ctx: UserCtx<PostEventPublishRequest, void>) {
     default:
       ctx.throw(400, "Invalid publish event type.")
   }
-  ctx.status = 200
+  ctx.body = { message: "Event published." }
 }

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

@@ -1,29 +1,33 @@
 import { licensing, quotas } from "@budibase/pro"
 import {
   ActivateLicenseKeyRequest,
+  ActivateLicenseKeyResponse,
   ActivateOfflineLicenseTokenRequest,
+  ActivateOfflineLicenseTokenResponse,
   GetLicenseKeyResponse,
   GetOfflineIdentifierResponse,
   GetOfflineLicenseTokenResponse,
   GetQuotaUsageResponse,
+  RefreshOfflineLicenseResponse,
   UserCtx,
 } from "@budibase/types"
 
 // LICENSE KEY
 
 export async function activateLicenseKey(
-  ctx: UserCtx<ActivateLicenseKeyRequest>
+  ctx: UserCtx<ActivateLicenseKeyRequest, ActivateLicenseKeyResponse>
 ) {
   const { licenseKey } = ctx.request.body
   await licensing.keys.activateLicenseKey(licenseKey)
-  ctx.status = 200
+  ctx.body = {
+    message: "License activated.",
+  }
 }
 
 export async function getLicenseKey(ctx: UserCtx<void, GetLicenseKeyResponse>) {
   const licenseKey = await licensing.keys.getLicenseKey()
   if (licenseKey) {
     ctx.body = { licenseKey: "*" }
-    ctx.status = 200
   } else {
     ctx.status = 404
   }
@@ -37,11 +41,16 @@ export async function deleteLicenseKey(ctx: UserCtx<void, void>) {
 // OFFLINE LICENSE
 
 export async function activateOfflineLicenseToken(
-  ctx: UserCtx<ActivateOfflineLicenseTokenRequest, void>
+  ctx: UserCtx<
+    ActivateOfflineLicenseTokenRequest,
+    ActivateOfflineLicenseTokenResponse
+  >
 ) {
   const { offlineLicenseToken } = ctx.request.body
   await licensing.offline.activateOfflineLicenseToken(offlineLicenseToken)
-  ctx.status = 200
+  ctx.body = {
+    message: "License token activated.",
+  }
 }
 
 export async function getOfflineLicenseToken(
@@ -50,7 +59,6 @@ export async function getOfflineLicenseToken(
   const offlineLicenseToken = await licensing.offline.getOfflineLicenseToken()
   if (offlineLicenseToken) {
     ctx.body = { offlineLicenseToken: "*" }
-    ctx.status = 200
   } else {
     ctx.status = 404
   }
@@ -66,14 +74,17 @@ export async function getOfflineLicenseIdentifier(
 ) {
   const identifierBase64 = await licensing.offline.getIdentifierBase64()
   ctx.body = { identifierBase64 }
-  ctx.status = 200
 }
 
 // LICENSES
 
-export const refresh = async (ctx: UserCtx<void, void>) => {
+export const refresh = async (
+  ctx: UserCtx<void, RefreshOfflineLicenseResponse>
+) => {
   await licensing.cache.refresh()
-  ctx.status = 200
+  ctx.body = {
+    message: "License refreshed.",
+  }
 }
 
 // USAGE
@@ -82,5 +93,4 @@ export const getQuotaUsage = async (
   ctx: UserCtx<void, GetQuotaUsageResponse>
 ) => {
   ctx.body = await quotas.getQuotaUsage()
-  ctx.status = 200
 }

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

@@ -4,6 +4,7 @@ import {
   AcceptUserInviteRequest,
   AcceptUserInviteResponse,
   AddSSoUserRequest,
+  AddSSoUserResponse,
   BulkUserRequest,
   BulkUserResponse,
   CheckInviteResponse,
@@ -93,7 +94,9 @@ export const save = async (ctx: UserCtx<User, SaveUserResponse>) => {
   }
 }
 
-export const addSsoSupport = async (ctx: Ctx<AddSSoUserRequest, void>) => {
+export const addSsoSupport = async (
+  ctx: Ctx<AddSSoUserRequest, AddSSoUserResponse>
+) => {
   const { email, ssoId } = ctx.request.body
   try {
     // Status is changed to 404 from getUserDoc if user is not found
@@ -113,7 +116,7 @@ export const addSsoSupport = async (ctx: Ctx<AddSSoUserRequest, void>) => {
       email,
       ssoId,
     })
-    ctx.status = 200
+    ctx.body = { message: "SSO support added." }
   } catch (err: any) {
     ctx.throw(err.status || 400, err)
   }

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

@@ -19,7 +19,6 @@ export const save = async (
   metadata = await accounts.metadata.saveMetadata(metadata)
 
   ctx.body = metadata
-  ctx.status = 200
 }
 
 export const destroy = async (ctx: Ctx<void, void>) => {

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

@@ -1,23 +1,23 @@
 import {
   FetchMigrationDefinitionsResponse,
   RunGlobalMigrationRequest,
+  RunGlobalMigrationResponse,
   UserCtx,
 } from "@budibase/types"
 
 const { migrate, MIGRATIONS } = require("../../../migrations")
 
 export const runMigrations = async (
-  ctx: UserCtx<RunGlobalMigrationRequest, void>
+  ctx: UserCtx<RunGlobalMigrationRequest, RunGlobalMigrationResponse>
 ) => {
   const options = ctx.request.body
   // don't await as can take a while, just return
   migrate(options)
-  ctx.status = 200
+  ctx.body = { message: "Migration started." }
 }
 
 export const fetchDefinitions = async (
   ctx: UserCtx<void, FetchMigrationDefinitionsResponse>
 ) => {
   ctx.body = MIGRATIONS
-  ctx.status = 200
 }

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

@@ -36,7 +36,7 @@ describe("/api/system/migrations", () => {
 
     it("runs migrations", async () => {
       const res = await config.api.migrations.runMigrations()
-      expect(res.text).toBe("OK")
+      expect(res.body.message).toBeDefined()
       expect(migrateFn).toHaveBeenCalledTimes(1)
     })
   })