@budibase/server 2.4.40 → 2.4.42-alpha.0

package/src/api/controllers/static/index.ts

@@ -11,10 +11,12 @@ import {
 } from "../../../utilities/fileSystem"
 import env from "../../../environment"
 import { DocumentType } from "../../../db/utils"
-import { context, objectStore, utils } from "@budibase/backend-core"
+import { context, objectStore, utils, configs } from "@budibase/backend-core"
 import AWS from "aws-sdk"
 import fs from "fs"
 import sdk from "../../../sdk"
+import * as pro from "@budibase/pro"
+
 const send = require("koa-send")
 
 async function prepareUpload({ s3Key, bucket, metadata, file }: any) {
@@ -98,33 +100,74 @@ export const deleteObjects = async function (ctx: any) {
 }
 
 export const serveApp = async function (ctx: any) {
-  const db = context.getAppDB({ skip_setup: true })
-  const appInfo = await db.get(DocumentType.APP_METADATA)
-  let appId = context.getAppId()
+  //Public Settings
+  const { config } = await configs.getSettingsConfigDoc()
+  const branding = await pro.branding.getBrandingConfig(config)
 
-  if (!env.isJest()) {
-    const App = require("./templates/BudibaseApp.svelte").default
-    const plugins = objectStore.enrichPluginURLs(appInfo.usedPlugins)
-    const { head, html, css } = App.render({
-      metaImage:
-        "https://res.cloudinary.com/daog6scxm/image/upload/v1666109324/meta-images/budibase-meta-image_uukc1m.png",
-      title: appInfo.name,
-      production: env.isProd(),
-      appId,
-      clientLibPath: objectStore.clientLibraryUrl(appId!, appInfo.version),
-      usedPlugins: plugins,
-    })
+  let db
+  try {
+    db = context.getAppDB({ skip_setup: true })
+    const appInfo = await db.get(DocumentType.APP_METADATA)
+    let appId = context.getAppId()
 
-    const appHbs = loadHandlebarsFile(`${__dirname}/templates/app.hbs`)
-    ctx.body = await processString(appHbs, {
-      head,
-      body: html,
-      style: css.code,
-      appId,
-    })
-  } else {
-    // just return the app info for jest to assert on
-    ctx.body = appInfo
+    if (!env.isJest()) {
+      const App = require("./templates/BudibaseApp.svelte").default
+      const plugins = objectStore.enrichPluginURLs(appInfo.usedPlugins)
+      const { head, html, css } = App.render({
+        metaImage:
+          branding?.metaImageUrl ||
+          "https://res.cloudinary.com/daog6scxm/image/upload/v1666109324/meta-images/budibase-meta-image_uukc1m.png",
+        metaDescription: branding?.metaDescription || "",
+        metaTitle:
+          branding?.metaTitle || `${appInfo.name} - built with Budibase`,
+        title: appInfo.name,
+        production: env.isProd(),
+        appId,
+        clientLibPath: objectStore.clientLibraryUrl(appId!, appInfo.version),
+        usedPlugins: plugins,
+        favicon:
+          branding.faviconUrl !== ""
+            ? objectStore.getGlobalFileUrl("settings", "faviconUrl")
+            : "",
+        logo:
+          config?.logoUrl !== ""
+            ? objectStore.getGlobalFileUrl("settings", "logoUrl")
+            : "",
+      })
+      const appHbs = loadHandlebarsFile(`${__dirname}/templates/app.hbs`)
+      ctx.body = await processString(appHbs, {
+        head,
+        body: html,
+        style: css.code,
+        appId,
+      })
+    } else {
+      // just return the app info for jest to assert on
+      ctx.body = appInfo
+    }
+  } catch (error) {
+    if (!env.isJest()) {
+      const App = require("./templates/BudibaseApp.svelte").default
+      const { head, html, css } = App.render({
+        title: branding?.metaTitle,
+        metaTitle: branding?.metaTitle,
+        metaImage:
+          branding?.metaImageUrl ||
+          "https://res.cloudinary.com/daog6scxm/image/upload/v1666109324/meta-images/budibase-meta-image_uukc1m.png",
+        metaDescription: branding?.metaDescription || "",
+        favicon:
+          branding.faviconUrl !== ""
+            ? objectStore.getGlobalFileUrl("settings", "faviconUrl")
+            : "",
+      })
+
+      const appHbs = loadHandlebarsFile(`${__dirname}/templates/app.hbs`)
+      ctx.body = await processString(appHbs, {
+        head,
+        body: html,
+        style: css.code,
+      })
+    }
   }
 }
 

package/src/api/controllers/static/templates/BudibaseApp.svelte

@@ -1,7 +1,10 @@
 <script>
   export let title = ""
   export let favicon = ""
+
   export let metaImage = ""
+  export let metaTitle = ""
+  export let metaDescription = ""
 
   export let clientLibPath
   export let usedPlugins
@@ -13,18 +16,33 @@
     name="viewport"
     content="width=device-width, initial-scale=1.0, viewport-fit=cover"
   />
+
+  <!-- Primary Meta Tags -->
+  <meta name="title" content={metaTitle} />
+  <meta name="description" content={metaDescription} />
+
   <!-- Opengraph Meta Tags -->
-  <meta name="twitter:card" content="summary_large_image" />
-  <meta name="twitter:site" content="@budibase" />
-  <meta name="twitter:image" content={metaImage} />
-  <meta name="twitter:title" content="{title} - built with Budibase" />
   <meta property="og:site_name" content="Budibase" />
   <meta property="og:title" content="{title} - built with Budibase" />
+  <meta property="og:description" content={metaDescription} />
   <meta property="og:type" content="website" />
   <meta property="og:image" content={metaImage} />
 
+  <!-- Twitter -->
+  <meta property="twitter:card" content="summary_large_image" />
+  <meta property="twitter:site" content="@budibase" />
+  <meta property="twitter:image" content={metaImage} />
+  <meta property="twitter:image:alt" content="{title} - built with Budibase" />
+  <meta property="twitter:title" content="{title} - built with Budibase" />
+  <meta property="twitter:description" content={metaDescription} />
+
   <title>{title}</title>
-  <link rel="icon" type="image/png" href={favicon} />
+  {#if favicon !== ""}
+    <link rel="icon" type="image/png" href={favicon} />
+  {:else}
+    <link rel="icon" type="image/png" href="https://i.imgur.com/Xhdt1YP.png" />
+  {/if}
+
   <link rel="stylesheet" href="https://rsms.me/inter/inter.css" />
   <link rel="preconnect" href="https://fonts.gstatic.com" />
   <link
@@ -83,11 +101,16 @@
 
 <body id="app">
   <div id="error">
-    <h1>There was an error loading your app</h1>
-    <h2>
-      The Budibase client library could not be loaded. Try republishing your
-      app.
-    </h2>
+    {#if clientLibPath}
+      <h1>There was an error loading your app</h1>
+      <h2>
+        The Budibase client library could not be loaded. Try republishing your
+        app.
+      </h2>
+    {:else}
+      <h2>We couldn't find that application</h2>
+      <p />
+    {/if}
   </div>
   <script type="application/javascript">
     window.INIT_TIME = Date.now()

package/src/api/controllers/table/external.ts

@@ -7,6 +7,7 @@ import {
   generateJunctionTableName,
   foreignKeyStructure,
   hasTypeChanged,
+  setStaticSchemas,
 } from "./utils"
 import { FieldTypes } from "../../../constants"
 import { makeExternalQuery } from "../../../integrations/base/query"
@@ -20,7 +21,7 @@ import {
   Operation,
   RenameColumn,
   FieldSchema,
-  BBContext,
+  UserCtx,
   TableRequest,
   RelationshipTypes,
 } from "@budibase/types"
@@ -194,20 +195,20 @@ function isRelationshipSetup(column: FieldSchema) {
   return column.foreignKey || column.through
 }
 
-export async function save(ctx: BBContext) {
-  const table: TableRequest = ctx.request.body
-  const renamed = table?._rename
+export async function save(ctx: UserCtx) {
+  const inputs: TableRequest = ctx.request.body
+  const renamed = inputs?._rename
   // can't do this right now
-  delete table.rows
+  delete inputs.rows
   const datasourceId = getDatasourceId(ctx.request.body)!
   // table doesn't exist already, note that it is created
-  if (!table._id) {
-    table.created = true
+  if (!inputs._id) {
+    inputs.created = true
   }
   let tableToSave: TableRequest = {
     type: "table",
-    _id: buildExternalTableId(datasourceId, table.name),
-    ...table,
+    _id: buildExternalTableId(datasourceId, inputs.name),
+    ...inputs,
   }
 
   let oldTable
@@ -224,6 +225,10 @@ export async function save(ctx: BBContext) {
   if (!datasource.entities) {
     datasource.entities = {}
   }
+
+  // GSheets is a specific case - only ever has a static primary key
+  tableToSave = setStaticSchemas(datasource, tableToSave)
+
   const oldTables = cloneDeep(datasource.entities)
   const tables: Record<string, Table> = datasource.entities
 
@@ -246,7 +251,7 @@ export async function save(ctx: BBContext) {
       const junctionTable = generateManyLinkSchema(
         datasource,
         schema,
-        table,
+        tableToSave,
         relatedTable
       )
       if (tables[junctionTable.name]) {
@@ -256,10 +261,12 @@ export async function save(ctx: BBContext) {
       extraTablesToUpdate.push(junctionTable)
     } else {
       const fkTable =
-        relationType === RelationshipTypes.ONE_TO_MANY ? table : relatedTable
+        relationType === RelationshipTypes.ONE_TO_MANY
+          ? tableToSave
+          : relatedTable
       const foreignKey = generateLinkSchema(
         schema,
-        table,
+        tableToSave,
         relatedTable,
         relationType
       )
@@ -271,11 +278,11 @@ export async function save(ctx: BBContext) {
         fkTable.constrained.push(foreignKey)
       }
       // foreign key is in other table, need to save it to external
-      if (fkTable._id !== table._id) {
+      if (fkTable._id !== tableToSave._id) {
         extraTablesToUpdate.push(fkTable)
       }
     }
-    generateRelatedSchema(schema, relatedTable, table, relatedColumnName)
+    generateRelatedSchema(schema, relatedTable, tableToSave, relatedColumnName)
     schema.main = true
   }
 
@@ -313,7 +320,7 @@ export async function save(ctx: BBContext) {
   return tableToSave
 }
 
-export async function destroy(ctx: BBContext) {
+export async function destroy(ctx: UserCtx) {
   const tableToDelete: TableRequest = await sdk.tables.getTable(
     ctx.params.tableId
   )
@@ -339,7 +346,7 @@ export async function destroy(ctx: BBContext) {
   return tableToDelete
 }
 
-export async function bulkImport(ctx: BBContext) {
+export async function bulkImport(ctx: UserCtx) {
   const table = await sdk.tables.getTable(ctx.params.tableId)
   const { rows }: { rows: unknown } = ctx.request.body
   const schema: unknown = table.schema
@@ -348,7 +355,7 @@ export async function bulkImport(ctx: BBContext) {
     ctx.throw(400, "Provided data import information is invalid.")
   }
 
-  const parsedRows = await parse(rows, schema)
+  const parsedRows = parse(rows, schema)
   await handleRequest(Operation.BULK_CREATE, table._id!, {
     rows: parsedRows,
   })

package/src/api/controllers/table/index.ts

@@ -8,7 +8,7 @@ import {
 import { isExternalTable, isSQL } from "../../../integrations/utils"
 import { getDatasourceParams } from "../../../db/utils"
 import { context, events } from "@budibase/backend-core"
-import { Table, BBContext } from "@budibase/types"
+import { Table, UserCtx } from "@budibase/types"
 import sdk from "../../../sdk"
 import csv from "csvtojson"
 
@@ -25,7 +25,7 @@ function pickApi({ tableId, table }: { tableId?: string; table?: Table }) {
 }
 
 // covers both internal and external
-export async function fetch(ctx: BBContext) {
+export async function fetch(ctx: UserCtx) {
   const db = context.getAppDB()
 
   const internal = await sdk.tables.getAllInternalTables()
@@ -53,12 +53,12 @@ export async function fetch(ctx: BBContext) {
   ctx.body = [...internal, ...external]
 }
 
-export async function find(ctx: BBContext) {
+export async function find(ctx: UserCtx) {
   const tableId = ctx.params.tableId
   ctx.body = await sdk.tables.getTable(tableId)
 }
 
-export async function save(ctx: BBContext) {
+export async function save(ctx: UserCtx) {
   const appId = ctx.appId
   const table = ctx.request.body
   const isImport = table.rows
@@ -79,7 +79,7 @@ export async function save(ctx: BBContext) {
   ctx.body = savedTable
 }
 
-export async function destroy(ctx: BBContext) {
+export async function destroy(ctx: UserCtx) {
   const appId = ctx.appId
   const tableId = ctx.params.tableId
   const deletedTable = await pickApi({ tableId }).destroy(ctx)
@@ -91,7 +91,7 @@ export async function destroy(ctx: BBContext) {
   ctx.body = { message: `Table ${tableId} deleted.` }
 }
 
-export async function bulkImport(ctx: BBContext) {
+export async function bulkImport(ctx: UserCtx) {
   const tableId = ctx.params.tableId
   await pickApi({ tableId }).bulkImport(ctx)
   // right now we don't trigger anything for bulk import because it
@@ -101,7 +101,7 @@ export async function bulkImport(ctx: BBContext) {
   ctx.body = { message: `Bulk rows created.` }
 }
 
-export async function csvToJson(ctx: BBContext) {
+export async function csvToJson(ctx: UserCtx) {
   const { csvString } = ctx.request.body
 
   const result = await csv().fromString(csvString)
@@ -110,7 +110,7 @@ export async function csvToJson(ctx: BBContext) {
   ctx.body = result
 }
 
-export async function validateNewTableImport(ctx: BBContext) {
+export async function validateNewTableImport(ctx: UserCtx) {
   const { rows, schema }: { rows: unknown; schema: unknown } = ctx.request.body
 
   if (isRows(rows) && isSchema(schema)) {
@@ -121,7 +121,7 @@ export async function validateNewTableImport(ctx: BBContext) {
   }
 }
 
-export async function validateExistingTableImport(ctx: BBContext) {
+export async function validateExistingTableImport(ctx: UserCtx) {
   const { rows, tableId }: { rows: unknown; tableId: unknown } =
     ctx.request.body
 

package/src/api/controllers/table/utils.ts

@@ -1,7 +1,11 @@
 import { parse, isSchema, isRows } from "../../../utilities/schema"
 import { getRowParams, generateRowID, InternalTables } from "../../../db/utils"
 import { isEqual } from "lodash"
-import { AutoFieldSubTypes, FieldTypes } from "../../../constants"
+import {
+  AutoFieldSubTypes,
+  FieldTypes,
+  GOOGLE_SHEETS_PRIMARY_KEY,
+} from "../../../constants"
 import {
   inputProcessing,
   cleanupAttachments,
@@ -16,7 +20,7 @@ import viewTemplate from "../view/viewBuilder"
 import { cloneDeep } from "lodash/fp"
 import { quotas } from "@budibase/pro"
 import { events, context } from "@budibase/backend-core"
-import { Database } from "@budibase/types"
+import { Database, Datasource, SourceName, Table } from "@budibase/types"
 
 export async function clearColumns(table: any, columnNames: any) {
   const db: Database = context.getAppDB()
@@ -392,5 +396,17 @@ export function hasTypeChanged(table: any, oldTable: any) {
   return false
 }
 
+// used for external tables, some of them will have static schemas that need
+// to be hard set
+export function setStaticSchemas(datasource: Datasource, table: Table) {
+  // GSheets is a specific case - only ever has a static primary key
+  if (table && datasource.source === SourceName.GOOGLE_SHEETS) {
+    table.primary = [GOOGLE_SHEETS_PRIMARY_KEY]
+    // if there is an id column, remove it, should never exist in GSheets
+    delete table.schema?.id
+  }
+  return table
+}
+
 const _TableSaveFunctions = TableSaveFunctions
 export { _TableSaveFunctions as TableSaveFunctions }

package/src/api/controllers/view/tests/__snapshots__/viewBuilder.spec.js.snap

@@ -1,48 +1,48 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`viewBuilder Calculate and filter creates a view with the calculation statistics and filter schema 1`] = `
-Object {
+{
   "map": "function (doc) {
-      if ((doc.tableId === \\"14f1c4e94d6a47b682ce89d35d4c78b0\\" && !(
-      doc[\\"myField\\"] === undefined ||
-      doc[\\"myField\\"] === null ||
-      doc[\\"myField\\"] === \\"\\" ||
-      (Array.isArray(doc[\\"myField\\"]) && doc[\\"myField\\"].length === 0)
-  )) && (doc[\\"age\\"] > 17)) {
-        emit(doc[\\"_id\\"], doc[\\"myField\\"]);
+      if ((doc.tableId === "14f1c4e94d6a47b682ce89d35d4c78b0" && !(
+      doc["myField"] === undefined ||
+      doc["myField"] === null ||
+      doc["myField"] === "" ||
+      (Array.isArray(doc["myField"]) && doc["myField"].length === 0)
+  )) && (doc["age"] > 17)) {
+        emit(doc["_id"], doc["myField"]);
       }
     }",
-  "meta": Object {
+  "meta": {
     "calculation": "stats",
     "field": "myField",
-    "filters": Array [
-      Object {
+    "filters": [
+      {
         "condition": "MT",
         "key": "age",
         "value": 17,
       },
     ],
     "groupBy": undefined,
-    "schema": Object {
-      "avg": Object {
+    "schema": {
+      "avg": {
         "type": "number",
       },
-      "count": Object {
+      "count": {
         "type": "number",
       },
-      "field": Object {
+      "field": {
         "type": "string",
       },
-      "max": Object {
+      "max": {
         "type": "number",
       },
-      "min": Object {
+      "min": {
         "type": "number",
       },
-      "sum": Object {
+      "sum": {
         "type": "number",
       },
-      "sumsqr": Object {
+      "sumsqr": {
         "type": "number",
       },
     },
@@ -53,42 +53,42 @@ Object {
 `;
 
 exports[`viewBuilder Calculate creates a view with the calculation statistics schema 1`] = `
-Object {
+{
   "map": "function (doc) {
-      if ((doc.tableId === \\"14f1c4e94d6a47b682ce89d35d4c78b0\\" && !(
-      doc[\\"myField\\"] === undefined ||
-      doc[\\"myField\\"] === null ||
-      doc[\\"myField\\"] === \\"\\" ||
-      (Array.isArray(doc[\\"myField\\"]) && doc[\\"myField\\"].length === 0)
+      if ((doc.tableId === "14f1c4e94d6a47b682ce89d35d4c78b0" && !(
+      doc["myField"] === undefined ||
+      doc["myField"] === null ||
+      doc["myField"] === "" ||
+      (Array.isArray(doc["myField"]) && doc["myField"].length === 0)
   )) ) {
-        emit(doc[\\"_id\\"], doc[\\"myField\\"]);
+        emit(doc["_id"], doc["myField"]);
       }
     }",
-  "meta": Object {
+  "meta": {
     "calculation": "stats",
     "field": "myField",
-    "filters": Array [],
+    "filters": [],
     "groupBy": undefined,
-    "schema": Object {
-      "avg": Object {
+    "schema": {
+      "avg": {
         "type": "number",
       },
-      "count": Object {
+      "count": {
         "type": "number",
       },
-      "field": Object {
+      "field": {
         "type": "string",
       },
-      "max": Object {
+      "max": {
         "type": "number",
       },
-      "min": Object {
+      "min": {
         "type": "number",
       },
-      "sum": Object {
+      "sum": {
         "type": "number",
       },
-      "sumsqr": Object {
+      "sumsqr": {
         "type": "number",
       },
     },
@@ -99,22 +99,22 @@ Object {
 `;
 
 exports[`viewBuilder Filter creates a view with multiple filters and conjunctions 1`] = `
-Object {
+{
   "map": "function (doc) {
-      if (doc.tableId === \\"14f1c4e94d6a47b682ce89d35d4c78b0\\" && (doc[\\"Name\\"] === \\"Test\\" || doc[\\"Yes\\"] > \\"Value\\")) {
-        emit(doc[\\"_id\\"], doc[\\"undefined\\"]);
+      if (doc.tableId === "14f1c4e94d6a47b682ce89d35d4c78b0" && (doc["Name"] === "Test" || doc["Yes"] > "Value")) {
+        emit(doc["_id"], doc["undefined"]);
       }
     }",
-  "meta": Object {
+  "meta": {
     "calculation": undefined,
     "field": undefined,
-    "filters": Array [
-      Object {
+    "filters": [
+      {
         "condition": "EQUALS",
         "key": "Name",
         "value": "Test",
       },
-      Object {
+      {
         "condition": "MT",
         "conjunction": "OR",
         "key": "Yes",
@@ -129,16 +129,16 @@ Object {
 `;
 
 exports[`viewBuilder Group By creates a view emitting the group by field 1`] = `
-Object {
+{
   "map": "function (doc) {
-      if (doc.tableId === \\"14f1c4e94d6a47b682ce89d35d4c78b0\\" ) {
-        emit(doc[\\"age\\"], doc[\\"score\\"]);
+      if (doc.tableId === "14f1c4e94d6a47b682ce89d35d4c78b0" ) {
+        emit(doc["age"], doc["score"]);
       }
     }",
-  "meta": Object {
+  "meta": {
     "calculation": undefined,
     "field": "score",
-    "filters": Array [],
+    "filters": [],
     "groupBy": "age",
     "schema": null,
     "tableId": "14f1c4e94d6a47b682ce89d35d4c78b0",

package/src/api/routes/public/index.ts

@@ -1,4 +1,5 @@
 import appEndpoints from "./applications"
+import metricEndpoints from "./metrics"
 import queryEndpoints from "./queries"
 import tableEndpoints from "./tables"
 import rowEndpoints from "./rows"
@@ -12,7 +13,7 @@ import env from "../../../environment"
 // below imports don't have declaration files
 const Router = require("@koa/router")
 const { RateLimit, Stores } = require("koa2-ratelimit")
-import { redis, permissions } from "@budibase/backend-core"
+import { middleware, redis, permissions } from "@budibase/backend-core"
 const { PermissionType, PermissionLevel } = permissions
 
 const PREFIX = "/api/public/v1"
@@ -91,6 +92,13 @@ function addToRouter(endpoints: any) {
   }
 }
 
+function applyAdminRoutes(endpoints: any) {
+  addMiddleware(endpoints.read, middleware.builderOrAdmin)
+  addMiddleware(endpoints.write, middleware.builderOrAdmin)
+  addToRouter(endpoints.read)
+  addToRouter(endpoints.write)
+}
+
 function applyRoutes(
   endpoints: any,
   permType: string,
@@ -119,6 +127,7 @@ function applyRoutes(
   addToRouter(endpoints.write)
 }
 
+applyAdminRoutes(metricEndpoints)
 applyRoutes(appEndpoints, PermissionType.APP, "appId")
 applyRoutes(tableEndpoints, PermissionType.TABLE, "tableId")
 applyRoutes(userEndpoints, PermissionType.USER, "userId")

package/src/api/routes/public/metrics.ts

@@ -0,0 +1,28 @@
+import controller from "../../controllers/public/metrics"
+import Endpoint from "./utils/Endpoint"
+
+const read = []
+
+/**
+ * @openapi
+ * /metrics:
+ *   get:
+ *     operationId: metricsGet
+ *     summary: Retrieve Budibase tenant metrics
+ *     description: Output metrics in OpenMetrics format compatible with Prometheus
+ *     tags:
+ *       - metrics
+ *     responses:
+ *       200:
+ *         description: Returns tenant metrics.
+ *         content:
+ *           text/plain:
+ *             schema:
+ *               type: string
+ *             examples:
+ *               metrics:
+ *                 $ref: '#/components/examples/metrics'
+ */
+read.push(new Endpoint("get", "/metrics", controller.fetch))
+
+export default { read }