@budibase/worker 3.12.6 → 3.12.7

package/nodemon.json

@@ -5,7 +5,8 @@
     "../pro",
     "../types",
     "../shared-core",
-    "../string-templates"
+    "../string-templates",
+    "../../.env"
   ],
   "ext": "js,ts,json",
   "ignore": ["**/*.spec.ts", "**/*.spec.js", "../*/dist/**/*"],

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "3.12.6",
+  "version": "3.12.7",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -21,19 +21,10 @@
     "run:docker": "node dist/index.js",
     "debug": "yarn build && node --expose-gc --inspect=9223 dist/index.js",
     "run:docker:cluster": "pm2-runtime start pm2.config.js",
-    "dev:stack:init": "node ./scripts/dev/manage.js init",
-    "dev": "npm run dev:stack:init && nodemon",
-    "dev:built": "yarn run dev:stack:init && yarn run run:docker",
+    "dev": "nodemon",
+    "dev:built": "yarn run run:docker",
     "test": "bash scripts/test.sh",
-    "test:watch": "jest --watch",
-    "env:multi:enable": "node scripts/multiTenancy.js enable",
-    "env:multi:disable": "node scripts/multiTenancy.js disable",
-    "env:selfhost:enable": "node scripts/selfhost.js enable",
-    "env:selfhost:disable": "node scripts/selfhost.js disable",
-    "env:localdomain:enable": "node scripts/localdomain.js enable",
-    "env:localdomain:disable": "node scripts/localdomain.js disable",
-    "env:account:enable": "node scripts/account.js enable",
-    "env:account:disable": "node scripts/account.js disable"
+    "test:watch": "jest --watch"
   },
   "author": "Budibase",
   "license": "GPL-3.0",
@@ -102,8 +93,7 @@
     "superagent": "^10.1.1",
     "supertest": "6.3.3",
     "timekeeper": "2.2.0",
-    "typescript": "5.7.2",
-    "update-dotenv": "1.1.1"
+    "typescript": "5.7.2"
   },
   "resolutions": {
     "@budibase/pro": "npm:@budibase/pro@latest"
@@ -123,5 +113,5 @@
       }
     }
   },
-  "gitHead": "a9dabfd71bc85ee7bff3ad4c1421e1478987d0a2"
+  "gitHead": "87d0fd4e2bfa88a5f45312ce133670856957b97b"
 }

package/src/environment.ts

@@ -1,14 +1,18 @@
 import { env as coreEnv } from "@budibase/backend-core"
 import { ServiceType } from "@budibase/types"
-import { join } from "path"
+import { join, resolve } from "path"
 import cloneDeep from "lodash/cloneDeep"
 
 coreEnv._set("SERVICE_TYPE", ServiceType.WORKER)
 
+const TOP_LEVEL_PATH =
+  process.env.TOP_LEVEL_PATH ||
+  process.env.WORKER_TOP_LEVEL_PATH ||
+  resolve(join(__dirname, "..", "..", ".."))
 let LOADED = false
 if (!LOADED && coreEnv.isDev() && !coreEnv.isTest()) {
   require("dotenv").config({
-    path: join(__dirname, "..", ".env"),
+    path: join(TOP_LEVEL_PATH, ".env"),
   })
   LOADED = true
 }
