@budibase/backend-core 2.6.18 → 2.6.19-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budibase/backend-core",
-  "version": "2.6.18",
+  "version": "2.6.19-alpha.0",
   "description": "Budibase backend core libraries used in server and worker",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -15,8 +15,6 @@
     "prebuild": "rimraf dist/",
     "prepack": "cp package.json dist",
     "build": "tsc -p tsconfig.build.json",
-    "build:pro": "../../scripts/pro/build.sh",
-    "postbuild": "yarn run build:pro",
     "build:dev": "yarn prebuild && tsc --build --watch --preserveWatchOutput",
     "test": "bash scripts/test.sh",
     "test:watch": "jest --watchAll"
@@ -24,7 +22,7 @@
   "dependencies": {
     "@budibase/nano": "10.1.2",
     "@budibase/pouchdb-replication-stream": "1.2.10",
-    "@budibase/types": "^2.6.18",
+    "@budibase/types": "2.6.19-alpha.0",
     "@shopify/jest-koa-mocks": "5.0.1",
     "@techpass/passport-openidconnect": "0.3.2",
     "aws-cloudfront-sign": "2.2.0",
@@ -90,5 +88,5 @@
     "tsconfig-paths": "4.0.0",
     "typescript": "4.7.3"
   },
-  "gitHead": "6e97c358e00e4a7be0c620858c564960c393c1b8"
+  "gitHead": "82e867c0f5b41fe3af88333effeb88f29b8b4d23"
 }

package/src/constants/db.ts

@@ -21,7 +21,7 @@ export enum ViewName {
   AUTOMATION_LOGS = "automation_logs",
   ACCOUNT_BY_EMAIL = "account_by_email",
   PLATFORM_USERS_LOWERCASE = "platform_users_lowercase",
-  USER_BY_GROUP = "by_group_user",
+  USER_BY_GROUP = "user_by_group",
   APP_BACKUP_BY_TRIGGER = "by_trigger",
 }
 

package/src/db/couch/DatabaseImpl.ts

@@ -12,7 +12,7 @@ import {
   isDocument,
 } from "@budibase/types"
 import { getCouchInfo } from "./connections"
-import { directCouchCall } from "./utils"
+import { directCouchUrlCall } from "./utils"
 import { getPouchDB } from "./pouchDB"
 import { WriteStream, ReadStream } from "fs"
 import { newid } from "../../docIds/newid"
