MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixing an issue with asset retrieval, adding a test case to check this as it is not checked through vite.

This commit is contained in:
mike12345567 2025-03-28 16:29:57 +00:00
parent d6f55b4bc8
commit 5e76c7fe2e
9 changed files with 84 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
packages/server/src/api/controllers/assets.ts
View File

@ -1,10 +1,12 @@
import { join } from "../../utilities/centralPath" import { join } from "../../utilities/centralPath"
import { TOP_LEVEL_PATH } from "../../utilities/fileSystem" import { TOP_LEVEL_PATH, DEV_ASSET_PATH } from "../../utilities/fileSystem"
import { Ctx } from "@budibase/types" import { Ctx } from "@budibase/types"
import env from "../../environment"
import send from "koa-send" import send from "koa-send"
// this is a public endpoint with no middlewares // this is a public endpoint with no middlewares
export const serveBuilderAssets = async function (ctx: Ctx<void, void>) { export const serveBuilderAssets = async function (ctx: Ctx<void, void>) {
const builderPath = join(TOP_LEVEL_PATH, "builder") let topLevelPath = env.isDev() ? DEV_ASSET_PATH : TOP_LEVEL_PATH
const builderPath = join(topLevelPath, "builder")
await send(ctx, ctx.file, { root: builderPath }) await send(ctx, ctx.file, { root: builderPath })
} }

5
packages/server/src/api/index.ts
View File

