Provide some functions to check the path in the context

packages/backend-core/src/utils/tests/utils.spec.ts

@@ -5,6 +5,8 @@ import * as db from "../../db"
 import { Header } from "../../constants"
 import { newid } from "../../utils"
 import env from "../../environment"
+import { beforeEach } from "@jest/globals"
+import { BBContext } from "@budibase/types"
 
 describe("utils", () => {
   const config = new DBTestConfiguration()
@@ -106,4 +108,79 @@ 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 is not in builder", 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)
+    })
+
+    it("returns false if current path doesn't remain to public API", async () => {
+      ctx.path = "/api/public"
+      expectResult(false)
+
+      ctx.path = "/xx"
+      expectResult(false)
+    })
+  })
 })

packages/backend-core/src/utils/utils.ts

@@ -1,10 +1,9 @@
-import { getAllApps, queryGlobalView } from "../db"
+import { getAllApps } from "../db"
 import {
   Header,
   MAX_VALID_DATE,
   DocumentType,
   SEPARATOR,
-  ViewName,
 } from "../constants"
 import env from "../environment"
 import * as tenancy from "../tenancy"
@@ -23,7 +22,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_REFERER_PREFIX = `${BUILDER_PREFIX}/app/`
+const PUBLIC_API_PREFIX = "/api/public/v1"
 
 function confirmAppId(possibleAppId: string | undefined) {
   return possibleAppId && possibleAppId.startsWith(APP_PREFIX)
@@ -69,6 +70,18 @@ export function isServingApp(ctx: Ctx) {
   return false
 }
 
+export function isServingBuilder(ctx: Ctx): boolean {
+  return ctx.path.startsWith(BUILDER_REFERER_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.