@budibase/server 1.3.20 → 1.3.21-alpha.1

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

@@ -231,20 +231,6 @@ 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", () => {
@@ -261,17 +247,14 @@ describe("/queries", () => {
     })
 
     it("should fail with invalid integration type", async () => {
-      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)
+      let error
+      try {
+        await createInvalidIntegration()
+      } catch (err) {
+        error = err
+      }
+      expect(error).toBeDefined()
+      expect(error.message).toBe("No datasource implementation found.")
     })
   })
 

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

@@ -23,7 +23,6 @@ describe("/users", () => {
   })
 
   describe("fetch", () => {
-
     it("returns a list of users from an instance db", async () => {
       await config.createUser("uuidx")
       await config.createUser("uuidy")
@@ -38,7 +37,6 @@ 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,6 +10,7 @@ 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
@@ -209,15 +210,35 @@ exports.automationValidator = (existing = false) => {
   }).unknown(true))
 }
 
-exports.applicationValidator = () => {
+exports.applicationValidator = (opts = { isCreate: true }) => {
   // prettier-ignore
-  return joiValidator.body(Joi.object({
+  const base = {
     _id: OPTIONAL_STRING,
     _rev: OPTIONAL_STRING,
-    name: Joi.string().required(),
     url: OPTIONAL_STRING,
     template: Joi.object({
       templateString: OPTIONAL_STRING,
-    }).unknown(true),
-  }).unknown(true))
+    })
+  }
+
+  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)
+  )
 }

package/src/app.ts

@@ -26,10 +26,17 @@ 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, getChecklist } from "./utilities/workerRequests"
+import {
+  createAdminUser,
+  generateApiKey,
+  getChecklist,
+} from "./utilities/workerRequests"
+import { watch } from "./watch"
+import { initialise as initialiseWebsockets } from "./websocket"
 
 const app = new Koa()
 
