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

restructuring server routers

This commit is contained in:
Martin McKeaveney 2020-04-06 14:05:57 +01:00
parent b5f48a01fc
commit 3519d0f210
7 changed files with 56 additions and 363 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

246
packages/server/middleware/routers.js
View File

@ -4,21 +4,18 @@ const StatusCodes = require("../utilities/statusCodes")
const { resolve } = require("path") const { resolve } = require("path")
const send = require("koa-send") const send = require("koa-send")
const routeHandlers = require("./routeHandlers") const routeHandlers = require("./routeHandlers")
const { const {
getPackageForBuilder,
getComponentDefinitions,
getApps,
saveScreen,
renameScreen,
deleteScreen,
buildPage,
componentLibraryInfo, componentLibraryInfo,
listScreens, } = require("../../utilities/builder")
saveBackend, const {
} = require("../utilities/builder") componentRoutes,
appsRoutes,
pageRoutes,
userRoutes,
authenticatedRoutes
} = require("./");
const builderPath = resolve(__dirname, "../builder") const builderPath = resolve(__dirname, "../../builder")
module.exports = (config, app) => { module.exports = (config, app) => {
const router = new Router() const router = new Router()
@ -28,6 +25,7 @@ module.exports = (config, app) => {
.use(async (ctx, next) => { .use(async (ctx, next) => {
ctx.sessionId = ctx.session._sessCtx.externalKey ctx.sessionId = ctx.session._sessCtx.externalKey
ctx.session.accessed = true ctx.session.accessed = true
ctx.config = config
const pathParts = ctx.path.split("/") const pathParts = ctx.path.split("/")
@ -45,6 +43,7 @@ module.exports = (config, app) => {
return return
} }
// Builder URLs should have admin access to the API
if (ctx.path.startsWith("/_builder/instance/_master")) { if (ctx.path.startsWith("/_builder/instance/_master")) {
const { const {
instance, instance,
@ -92,7 +91,7 @@ module.exports = (config, app) => {
}) })
.get("/_builder/:appname/componentlibrary", async ctx => { .get("/_builder/:appname/componentlibrary", async ctx => {
const info = await componentLibraryInfo( const info = await componentLibraryInfo(
config, ctx.config,
ctx.params.appname, ctx.params.appname,
ctx.query.lib ctx.query.lib
) )
@ -111,220 +110,25 @@ module.exports = (config, app) => {
await send(ctx, "/index.html", { root: builderPath }) await send(ctx, "/index.html", { root: builderPath })
} }
}) })
.post("/:appname/api/authenticate", routeHandlers.authenticate)
.post(
"/_builder/instance/:appname/:instanceid/api/authenticate",
routeHandlers.authenticate
)
.post(
"/:appname/api/setPasswordFromTemporaryCode",
routeHandlers.setPasswordFromTemporaryCode
)
.post(
"/_builder/instance/:appname/:instanceid/api/setPasswordFromTemporaryCode",
routeHandlers.setPasswordFromTemporaryCode
)
.post(
"/:appname/api/createTemporaryAccess",
routeHandlers.createTemporaryAccess
)
.post(
"/_builder/instance/:appname/:instanceid/api/createTemporaryAccess",
routeHandlers.createTemporaryAccess
)
.get("/_builder/api/apps", async ctx => {
ctx.body = await getApps(config, ctx.master)
ctx.response.status = StatusCodes.OK
})
.get("/_builder/api/:appname/appPackage", async ctx => {
const application = await ctx.master.getApplicationWithInstances(
ctx.params.appname
)
ctx.body = await getPackageForBuilder(config, application)
ctx.response.status = StatusCodes.OK
})
.get("/_builder/api/:appname/components", async ctx => {
try {
ctx.body = getComponentDefinitions(
config,
ctx.params.appname,
ctx.query.lib
)
ctx.response.status = StatusCodes.OK
} catch (e) {
if (e.status) {
ctx.response.status = e.status
} else {
throw e
}
}
})
.get("/_builder/api/:appname/componentlibrary", async ctx => {
const info = await componentLibraryInfo(
config,
ctx.params.appname,
ctx.query.lib ? decodeURI(ctx.query.lib) : ""
)
ctx.body = info.components
ctx.response.status = StatusCodes.OK
})
.post("/_builder/api/:appname/backend", async ctx => {
await saveBackend(
config,
ctx.params.appname,
ctx.request.body.appDefinition,
ctx.request.body.accessLevels
)
ctx.master.deleteLatestPackageFromCache(ctx.params.appname)
ctx.response.status = StatusCodes.OK
})
.post("/_builder/api/:appname/pages/:pageName", async ctx => {
await buildPage(
config,
ctx.params.appname,
ctx.params.pageName,
ctx.request.body
)
ctx.response.status = StatusCodes.OK
})
.get("/_builder/api/:appname/pages/:pagename/screens", async ctx => {
ctx.body = await listScreens(
config,
ctx.params.appname,
ctx.params.pagename
)
ctx.response.status = StatusCodes.OK
})
.post("/_builder/api/:appname/pages/:pagename/screen", async ctx => {
ctx.body = await saveScreen(
config,
ctx.params.appname,
ctx.params.pagename,
ctx.request.body
)
ctx.response.status = StatusCodes.OK
})
.patch("/_builder/api/:appname/pages/:pagename/screen", async ctx => {
await renameScreen(
config,
ctx.params.appname,
ctx.params.pagename,
ctx.request.body.oldname,
ctx.request.body.newname
)
ctx.response.status = StatusCodes.OK
})
.delete("/_builder/api/:appname/pages/:pagename/screen/*", async ctx => {
const name = ctx.request.path.replace(
`/_builder/api/${ctx.params.appname}/pages/${ctx.params.pagename}/screen/`,
""
)
await deleteScreen( router.use(userRoutes.routes());
config, router.use(userRoutes.allowedMethods());
ctx.params.appname, router.use(appsRoutes.routes())
ctx.params.pagename, router.use(appsRoutes.allowedMethods());
decodeURI(name) router.use(componentRoutes.routes());
) router.use(componentRoutes.allowedMethods());
router.use(pageRoutes.routes());
router.use(pageRoutes.allowedMethods());
ctx.response.status = StatusCodes.OK router
})
.get("/:appname", async ctx => { .get("/:appname", async ctx => {
await send(ctx, "/index.html", { root: ctx.publicPath }) await send(ctx, "/index.html", { root: ctx.publicPath })
}) })
.get("/:appname/*", routeHandlers.appDefault) .get("/:appname/*", routeHandlers.appDefault)
.get("/_builder/instance/:appname/:instanceid/*", routeHandlers.appDefault) .get("/_builder/instance/:appname/:instanceid/*", routeHandlers.appDefault)
// EVERYTHING BELOW HERE REQUIRES AUTHENTICATION
.use(async (ctx, next) => { router.use(authenticatedRoutes.routes());
if (ctx.isAuthenticated) { router.use(authenticatedRoutes.allowedMethods());
await next()
} else {
ctx.response.status = StatusCodes.UNAUTHORIZED
}
})
.post(
"/_builder/instance/:appname/:instanceid/api/upgradeData",
routeHandlers.upgradeData
)
.post("/:appname/api/changeMyPassword", routeHandlers.changeMyPassword)
.post(
"/_builder/instance/:appname/:instanceid/api/changeMyPassword",
routeHandlers.changeMyPassword
)
.post(
"/:appname/api/executeAction/:actionname",
routeHandlers.executeAction
)
.post(
"/_builder/instance/:appname/:instanceid/api/executeAction/:actionname",
routeHandlers.executeAction
)
.post("/:appname/api/createUser", routeHandlers.createUser)
.post(
"/_builder/instance/:appname/:instanceid/api/createUser",
routeHandlers.createUser
)
.post("/:appname/api/enableUser", routeHandlers.enableUser)
.post(
"/_builder/instance/:appname/:instanceid/api/enableUser",
routeHandlers.enableUser
)
.post("/:appname/api/disableUser", routeHandlers.disableUser)
.post(
"/_builder/instance/:appname/:instanceid/api/disableUser",
routeHandlers.disableUser
)
.get("/:appname/api/users", routeHandlers.getUsers)
.get(
"/_builder/instance/:appname/:instanceid/api/users",
routeHandlers.getUsers
)
.get("/:appname/api/accessLevels", routeHandlers.getAccessLevels)
.get(
"/_builder/instance/:appname/:instanceid/api/accessLevels",
routeHandlers.getAccessLevels
)
.get("/:appname/api/listRecords/*", routeHandlers.listRecordsGet)
.get(
"/_builder/instance/:appname/:instanceid/api/listRecords/*",
routeHandlers.listRecordsGet
)
.post("/:appname/api/listRecords/*", routeHandlers.listRecordsPost)
.post(
"/_builder/instance/:appname/:instanceid/api/listRecords/*",
routeHandlers.listRecordsPost
)
.post("/:appname/api/aggregates/*", routeHandlers.aggregatesPost)
.post(
"/_builder/instance/:appname/:instanceid/api/aggregates/*",
routeHandlers.aggregatesPost
)
.post("/:appname/api/files/*", routeHandlers.postFiles)
.post(
"/_builder/instance/:appname/:instanceid/api/files/*",
routeHandlers.postFiles
)
.post("/:appname/api/record/*", routeHandlers.saveRecord)
.post(
"/_builder/instance/:appname/:instanceid/api/record/*",
routeHandlers.saveRecord
)
.get("/:appname/api/lookup_field/*", routeHandlers.lookupField)
.get(
"/_builder/instance/:appname/:instanceid/api/lookup_field/*",
routeHandlers.lookupField
)
.get("/:appname/api/record/*", routeHandlers.getRecord)
.get(
"/_builder/instance/:appname/:instanceid/api/record/*",
routeHandlers.getRecord
)
.del("/:appname/api/record/*", routeHandlers.deleteRecord)
.del(
"/_builder/instance/:appname/:instanceid/api/record/*",
routeHandlers.deleteRecord
)
.post("/:appname/api/apphierarchy", routeHandlers.saveAppHierarchy)
return router return router
} }

5
packages/server/middleware/routes/apps.js
View File

@ -1,4 +1,5 @@
const Router = require("@koa/router"); const Router = require("@koa/router");
const StatusCodes = require("../../utilities/statusCodes")
const { const {
getPackageForBuilder, getPackageForBuilder,
getApps, getApps,
@ -8,7 +9,7 @@ const {
const router = Router(); const router = Router();
router.get("/_builder/api/apps", async ctx => { router.get("/_builder/api/apps", async ctx => {
ctx.body = await getApps(config, ctx.master) ctx.body = await getApps(ctx.config, ctx.master)
ctx.response.status = StatusCodes.OK ctx.response.status = StatusCodes.OK
}) })
@ -16,7 +17,7 @@ router.get("/_builder/api/:appname/appPackage", async ctx => {
const application = await ctx.master.getApplicationWithInstances( const application = await ctx.master.getApplicationWithInstances(
ctx.params.appname ctx.params.appname
) )
ctx.body = await getPackageForBuilder(config, application) ctx.body = await getPackageForBuilder(ctx.config, application)
ctx.response.status = StatusCodes.OK ctx.response.status = StatusCodes.OK
}) })

7
packages/server/middleware/routes/authenticated.js
View File

@ -1,15 +1,18 @@
const Router = require("@koa/router"); const Router = require("@koa/router");
const StatusCodes = require("../../utilities/statusCodes")
const routeHandlers = require("../routeHandlers") const routeHandlers = require("../routeHandlers")
const router = Router(); const router = Router();
router.use(async (ctx, next) => { async function isAuthenticated(ctx, next) {
if (ctx.isAuthenticated) { if (ctx.isAuthenticated) {
await next() await next()
} else { } else {
ctx.response.status = StatusCodes.UNAUTHORIZED ctx.response.status = StatusCodes.UNAUTHORIZED
} }
}) }
router.use(isAuthenticated)
router.post( router.post(
"/_builder/instance/:appname/:instanceid/api/upgradeData", "/_builder/instance/:appname/:instanceid/api/upgradeData",

117
packages/server/middleware/routes/builderRouter.js
View File

@ -1,117 +0,0 @@
const Router = require("@koa/router")
const session = require("../session")
const StatusCodes = require("../../utilities/statusCodes")
const { resolve } = require("path")
const send = require("koa-send")
const routeHandlers = require("../routeHandlers")
const {
componentRoutes,
appsRoutes,
pageRoutes,
userRoutes,
authenticatedRoutes
} = require("./");
const builderPath = resolve(__dirname, "../builder")
module.exports = (config, app) => {
const router = new Router()
router
.use(session(config, app))
.use(async (ctx, next) => {
ctx.sessionId = ctx.session._sessCtx.externalKey
ctx.session.accessed = true
ctx.config = config
const pathParts = ctx.path.split("/")
if (pathParts.length < 2) {
ctx.throw(StatusCodes.NOT_FOUND, "App Name not declared")
}
const appname = pathParts[1]
ctx.set("x-bbappname", appname)
if (appname === "_builder") {
if (!config.dev) {
ctx.response.status = StatusCodes.FORBIDDEN
ctx.body = "run in dev mode to access builder"
return
}
if (ctx.path.startsWith("/_builder/instance/_master")) {
const {
instance,
publicPath,
sharedPath,
} = await ctx.master.getFullAccessApiForMaster()
ctx.instance = instance
ctx.publicPath = publicPath
ctx.sharedPath = sharedPath
ctx.isAuthenticated = !!ctx.instance
} else if (ctx.path.startsWith("/_builder/instance")) {
const builderAppName = pathParts[3]
const instanceId = pathParts[4]
const {
bbInstance,
publicPath,
sharedPath,
} = await ctx.master.getFullAccessApiForInstanceId(
builderAppName,
instanceId
)
ctx.instance = bbInstance
ctx.publicPath = publicPath
ctx.sharedPath = sharedPath
ctx.isAuthenticated = !!ctx.instance
}
await next()
} else {
const instance = await ctx.master.getInstanceApiForSession(
appname,
ctx.sessionId
)
ctx.instance = instance.instance
ctx.publicPath = instance.publicPath
ctx.sharedPath = instance.sharedPath
ctx.isAuthenticated = !!instance.instance
await next()
}
})
router.get("/_builder", async ctx => {
await send(ctx, "/index.html", { root: builderPath })
})
router.get("/_builder/*", async (ctx, next) => {
const path = ctx.path.replace("/_builder", "")
const isFile = new RegExp(/(.+\..{1,5})/g).test(path)
if (path.startsWith("/api/") || path.startsWith("/instance/")) {
await next()
} else if (isFile) {
await send(ctx, path, { root: builderPath })
} else {
await send(ctx, "/index.html", { root: builderPath })
}
})
router.use(userRoutes.routes());
router.use(appsRoutes.routes())
router.use(componentRoutes.routes());
router.use(pageRoutes.routes());
router.get("/:appname", async ctx => {
await send(ctx, "/index.html", { root: ctx.publicPath })
})
router.get("/:appname/*", routeHandlers.appDefault)
router.get("/_builder/instance/:appname/:instanceid/*", routeHandlers.appDefault)
router.use(authenticatedRoutes.routes());
return router
}

19
packages/server/middleware/routes/components.js
View File

@ -1,5 +1,6 @@
const Router = require("@koa/router"); const Router = require("@koa/router");
const send = require("koa-send") const send = require("koa-send")
const StatusCodes = require("../../utilities/statusCodes")
const { const {
getComponentDefinitions, getComponentDefinitions,
componentLibraryInfo, componentLibraryInfo,
@ -8,6 +9,15 @@ const {
const router = Router(); const router = Router();
router.get("/_builder/:appname/componentlibrary", async ctx => {
const info = await componentLibraryInfo(
ctx.config,
ctx.params.appname,
ctx.query.lib
)
await send(ctx, info.components._lib || "index.js", { root: info.libDir })
})
router.get("/_builder/api/:appname/components", async ctx => { router.get("/_builder/api/:appname/components", async ctx => {
try { try {
ctx.body = getComponentDefinitions( ctx.body = getComponentDefinitions(
@ -35,13 +45,4 @@ router.get("/_builder/api/:appname/componentlibrary", async ctx => {
ctx.response.status = StatusCodes.OK ctx.response.status = StatusCodes.OK
}) })
router.get("/_builder/:appname/componentlibrary", async ctx => {
const info = await componentLibraryInfo(
ctx.config,
ctx.params.appname,
ctx.query.lib
)
await send(ctx, info.components._lib || "index.js", { root: info.libDir })
})
module.exports = router module.exports = router

9
packages/server/middleware/routes/pages.js
View File

@ -1,4 +1,5 @@
const Router = require("@koa/router"); const Router = require("@koa/router");
const StatusCodes = require("../../utilities/statusCodes")
const { const {
listScreens, listScreens,
saveScreen, saveScreen,
@ -10,7 +11,7 @@ const router = Router()
router.get("/_builder/api/:appname/pages/:pagename/screens", async ctx => { router.get("/_builder/api/:appname/pages/:pagename/screens", async ctx => {
ctx.body = await listScreens( ctx.body = await listScreens(
config, ctx.config,
ctx.params.appname, ctx.params.appname,
ctx.params.pagename ctx.params.pagename
) )
@ -20,7 +21,7 @@ router.get("/_builder/api/:appname/pages/:pagename/screens", async ctx => {
router router
.post("/_builder/api/:appname/pages/:pagename/screen", async ctx => { .post("/_builder/api/:appname/pages/:pagename/screen", async ctx => {
ctx.body = await saveScreen( ctx.body = await saveScreen(
config, ctx.config,
ctx.params.appname, ctx.params.appname,
ctx.params.pagename, ctx.params.pagename,
ctx.request.body ctx.request.body
@ -31,7 +32,7 @@ router
router router
.patch("/_builder/api/:appname/pages/:pagename/screen", async ctx => { .patch("/_builder/api/:appname/pages/:pagename/screen", async ctx => {
await renameScreen( await renameScreen(
config, ctx.config,
ctx.params.appname, ctx.params.appname,
ctx.params.pagename, ctx.params.pagename,
ctx.request.body.oldname, ctx.request.body.oldname,
@ -48,7 +49,7 @@ router
) )
await deleteScreen( await deleteScreen(
config, ctx.config,
ctx.params.appname, ctx.params.appname,
ctx.params.pagename, ctx.params.pagename,
decodeURI(name) decodeURI(name)

16
packages/server/yarn.lock
View File

@ -131,10 +131,10 @@
lodash "^4.17.13" lodash "^4.17.13"
to-fast-properties "^2.0.0" to-fast-properties "^2.0.0"
"@budibase/client@^0.0.27": "@budibase/client@^0.0.32":
version "0.0.27" version "0.0.32"
resolved "https://registry.yarnpkg.com/@budibase/client/-/client-0.0.27.tgz#d43a66202a23103ae5ac89d9fa69c3cd36b2a090" resolved "https://registry.yarnpkg.com/@budibase/client/-/client-0.0.32.tgz#76d9f147563a0bf939eae7f32ce75b2a527ba496"
integrity sha512-emS6L66fzfr/CdnpazlqveVKqcSQA9+sQRcbzLZ+sJLFk6FNIezRQcMjGHz+ooeYS91OVgOfleqXDCnvHO+MNg== integrity sha512-jmCCLn0CUoQbL6h623S5IqK6+GYLqX3WzUTZInSb1SCBOM3pI0eLP5HwTR6s7r42SfD0v9jTWRdyTnHiElNj8A==
dependencies: dependencies:
"@nx-js/compiler-util" "^2.0.0" "@nx-js/compiler-util" "^2.0.0"
bcryptjs "^2.4.3" bcryptjs "^2.4.3"
@ -145,10 +145,10 @@
shortid "^2.2.8" shortid "^2.2.8"
svelte "^3.9.2" svelte "^3.9.2"
"@budibase/core@^0.0.27": "@budibase/core@^0.0.32":
version "0.0.27" version "0.0.32"
resolved "https://registry.yarnpkg.com/@budibase/core/-/core-0.0.27.tgz#05bbacce692222089a1ae85b7ea4bb322e327f64" resolved "https://registry.yarnpkg.com/@budibase/core/-/core-0.0.32.tgz#c5d9ab869c5e9596a1ac337aaf041e795b1cc7fa"
integrity sha512-V8qGB9Lcwz8CFGzYct6i1oI+WiYgEOCsBBQ6DPPRLLVg07i2DHI9Ynwa35QXWTO3WeyWIxy//WSmVwSlYPAtOw== integrity sha512-B6DHlz/C/m3jrxHbImT4bphdJlL7r2qmGrmcVBSc9mGHvwcRh1xfFGrsPCOU2IEJow+DWD63BIjyHzLPI3cerQ==
dependencies: dependencies:
"@nx-js/compiler-util" "^2.0.0" "@nx-js/compiler-util" "^2.0.0"
bcryptjs "^2.4.3" bcryptjs "^2.4.3"