Sync app quota to correct number, reset and disable rows quota

packages/auth/src/db/constants.js

@@ -21,6 +21,7 @@ exports.StaticDatabases = {
     name: "global-db",
     docs: {
       apiKeys: "apikeys",
+      usageQuota: "usage_quota",
     },
   },
   // contains information about tenancy and so on
@@ -28,7 +29,6 @@ exports.StaticDatabases = {
     name: "global-info",
     docs: {
       tenants: "tenants",
-      usageQuota: "usage_quota",
     },
   },
 }

packages/auth/src/db/utils.js

@@ -450,7 +450,7 @@ async function getScopedConfig(db, params) {
 
 function generateNewUsageQuotaDoc() {
   return {
-    _id: StaticDatabases.PLATFORM_INFO.docs.usageQuota,
+    _id: StaticDatabases.GLOBAL.docs.usageQuota,
     quotaReset: Date.now() + 2592000000,
     usageQuota: {
       automationRuns: 0,

packages/auth/src/index.js

@@ -68,4 +68,5 @@ module.exports = {
   },
   StaticDatabases,
   constants: require("./constants"),
+  migrations: require("./migrations"),
 }

packages/auth/src/migrations/index.js

@@ -7,11 +7,13 @@ exports.MIGRATION_DBS = {
 
 exports.MIGRATIONS = {
   USER_EMAIL_VIEW_CASING: "user_email_view_casing",
+  SYNC_APP_AND_RESET_ROWS_QUOTAS: "sync_app_and_reset_rows_quotas",
 }
 
 const DB_LOOKUP = {
   [exports.MIGRATION_DBS.GLOBAL_DB]: [
     exports.MIGRATIONS.USER_EMAIL_VIEW_CASING,
+    exports.MIGRATIONS.SYNC_APP_AND_RESET_ROWS_QUOTAS,
   ],
 }
 

packages/server/src/middleware/usageQuota.js

@@ -17,14 +17,14 @@ const METHOD_MAP = {
 }
 
 const DOMAIN_MAP = {
-  rows: usageQuota.Properties.ROW,
+  // rows: usageQuota.Properties.ROW,                 // works - disabled
-  upload: usageQuota.Properties.UPLOAD,
+  // upload: usageQuota.Properties.UPLOAD,            // doesn't work yet
-  views: usageQuota.Properties.VIEW,
+  // views: usageQuota.Properties.VIEW,               // doesn't work yet
-  users: usageQuota.Properties.USER,
+  // 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,
+  // automationRuns: usageQuota.Properties.AUTOMATION, // doesn't work yet
 }
 
 function getProperty(url) {

packages/server/src/migrations/sync_app_and_reset_rows_quotas.js

@@ -0,0 +1,27 @@
+const { MIGRATIONS, MIGRATION_DBS, migrateIfRequired } =
+  require("@budibase/auth").migrations
+const { getGlobalDB } = require("@budibase/auth/tenancy")
+const { getUsageQuotaDoc } = require("../utilities/usageQuota")
+const { getAllApps } = require("@budibase/auth/db")
+const CouchDB = require("../db")
+
+exports.migrate = async () => {
+  await migrateIfRequired(
+    MIGRATION_DBS.GLOBAL_DB,
+    MIGRATIONS.SYNC_APP_AND_RESET_ROWS_QUOTAS,
+    async () => {
+      const globalDb = getGlobalDB()
+      const usageDoc = await getUsageQuotaDoc(globalDb)
+
+      // reset the rows
+      usageDoc.usageQuota.rows = 0
+
+      // sync the apps
+      const apps = await getAllApps(CouchDB, { dev: true })
+      const appCount = apps ? apps.length : 0
+      usageDoc.usageQuota.apps = appCount
+
+      await globalDb.put(usageDoc)
+    }
+  )
+}

packages/server/src/migrations/tests/sync_app_and_reset_rows_quotas.spec.js

@@ -0,0 +1,39 @@
+const { getGlobalDB } = require("@budibase/auth/tenancy")
+const TestConfig = require("../../tests/utilities/TestConfiguration")
+const { getUsageQuotaDoc, update, Properties } = require("../../utilities/usageQuota")
+const { migrate } = require("../sync_app_and_reset_rows_quotas")
+const env = require("../../environment")
+
+describe("Sync App And Reset Rows Quotas Migration", () => {
+  let config = new TestConfig(false)
+
+  beforeEach(async () => {
+    await config.init()
+    env._set("USE_QUOTAS", 1)
+  })
+
+  afterAll(config.end)
+
+  it("migrates successfully", async () => {
+    // create the usage quota doc and mock usages
+    const db = getGlobalDB()
+    await getUsageQuotaDoc(db)
+    await update(Properties.APPS, 3)
+    await update(Properties.ROW, 300)
+
+    let usageDoc = await getUsageQuotaDoc(db)
+    expect(usageDoc.usageQuota.apps).toEqual(3)
+    expect(usageDoc.usageQuota.rows).toEqual(300)
+
+    // create an extra app to test the migration
+    await config.createApp("quota-test")
+
+    // migrate
+    await migrate()
+
+    // assert the migration worked 
+    usageDoc = await getUsageQuotaDoc(db)
+    expect(usageDoc.usageQuota.apps).toEqual(2)
+    expect(usageDoc.usageQuota.rows).toEqual(0)
+  })
+})

packages/server/src/utilities/usageQuota.js

@@ -5,24 +5,20 @@ const {
   generateNewUsageQuotaDoc,
 } = require("@budibase/auth/db")
 
-function getNewQuotaReset() {
-  return Date.now() + 2592000000
-}
-
 exports.Properties = {
-  ROW: "rows",
+  ROW: "rows", // mostly works - disabled - app / table deletion not yet accounted for
-  UPLOAD: "storage",
+  UPLOAD: "storage", // doesn't work yet
-  VIEW: "views",
+  VIEW: "views", // doesn't work yet
-  USER: "users",
+  USER: "users", // doesn't work yet
-  AUTOMATION: "automationRuns",
+  AUTOMATION: "automationRuns", // doesn't work yet
-  APPS: "apps",
+  APPS: "apps", // works
-  EMAILS: "emails",
+  EMAILS: "emails", // doesn't work yet
 }
 
-async function getUsageQuotaDoc(db) {
+exports.getUsageQuotaDoc = async db => {
   let quota
   try {
-    quota = await db.get(StaticDatabases.PLATFORM_INFO.docs.usageQuota)
+    quota = await db.get(StaticDatabases.GLOBAL.docs.usageQuota)
   } catch (err) {
     // doc doesn't exist. Create it
     quota = await db.post(generateNewUsageQuotaDoc())
@@ -45,15 +41,7 @@ exports.update = async (property, usage) => {
 
   try {
     const db = getGlobalDB()
-    const quota = await getUsageQuotaDoc(db)
+    const quota = await exports.getUsageQuotaDoc(db)
-
-    // Check if the quota needs reset
-    if (Date.now() >= quota.quotaReset) {
-      quota.quotaReset = getNewQuotaReset()
-      for (let prop of Object.keys(quota.usageQuota)) {
-        quota.usageQuota[prop] = 0
-      }
-    }
 
     // increment the quota
     quota.usageQuota[property] += usage

packages/server/src/utilities/usageQuoteReset.js

@@ -0,0 +1,18 @@
+// UNUSED CODE
+// Preserved for future use
+
+/* eslint-disable no-unused-vars */
+
+function getNewQuotaReset() {
+  return Date.now() + 2592000000
+}
+
+function resetQuotasIfRequired(quota) {
+  // Check if the quota needs reset
+  if (Date.now() >= quota.quotaReset) {
+    quota.quotaReset = getNewQuotaReset()
+    for (let prop of Object.keys(quota.usageQuota)) {
+      quota.usageQuota[prop] = 0
+    }
+  }
+}

packages/worker/src/api/controllers/global/users.js

@@ -69,9 +69,7 @@ exports.adminUser = async ctx => {
   if (!env.SELF_HOSTED) {
     // could be a scenario where it exists, make sure its clean
     try {
-      const usageQuota = await db.get(
+      const usageQuota = await db.get(StaticDatabases.GLOBAL.docs.usageQuota)
-        StaticDatabases.PLATFORM_INFO.docs.usageQuota
-      )
       if (usageQuota) {
         await db.remove(usageQuota._id, usageQuota._rev)
       }