@budibase/server 1.3.19 → 1.3.21-alpha.0

package/src/integrations/postgres.ts

@@ -16,317 +16,313 @@ import {
 } from "./utils"
 import Sql from "./base/sql"
 
-module PostgresModule {
-  const { Client, types } = require("pg")
-  const { escapeDangerousCharacters } = require("../utilities")
+const { Client, types } = require("pg")
+const { escapeDangerousCharacters } = require("../utilities")
 
-  // Return "date" and "timestamp" types as plain strings.
-  // This lets us reference the original stored timezone.
-  // types is undefined when running in a test env for some reason.
-  if (types) {
-    types.setTypeParser(1114, (val: any) => val) // timestamp
-    types.setTypeParser(1082, (val: any) => val) // date
-    types.setTypeParser(1184, (val: any) => val) // timestampz
-  }
+// Return "date" and "timestamp" types as plain strings.
+// This lets us reference the original stored timezone.
+// types is undefined when running in a test env for some reason.
+if (types) {
+  types.setTypeParser(1114, (val: any) => val) // timestamp
+  types.setTypeParser(1082, (val: any) => val) // date
+  types.setTypeParser(1184, (val: any) => val) // timestampz
+}
 
-  const JSON_REGEX = /'{.*}'::json/s
+const JSON_REGEX = /'{.*}'::json/s
 
-  interface PostgresConfig {
-    host: string
-    port: number
-    database: string
-    user: string
-    password: string
-    schema: string
-    ssl?: boolean
-    ca?: string
-    rejectUnauthorized?: boolean
-  }
+interface PostgresConfig {
+  host: string
+  port: number
+  database: string
+  user: string
+  password: string
+  schema: string
+  ssl?: boolean
+  ca?: string
+  rejectUnauthorized?: boolean
+}
 
-  const SCHEMA: Integration = {
-    docs: "https://node-postgres.com",
-    plus: true,
-    friendlyName: "PostgreSQL",
-    type: "Relational",
-    description:
-      "PostgreSQL, also known as Postgres, is a free and open-source relational database management system emphasizing extensibility and SQL compliance.",
-    datasource: {
-      host: {
-        type: DatasourceFieldType.STRING,
-        default: "localhost",
-        required: true,
-      },
-      port: {
-        type: DatasourceFieldType.NUMBER,
-        required: true,
-        default: 5432,
-      },
-      database: {
-        type: DatasourceFieldType.STRING,
-        default: "postgres",
-        required: true,
-      },
-      user: {
-        type: DatasourceFieldType.STRING,
-        default: "root",
-        required: true,
-      },
-      password: {
-        type: DatasourceFieldType.PASSWORD,
-        default: "root",
-        required: true,
-      },
-      schema: {
-        type: DatasourceFieldType.STRING,
-        default: "public",
-        required: true,
-      },
-      ssl: {
-        type: DatasourceFieldType.BOOLEAN,
-        default: false,
-        required: false,
-      },
-      rejectUnauthorized: {
-        type: DatasourceFieldType.BOOLEAN,
-        default: false,
-        required: false,
-      },
-      ca: {
-        type: DatasourceFieldType.LONGFORM,
-        default: false,
-        required: false,
-      },
+const SCHEMA: Integration = {
+  docs: "https://node-postgres.com",
+  plus: true,
+  friendlyName: "PostgreSQL",
+  type: "Relational",
+  description:
+    "PostgreSQL, also known as Postgres, is a free and open-source relational database management system emphasizing extensibility and SQL compliance.",
+  datasource: {
+    host: {
+      type: DatasourceFieldType.STRING,
+      default: "localhost",
+      required: true,
     },
-    query: {
-      create: {
-        type: QueryType.SQL,
-      },
-      read: {
-        type: QueryType.SQL,
-      },
-      update: {
-        type: QueryType.SQL,
-      },
-      delete: {
-        type: QueryType.SQL,
-      },
+    port: {
+      type: DatasourceFieldType.NUMBER,
+      required: true,
+      default: 5432,
     },
-  }
+    database: {
+      type: DatasourceFieldType.STRING,
+      default: "postgres",
+      required: true,
+    },
+    user: {
+      type: DatasourceFieldType.STRING,
+      default: "root",
+      required: true,
+    },
+    password: {
+      type: DatasourceFieldType.PASSWORD,
+      default: "root",
+      required: true,
+    },
+    schema: {
+      type: DatasourceFieldType.STRING,
+      default: "public",
+      required: true,
+    },
+    ssl: {
+      type: DatasourceFieldType.BOOLEAN,
+      default: false,
+      required: false,
+    },
+    rejectUnauthorized: {
+      type: DatasourceFieldType.BOOLEAN,
+      default: false,
+      required: false,
+    },
+    ca: {
+      type: DatasourceFieldType.LONGFORM,
+      default: false,
+      required: false,
+    },
+  },
+  query: {
+    create: {
+      type: QueryType.SQL,
+    },
+    read: {
+      type: QueryType.SQL,
+    },
+    update: {
+      type: QueryType.SQL,
+    },
+    delete: {
+      type: QueryType.SQL,
+    },
+  },
+}
 
-  class PostgresIntegration extends Sql implements DatasourcePlus {
-    private readonly client: any
-    private readonly config: PostgresConfig
-    private index: number = 1
-    private open: boolean
-    public tables: Record<string, Table> = {}
-    public schemaErrors: Record<string, string> = {}
+class PostgresIntegration extends Sql implements DatasourcePlus {
+  private readonly client: any
+  private readonly config: PostgresConfig
+  private index: number = 1
+  private open: boolean
+  public tables: Record<string, Table> = {}
+  public schemaErrors: Record<string, string> = {}
 
-    COLUMNS_SQL!: string
+  COLUMNS_SQL!: string
 
-    PRIMARY_KEYS_SQL = `
-    select tc.table_schema, tc.table_name, kc.column_name as primary_key 
-    from information_schema.table_constraints tc
-    join 
-      information_schema.key_column_usage kc on kc.table_name = tc.table_name 
-      and kc.table_schema = tc.table_schema 
-      and kc.constraint_name = tc.constraint_name
-    where tc.constraint_type = 'PRIMARY KEY';
-    `
+  PRIMARY_KEYS_SQL = `
+  select tc.table_schema, tc.table_name, kc.column_name as primary_key 
+  from information_schema.table_constraints tc
+  join 
+    information_schema.key_column_usage kc on kc.table_name = tc.table_name 
+    and kc.table_schema = tc.table_schema 
+    and kc.constraint_name = tc.constraint_name
+  where tc.constraint_type = 'PRIMARY KEY';
+  `
 
-    constructor(config: PostgresConfig) {
-      super(SqlClient.POSTGRES)
-      this.config = config
+  constructor(config: PostgresConfig) {
+    super(SqlClient.POSTGRES)
+    this.config = config
 
-      let newConfig = {
-        ...this.config,
-        ssl: this.config.ssl
-          ? {
-              rejectUnauthorized: this.config.rejectUnauthorized,
-              ca: this.config.ca,
-            }
-          : undefined,
-      }
-      this.client = new Client(newConfig)
-      this.open = false
+    let newConfig = {
+      ...this.config,
+      ssl: this.config.ssl
+        ? {
+            rejectUnauthorized: this.config.rejectUnauthorized,
+            ca: this.config.ca,
+          }
+        : undefined,
     }
+    this.client = new Client(newConfig)
+    this.open = false
+  }
 
-    getBindingIdentifier(): string {
-      return `$${this.index++}`
-    }
+  getBindingIdentifier(): string {
+    return `$${this.index++}`
+  }
 
-    getStringConcat(parts: string[]): string {
-      return parts.join(" || ")
-    }
+  getStringConcat(parts: string[]): string {
+    return parts.join(" || ")
+  }
 
-    async openConnection() {
-      await this.client.connect()
-      if (!this.config.schema) {
-        this.config.schema = "public"
-      }
-      this.client.query(`SET search_path TO ${this.config.schema}`)
-      this.COLUMNS_SQL = `select * from information_schema.columns where table_schema = '${this.config.schema}'`
-      this.open = true
+  async openConnection() {
+    await this.client.connect()
+    if (!this.config.schema) {
+      this.config.schema = "public"
     }
+    this.client.query(`SET search_path TO ${this.config.schema}`)
+    this.COLUMNS_SQL = `select * from information_schema.columns where table_schema = '${this.config.schema}'`
+    this.open = true
+  }
 
-    closeConnection() {
-      const pg = this
-      return new Promise<void>((resolve, reject) => {
-        this.client.end((err: any) => {
-          pg.open = false
-          if (err) {
-            reject(err)
-          } else {
-            resolve()
-          }
-        })
+  closeConnection() {
+    const pg = this
+    return new Promise<void>((resolve, reject) => {
+      this.client.end((err: any) => {
+        pg.open = false
+        if (err) {
+          reject(err)
+        } else {
+          resolve()
+        }
       })
-    }
+    })
+  }
 
-    async internalQuery(query: SqlQuery, close: boolean = true) {
-      if (!this.open) {
-        await this.openConnection()
-      }
-      const client = this.client
-      this.index = 1
-      // need to handle a specific issue with json data types in postgres,
-      // new lines inside the JSON data will break it
-      if (query && query.sql) {
-        const matches = query.sql.match(JSON_REGEX)
-        if (matches && matches.length > 0) {
-          for (let match of matches) {
-            const escaped = escapeDangerousCharacters(match)
-            query.sql = query.sql.replace(match, escaped)
-          }
+  async internalQuery(query: SqlQuery, close: boolean = true) {
+    if (!this.open) {
+      await this.openConnection()
+    }
+    const client = this.client
+    this.index = 1
+    // need to handle a specific issue with json data types in postgres,
+    // new lines inside the JSON data will break it
+    if (query && query.sql) {
+      const matches = query.sql.match(JSON_REGEX)
+      if (matches && matches.length > 0) {
+        for (let match of matches) {
+          const escaped = escapeDangerousCharacters(match)
+          query.sql = query.sql.replace(match, escaped)
         }
       }
-      try {
-        return await client.query(query.sql, query.bindings || [])
-      } catch (err) {
+    }
+    try {
+      return await client.query(query.sql, query.bindings || [])
+    } catch (err) {
+      await this.closeConnection()
+      // @ts-ignore
+      throw new Error(err)
+    } finally {
+      if (close) {
         await this.closeConnection()
-        // @ts-ignore
-        throw new Error(err)
-      } finally {
-        if (close) {
-          await this.closeConnection()
-        }
       }
     }
+  }
 
-    /**
-     * Fetches the tables from the postgres table and assigns them to the datasource.
-     * @param {*} datasourceId - datasourceId to fetch
-     * @param entities - the tables that are to be built
-     */
-    async buildSchema(datasourceId: string, entities: Record<string, Table>) {
-      let tableKeys: { [key: string]: string[] } = {}
-      await this.openConnection()
-      try {
-        const primaryKeysResponse = await this.client.query(
-          this.PRIMARY_KEYS_SQL
-        )
-        for (let table of primaryKeysResponse.rows) {
-          const tableName = table.table_name
-          if (!tableKeys[tableName]) {
-            tableKeys[tableName] = []
-          }
-          const key = table.column_name || table.primary_key
-          // only add the unique keys
-          if (key && tableKeys[tableName].indexOf(key) === -1) {
-            tableKeys[tableName].push(key)
-          }
+  /**
+   * Fetches the tables from the postgres table and assigns them to the datasource.
+   * @param {*} datasourceId - datasourceId to fetch
+   * @param entities - the tables that are to be built
+   */
+  async buildSchema(datasourceId: string, entities: Record<string, Table>) {
+    let tableKeys: { [key: string]: string[] } = {}
+    await this.openConnection()
+    try {
+      const primaryKeysResponse = await this.client.query(this.PRIMARY_KEYS_SQL)
+      for (let table of primaryKeysResponse.rows) {
+        const tableName = table.table_name
+        if (!tableKeys[tableName]) {
+          tableKeys[tableName] = []
+        }
+        const key = table.column_name || table.primary_key
+        // only add the unique keys
+        if (key && tableKeys[tableName].indexOf(key) === -1) {
+          tableKeys[tableName].push(key)
         }
-      } catch (err) {
-        tableKeys = {}
       }
+    } catch (err) {
+      tableKeys = {}
+    }
 
-      try {
-        const columnsResponse = await this.client.query(this.COLUMNS_SQL)
-
-        const tables: { [key: string]: Table } = {}
+    try {
+      const columnsResponse = await this.client.query(this.COLUMNS_SQL)
 
-        for (let column of columnsResponse.rows) {
-          const tableName: string = column.table_name
-          const columnName: string = column.column_name
+      const tables: { [key: string]: Table } = {}
 
-          // table key doesn't exist yet
-          if (!tables[tableName] || !tables[tableName].schema) {
-            tables[tableName] = {
-              _id: buildExternalTableId(datasourceId, tableName),
-              primary: tableKeys[tableName] || [],
-              name: tableName,
-              schema: {},
-            }
-          }
+      for (let column of columnsResponse.rows) {
+        const tableName: string = column.table_name
+        const columnName: string = column.column_name
 
-          const identity = !!(
-            column.identity_generation ||
-            column.identity_start ||
-            column.identity_increment
-          )
-          const hasDefault =
-            typeof column.column_default === "string" &&
-            column.column_default.startsWith("nextval")
-          const isGenerated =
-            column.is_generated && column.is_generated !== "NEVER"
-          const isAuto: boolean = hasDefault || identity || isGenerated
-          tables[tableName].schema[columnName] = {
-            autocolumn: isAuto,
-            name: columnName,
-            ...convertSqlType(column.data_type),
-            externalType: column.data_type,
+        // table key doesn't exist yet
+        if (!tables[tableName] || !tables[tableName].schema) {
+          tables[tableName] = {
+            _id: buildExternalTableId(datasourceId, tableName),
+            primary: tableKeys[tableName] || [],
+            name: tableName,
+            schema: {},
           }
         }
 
-        const final = finaliseExternalTables(tables, entities)
-        this.tables = final.tables
-        this.schemaErrors = final.errors
-      } catch (err) {
-        // @ts-ignore
-        throw new Error(err)
-      } finally {
-        await this.closeConnection()
+        const identity = !!(
+          column.identity_generation ||
+          column.identity_start ||
+          column.identity_increment
+        )
+        const hasDefault =
+          typeof column.column_default === "string" &&
+          column.column_default.startsWith("nextval")
+        const isGenerated =
+          column.is_generated && column.is_generated !== "NEVER"
+        const isAuto: boolean = hasDefault || identity || isGenerated
+        tables[tableName].schema[columnName] = {
+          autocolumn: isAuto,
+          name: columnName,
+          ...convertSqlType(column.data_type),
+          externalType: column.data_type,
+        }
       }
-    }
 
-    async create(query: SqlQuery | string) {
-      const response = await this.internalQuery(getSqlQuery(query))
-      return response.rows.length ? response.rows : [{ created: true }]
+      const final = finaliseExternalTables(tables, entities)
+      this.tables = final.tables
+      this.schemaErrors = final.errors
+    } catch (err) {
+      // @ts-ignore
+      throw new Error(err)
+    } finally {
+      await this.closeConnection()
     }
+  }
 
-    async read(query: SqlQuery | string) {
-      const response = await this.internalQuery(getSqlQuery(query))
-      return response.rows
-    }
+  async create(query: SqlQuery | string) {
+    const response = await this.internalQuery(getSqlQuery(query))
+    return response.rows.length ? response.rows : [{ created: true }]
+  }
 
-    async update(query: SqlQuery | string) {
-      const response = await this.internalQuery(getSqlQuery(query))
-      return response.rows.length ? response.rows : [{ updated: true }]
-    }
+  async read(query: SqlQuery | string) {
+    const response = await this.internalQuery(getSqlQuery(query))
+    return response.rows
+  }
 
-    async delete(query: SqlQuery | string) {
-      const response = await this.internalQuery(getSqlQuery(query))
-      return response.rows.length ? response.rows : [{ deleted: true }]
-    }
+  async update(query: SqlQuery | string) {
+    const response = await this.internalQuery(getSqlQuery(query))
+    return response.rows.length ? response.rows : [{ updated: true }]
+  }
 
-    async query(json: QueryJson) {
-      const operation = this._operation(json).toLowerCase()
-      const input = this._query(json)
-      if (Array.isArray(input)) {
-        const responses = []
-        for (let query of input) {
-          responses.push(await this.internalQuery(query, false))
-        }
-        await this.closeConnection()
-        return responses
-      } else {
-        const response = await this.internalQuery(input)
-        return response.rows.length ? response.rows : [{ [operation]: true }]
+  async delete(query: SqlQuery | string) {
+    const response = await this.internalQuery(getSqlQuery(query))
+    return response.rows.length ? response.rows : [{ deleted: true }]
+  }
+
+  async query(json: QueryJson) {
+    const operation = this._operation(json).toLowerCase()
+    const input = this._query(json)
+    if (Array.isArray(input)) {
+      const responses = []
+      for (let query of input) {
+        responses.push(await this.internalQuery(query, false))
       }
+      await this.closeConnection()
+      return responses
+    } else {
+      const response = await this.internalQuery(input)
+      return response.rows.length ? response.rows : [{ [operation]: true }]
     }
   }
+}
 
-  module.exports = {
-    schema: SCHEMA,
-    integration: PostgresIntegration,
-  }
+export default {
+  schema: SCHEMA,
+  integration: PostgresIntegration,
 }