@budibase/server 1.3.21-alpha.1 → 1.3.21

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

@@ -3,7 +3,6 @@
   export let favicon = ""
 
   export let clientLibPath
-  export let usedPlugins
 </script>
 
 <svelte:head>
@@ -84,15 +83,6 @@
   </script>
   <script type="application/javascript" src={clientLibPath}>
   </script>
-  <!-- Custom components need inserted after the core client library -->
-  <!-- But before loadBudibase is called -->
-  {#if usedPlugins?.length}
-    {#each usedPlugins as plugin}
-      <script
-        type="application/javascript"
-        src={`/plugins/${plugin.jsUrl}`}></script>
-    {/each}
-  {/if}
   <script type="application/javascript">
     if (window.loadBudibase) {
       window.loadBudibase()

package/src/api/controllers/static/templates/preview.hbs

@@ -66,9 +66,7 @@
         customTheme,
         previewDevice,
         navigation,
-        hiddenComponentIds,
-        usedPlugins,
-        location
+        hiddenComponentIds
       } = parsed
 
       // Set some flags so the app knows we're in the builder
@@ -83,8 +81,6 @@
       window["##BUDIBASE_PREVIEW_DEVICE##"] = previewDevice
       window["##BUDIBASE_PREVIEW_NAVIGATION##"] = navigation
       window["##BUDIBASE_HIDDEN_COMPONENT_IDS##"] = hiddenComponentIds
-      window["##BUDIBASE_USED_PLUGINS##"] = usedPlugins
-      window["##BUDIBASE_LOCATION##"] = location
 
       // Initialise app
       try {

package/src/api/index.js

@@ -54,8 +54,8 @@ router
       noTenancyRequired: true,
     })
   )
-  .use(pro.licensing())
   .use(currentApp)
+  .use(pro.licensing())
   .use(auditLog)
 
 // error handling middleware

package/src/api/routes/application.ts

@@ -2,27 +2,16 @@ import Router from "@koa/router"
 import * as controller from "../controllers/application"
 import authorized from "../../middleware/authorized"
 import { BUILDER } from "@budibase/backend-core/permissions"
-import { applicationValidator } from "./utils/validators"
 
 const router = new Router()
 
 router
   .post("/api/applications/:appId/sync", authorized(BUILDER), controller.sync)
-  .post(
-    "/api/applications",
-    authorized(BUILDER),
-    applicationValidator(),
-    controller.create
-  )
+  .post("/api/applications", authorized(BUILDER), controller.create)
   .get("/api/applications/:appId/definition", controller.fetchAppDefinition)
   .get("/api/applications", controller.fetch)
   .get("/api/applications/:appId/appPackage", controller.fetchAppPackage)
-  .put(
-    "/api/applications/:appId",
-    authorized(BUILDER),
-    applicationValidator({ isCreate: false }),
-    controller.update
-  )
+  .put("/api/applications/:appId", authorized(BUILDER), controller.update)
   .post(
     "/api/applications/:appId/client/update",
     authorized(BUILDER),

package/src/api/routes/index.ts

@@ -24,7 +24,6 @@ import metadataRoutes from "./metadata"
 import devRoutes from "./dev"
 import cloudRoutes from "./cloud"
 import migrationRoutes from "./migrations"
-import pluginRoutes from "./plugin"
 
 export { default as staticRoutes } from "./static"
 export { default as publicRoutes } from "./public"
@@ -58,5 +57,4 @@ export const mainRoutes = [
   tableRoutes,
   rowRoutes,
   migrationRoutes,
-  pluginRoutes,
 ]

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

@@ -143,7 +143,88 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read))
  *       content:
  *         application/json:
  *           schema:
