@budibase/server 2.1.43-alpha.1 → 2.1.43-alpha.11

package/src/api/routes/public/tests/users.spec.js

@@ -0,0 +1,38 @@
+const setup = require("../../tests/utilities")
+const { generateMakeRequest } = require("./utils")
+
+const workerRequests = require("../../../../utilities/workerRequests")
+
+let config = setup.getConfig()
+let apiKey, globalUser, makeRequest
+
+beforeAll(async () => {
+  await config.init()
+  globalUser = await config.globalUser()
+  apiKey = await config.generateApiKey(globalUser._id)
+  makeRequest = generateMakeRequest(apiKey, setup)
+  workerRequests.readGlobalUser.mockReturnValue(globalUser)
+})
+
+afterAll(setup.afterAll)
+
+describe("check user endpoints", () => {
+  it("should not allow a user to update their own roles", async () => {
+    const res = await makeRequest("put", `/users/${globalUser._id}`, {
+      ...globalUser,
+      roles: {
+        "app_1": "ADMIN",
+      }
+    })
+    expect(workerRequests.saveGlobalUser.mock.lastCall[0].body.data.roles["app_1"]).toBeUndefined()
+    expect(res.status).toBe(200)
+    expect(res.body.data.roles["app_1"]).toBeUndefined()
+  })
+
+  it("should not allow a user to delete themselves", async () => {
+    const res = await makeRequest("delete", `/users/${globalUser._id}`)
+    expect(res.status).toBe(405)
+    expect(workerRequests.deleteGlobalUser.mock.lastCall).toBeUndefined()
+  })
+})
+

package/src/api/routes/public/tests/utils.ts

@@ -0,0 +1,28 @@
+import { checkSlashesInUrl } from "../../../../utilities"
+
+export function generateMakeRequest(apiKey: string, setup: any) {
+  const request = setup.getRequest()
+  const config = setup.getConfig()
+  return async (
+    method: string,
+    endpoint: string,
+    body?: any,
+    intAppId: string = config.getAppId()
+  ) => {
+    const extraHeaders: any = {
+      "x-budibase-api-key": apiKey,
+    }
+    if (intAppId) {
+      extraHeaders["x-budibase-app-id"] = intAppId
+    }
+    const req = request[method](
+      checkSlashesInUrl(`/api/public/v1/${endpoint}`)
+    ).set(config.defaultHeaders(extraHeaders))
+    if (body) {
+      req.send(body)
+    }
+    const res = await req
+    expect(res.body).toBeDefined()
+    return res
+  }
+}

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

@@ -17,7 +17,6 @@ const {
   checkBuilderEndpoint,
 } = require("./utilities/TestFunctions")
 const setup = require("./utilities")
-const { basicScreen, basicLayout } = setup.structures
 const { AppStatus } = require("../../../db/utils")
 const { events } = require("@budibase/backend-core")
 

package/src/integrations/base/types.ts

