@budibase/server 1.0.105-alpha.21 → 1.0.105-alpha.24

package/dist/utilities/usageQuota/index.js

@@ -1,86 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-const env = require("../../environment");
-const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy");
-const { StaticDatabases, generateNewUsageQuotaDoc, } = require("@budibase/backend-core/db");
-exports.useQuotas = () => {
-    // check if quotas are enabled
-    if (env.USE_QUOTAS) {
-        // check if there are any tenants without limits
-        if (env.EXCLUDE_QUOTAS_TENANTS) {
-            const excludedTenants = env.EXCLUDE_QUOTAS_TENANTS.replace(/\s/g, "").split(",");
-            const tenantId = getTenantId();
-            if (excludedTenants.includes(tenantId)) {
-                return false;
-            }
-        }
-        return true;
-    }
-    return false;
-};
-exports.Properties = {
-    ROW: "rows",
-    UPLOAD: "storage",
-    VIEW: "views",
-    USER: "users",
-    AUTOMATION: "automationRuns",
-    APPS: "apps",
-    EMAILS: "emails", // doesn't work yet
-};
-exports.getUsageQuotaDoc = (db) => __awaiter(void 0, void 0, void 0, function* () {
-    let quota;
-    try {
-        quota = yield db.get(StaticDatabases.GLOBAL.docs.usageQuota);
-    }
-    catch (err) {
-        // doc doesn't exist. Create it
-        quota = generateNewUsageQuotaDoc();
-        const response = yield db.put(quota);
-        quota._rev = response.rev;
-    }
-    return quota;
-});
-/**
- * Given a specified tenantId this will add to the usage object for the specified property.
- * @param {string} property The property which is to be added to (within the nested usageQuota object).
- * @param {number} usage The amount (this can be negative) to adjust the number by.
- * @param {object} opts optional - options such as dryRun, to check what update will do.
- * @returns {Promise<void>} When this completes the API key will now be up to date - the quota period may have
- * also been reset after this call.
- */
-exports.update = (property, usage, opts = { dryRun: false }) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!exports.useQuotas()) {
-        return;
-    }
-    try {
-        const db = getGlobalDB();
-        const quota = yield exports.getUsageQuotaDoc(db);
-        // increment the quota
-        quota.usageQuota[property] += usage;
-        if (quota.usageQuota[property] > quota.usageLimits[property] &&
-            usage > 0 // allow for decrementing usage when the quota is already exceeded
-        ) {
-            throw new Error(`You have exceeded your usage quota of ${quota.usageLimits[property]} ${property}.`);
-        }
-        if (quota.usageQuota[property] < 0) {
-            // never go negative if the quota has previously been exceeded
-            quota.usageQuota[property] = 0;
-        }
-        // update the usage quotas
-        if (!opts.dryRun) {
-            yield db.put(quota);
-        }
-    }
-    catch (err) {
-        console.error(`Error updating usage quotas for ${property}`, err);
-        throw err;
-    }
-});

package/src/api/routes/index.js

@@ -1,62 +0,0 @@
-const authRoutes = require("./auth")
-const layoutRoutes = require("./layout")
-const screenRoutes = require("./screen")
-const userRoutes = require("./user")
-const applicationRoutes = require("./application")
-const tableRoutes = require("./table")
-const rowRoutes = require("./row")
-const viewRoutes = require("./view")
-const staticRoutes = require("./static")
-const componentRoutes = require("./component")
-const automationRoutes = require("./automation")
-const webhookRoutes = require("./webhook")
-const roleRoutes = require("./role")
-const deployRoutes = require("./deploy")
-const apiKeysRoutes = require("./apikeys")
-const templatesRoutes = require("./templates")
-const analyticsRoutes = require("./analytics")
-const routingRoutes = require("./routing")
-const integrationRoutes = require("./integration")
-const permissionRoutes = require("./permission")
-const datasourceRoutes = require("./datasource")
-const queryRoutes = require("./query")
-const backupRoutes = require("./backup")
-const metadataRoutes = require("./metadata")
-const devRoutes = require("./dev")
-const cloudRoutes = require("./cloud")
-const migrationRoutes = require("./migrations")
-const publicRoutes = require("./public")
-
-exports.mainRoutes = [
-  authRoutes,
-  deployRoutes,
-  layoutRoutes,
-  screenRoutes,
-  userRoutes,
-  applicationRoutes,
-  automationRoutes,
-  viewRoutes,
-  componentRoutes,
-  roleRoutes,
-  apiKeysRoutes,
-  templatesRoutes,
-  analyticsRoutes,
-  webhookRoutes,
-  routingRoutes,
-  integrationRoutes,
-  permissionRoutes,
-  datasourceRoutes,
-  queryRoutes,
-  backupRoutes,
-  metadataRoutes,
-  devRoutes,
-  cloudRoutes,
-  // these need to be handled last as they still use /api/:tableId
-  // this could be breaking as koa may recognise other routes as this
-  tableRoutes,
-  rowRoutes,
-  migrationRoutes,
-]
-
-exports.publicRoutes = publicRoutes
-exports.staticRoutes = staticRoutes