@@ -46,6 +46,8 @@ export class DatabaseImpl implements Database {
   private readonly instanceNano?: Nano.ServerScope
   private readonly pouchOpts: DatabaseOpts
 
+  private readonly couchInfo = getCouchInfo()
+
   constructor(dbName?: string, opts?: DatabaseOpts, connection?: string) {
     if (dbName == null) {
       throw new Error("Database name cannot be undefined.")
@@ -53,8 +55,8 @@ export class DatabaseImpl implements Database {
     this.name = dbName
     this.pouchOpts = opts || {}
     if (connection) {
-      const couchInfo = getCouchInfo(connection)
-      this.instanceNano = buildNano(couchInfo)
+      this.couchInfo = getCouchInfo(connection)
+      this.instanceNano = buildNano(this.couchInfo)
     }
     if (!DatabaseImpl.nano) {
       DatabaseImpl.init()
@@ -67,7 +69,11 @@ export class DatabaseImpl implements Database {
   }
 
   async exists() {
-    let response = await directCouchCall(`/${this.name}`, "HEAD")
+    const response = await directCouchUrlCall({
+      url: `${this.couchInfo.url}/${this.name}`,
+      method: "HEAD",
+      cookie: this.couchInfo.cookie,
+    })
     return response.status === 200
   }
 

package/src/db/couch/connections.ts

@@ -4,21 +4,21 @@ export const getCouchInfo = (connection?: string) => {
   const urlInfo = getUrlInfo(connection)
   let username
   let password
-  if (env.COUCH_DB_USERNAME) {
-    // set from env
-    username = env.COUCH_DB_USERNAME
-  } else if (urlInfo.auth.username) {
+  if (urlInfo.auth?.username) {
     // set from url
     username = urlInfo.auth.username
+  } else if (env.COUCH_DB_USERNAME) {
+    // set from env
+    username = env.COUCH_DB_USERNAME
   } else if (!env.isTest()) {
     throw new Error("CouchDB username not set")
   }
-  if (env.COUCH_DB_PASSWORD) {
-    // set from env
-    password = env.COUCH_DB_PASSWORD
-  } else if (urlInfo.auth.password) {
+  if (urlInfo.auth?.password) {
     // set from url
     password = urlInfo.auth.password
+  } else if (env.COUCH_DB_PASSWORD) {
+    // set from env
+    password = env.COUCH_DB_PASSWORD
   } else if (!env.isTest()) {
     throw new Error("CouchDB password not set")
   }

package/src/db/couch/utils.ts

@@ -9,6 +9,20 @@ export async function directCouchCall(
 ) {
   let { url, cookie } = getCouchInfo()
   const couchUrl = `${url}/${path}`
+  return await directCouchUrlCall({ url: couchUrl, cookie, method, body })
+}
+
+export async function directCouchUrlCall({
+  url,
+  cookie,
+  method,
+  body,
+}: {
+  url: string
+  cookie: string
+  method: string
+  body?: any
+}) {
   const params: any = {
     method: method,
     headers: {
@@ -19,7 +33,7 @@ export async function directCouchCall(
     params.body = JSON.stringify(body)
     params.headers["Content-Type"] = "application/json"
   }
-  return await fetch(checkSlashesInUrl(encodeURI(couchUrl)), params)
+  return await fetch(checkSlashesInUrl(encodeURI(url)), params)
 }
 
 export async function directCouchQuery(

package/src/logging/pino/logger.ts

@@ -94,12 +94,37 @@ if (!env.DISABLE_PINO_LOGGER) {
       }
     }
 
-    const mergingObject = {
-      objects: objects.length ? objects : undefined,
+    const mergingObject: any = {
       err: error,
       ...contextObject,
     }
 
+    if (objects.length) {
+      // init generic data object for params supplied that don't have a
+      // '_logKey' field. This prints an object using argument index as the key
+      // e.g. { 0: {}, 1: {} }
+      const data: any = {}
+      let dataIndex = 0
+
+      for (let i = 0; i < objects.length; i++) {
+        const object = objects[i]
+        // the object has specified a log key
+        // use this instead of generic key
+        const logKey = object._logKey
+        if (logKey) {
+          delete object._logKey
+          mergingObject[logKey] = object
+        } else {
+          data[dataIndex] = object
+          dataIndex++
+        }
+      }
+
+      if (Object.keys(data).length) {
+        mergingObject.data = data
+      }
+    }
+
     return [mergingObject, message]
   }
 

package/src/queue/listeners.ts

@@ -45,7 +45,8 @@ function getLogParams(
   const message = `[BULL] ${eventType}=${event}`
   const err = opts.error
 
-  const data = {
+  const bullLog = {
+    _logKey: "bull",
     eventType,
     event,
     job: opts.job,
@@ -53,7 +54,17 @@ function getLogParams(
     ...extra,
   }
 
-  return [message, err, data]
+  let automationLog
+  if (opts.job?.data?.automation) {
+    automationLog = {
+      _logKey: "automation",
+      trigger: opts.job
+        ? opts.job.data.automation.definition.trigger.event
+        : undefined,
+    }
+  }
+
+  return [message, err, bullLog, automationLog]
 }
 
 enum BullEvent {

package/src/utils/tests/utils.spec.ts

@@ -5,6 +5,7 @@ import * as db from "../../db"
 import { Header } from "../../constants"
 import { newid } from "../../utils"
 import env from "../../environment"
+import { BBContext } from "@budibase/types"
 
 describe("utils", () => {
   const config = new DBTestConfiguration()
@@ -106,4 +107,85 @@ describe("utils", () => {
       expect(actual).toBe(undefined)
     })
   })
+
+  describe("isServingBuilder", () => {
+    let ctx: BBContext
+
+    const expectResult = (result: boolean) =>
+      expect(utils.isServingBuilder(ctx)).toBe(result)
+
+    beforeEach(() => {
+      ctx = structures.koa.newContext()
+    })
+
+    it("returns true if current path is in builder", async () => {
+      ctx.path = "/builder/app/app_"
+      expectResult(true)
+    })
+
+    it("returns false if current path doesn't have '/' suffix", async () => {
+      ctx.path = "/builder/app"
+      expectResult(false)
+
+      ctx.path = "/xx"
+      expectResult(false)
+    })
+  })
+
+  describe("isServingBuilderPreview", () => {
+    let ctx: BBContext
+
+    const expectResult = (result: boolean) =>
+      expect(utils.isServingBuilderPreview(ctx)).toBe(result)
+
+    beforeEach(() => {
+      ctx = structures.koa.newContext()
+    })
+
+    it("returns true if current path is in builder preview", async () => {
+      ctx.path = "/app/preview/xx"
+      expectResult(true)
+    })
+
+    it("returns false if current path is not in builder preview", async () => {
+      ctx.path = "/builder"
+      expectResult(false)
+
+      ctx.path = "/xx"
+      expectResult(false)
+    })
+  })
+
+  describe("isPublicAPIRequest", () => {
+    let ctx: BBContext
+
+    const expectResult = (result: boolean) =>
+      expect(utils.isPublicApiRequest(ctx)).toBe(result)
+
+    beforeEach(() => {
+      ctx = structures.koa.newContext()
+    })
+
+    it("returns true if current path remains to public API", async () => {
+      ctx.path = "/api/public/v1/invoices"
+      expectResult(true)
+
+      ctx.path = "/api/public/v1"
+      expectResult(true)
+
+      ctx.path = "/api/public/v2"
+      expectResult(true)
+
+      ctx.path = "/api/public/v21"
+      expectResult(true)
+    })
+
+    it("returns false if current path doesn't remain to public API", async () => {
+      ctx.path = "/api/public"
+      expectResult(false)
+
+      ctx.path = "/xx"
+      expectResult(false)
+    })
+  })
 })

package/src/utils/utils.ts

@@ -1,11 +1,5 @@
-import { getAllApps, queryGlobalView } from "../db"
-import {
-  Header,
-  MAX_VALID_DATE,
-  DocumentType,
-  SEPARATOR,
-  ViewName,
-} from "../constants"
+import { getAllApps } from "../db"
+import { Header, MAX_VALID_DATE, DocumentType, SEPARATOR } from "../constants"
 import env from "../environment"
 import * as tenancy from "../tenancy"
 import * as context from "../context"
@@ -23,7 +17,9 @@ const APP_PREFIX = DocumentType.APP + SEPARATOR
 const PROD_APP_PREFIX = "/app/"
 
 const BUILDER_PREVIEW_PATH = "/app/preview"
-const BUILDER_REFERER_PREFIX = "/builder/app/"
+const BUILDER_PREFIX = "/builder"
+const BUILDER_APP_PREFIX = `${BUILDER_PREFIX}/app/`
+const PUBLIC_API_PREFIX = "/api/public/v"
 
 function confirmAppId(possibleAppId: string | undefined) {
   return possibleAppId && possibleAppId.startsWith(APP_PREFIX)
@@ -69,6 +65,18 @@ export function isServingApp(ctx: Ctx) {
   return false
 }
 
+export function isServingBuilder(ctx: Ctx): boolean {
+  return ctx.path.startsWith(BUILDER_APP_PREFIX)
+}
+
+export function isServingBuilderPreview(ctx: Ctx): boolean {
+  return ctx.path.startsWith(BUILDER_PREVIEW_PATH)
+}
+
+export function isPublicApiRequest(ctx: Ctx): boolean {
+  return ctx.path.startsWith(PUBLIC_API_PREFIX)
+}
+
 /**
  * Given a request tries to find the appId, which can be located in various places
  * @param {object} ctx The main request body to look through.
@@ -110,7 +118,7 @@ export async function getAppIdFromCtx(ctx: Ctx) {
   // make sure this is performed after prod app url resolution, in case the
   // referer header is present from a builder redirect
   const referer = ctx.request.headers.referer
-  if (!appId && referer?.includes(BUILDER_REFERER_PREFIX)) {
+  if (!appId && referer?.includes(BUILDER_APP_PREFIX)) {
     const refererId = parseAppIdFromUrl(ctx.request.headers.referer)
     appId = confirmAppId(refererId)
   }

package/tsconfig.json

@@ -7,11 +7,6 @@
       "@budibase/types": ["../types/src"]
     }
   },
-  "references": [
-    { "path": "../types" }
-  ],
-  "exclude": [
-    "node_modules",
-    "dist",
-  ]
-}
+
+  "exclude": ["node_modules", "dist"]
+}