@budibase/server 1.3.12-alpha.0 → 1.3.12-alpha.3

package/src/app.ts

@@ -26,10 +26,12 @@ 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 { watch } from "./watch"
 
 const app = new Koa()
 
@@ -139,6 +141,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/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,
 }

package/src/integrations/arangodb.ts

@@ -5,106 +5,104 @@ import {
   IntegrationBase,
 } from "@budibase/types"
 
-module ArangoModule {
-  const { Database, aql } = require("arangojs")
+const { Database, aql } = require("arangojs")
 
-  interface ArangodbConfig {
-    url: string
-    username: string
-    password: string
-    databaseName: string
-    collection: string
-  }
+interface ArangodbConfig {
+  url: string
+  username: string
+  password: string
+  databaseName: string
+  collection: string
+}
 
-  const SCHEMA: Integration = {
-    docs: "https://github.com/arangodb/arangojs",
-    friendlyName: "ArangoDB",
-    type: "Non-relational",
-    description:
-      "ArangoDB is a scalable open-source multi-model database natively supporting graph, document and search. All supported data models & access patterns can be combined in queries allowing for maximal flexibility. ",
-    datasource: {
-      url: {
-        type: DatasourceFieldType.STRING,
-        default: "http://localhost:8529",
-        required: true,
-      },
-      username: {
-        type: DatasourceFieldType.STRING,
-        default: "root",
-        required: true,
-      },
-      password: {
-        type: DatasourceFieldType.PASSWORD,
-        required: true,
-      },
-      databaseName: {
-        type: DatasourceFieldType.STRING,
-        default: "_system",
-        required: true,
-      },
-      collection: {
-        type: DatasourceFieldType.STRING,
-        required: true,
-      },
+const SCHEMA: Integration = {
+  docs: "https://github.com/arangodb/arangojs",
+  friendlyName: "ArangoDB",
+  type: "Non-relational",
+  description:
+    "ArangoDB is a scalable open-source multi-model database natively supporting graph, document and search. All supported data models & access patterns can be combined in queries allowing for maximal flexibility. ",
+  datasource: {
+    url: {
+      type: DatasourceFieldType.STRING,
+      default: "http://localhost:8529",
+      required: true,
     },
-    query: {
-      read: {
-        type: QueryType.SQL,
-      },
-      create: {
-        type: QueryType.JSON,
-      },
+    username: {
+      type: DatasourceFieldType.STRING,
+      default: "root",
+      required: true,
     },
-  }
-
-  class ArangoDBIntegration implements IntegrationBase {
-    private config: ArangodbConfig
-    private client: any
+    password: {
+      type: DatasourceFieldType.PASSWORD,
+      required: true,
+    },
+    databaseName: {
+      type: DatasourceFieldType.STRING,
+      default: "_system",
+      required: true,
+    },
+    collection: {
+      type: DatasourceFieldType.STRING,
+      required: true,
+    },
+  },
+  query: {
+    read: {
+      type: QueryType.SQL,
+    },
+    create: {
+      type: QueryType.JSON,
+    },
+  },
+}
 
-    constructor(config: ArangodbConfig) {
-      const newConfig = {
-        auth: {
-          username: config.username,
-          password: config.password,
-        },
-      }
+class ArangoDBIntegration implements IntegrationBase {
+  private config: ArangodbConfig
+  private client: any
 
-      this.config = config
-      this.client = new Database(newConfig)
+  constructor(config: ArangodbConfig) {
+    const newConfig = {
+      auth: {
+        username: config.username,
+        password: config.password,
+      },
     }
 
-    async read(query: { sql: any }) {
-      try {
-        const result = await this.client.query(query.sql)
-        return result.all()
-      } catch (err) {
-        // @ts-ignore
-        console.error("Error querying arangodb", err.message)
-        throw err
-      } finally {
-        this.client.close()
-      }
-    }
+    this.config = config
+    this.client = new Database(newConfig)
+  }
 
-    async create(query: { json: any }) {
-      const clc = this.client.collection(this.config.collection)
-      try {
-        const result = await this.client.query(
-          aql`INSERT ${query.json} INTO ${clc} RETURN NEW`
-        )
-        return result.all()
-      } catch (err) {
-        // @ts-ignore
-        console.error("Error querying arangodb", err.message)
-        throw err
-      } finally {
-        this.client.close()
-      }
+  async read(query: { sql: any }) {
+    try {
+      const result = await this.client.query(query.sql)
+      return result.all()
+    } catch (err) {
+      // @ts-ignore
+      console.error("Error querying arangodb", err.message)
+      throw err
+    } finally {
+      this.client.close()
     }
   }
 
-  module.exports = {
-    schema: SCHEMA,
-    integration: ArangoDBIntegration,
+  async create(query: { json: any }) {
+    const clc = this.client.collection(this.config.collection)
+    try {
+      const result = await this.client.query(
+        aql`INSERT ${query.json} INTO ${clc} RETURN NEW`
+      )
+      return result.all()
+    } catch (err) {
+      // @ts-ignore
+      console.error("Error querying arangodb", err.message)
+      throw err
+    } finally {
+      this.client.close()
+    }
   }
 }
+
+export default {
+  schema: SCHEMA,
+  integration: ArangoDBIntegration,
+}

package/src/integrations/base/query.ts

@@ -1,11 +1,11 @@
 import { QueryJson, Datasource } from "@budibase/types"
-const { integrations } = require("../index")
+const { getIntegration } = require("../index")
 
 export async function makeExternalQuery(
   datasource: Datasource,
   json: QueryJson
 ) {
-  const Integration = integrations[datasource.source]
+  const Integration = await getIntegration(datasource.source)
   // query is the opinionated function
   if (Integration.prototype.query) {
     const integration = new Integration(datasource.config)