package/src/middleware/tests/usageQuota.spec.js

@@ -1,134 +0,0 @@
-jest.mock("../../db")
-jest.mock("../../utilities/usageQuota")
-jest.mock("@budibase/backend-core/tenancy", () => ({
-  getTenantId: () => "testing123"
-}))
-
-const usageQuotaMiddleware = require("../usageQuota")
-const usageQuota = require("../../utilities/usageQuota")
-const CouchDB = require("../../db")
-const env = require("../../environment")
-
-class TestConfiguration {
-  constructor() {
-    this.throw = jest.fn()
-    this.next = jest.fn()
-    this.middleware = usageQuotaMiddleware
-    this.ctx = {
-      throw: this.throw,
-      next: this.next,
-      appId: "test",
-      request: {
-        body: {}
-      },
-      req: {
-        method: "POST",
-        url: "/applications"
-      }
-    }
-    usageQuota.useQuotas = () => true
-  }
-
-  executeMiddleware() {
-    return this.middleware(this.ctx, this.next)
-  }
-
-  setProd(bool) {
-    if (bool) {
-      env.isDev = () => false
-      env.isProd = () => true
-      this.ctx.user = { tenantId: "test" }
-    } else {
-      env.isDev = () => true
-      env.isProd = () => false
-    }
-  }
-
-  setMethod(method) {
-    this.ctx.req.method = method
-  }
-
-  setUrl(url) {
-    this.ctx.req.url = url
-  }
-
-  setBody(body) {
-    this.ctx.request.body = body
-  }
-
-  setFiles(files) {
-    this.ctx.request.files = { file: files }
-  }
-}
-
-describe("usageQuota middleware", () => {
-  let config
-
-  beforeEach(() => {
-    config = new TestConfiguration()
-  })
-
-  it("skips the middleware if there is no usage property or method", async () => {
-    await config.executeMiddleware()
-    expect(config.next).toHaveBeenCalled()
-  })
-
-  it("passes through to next middleware if document already exists", async () => {
-    config.setProd(true)
-    config.setBody({
-      _id: "test",
-      _rev: "test",
-    })
-
-    CouchDB.mockImplementationOnce(() => ({ 
-      get: async () => true
-    }))
-
-    await config.executeMiddleware()
-
-    expect(config.next).toHaveBeenCalled()
-  })
-
-  it("throws if request has _id, but the document no longer exists", async () => {
-    config.setBody({
-      _id: "123",
-      _rev: "test",
-    })
-    config.setProd(true)
-
-    CouchDB.mockImplementationOnce(() => ({ 
-      get: async () => {
-        throw new Error()
-      } 
-    }))
-
-    await config.executeMiddleware()
-    expect(config.throw).toHaveBeenCalledWith(404, `${config.ctx.request.body._id} does not exist`)
-  })
-
-  it("calculates and persists the correct usage quota for the relevant action", async () => {
-    config.setUrl("/rows")
-
-    await config.executeMiddleware()
-
-    expect(usageQuota.update).toHaveBeenCalledWith("rows", 1)
-    expect(config.next).toHaveBeenCalled()
-  })
-
-  // it("calculates the correct file size from a file upload call and adds it to quota", async () => {
-  //   config.setUrl("/upload")
-  //   config.setProd(true)
-  //   config.setFiles([
-  //     {
-  //       size: 100
-  //     },
-  //     {
-  //       size: 10000
-  //     },
-  //   ])
-  //   await config.executeMiddleware()
-
-  //   expect(usageQuota.update).toHaveBeenCalledWith("storage", 10100)
-  //   expect(config.next).toHaveBeenCalled()
-  // })
-})

package/src/middleware/usageQuota.js