- *             $ref: '#/components/schemas/rowSearch'
+ *             type: object
+ *             required:
+ *               - query
+ *             properties:
+ *               query:
+ *                 type: object
+ *                 properties:
+ *                   allOr:
+ *                     type: boolean
+ *                     description: Specifies that a row should be returned if it satisfies
+ *                       any of the specified options, rather than requiring it to fulfill all
+ *                       the search parameters. This defaults to false, meaning AND logic will be used.
+ *                   string:
+ *                     type: object
+ *                     example:
+ *                       columnName1: value
+ *                       columnName2: value
+ *                     description: A map of field name to the string to search for,
+ *                       this will look for rows that have a value starting with the
+ *                       string value.
+ *                     additionalProperties:
+ *                       type: string
+ *                       description: The value to search for in the column.
+ *                   fuzzy:
+ *                     type: object
+ *                     description: A fuzzy search, only supported by internal tables.
+ *                   range:
+ *                     type: object
+ *                     description: Searches within a range, the format of this must be
+ *                       in the format of an object with a "low" and "high" property.
+ *                     example:
+ *                       columnName1: { low: 10, high: 20 }
+ *                   equal:
+ *                     type: object
+ *                     description: Searches for rows that have a column value that is
+ *                       exactly the value set.
+ *                   notEqual:
+ *                     type: object
+ *                     description: Searches for any row which does not contain the specified
+ *                       column value.
+ *                   empty:
+ *                     type: object
+ *                     description: Searches for rows which do not contain the specified column.
+ *                       The object should simply contain keys of the column names, these
+ *                       can map to any value.
+ *                     example:
+ *                       columnName1: ""
+ *                   notEmpty:
+ *                     type: object
+ *                     description: Searches for rows which have the specified column.
+ *                   oneOf:
+ *                     type: object
+ *                     description: Searches for rows which have a column value that is any
+ *                       of the specified values. The format of this must be columnName -> [value1, value2].
+ *               paginate:
+ *                 type: boolean
+ *                 description: Enables pagination, by default this is disabled.
+ *               bookmark:
+ *                 oneOf:
+ *                   - type: string
+ *                   - type: integer
+ *                 description: If retrieving another page, the bookmark from the previous request must be supplied.
+ *               limit:
+ *                 type: integer
+ *                 description: The maximum number of rows to return, useful when paginating, for internal tables this
+ *                   will be limited to 1000, for SQL tables it will be 5000.
+ *               sort:
+ *                 type: object
+ *                 description: A set of parameters describing the sort behaviour of the search.
+ *                 properties:
+ *                   order:
+ *                     type: string
+ *                     enum: [ascending, descending]
+ *                     description: The order of the sort, by default this is ascending.
+ *                   column:
+ *                     type: string
+ *                     description: The name of the column by which the rows will be sorted.
+ *                   type:
+ *                     type: string
+ *                     enum: [string, number]
+ *                     description: Defines whether the column should be treated as a string
+ *                       or as numbers when sorting.
  *     responses:
  *       200:
  *         description: The response will contain an array of rows that match the search parameters.

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

@@ -26,7 +26,7 @@ const read = [],
  *     responses:
  *       200:
  *         description: Returns the created table, including the ID which has been generated for it. This can be
- *           internal or external datasources.
+ *           internal or external data sources.
  *         content:
  *           application/json:
  *             schema:

package/src/api/routes/table.js

@@ -55,7 +55,7 @@ router
    * @apiParam (Body) {string} [_rev] If updating an existing internal table then the revision must also be specified.
    * @apiParam (Body) {string} type] This should either be "internal" or "external" depending on the table type -
    * this will default to internal.
-   * @apiParam (Body) {string} [sourceId] If creating an external table then this should be set to the datasource ID. If
+   * @apiParam (Body) {string} [sourceId] If creating an external table then this should be set to the data source ID. If
    * building an internal table this does not need to be set, although it will be returned as "bb_internal".
    * @apiParam (Body) {string} name The name of the table, this will be used in the UI. To rename the table simply
    * supply the table structure to this endpoint with the name changed.

package/src/api/routes/tests/query.spec.js

@@ -231,6 +231,20 @@ describe("/queries", () => {
         url: `/api/queries/preview`,
       })
     })
+
+    it("should fail with invalid integration type", async () => {
+      const { datasource } = await createInvalidIntegration()
+      await request
+        .post(`/api/queries/preview`)
+        .send({
+          datasourceId: datasource._id,
+          parameters: {},
+          fields: {},
+          queryVerb: "read",
+        })
+        .set(config.defaultHeaders())
+        .expect(400)
+    })
   })
 
   describe("execute", () => {
@@ -247,14 +261,17 @@ describe("/queries", () => {
     })
 
     it("should fail with invalid integration type", async () => {
-      let error
-      try {
-        await createInvalidIntegration()
-      } catch (err) {
-        error = err
-      }
-      expect(error).toBeDefined()
-      expect(error.message).toBe("No datasource implementation found.")
+      const { query, datasource } = await createInvalidIntegration()
+      await request
+        .post(`/api/queries/${query._id}`)
+        .send({
+          datasourceId: datasource._id,
+          parameters: {},
+          fields: {},
+          queryVerb: "read",
+        })
+        .set(config.defaultHeaders())
+        .expect(400)
     })
   })
 