@@ -0,0 +1,134 @@
+export interface MSSQLTablesResponse {
+  TABLE_CATALOG: string
+  TABLE_SCHEMA: string
+  TABLE_NAME: string
+  TABLE_TYPE: string
+}
+
+export interface MSSQLColumn {
+  IS_COMPUTED: number
+  IS_IDENTITY: number
+  TABLE_CATALOG: string
+  TABLE_SCHEMA: string
+  TABLE_NAME: string
+  COLUMN_NAME: string
+  ORDINAL_POSITION: number
+  COLUMN_DEFAULT: null | any
+  IS_NULLABLE: "NO" | "YES"
+  DATA_TYPE: string
+  CHARACTER_MAXIMUM_LENGTH: null | number
+  CHARACTER_OCTET_LENGTH: null | number
+  NUMERIC_PRECISION: null | number
+  NUMERIC_PRECISION_RADIX: null | number
+  NUMERIC_SCALE: null | number
+  DATETIME_PRECISION: null | string
+  CHARACTER_SET_CATALOG: null | string
+  CHARACTER_SET_SCHEMA: null | string
+  CHARACTER_SET_NAME: null | string
+  COLLATION_CATALOG: null | string
+  COLLATION_SCHEMA: null | string
+  COLLATION_NAME: null | string
+  DOMAIN_CATALOG: null | string
+  DOMAIN_SCHEMA: null | string
+  DOMAIN_NAME: null | string
+}
+
+export interface PostgresColumn {
+  table_catalog: string
+  table_schema: string
+  table_name: string
+  column_name: string
+  ordinal_position: number
+  column_default: null | any
+  is_nullable: "NO" | "YES"
+  data_type: string
+  character_maximum_length: null | number
+  character_octet_length: null | number
+  numeric_precision: null | number
+  numeric_precision_radix: null | number
+  numeric_scale: null | number
+  datetime_precision: null | string
+  interval_type: null | string
+  interval_precision: null | string
+  character_set_catalog: null | string
+  character_set_schema: null | string
+  character_set_name: null | string
+  collation_catalog: null | string
+  collation_schema: null | string
+  collation_name: null | string
+  domain_catalog: null | string
+  domain_schema: null | string
+  domain_name: null | string
+  udt_catalog: string
+  udt_schema: string
+  udt_name: string
+  scope_catalog: null | string
+  scope_schema: null | string
+  scope_name: null | string
+  maximum_cardinality: null | string
+  dtd_identifier: string
+  is_self_referencing: "NO" | "YES"
+  is_identity: "NO" | "YES"
+  identity_generation: null | number
+  identity_start: null | number
+  identity_increment: null | number
+  identity_maximum: null | number
+  identity_minimum: null | number
+  identity_cycle: "NO" | "YES"
+  is_generated: "NEVER"
+  generation_expression: null | string
+  is_updatable: "NO" | "YES"
+}
+
+export interface MySQLColumn {
+  Field: string
+  Type: string
+  Null: "NO" | "YES"
+  Key: "PRI" | "MUL" | ""
+  Default: null | any
+  Extra: null | string
+}
+
+/**
+ * Raw query response
+ */
+export interface OracleColumnsResponse {
+  TABLE_NAME: string
+  COLUMN_NAME: string
+  DATA_TYPE: string
+  DATA_DEFAULT: null | string
+  COLUMN_ID: number
+  CONSTRAINT_NAME: null | string
+  CONSTRAINT_TYPE: null | string
+  R_CONSTRAINT_NAME: null | string
+  SEARCH_CONDITION: null | string
+}
+
+/**
+ * An oracle constraint
+ */
+export interface OracleConstraint {
+  name: string
+  type: string
+  relatedConstraintName: null | string
+  searchCondition: null | string
+}
+
+/**
+ * An oracle column and it's related constraints
+ */
+export interface OracleColumn {
+  name: string
+  type: string
+  default: null | string
+  id: number
+  constraints: { [key: string]: OracleConstraint }
+}
+
+/**
+ * An oracle table and it's related columns
+ */
+export interface OracleTable {
+  name: string
+  columns: { [key: string]: OracleColumn }
+}

package/src/integrations/microsoftSqlServer.ts

@@ -17,6 +17,7 @@ import {
   SqlClient,
 } from "./utils"
 import Sql from "./base/sql"
+import { MSSQLTablesResponse, MSSQLColumn } from "./base/types"
 
 const sqlServer = require("mssql")
 const DEFAULT_SCHEMA = "dbo"
@@ -31,13 +32,6 @@ interface MSSQLConfig {
   encrypt?: boolean
 }
 