@@ -1,164 +0,0 @@
-const usageQuota = require("../utilities/usageQuota")
-const { getUniqueRows } = require("../utilities/usageQuota/rows")
-const {
-  isExternalTable,
-  isRowId: isExternalRowId,
-} = require("../integrations/utils")
-const { getAppDB } = require("@budibase/backend-core/context")
-
-// currently only counting new writes and deletes
-const METHOD_MAP = {
-  POST: 1,
-  DELETE: -1,
-}
-
-const DOMAIN_MAP = {
-  rows: usageQuota.Properties.ROW,
-  // upload: usageQuota.Properties.UPLOAD,            // doesn't work yet
-  // views: usageQuota.Properties.VIEW,               // doesn't work yet
-  // users: usageQuota.Properties.USER,               // doesn't work yet
-  applications: usageQuota.Properties.APPS,
-  // this will not be updated by endpoint calls
-  // instead it will be updated by triggerInfo
-  // automationRuns: usageQuota.Properties.AUTOMATION, // doesn't work yet
-}
-
-function getProperty(url) {
-  for (let domain of Object.keys(DOMAIN_MAP)) {
-    if (url.indexOf(domain) !== -1) {
-      return DOMAIN_MAP[domain]
-    }
-  }
-}
-
-module.exports = async (ctx, next) => {
-  if (!usageQuota.useQuotas()) {
-    return next()
-  }
-
-  let usage = METHOD_MAP[ctx.req.method]
-  const property = getProperty(ctx.req.url)
-  if (usage == null || property == null) {
-    return next()
-  }
-  // post request could be a save of a pre-existing entry
-  if (ctx.request.body && ctx.request.body._id && ctx.request.body._rev) {
-    const usageId = ctx.request.body._id
-    try {
-      if (ctx.appId) {
-        const db = getAppDB()
-        await db.get(usageId)
-      }
-      return next()
-    } catch (err) {
-      if (
-        isExternalTable(usageId) ||
-        (ctx.request.body.tableId &&
-          isExternalTable(ctx.request.body.tableId)) ||
-        isExternalRowId(usageId)
-      ) {
-        return next()
-      } else {
-        ctx.throw(404, `${usageId} does not exist`)
-      }
-    }
-  }
-
-  // update usage for uploads to be the total size
-  if (property === usageQuota.Properties.UPLOAD) {
-    const files =
-      ctx.request.files.file.length > 1
-        ? Array.from(ctx.request.files.file)
-        : [ctx.request.files.file]
-    usage = files.map(file => file.size).reduce((total, size) => total + size)
-  }
-  try {
-    await performRequest(ctx, next, property, usage)
-  } catch (err) {
-    ctx.throw(400, err)
-  }
-}
-
-const performRequest = async (ctx, next, property, usage) => {
-  const usageContext = {
-    skipNext: false,
-    skipUsage: false,
-    [usageQuota.Properties.APPS]: {},
-  }
-
-  if (usage === -1) {
-    if (PRE_DELETE[property]) {
-      await PRE_DELETE[property](ctx, usageContext)
-    }
-  } else {
-    if (PRE_CREATE[property]) {
-      await PRE_CREATE[property](ctx, usageContext)
-    }
-  }
-
-  // run the request
-  if (!usageContext.skipNext) {
-    await usageQuota.update(property, usage, { dryRun: true })
-    await next()
-  }
-
-  if (usage === -1) {
-    if (POST_DELETE[property]) {
-      await POST_DELETE[property](ctx, usageContext)
-    }
-  } else {
-    if (POST_CREATE[property]) {
-      await POST_CREATE[property](ctx, usageContext)
-    }
-  }
-
-  // update the usage
-  if (!usageContext.skipUsage) {
-    await usageQuota.update(property, usage)
-  }
-}
-
-const appPreDelete = async (ctx, usageContext) => {
-  if (ctx.query.unpublish) {
-    // don't run usage decrement for unpublish
-    usageContext.skipUsage = true
-    return
-  }
-
-  // store the row count to delete
-  const rows = await getUniqueRows([ctx.appId])
-  if (rows.length) {
-    usageContext[usageQuota.Properties.APPS] = { rowCount: rows.length }
-  }
-}
-
-const appPostDelete = async (ctx, usageContext) => {
-  // delete the app rows from usage
-  const rowCount = usageContext[usageQuota.Properties.APPS].rowCount
-  if (rowCount) {
-    await usageQuota.update(usageQuota.Properties.ROW, -rowCount)
-  }
-}
-
-const appPostCreate = async ctx => {
-  // app import & template creation
-  if (ctx.request.body.useTemplate === "true") {
-    const rows = await getUniqueRows([ctx.response.body.appId])
-    const rowCount = rows ? rows.length : 0
-    await usageQuota.update(usageQuota.Properties.ROW, rowCount)
-  }
-}
-
-const PRE_DELETE = {
-  [usageQuota.Properties.APPS]: appPreDelete,
-}
-
-const POST_DELETE = {
-  [usageQuota.Properties.APPS]: appPostDelete,
-}
-
-const PRE_CREATE = {}
-
-const POST_CREATE = {
-  [usageQuota.Properties.APPS]: appPostCreate,
-}