@ -8,7 +8,7 @@ import { middleware as pro } from "@budibase/pro"
import { apiEnabled, automationsEnabled } from "../features" import { apiEnabled, automationsEnabled } from "../features"
import migrations from "../middleware/appMigrations" import migrations from "../middleware/appMigrations"
import { automationQueue } from "../automations" import { automationQueue } from "../automations"
import { serveBuilderAssets } from "./controllers/assets" import assetRouter from "./routes/assets"
export { shutdown } from "./routes/public" export { shutdown } from "./routes/public"
const compress = require("koa-compress") const compress = require("koa-compress")
@ -47,7 +47,8 @@ if (apiEnabled()) {
.redirect("/", "/builder") .redirect("/", "/builder")
// send assets before middleware // send assets before middleware
router.get("/builder/:file*", serveBuilderAssets) router.use(assetRouter.routes())
router.use(assetRouter.allowedMethods())
router router
.use( .use(

11
packages/server/src/api/routes/assets.ts Normal file
View File

@ -0,0 +1,11 @@
import { addFileManagement } from "../utils"
import { serveBuilderAssets } from "../controllers/assets"
import Router from "@koa/router"
const router: Router = new Router()
addFileManagement(router)
router.get("/builder/:file*", serveBuilderAssets)
export default router

21
packages/server/src/api/routes/static.ts
View File

@ -1,32 +1,15 @@
import Router from "@koa/router" import Router from "@koa/router"
import * as controller from "../controllers/static" import * as controller from "../controllers/static"
import { budibaseTempDir } from "../../utilities/budibaseDir"
import authorized from "../../middleware/authorized" import authorized from "../../middleware/authorized"
import { permissions } from "@budibase/backend-core" import { permissions } from "@budibase/backend-core"
import env from "../../environment" import { addFileManagement } from "../utils"
import { paramResource } from "../../middleware/resourceId" import { paramResource } from "../../middleware/resourceId"
import { devClientLibPath } from "../../utilities/fileSystem"
const { BUILDER, PermissionType, PermissionLevel } = permissions const { BUILDER, PermissionType, PermissionLevel } = permissions
const router: Router = new Router() const router: Router = new Router()
/* istanbul ignore next */ addFileManagement(router)
router.param("file", async (file: any, ctx: any, next: any) => {
ctx.file = file && file.includes(".") ? file : "index.html"
if (!ctx.file.startsWith("budibase-client")) {
return next()
}
// test serves from require
if (env.isTest()) {
const path = devClientLibPath()
ctx.devPath = path.split(ctx.file)[0]
} else if (env.isDev()) {
// Serving the client library from your local dir in dev
ctx.devPath = budibaseTempDir()
}
return next()
})
router router
.get("/api/assets/client", controller.serveClientLibrary) .get("/api/assets/client", controller.serveClientLibrary)

29
packages/server/src/api/routes/tests/assets.spec.ts Normal file
View File

@ -0,0 +1,29 @@
import fs from "fs"
import { join } from "path"
import { DEV_ASSET_PATH } from "../../../utilities/fileSystem"
import * as setup from "./utilities"
const path = join(DEV_ASSET_PATH, "builder", "index.html")
let addedIndexHtml = false
const config = setup.getConfig()
beforeAll(async () => {
if (!fs.existsSync(path)) {
fs.writeFileSync(path, "<html></html>", "utf8")
addedIndexHtml = true
}
await config.init()
})
afterAll(() => {
if (addedIndexHtml) {
fs.rmSync(path)
}
})
describe("/builder/:file*", () => {
it("should be able to retrieve the builder file", async () => {
const res = await config.api.assets.get("index.html")
expect(res.text).toContain("<html")
})
})

23
packages/server/src/api/utils.ts Normal file
View File

@ -0,0 +1,23 @@
import env from "../environment"
import { devClientLibPath } from "../utilities/fileSystem"
import { budibaseTempDir } from "../utilities/budibaseDir"
import Router from "@koa/router"
export function addFileManagement(router: Router) {
/* istanbul ignore next */
router.param("file", async (file: any, ctx: any, next: any) => {
ctx.file = file && file.includes(".") ? file : "index.html"
if (!ctx.file.startsWith("budibase-client")) {
return next()
}
// test serves from require
if (env.isTest()) {
const path = devClientLibPath()
ctx.devPath = path.split(ctx.file)[0]
} else if (env.isDev()) {
// Serving the client library from your local dir in dev
ctx.devPath = budibaseTempDir()
}
return next()
})
}

8
packages/server/src/tests/utilities/api/assets.ts Normal file
View File

@ -0,0 +1,8 @@
import { TestAPI } from "./base"
export class AssetsAPI extends TestAPI {
get = async (path: string) => {
// has to be raw, body isn't JSON
return await this._requestRaw("get", `/builder/${path}`)
}
}

3
packages/server/src/tests/utilities/api/index.ts
View File

@ -21,6 +21,7 @@ import { EnvironmentAPI } from "./environment"
import { UserPublicAPI } from "./public/user" import { UserPublicAPI } from "./public/user"
import { MiscAPI } from "./misc" import { MiscAPI } from "./misc"
import { OAuth2API } from "./oauth2" import { OAuth2API } from "./oauth2"
import { AssetsAPI } from "./assets"
export default class API { export default class API {
application: ApplicationAPI application: ApplicationAPI
@ -44,6 +45,7 @@ export default class API {
user: UserAPI user: UserAPI
viewV2: ViewV2API viewV2: ViewV2API
webhook: WebhookAPI webhook: WebhookAPI
assets: AssetsAPI
public: { public: {
user: UserPublicAPI user: UserPublicAPI
@ -71,6 +73,7 @@ export default class API {
this.user = new UserAPI(config) this.user = new UserAPI(config)
this.viewV2 = new ViewV2API(config) this.viewV2 = new ViewV2API(config)
this.webhook = new WebhookAPI(config) this.webhook = new WebhookAPI(config)
this.assets = new AssetsAPI(config)
this.public = { this.public = {
user: new UserPublicAPI(config), user: new UserPublicAPI(config),
} }

1
packages/server/src/utilities/fileSystem/filesystem.ts
View File

@ -8,6 +8,7 @@ import { v4 as uuid } from "uuid"
export const TOP_LEVEL_PATH = export const TOP_LEVEL_PATH =
env.TOP_LEVEL_PATH || resolve(join(__dirname, "..", "..", "..")) env.TOP_LEVEL_PATH || resolve(join(__dirname, "..", "..", ".."))
export const DEV_ASSET_PATH = join(TOP_LEVEL_PATH, "packages", "server")
/** /**
* Upon first startup of instance there may not be everything we need in tmp directory, set it up. * Upon first startup of instance there may not be everything we need in tmp directory, set it up.