@@ -74,6 +81,7 @@ if (env.isProd()) {
 
 const server = http.createServer(app.callback())
 destroyable(server)
+initialiseWebsockets(server)
 
 let shuttingDown = false,
   errCode = 0
@@ -123,11 +131,16 @@ module.exports = server.listen(env.PORT || 0, async () => {
     if (!checklist?.adminUser?.checked) {
       try {
         const tenantId = tenancy.getTenantId()
-        await createAdminUser(
+        const user = 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
@@ -139,6 +152,16 @@ 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,6 +42,7 @@ const DocumentType = {
   MEM_VIEW: "view",
   USER_FLAG: "flag",
   AUTOMATION_METADATA: "meta_au",
+  PLUGIN: "plg",
 }
 
 const InternalTables = {
@@ -370,6 +371,10 @@ 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
  */
@@ -379,3 +384,10 @@ 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,58 +278,7 @@ export interface paths {
       };
       requestBody: {
         content: {
-          "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";
-            };
-          };
+          "application/json": components["schemas"]["rowSearch"];
         };
       };
     };
@@ -344,7 +293,7 @@ export interface paths {
         };
       };
       responses: {
-        /** Returns the created table, including the ID which has been generated for it. This can be internal or external data sources. */
+        /** Returns the created table, including the ID which has been generated for it. This can be internal or external datasources. */
         200: {
           content: {
             "application/json": components["schemas"]["tableOutput"];
@@ -965,7 +914,7 @@ export interface components {
     query: {
       /** @description The ID of the query. */
       _id: string;
-      /** @description The ID of the data source the query belongs to. */
+      /** @description The ID of the datasource the query belongs to. */
       datasourceId?: string;
       /** @description The bindings which are required to perform this query. */
       parameters?: string[];
@@ -989,7 +938,7 @@ export interface components {
       data: {
         /** @description The ID of the query. */
         _id: string;
-        /** @description The ID of the data source the query belongs to. */
+        /** @description The ID of the datasource the query belongs to. */
         datasourceId?: string;
         /** @description The bindings which are required to perform this query. */
         parameters?: string[];
@@ -1105,6 +1054,58 @@ 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,6 +74,7 @@ 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,

package/src/integrations/airtable.ts

@@ -5,146 +5,144 @@ import {
   IntegrationBase,
 } from "@budibase/types"
 
-module AirtableModule {
-  const Airtable = require("airtable")
+const Airtable = require("airtable")
 
-  interface AirtableConfig {
-    apiKey: string
-    base: string
-  }
+interface AirtableConfig {
+  apiKey: string
+  base: string
+}
 
-  const SCHEMA: Integration = {
-    docs: "https://airtable.com/api",
-    description:
-      "Airtable is a spreadsheet-database hybrid, with the features of a database but applied to a spreadsheet.",
-    friendlyName: "Airtable",
-    type: "Spreadsheet",
-    datasource: {
-      apiKey: {
-        type: DatasourceFieldType.PASSWORD,
-        default: "enter api key",
-        required: true,
-      },
-      base: {
-        type: DatasourceFieldType.STRING,
-        default: "mybase",
-        required: true,
-      },
+const SCHEMA: Integration = {
+  docs: "https://airtable.com/api",
+  description:
+    "Airtable is a spreadsheet-database hybrid, with the features of a database but applied to a spreadsheet.",
+  friendlyName: "Airtable",
+  type: "Spreadsheet",
+  datasource: {
+    apiKey: {
+      type: DatasourceFieldType.PASSWORD,
+      default: "enter api key",
+      required: true,
+    },
+    base: {
+      type: DatasourceFieldType.STRING,
+      default: "mybase",
+      required: true,
     },
-    query: {
-      create: {
-        type: QueryType.FIELDS,
-        customisable: true,
-        fields: {
-          table: {
-            type: DatasourceFieldType.STRING,
-            required: true,
-          },
+  },
+  query: {
+    create: {
+      type: QueryType.FIELDS,
+      customisable: true,
+      fields: {
+        table: {
+          type: DatasourceFieldType.STRING,
+          required: true,
         },
       },
-      read: {
-        type: QueryType.FIELDS,
-        fields: {
-          table: {
-            type: DatasourceFieldType.STRING,
-            required: true,
-          },
-          view: {
-            type: DatasourceFieldType.STRING,
-            required: true,
-          },
-          numRecords: {
-            type: DatasourceFieldType.NUMBER,
-            default: 10,
-          },
+    },
+    read: {
+      type: QueryType.FIELDS,
+      fields: {
+        table: {
+          type: DatasourceFieldType.STRING,
+          required: true,
         },
-      },
-      update: {
-        type: QueryType.FIELDS,
-        customisable: true,
-        fields: {
-          id: {
-            display: "Record ID",
-            type: DatasourceFieldType.STRING,
-            required: true,
-          },
-          table: {
-            type: DatasourceFieldType.STRING,
-            required: true,
-          },
+        view: {
+          type: DatasourceFieldType.STRING,
+          required: true,
+        },
+        numRecords: {
+          type: DatasourceFieldType.NUMBER,
+          default: 10,
         },
       },
-      delete: {
-        type: QueryType.JSON,
+    },
+    update: {
+      type: QueryType.FIELDS,
+      customisable: true,
+      fields: {
+        id: {
+          display: "Record ID",
+          type: DatasourceFieldType.STRING,
+          required: true,
+        },
+        table: {
+          type: DatasourceFieldType.STRING,
+          required: true,
+        },
       },
     },
-  }
+    delete: {
+      type: QueryType.JSON,
+    },
+  },
+}
 
-  class AirtableIntegration implements IntegrationBase {
-    private config: AirtableConfig
-    private client: any
+class AirtableIntegration implements IntegrationBase {
+  private config: AirtableConfig
+  private client: any
 
-    constructor(config: AirtableConfig) {
-      this.config = config
-      this.client = new Airtable(config).base(config.base)
-    }
+  constructor(config: AirtableConfig) {
+    this.config = config
+    this.client = new Airtable(config).base(config.base)
+  }
 
-    async create(query: { table: any; json: any }) {
-      const { table, json } = query
+  async create(query: { table: any; json: any }) {
+    const { table, json } = query
 
-      try {
-        return await this.client(table).create([
-          {
-            fields: json,
-          },
-        ])
-      } catch (err) {
-        console.error("Error writing to airtable", err)
-        throw err
-      }
+    try {
+      return await this.client(table).create([
+        {
+          fields: json,
+        },
+      ])
+    } catch (err) {
+      console.error("Error writing to airtable", err)
+      throw err
     }
+  }
 
-    async read(query: { table: any; numRecords: any; view: any }) {
-      try {
-        const records = await this.client(query.table)
-          .select({ maxRecords: query.numRecords || 10, view: query.view })
-          .firstPage()
-        // @ts-ignore
-        return records.map(({ fields }) => fields)
-      } catch (err) {
-        console.error("Error writing to airtable", err)
-        return []
-      }
+  async read(query: { table: any; numRecords: any; view: any }) {
+    try {
+      const records = await this.client(query.table)
+        .select({ maxRecords: query.numRecords || 10, view: query.view })
+        .firstPage()
+      // @ts-ignore
+      return records.map(({ fields }) => fields)
+    } catch (err) {
+      console.error("Error writing to airtable", err)
+      return []
     }
+  }
 
-    async update(query: { table: any; id: any; json: any }) {
-      const { table, id, json } = query
+  async update(query: { table: any; id: any; json: any }) {
+    const { table, id, json } = query
 
-      try {
-        return await this.client(table).update([
-          {
-            id,
-            fields: json,
-          },
-        ])
-      } catch (err) {
-        console.error("Error writing to airtable", err)
-        throw err
-      }
+    try {
+      return await this.client(table).update([
+        {
+          id,
+          fields: json,
+        },
+      ])
+    } catch (err) {
+      console.error("Error writing to airtable", err)
+      throw err
     }
+  }
 
-    async delete(query: { table: any; ids: any }) {
-      try {
-        return await this.client(query.table).destroy(query.ids)
-      } catch (err) {
-        console.error("Error writing to airtable", err)
-        throw err
-      }
+  async delete(query: { table: any; ids: any }) {
+    try {
+      return await this.client(query.table).destroy(query.ids)
+    } catch (err) {
+      console.error("Error writing to airtable", err)
+      throw err
     }
   }
+}
 
-  module.exports = {
-    schema: SCHEMA,
-    integration: AirtableIntegration,
-  }
+export default {
+  schema: SCHEMA,
+  integration: AirtableIntegration,
 }