-interface TablesResponse {
-  TABLE_CATALOG: string
-  TABLE_SCHEMA: string
-  TABLE_NAME: string
-  TABLE_TYPE: string
-}
-
 const SCHEMA: Integration = {
   docs: "https://github.com/tediousjs/node-mssql",
   plus: true,
@@ -210,7 +204,7 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
    */
   async buildSchema(datasourceId: string, entities: Record<string, Table>) {
     await this.connect()
-    let tableInfo: TablesResponse[] = await this.runSQL(this.TABLES_SQL)
+    let tableInfo: MSSQLTablesResponse[] = await this.runSQL(this.TABLES_SQL)
     if (tableInfo == null || !Array.isArray(tableInfo)) {
       throw "Unable to get list of tables in database"
     }
@@ -228,15 +222,20 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
       // find primary key constraints
       const constraints = await this.runSQL(this.getConstraintsSQL(tableName))
       // find the computed and identity columns (auto columns)
-      const columns = await this.runSQL(this.getAutoColumnsSQL(tableName))
+      const columns: MSSQLColumn[] = await this.runSQL(
+        this.getAutoColumnsSQL(tableName)
+      )
       const primaryKeys = constraints
         .filter(
           (constraint: any) => constraint.CONSTRAINT_TYPE === "PRIMARY KEY"
         )
         .map((constraint: any) => constraint.COLUMN_NAME)
       const autoColumns = columns
-        .filter((col: any) => col.IS_COMPUTED || col.IS_IDENTITY)
-        .map((col: any) => col.COLUMN_NAME)
+        .filter(col => col.IS_COMPUTED || col.IS_IDENTITY)
+        .map(col => col.COLUMN_NAME)
+      const requiredColumns = columns
+        .filter(col => col.IS_NULLABLE === "NO")
+        .map(col => col.COLUMN_NAME)
 
       let schema: TableSchema = {}
       for (let def of definition) {
@@ -245,8 +244,11 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
           continue
         }
         schema[name] = {
-          autocolumn: !!autoColumns.find((col: string) => col === name),
+          autocolumn: !!autoColumns.find(col => col === name),
           name: name,
+          constraints: {
+            presence: requiredColumns.find(col => col === name),
+          },
           ...convertSqlType(def.DATA_TYPE),
           externalType: def.DATA_TYPE,
         }

package/src/integrations/mysql.ts

@@ -18,6 +18,7 @@ import {
 import dayjs from "dayjs"
 const { NUMBER_REGEX } = require("../utilities")
 import Sql from "./base/sql"
+import { MySQLColumn } from "./base/types"
 
 const mysql = require("mysql2/promise")
 
@@ -203,11 +204,11 @@ class MySQLIntegration extends Sql implements DatasourcePlus {
 
     try {
       // get the tables first
-      const tablesResp = await this.internalQuery(
+      const tablesResp: Record<string, string>[] = await this.internalQuery(
         { sql: "SHOW TABLES;" },
         { connect: false }
       )
-      const tableNames = tablesResp.map(
+      const tableNames: string[] = tablesResp.map(
         (obj: any) =>
           obj[`Tables_in_${database}`] ||
           obj[`Tables_in_${database.toLowerCase()}`]
@@ -215,7 +216,7 @@ class MySQLIntegration extends Sql implements DatasourcePlus {
       for (let tableName of tableNames) {
         const primaryKeys = []
         const schema: TableSchema = {}
-        const descResp = await this.internalQuery(
+        const descResp: MySQLColumn[] = await this.internalQuery(
           { sql: `DESCRIBE \`${tableName}\`;` },
           { connect: false }
         )

package/src/integrations/oracle.ts

@@ -24,6 +24,12 @@ import {
   ExecuteOptions,
   Result,
 } from "oracledb"
+import {
+  OracleTable,
+  OracleColumn,
+  OracleColumnsResponse,
+  OracleConstraint,
+} from "./base/types"
 let oracledb: any
 try {
   oracledb = require("oracledb")
@@ -89,50 +95,6 @@ const SCHEMA: Integration = {
 
 const UNSUPPORTED_TYPES = ["BLOB", "CLOB", "NCLOB"]
 
-/**
- * Raw query response
- */
-interface ColumnsResponse {
-  TABLE_NAME: string
-  COLUMN_NAME: string
-  DATA_TYPE: string
-  DATA_DEFAULT: string | null
-  COLUMN_ID: number
-  CONSTRAINT_NAME: string | null
-  CONSTRAINT_TYPE: string | null
-  R_CONSTRAINT_NAME: string | null
-  SEARCH_CONDITION: string | null
-}
-
-/**
- * An oracle constraint
- */
-interface OracleConstraint {
-  name: string
-  type: string
-  relatedConstraintName: string | null
-  searchCondition: string | null
-}
-
-/**
- * An oracle column and it's related constraints
- */
-interface OracleColumn {
-  name: string
-  type: string
-  default: string | null
-  id: number
-  constraints: { [key: string]: OracleConstraint }
-}
-
-/**
- * An oracle table and it's related columns
- */
-interface OracleTable {
-  name: string
-  columns: { [key: string]: OracleColumn }
-}
-
 const OracleContraintTypes = {
   PRIMARY: "P",
   NOT_NULL_OR_CHECK: "C",
@@ -195,7 +157,7 @@ class OracleIntegration extends Sql implements DatasourcePlus {
   /**
    * Map the flat tabular columns and constraints data into a nested object
    */
-  private mapColumns(result: Result<ColumnsResponse>): {
+  private mapColumns(result: Result<OracleColumnsResponse>): {
     [key: string]: OracleTable
   } {
     const oracleTables: { [key: string]: OracleTable } = {}
@@ -299,7 +261,7 @@ class OracleIntegration extends Sql implements DatasourcePlus {
    * @param entities - the tables that are to be built
    */
   async buildSchema(datasourceId: string, entities: Record<string, Table>) {
-    const columnsResponse = await this.internalQuery<ColumnsResponse>({
+    const columnsResponse = await this.internalQuery<OracleColumnsResponse>({
       sql: this.COLUMNS_SQL,
     })
     const oracleTables = this.mapColumns(columnsResponse)
@@ -334,6 +296,9 @@ class OracleIntegration extends Sql implements DatasourcePlus {
             fieldSchema = {
               autocolumn: OracleIntegration.isAutoColumn(oracleColumn),
               name: columnName,
+              constraints: {
+                presence: false,
+              },
               ...this.internalConvertType(oracleColumn),
             }
             table.schema[columnName] = fieldSchema
@@ -343,6 +308,12 @@ class OracleIntegration extends Sql implements DatasourcePlus {
           Object.values(oracleColumn.constraints).forEach(oracleConstraint => {
             if (oracleConstraint.type === OracleContraintTypes.PRIMARY) {
               table.primary!.push(columnName)
+            } else if (
+              oracleConstraint.type === OracleContraintTypes.NOT_NULL_OR_CHECK
+            ) {
+              table.schema[columnName].constraints = {
+                presence: true,
+              }
             }
           })
         })

package/src/integrations/postgres.ts

@@ -15,9 +15,10 @@ import {
   SqlClient,
 } from "./utils"
 import Sql from "./base/sql"
+import { PostgresColumn } from "./base/types"
+import { escapeDangerousCharacters } from "../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.
@@ -237,7 +238,8 @@ class PostgresIntegration extends Sql implements DatasourcePlus {
     }
 
     try {
-      const columnsResponse = await this.client.query(this.COLUMNS_SQL)
+      const columnsResponse: { rows: PostgresColumn[] } =
+        await this.client.query(this.COLUMNS_SQL)
 
       const tables: { [key: string]: Table } = {}
 
@@ -260,6 +262,9 @@ class PostgresIntegration extends Sql implements DatasourcePlus {
           column.identity_start ||
           column.identity_increment
         )
+        const constraints = {
+          presence: column.is_nullable === "NO",
+        }
         const hasDefault =
           typeof column.column_default === "string" &&
           column.column_default.startsWith("nextval")
@@ -269,6 +274,7 @@ class PostgresIntegration extends Sql implements DatasourcePlus {
         tables[tableName].schema[columnName] = {
           autocolumn: isAuto,
           name: columnName,
+          constraints,
           ...convertSqlType(column.data_type),
           externalType: column.data_type,
         }

package/src/migrations/functions/appUrls.ts

@@ -1,5 +1,5 @@
 import { db as dbCore } from "@budibase/backend-core"
-import { getAppUrl } from "../../api/controllers/application"
+import sdk from "../../sdk"
 
 /**
  * Date:
@@ -20,14 +20,7 @@ export const run = async (appDb: any) => {
   }
 
   if (!metadata.url) {
-    const context = {
-      request: {
-        body: {
-          name: metadata.name,
-        },
-      },
-    }
-    metadata.url = getAppUrl(context)
+    metadata.url = sdk.applications.getAppUrl({ name: metadata.name })
     console.log(`Adding url to app: ${metadata.url}`)
     await appDb.put(metadata)
   }

package/src/sdk/app/applications/index.ts

@@ -0,0 +1,7 @@
+import * as sync from "./sync"
+import * as utils from "./utils"
+
+export default {
+  ...sync,
+  ...utils,
+}

package/src/sdk/app/applications/sync.ts

@@ -0,0 +1,53 @@
+import env from "../../../environment"
+import { db as dbCore, context } from "@budibase/backend-core"
+import sdk from "../../"
+
+export async function syncApp(appId: string) {
+  if (env.DISABLE_AUTO_PROD_APP_SYNC) {
+    return {
+      message:
+        "App sync disabled. You can reenable with the DISABLE_AUTO_PROD_APP_SYNC environment variable.",
+    }
+  }
+
+  if (dbCore.isProdAppID(appId)) {
+    throw new Error("This action cannot be performed for production apps")
+  }
+
+  // replicate prod to dev
+  const prodAppId = dbCore.getProdAppID(appId)
+
+  // specific case, want to make sure setup is skipped
+  const prodDb = context.getProdAppDB({ skip_setup: true })
+  const exists = await prodDb.exists()
+  if (!exists) {
+    // the database doesn't exist. Don't replicate
+    return {
+      message: "App sync not required, app not deployed.",
+    }
+  }
+
+  const replication = new dbCore.Replication({
+    source: prodAppId,
+    target: appId,
+  })
+  let error
+  try {
+    await replication.replicate(replication.appReplicateOpts())
+  } catch (err) {
+    error = err
+  } finally {
+    await replication.close()
+  }
+
+  // sync the users
+  await sdk.users.syncGlobalUsers()
+
+  if (error) {
+    throw error
+  } else {
+    return {
+      message: "App sync completed successfully.",
+    }
+  }
+}

package/src/sdk/app/applications/utils.ts

@@ -0,0 +1,17 @@
+const URL_REGEX_SLASH = /\/|\\/g
+
+export function getAppUrl(opts?: { name?: string; url?: string }) {
+  // construct the url
+  let url
+  if (opts?.url) {
+    // if the url is provided, use that
+    url = encodeURI(opts?.url)
+  } else if (opts?.name) {
+    // otherwise use the name
+    url = encodeURI(`${opts?.name}`)
+  }
+  if (url) {
+    url = `/${url.replace(URL_REGEX_SLASH, "")}`.toLowerCase()
+  }
+  return url as string
+}

package/src/sdk/index.ts

@@ -1,15 +1,16 @@
 import { default as backups } from "./app/backups"
 import { default as tables } from "./app/tables"
 import { default as automations } from "./app/automations"
+import { default as applications } from "./app/applications"
+import { default as users } from "./users"
 
 const sdk = {
   backups,
   tables,
   automations,
+  applications,
+  users,
 }
 
 // default export for TS
 export default sdk
-
-// default export for JS
-module.exports = sdk

package/src/sdk/users/index.ts

@@ -0,0 +1,5 @@
+import * as utils from "./utils"
+
+export default {
+  ...utils,
+}

package/src/sdk/users/utils.ts

@@ -0,0 +1,64 @@
+import { getGlobalUsers } from "../../utilities/global"
+import { context, roles as rolesCore } from "@budibase/backend-core"
+import {
+  generateUserMetadataID,
+  getUserMetadataParams,
+  InternalTables,
+} from "../../db/utils"
+import { isEqual } from "lodash"
+
+export function combineMetadataAndUser(user: any, metadata: any) {
+  // skip users with no access
+  if (user.roleId === rolesCore.BUILTIN_ROLE_IDS.PUBLIC) {
+    return null
+  }
+  delete user._rev
+  const metadataId = generateUserMetadataID(user._id)
+  const newDoc = {
+    ...user,
+    _id: metadataId,
+    tableId: InternalTables.USER_METADATA,
+  }
+  const found = Array.isArray(metadata)
+    ? metadata.find(doc => doc._id === metadataId)
+    : metadata
+  // copy rev over for the purposes of equality check
+  if (found) {
+    newDoc._rev = found._rev
+  }
+  if (found == null || !isEqual(newDoc, found)) {
+    return {
+      ...found,
+      ...newDoc,
+    }
+  }
+  return null
+}
+
+export async function rawUserMetadata() {
+  const db = context.getAppDB()
+  return (
+    await db.allDocs(
+      getUserMetadataParams(null, {
+        include_docs: true,
+      })
+    )
+  ).rows.map(row => row.doc)
+}
+
+export async function syncGlobalUsers() {
+  // sync user metadata
+  const db = context.getAppDB()
+  const [users, metadata] = await Promise.all([
+    getGlobalUsers(),
+    rawUserMetadata(),
+  ])
+  const toWrite = []
+  for (let user of users) {
+    const combined = await combineMetadataAndUser(user, metadata)
+    if (combined) {
+      toWrite.push(combined)
+    }
+  }
+  await db.bulkDocs(toWrite)
+}

package/src/utilities/workerRequests.ts

@@ -3,7 +3,7 @@ import env from "../environment"
 import { checkSlashesInUrl } from "./index"
 import { db as dbCore, constants, tenancy } from "@budibase/backend-core"
 import { updateAppRole } from "./global"
-import { BBContext, Automation } from "@budibase/types"
+import { BBContext, User } from "@budibase/types"
 
 export function request(ctx?: BBContext, request?: any) {
   if (!request.headers) {
@@ -138,7 +138,7 @@ export async function deleteGlobalUser(ctx: BBContext) {
   return checkResponse(response, "delete user", { ctx })
 }
 
-export async function readGlobalUser(ctx: BBContext) {
+export async function readGlobalUser(ctx: BBContext): Promise<User> {
   const response = await fetch(
     checkSlashesInUrl(
       env.WORKER_URL + `/api/global/users/${ctx.params.userId}`