@@ -40,6 +44,7 @@ const environment = {
   // prefer worker port to generic port
   PORT: process.env.WORKER_PORT || process.env.PORT,
   CLUSTER_PORT: process.env.CLUSTER_PORT,
+  WORKER_SERVICE: process.env.WORKER_SERVICE,
   // flags
   NODE_ENV: process.env.NODE_ENV,
   SELF_HOSTED: !!parseInt(process.env.SELF_HOSTED || ""),
@@ -59,6 +64,7 @@ const environment = {
   SESSION_UPDATE_PERIOD: process.env.SESSION_UPDATE_PERIOD,
   ENCRYPTED_TEST_PUBLIC_API_KEY: process.env.ENCRYPTED_TEST_PUBLIC_API_KEY,
   SESSION_EXPIRY_SECONDS: process.env.SESSION_EXPIRY_SECONDS,
+  TOP_LEVEL_PATH: TOP_LEVEL_PATH,
   /**
    * Mock the email service in use - links to ethereal hosted emails are logged instead.
    */

package/src/index.ts

@@ -85,10 +85,12 @@ app.use(api.routes())
 
 const server = http.createServer(app.callback())
 
-const shutdown = async () => {
-  console.log("Worker service shutting down gracefully...")
+const shutdown = async (signal?: string) => {
+  console.log(
+    `Worker service shutting down gracefully... ${signal ? `Signal: ${signal}` : ""}`
+  )
   timers.cleanup()
-  events.shutdown()
+  await events.shutdown()
   await redis.clients.shutdown()
   await queue.shutdown()
 }
@@ -97,7 +99,7 @@ gracefulShutdown(server, {
   signals: "SIGINT SIGTERM",
   timeout: 30000,
   onShutdown: shutdown,
-  forceExit: !env.isTest,
+  forceExit: !env.isTest(),
   finally: () => {
     console.log("Worker service shutdown complete")
   },
@@ -106,7 +108,7 @@ gracefulShutdown(server, {
 process.on("uncaughtException", async err => {
   logging.logAlert("Uncaught exception.", err)
   await shutdown()
-  if (!env.isTest) {
+  if (!env.isTest()) {
     process.exit(1)
   }
 })
@@ -114,7 +116,7 @@ process.on("uncaughtException", async err => {
 process.on("unhandledRejection", async reason => {
   logging.logAlert("Unhandled Promise Rejection", reason as Error)
   await shutdown()
-  if (!env.isTest) {
+  if (!env.isTest()) {
     process.exit(1)
   }
 })

package/src/tests/TestConfiguration.ts

@@ -37,10 +37,14 @@ import {
 } from "@budibase/types"
 import API from "./api"
 import jwt, { Secret } from "jsonwebtoken"
+import http from "http"
 
 class TestConfiguration {
-  server: any
-  request: any
+  server: http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> =
+    undefined!
+
+  request: supertest.SuperTest<supertest.Test> = undefined!
+
   api: API
   tenantId: string
   user?: User

package/scripts/account.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-const updateDotEnv = require("update-dotenv")
-
-const arg = process.argv.slice(2)[0]
-
-updateDotEnv({
-  DISABLE_ACCOUNT_PORTAL: arg === "enable" ? "" : "1",
-}).then(() => console.log("Updated worker!"))

package/scripts/dev/manage.js

@@ -1,55 +0,0 @@
-#!/usr/bin/env node
-const { parsed: existingConfig } = require("dotenv").config()
-const updateDotEnv = require("update-dotenv")
-
-async function init() {
-  let config = {
-    SELF_HOSTED: "1",
-    PORT: "4002",
-    CLUSTER_PORT: "10000",
-    JWT_SECRET: "testsecret",
-    INTERNAL_API_KEY: "budibase",
-    MINIO_ACCESS_KEY: "budibase",
-    MINIO_SECRET_KEY: "budibase",
-    REDIS_URL: "localhost:6379",
-    REDIS_PASSWORD: "budibase",
-    MINIO_URL: "http://localhost:4004",
-    COUCH_DB_URL: "http://budibase:budibase@localhost:4005",
-    COUCH_DB_USERNAME: "budibase",
-    COUCH_DB_PASSWORD: "budibase",
-    // empty string is false
-    MULTI_TENANCY: "",
-    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",
-    ENABLE_EMAIL_TEST_MODE: "1",
-    HTTP_LOGGING: "0",
-    VERSION: "0.0.0+local",
-    PASSWORD_MIN_LENGTH: "1",
-  }
-
-  config = { ...config, ...existingConfig }
-
-  await updateDotEnv(config)
-}
-
-// if more than init required use this to determine the command type
-//const managementCommand = process.argv.slice(2)[0]
-
-// for now only one command
-let command = init
-
-command()
-  .then(() => {
-    console.log("Done! 🎉")
-  })
-  .catch(err => {
-    console.error(
-      "Something went wrong while managing budibase dev worker:",
-      err.message
-    )
-  })

package/scripts/localdomain.js

@@ -1,52 +0,0 @@
-#!/usr/bin/env node
-const updateDotEnv = require("update-dotenv")
-
-const arg = process.argv.slice(2)[0]
-const isEnable = arg === "enable"
-
-let domain = process.argv.slice(2)[1]
-if (!domain) {
-  domain = "local.com"
-}
-
-const getAccountPortalUrl = () => {
-  if (isEnable) {
-    return `http://account.${domain}:10001`
-  } else {
-    return `http://localhost:10001`
-  }
-}
-
-const getBudibaseUrl = () => {
-  if (isEnable) {
-    return `http://${domain}:10000`
-  } else {
-    return `http://localhost:10000`
-  }
-}
-
-const getCookieDomain = () => {
-  if (isEnable) {
-    return `.${domain}`
-  } else {
-    return ""
-  }
-}
-
-/**
- * For testing multi tenancy sub domains locally.
- *
- * Relies on an entry in /etc/hosts e.g:
- *
- * 127.0.0.1   local.com
- *
- * and an entry for each tenant you wish to test locally e.g:
- *
- * 127.0.0.1   t1.local.com
- * 127.0.0.1   t2.local.com
- */
-updateDotEnv({
-  ACCOUNT_PORTAL_URL: getAccountPortalUrl(),
-  COOKIE_DOMAIN: getCookieDomain(),
-  PLATFORM_URL: getBudibaseUrl(),
-}).then(() => console.log("Updated worker!"))

package/scripts/multiTenancy.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-const updateDotEnv = require("update-dotenv")
-
-const arg = process.argv.slice(2)[0]
-
-updateDotEnv({
-  MULTI_TENANCY: arg === "enable" ? "1" : "",
-}).then(() => console.log("Updated worker!"))

package/scripts/selfhost.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-const updateDotEnv = require("update-dotenv")
-
-const arg = process.argv.slice(2)[0]
-
-updateDotEnv({
-  SELF_HOSTED: arg === "enable" ? "1" : "0",
-}).then(() => console.log("Updated worker!"))