package/src/migrations/functions/usageQuotas/tests/syncApps.spec.js

@@ -1,37 +0,0 @@
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
-const TestConfig = require("../../../../tests/utilities/TestConfiguration")
-const { getUsageQuotaDoc, update, Properties } = require("../../../../utilities/usageQuota")
-const syncApps = require("../syncApps")
-const env = require("../../../../environment")
-
-describe("syncApps", () => {
-  let config = new TestConfig(false)
-
-  beforeEach(async () => {
-    await config.init()
-    env._set("USE_QUOTAS", 1)
-  })
-
-  afterAll(config.end)  
-
-  it("runs successfully", async () => {
-    // create the usage quota doc and mock usages
-    const db = getGlobalDB()
-    await getUsageQuotaDoc(db)
-    await update(Properties.APPS, 3)
-
-    let usageDoc = await getUsageQuotaDoc(db)
-    expect(usageDoc.usageQuota.apps).toEqual(3)
-
-    // create an extra app to test the migration
-    await config.createApp("quota-test")
-
-    // migrate
-    await syncApps.run()
-
-    // assert the migration worked 
-    usageDoc = await getUsageQuotaDoc(db)
-    expect(usageDoc.usageQuota.apps).toEqual(2)
-  })
-})
-

package/src/migrations/functions/usageQuotas/tests/syncRows.spec.js

@@ -1,43 +0,0 @@
-const { getGlobalDB } = require("@budibase/backend-core/tenancy")
-const TestConfig = require("../../../../tests/utilities/TestConfiguration")
-const { getUsageQuotaDoc, update, Properties } = require("../../../../utilities/usageQuota")
-const syncRows = require("../syncRows")
-const env = require("../../../../environment")
-
-describe("syncRows", () => {
-  let config = new TestConfig(false)
-
-  beforeEach(async () => {
-    await config.init()
-    env._set("USE_QUOTAS", 1)
-  })
-
-  afterAll(config.end)  
-
-  it("runs successfully", async () => {
-    // create the usage quota doc and mock usages
-    const db = getGlobalDB()
-    await getUsageQuotaDoc(db)
-    await update(Properties.ROW, 300)
-
-    let usageDoc = await getUsageQuotaDoc(db)
-    expect(usageDoc.usageQuota.rows).toEqual(300)
-
-    // app 1
-    await config.createTable()
-    await config.createRow()
-    // app 2
-    await config.createApp("second-app")
-    await config.createTable()
-    await config.createRow()
-    await config.createRow()
-    
-    // migrate
-    await syncRows.run()
-
-    // assert the migration worked 
-    usageDoc = await getUsageQuotaDoc(db)
-    expect(usageDoc.usageQuota.rows).toEqual(3)
-  })
-})
-

package/src/utilities/tests/usageQuota/usageQuota.spec.js