package/src/api/routes/tests/user.spec.js

@@ -23,6 +23,7 @@ describe("/users", () => {
   })
 
   describe("fetch", () => {
+
     it("returns a list of users from an instance db", async () => {
       await config.createUser("uuidx")
       await config.createUser("uuidy")
@@ -37,6 +38,7 @@ describe("/users", () => {
       expect(res.body.find(u => u._id === `ro_ta_users_us_uuidy`)).toBeDefined()
     })
 
+
     it("should apply authorization to endpoint", async () => {
       await config.createUser()
       await checkPermissionsEndpoint({

package/src/api/routes/utils/validators.js

@@ -10,7 +10,6 @@ const Joi = require("joi")
 const OPTIONAL_STRING = Joi.string().optional().allow(null).allow("")
 const OPTIONAL_NUMBER = Joi.number().optional().allow(null)
 const OPTIONAL_BOOLEAN = Joi.boolean().optional().allow(null)
-const APP_NAME_REGEX = /^[\w\s]+$/
 
 exports.tableValidator = () => {
   // prettier-ignore
@@ -210,35 +209,15 @@ exports.automationValidator = (existing = false) => {
   }).unknown(true))
 }
 
-exports.applicationValidator = (opts = { isCreate: true }) => {
+exports.applicationValidator = () => {
   // prettier-ignore
-  const base = {
+  return joiValidator.body(Joi.object({
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
+    name: Joi.string().required(),
     url: OPTIONAL_STRING,
     template: Joi.object({
       templateString: OPTIONAL_STRING,
-    })
-  }
-
-  const appNameValidator = Joi.string()
-    .pattern(new RegExp(APP_NAME_REGEX))
-    .error(new Error("App name must be letters, numbers and spaces only"))
-  if (opts.isCreate) {
-    base.name = appNameValidator.required()
-  } else {
-    base.name = appNameValidator.optional()
-  }
-
-  return joiValidator.body(
-    Joi.object({
-      _id: OPTIONAL_STRING,
-      _rev: OPTIONAL_STRING,
-      name: appNameValidator,
-      url: OPTIONAL_STRING,
-      template: Joi.object({
-        templateString: OPTIONAL_STRING,
-      }).unknown(true),
-    }).unknown(true)
-  )
+    }).unknown(true),
+  }).unknown(true))
 }

package/src/app.ts

@@ -26,17 +26,10 @@ const bullboard = require("./automations/bullboard")
 const { logAlert } = require("@budibase/backend-core/logging")
 const { pinoSettings } = require("@budibase/backend-core")
 const { Thread } = require("./threads")
-const fs = require("fs")
 import redis from "./utilities/redis"
 import * as migrations from "./migrations"
 import { events, installation, tenancy } from "@budibase/backend-core"
-import {
-  createAdminUser,
-  generateApiKey,
-  getChecklist,
-} from "./utilities/workerRequests"
-import { watch } from "./watch"
-import { initialise as initialiseWebsockets } from "./websocket"
+import { createAdminUser, getChecklist } from "./utilities/workerRequests"
 
 const app = new Koa()
 
@@ -81,7 +74,6 @@ if (env.isProd()) {
 
 const server = http.createServer(app.callback())
 destroyable(server)
-initialiseWebsockets(server)
 
 let shuttingDown = false,
   errCode = 0
@@ -131,16 +123,11 @@ module.exports = server.listen(env.PORT || 0, async () => {
     if (!checklist?.adminUser?.checked) {
       try {
         const tenantId = tenancy.getTenantId()
-        const user = await createAdminUser(
+        await createAdminUser(
           env.BB_ADMIN_USER_EMAIL,
           env.BB_ADMIN_USER_PASSWORD,
           tenantId
         )
-        // Need to set up an API key for automated integration tests
-        if (env.isTest()) {
-          await generateApiKey(user._id)
-        }
-
         console.log(
           "Admin account automatically created for",
           env.BB_ADMIN_USER_EMAIL
@@ -152,16 +139,6 @@ module.exports = server.listen(env.PORT || 0, async () => {
     }
   }
 
-  // monitor plugin directory if required
-  if (
-    env.SELF_HOSTED &&
-    !env.MULTI_TENANCY &&
-    env.PLUGINS_DIR &&
-    fs.existsSync(env.PLUGINS_DIR)
-  ) {
-    watch()
-  }
-
   // check for version updates
   await installation.checkInstallVersion()
 

package/src/db/utils.js

@@ -42,7 +42,6 @@ const DocumentType = {
   MEM_VIEW: "view",
   USER_FLAG: "flag",
   AUTOMATION_METADATA: "meta_au",
-  PLUGIN: "plg",
 }
 
 const InternalTables = {
@@ -371,10 +370,6 @@ exports.getMemoryViewParams = (otherProps = {}) => {
   return getDocParams(DocumentType.MEM_VIEW, null, otherProps)
 }
 
-exports.generatePluginID = name => {
-  return `${DocumentType.PLUGIN}${SEPARATOR}${name}`
-}
-
 /**
  * This can be used with the db.allDocs to get a list of IDs
  */
@@ -384,10 +379,3 @@ exports.getMultiIDParams = ids => {
     include_docs: true,
   }
 }
-
-/**
- * Gets parameters for retrieving automations, this is a utility function for the getDocParams function.
- */
-exports.getPluginParams = (pluginId = null, otherProps = {}) => {
-  return getDocParams(DocumentType.PLUGIN, pluginId, otherProps)
-}

package/src/definitions/openapi.ts

@@ -278,7 +278,58 @@ export interface paths {
       };
       requestBody: {
         content: {
-          "application/json": components["schemas"]["rowSearch"];
+          "application/json": {
+            query: {
+              /** @description Specifies that a row should be returned if it satisfies any of the specified options, rather than requiring it to fulfill all the search parameters. This defaults to false, meaning AND logic will be used. */
+              allOr?: boolean;
+              /**
+               * @description A map of field name to the string to search for, this will look for rows that have a value starting with the string value.
+               * @example [object Object]
+               */
+              string?: { [key: string]: string };
+              /** @description A fuzzy search, only supported by internal tables. */
+              fuzzy?: { [key: string]: unknown };
+              /**
+               * @description Searches within a range, the format of this must be in the format of an object with a "low" and "high" property.
+               * @example [object Object]
+               */
+              range?: { [key: string]: unknown };
+              /** @description Searches for rows that have a column value that is exactly the value set. */
+              equal?: { [key: string]: unknown };
+              /** @description Searches for any row which does not contain the specified column value. */
+              notEqual?: { [key: string]: unknown };
+              /**
+               * @description Searches for rows which do not contain the specified column. The object should simply contain keys of the column names, these can map to any value.
+               * @example [object Object]
+               */
+              empty?: { [key: string]: unknown };
+              /** @description Searches for rows which have the specified column. */
+              notEmpty?: { [key: string]: unknown };
+              /** @description Searches for rows which have a column value that is any of the specified values. The format of this must be columnName -> [value1, value2]. */
+              oneOf?: { [key: string]: unknown };
+            };
+            /** @description Enables pagination, by default this is disabled. */
+            paginate?: boolean;
+            /** @description If retrieving another page, the bookmark from the previous request must be supplied. */
+            bookmark?: string | number;
+            /** @description The maximum number of rows to return, useful when paginating, for internal tables this will be limited to 1000, for SQL tables it will be 5000. */
+            limit?: number;
+            /** @description A set of parameters describing the sort behaviour of the search. */
+            sort?: {
+              /**
+               * @description The order of the sort, by default this is ascending.
+               * @enum {string}
+               */
+              order?: "ascending" | "descending";
+              /** @description The name of the column by which the rows will be sorted. */
+              column?: string;
+              /**
+               * @description Defines whether the column should be treated as a string or as numbers when sorting.
+               * @enum {string}
+               */
+              type?: "string" | "number";
+            };
+          };
         };
       };
     };
@@ -293,7 +344,7 @@ export interface paths {
         };
       };
       responses: {
-        /** Returns the created table, including the ID which has been generated for it. This can be internal or external datasources. */
+        /** Returns the created table, including the ID which has been generated for it. This can be internal or external data sources. */
         200: {
           content: {
             "application/json": components["schemas"]["tableOutput"];
@@ -914,7 +965,7 @@ export interface components {
     query: {
       /** @description The ID of the query. */
       _id: string;
-      /** @description The ID of the datasource the query belongs to. */
+      /** @description The ID of the data source the query belongs to. */
       datasourceId?: string;
       /** @description The bindings which are required to perform this query. */
       parameters?: string[];
@@ -938,7 +989,7 @@ export interface components {
       data: {
         /** @description The ID of the query. */
         _id: string;
-        /** @description The ID of the datasource the query belongs to. */
+        /** @description The ID of the data source the query belongs to. */
         datasourceId?: string;
         /** @description The bindings which are required to perform this query. */
         parameters?: string[];
@@ -1054,58 +1105,6 @@ export interface components {
         _id: string;
       }[];
     };
-    rowSearch: {
-      query: {
-        /** @description Specifies that a row should be returned if it satisfies any of the specified options, rather than requiring it to fulfill all the search parameters. This defaults to false, meaning AND logic will be used. */
-        allOr?: boolean;
-        /**
-         * @description A map of field name to the string to search for, this will look for rows that have a value starting with the string value.
-         * @example [object Object]
-         */
-        string?: { [key: string]: string };
-        /** @description A fuzzy search, only supported by internal tables. */
-        fuzzy?: { [key: string]: unknown };
-        /**
-         * @description Searches within a range, the format of this must be in the format of an object with a "low" and "high" property.
-         * @example [object Object]
-         */
-        range?: { [key: string]: unknown };
-        /** @description Searches for rows that have a column value that is exactly the value set. */
-        equal?: { [key: string]: unknown };
-        /** @description Searches for any row which does not contain the specified column value. */
-        notEqual?: { [key: string]: unknown };
-        /**
-         * @description Searches for rows which do not contain the specified column. The object should simply contain keys of the column names, these can map to any value.
-         * @example [object Object]
-         */
-        empty?: { [key: string]: unknown };
-        /** @description Searches for rows which have the specified column. */
-        notEmpty?: { [key: string]: unknown };
-        /** @description Searches for rows which have a column value that is any of the specified values. The format of this must be columnName -> [value1, value2]. */
-        oneOf?: { [key: string]: unknown };
-      };
-      /** @description Enables pagination, by default this is disabled. */
-      paginate?: boolean;
-      /** @description If retrieving another page, the bookmark from the previous request must be supplied. */
-      bookmark?: string | number;
-      /** @description The maximum number of rows to return, useful when paginating, for internal tables this will be limited to 1000, for SQL tables it will be 5000. */
-      limit?: number;
-      /** @description A set of parameters describing the sort behaviour of the search. */
-      sort?: {
-        /**
-         * @description The order of the sort, by default this is ascending.
-         * @enum {string}
-         */
-        order?: "ascending" | "descending";
-        /** @description The name of the column by which the rows will be sorted. */
-        column?: string;
-        /**
-         * @description Defines whether the column should be treated as a string or as numbers when sorting.
-         * @enum {string}
-         */
-        type?: "string" | "number";
-      };
-    };
     nameSearch: {
       /** @description The name to be used when searching - this will be used in a case insensitive starts with match. */
       name: string;

package/src/environment.js

@@ -74,7 +74,6 @@ module.exports = {
   SQL_MAX_ROWS: process.env.SQL_MAX_ROWS,
   BB_ADMIN_USER_EMAIL: process.env.BB_ADMIN_USER_EMAIL,
   BB_ADMIN_USER_PASSWORD: process.env.BB_ADMIN_USER_PASSWORD,
-  PLUGINS_DIR: process.env.PLUGINS_DIR || "/plugins",
   // flags
   ALLOW_DEV_AUTOMATIONS: process.env.ALLOW_DEV_AUTOMATIONS,
   DISABLE_THREADING: process.env.DISABLE_THREADING,