@@ -1,72 +0,0 @@
-const getTenantId = jest.fn()
-jest.mock("@budibase/backend-core/tenancy", () => ({
-  getTenantId
-}))
-const usageQuota = require("../../usageQuota")
-const env = require("../../../environment")
-
-class TestConfiguration {
-  constructor() {
-    this.enableQuotas()
-  }
-
-  enableQuotas = () => {
-    env.USE_QUOTAS = 1
-  }
-
-  disableQuotas = () => {
-    env.USE_QUOTAS = null
-  }
-
-  setTenantId = (tenantId) => {
-    getTenantId.mockReturnValue(tenantId)
-  } 
-
-  setExcludedTenants = (tenants) => {
-    env.EXCLUDE_QUOTAS_TENANTS = tenants
-  }
-
-  reset = () => {
-    this.disableQuotas()
-    this.setExcludedTenants(null)
-  }
-}
-
-describe("usageQuota", () => {
-  let config
-
-  beforeEach(() => {
-    config = new TestConfiguration()
-  })
-
-  afterEach(() => {
-    config.reset()
-  })
-
-  describe("useQuotas", () => {
-    it("works when no settings have been provided", () => {
-      config.reset()
-      expect(usageQuota.useQuotas()).toBe(false)
-    })
-    it("honours USE_QUOTAS setting", () => {
-      config.disableQuotas()
-      expect(usageQuota.useQuotas()).toBe(false)
-
-      config.enableQuotas()
-      expect(usageQuota.useQuotas()).toBe(true)
-    })
-    it("honours EXCLUDE_QUOTAS_TENANTS setting", () => {
-      config.setTenantId("test")
-
-      // tenantId is in the list
-      config.setExcludedTenants("test, test2, test2")
-      expect(usageQuota.useQuotas()).toBe(false)
-      config.setExcludedTenants("test,test2,test2")
-      expect(usageQuota.useQuotas()).toBe(false)
-
-      // tenantId is not in the list
-      config.setTenantId("other")
-      expect(usageQuota.useQuotas()).toBe(true)
-    })
-  })
-})

package/src/utilities/usageQuota/index.js

@@ -1,93 +0,0 @@
-const env = require("../../environment")
-const { getGlobalDB, getTenantId } = require("@budibase/backend-core/tenancy")
-const {
-  StaticDatabases,
-  generateNewUsageQuotaDoc,
-} = require("@budibase/backend-core/db")
-
-exports.useQuotas = () => {
-  // check if quotas are enabled
-  if (env.USE_QUOTAS) {
-    // check if there are any tenants without limits
-    if (env.EXCLUDE_QUOTAS_TENANTS) {
-      const excludedTenants = env.EXCLUDE_QUOTAS_TENANTS.replace(
-        /\s/g,
-        ""
-      ).split(",")
-      const tenantId = getTenantId()
-      if (excludedTenants.includes(tenantId)) {
-        return false
-      }
-    }
-    return true
-  }
-  return false
-}
-
-exports.Properties = {
-  ROW: "rows",
-  UPLOAD: "storage", // doesn't work yet
-  VIEW: "views", // doesn't work yet
-  USER: "users", // doesn't work yet
-  AUTOMATION: "automationRuns", // doesn't work yet
-  APPS: "apps",
-  EMAILS: "emails", // doesn't work yet
-}
-
-exports.getUsageQuotaDoc = async db => {
-  let quota
-  try {
-    quota = await db.get(StaticDatabases.GLOBAL.docs.usageQuota)
-  } catch (err) {
-    // doc doesn't exist. Create it
-    quota = generateNewUsageQuotaDoc()
-    const response = await db.put(quota)
-    quota._rev = response.rev
-  }
-
-  return quota
-}
-
-/**
- * Given a specified tenantId this will add to the usage object for the specified property.
- * @param {string} property The property which is to be added to (within the nested usageQuota object).
- * @param {number} usage The amount (this can be negative) to adjust the number by.
- * @param {object} opts optional - options such as dryRun, to check what update will do.
- * @returns {Promise<void>} When this completes the API key will now be up to date - the quota period may have
- * also been reset after this call.
- */
-exports.update = async (property, usage, opts = { dryRun: false }) => {
-  if (!exports.useQuotas()) {
-    return
-  }
-
-  try {
-    const db = getGlobalDB()
-    const quota = await exports.getUsageQuotaDoc(db)
-
-    // increment the quota
-    quota.usageQuota[property] += usage
-
-    if (
-      quota.usageQuota[property] > quota.usageLimits[property] &&
-      usage > 0 // allow for decrementing usage when the quota is already exceeded
-    ) {
-      throw new Error(
-        `You have exceeded your usage quota of ${quota.usageLimits[property]} ${property}.`
-      )
-    }
-
-    if (quota.usageQuota[property] < 0) {
-      // never go negative if the quota has previously been exceeded
-      quota.usageQuota[property] = 0
-    }
-
-    // update the usage quotas
-    if (!opts.dryRun) {
-      await db.put(quota)
-    }
-  } catch (err) {
-    console.error(`Error updating usage quotas for ${property}`, err)
-    throw err
-  }
-}