From 90453212d5a258bc8f8bb98f07c84ba3ea009d75 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Mon, 4 Jul 2022 15:44:47 +0100
Subject: [PATCH] Moving majority of automation logging functionality to pro.

---
 packages/backend-core/src/index.ts            |   2 +
 .../automation/HistoryDetailsPanel.svelte     |   2 +-
 .../server/src/api/controllers/application.ts |   3 +-
 .../server/src/api/controllers/automation.js  |  11 +-
 .../server/src/automations/logging/index.ts   | 145 +++---------------
 packages/server/src/db/utils.js               |   4 -
 packages/server/src/utilities/index.js        |  37 -----
 .../types/src/documents/app/automation.ts     |   4 +-
 scripts/link-dependencies.sh                  |   3 +
 9 files changed, 36 insertions(+), 175 deletions(-)

diff --git a/packages/backend-core/src/index.ts b/packages/backend-core/src/index.ts
index 6eb6b14bc4..ab89eed3b2 100644
--- a/packages/backend-core/src/index.ts
+++ b/packages/backend-core/src/index.ts
@@ -13,6 +13,7 @@ import deprovisioning from "./context/deprovision"
 import auth from "./auth"
 import constants from "./constants"
 import * as dbConstants from "./db/constants"
+import logging from "./logging"
 
 // mimic the outer package exports
 import * as db from "./pkg/db"
@@ -49,6 +50,7 @@ const core = {
   deprovisioning,
   installation,
   errors,
+  logging,
   ...errorClasses,
 }
 
diff --git a/packages/builder/src/components/portal/overview/automation/HistoryDetailsPanel.svelte b/packages/builder/src/components/portal/overview/automation/HistoryDetailsPanel.svelte
index b386c0b0f9..76e2095e64 100644
--- a/packages/builder/src/components/portal/overview/automation/HistoryDetailsPanel.svelte
+++ b/packages/builder/src/components/portal/overview/automation/HistoryDetailsPanel.svelte
@@ -1,6 +1,6 @@
 <script>
   import { Layout, Icon, ActionButton } from "@budibase/bbui"
-  import StatusRenderer from "components/portal/overview/StatusRenderer.svelte"
+  import StatusRenderer from "./StatusRenderer.svelte"
   import DateTimeRenderer from "components/common/renderers/DateTimeRenderer.svelte"
   import TestDisplay from "components/automation/AutomationBuilder/TestDisplay.svelte"
   import { goto } from "@roxi/routify"
diff --git a/packages/server/src/api/controllers/application.ts b/packages/server/src/api/controllers/application.ts
index 9736ebaba5..3de0b67819 100644
--- a/packages/server/src/api/controllers/application.ts
+++ b/packages/server/src/api/controllers/application.ts
@@ -45,6 +45,7 @@ const { getTenantId, isMultiTenant } = require("@budibase/backend-core/tenancy")
 import { syncGlobalUsers } from "./user"
 const { app: appCache } = require("@budibase/backend-core/cache")
 import { cleanupAutomations } from "../../automations/utils"
+import { checkAppMetadata } from "../../automations/logging"
 const {
   getAppDB,
   getProdAppDB,
@@ -192,7 +193,7 @@ export const fetch = async (ctx: any) => {
     }
   }
 
-  ctx.body = apps
+  ctx.body = await checkAppMetadata(apps)
 }
 
 export const fetchAppDefinition = async (ctx: any) => {
diff --git a/packages/server/src/api/controllers/automation.js b/packages/server/src/api/controllers/automation.js
index 49ec70fc65..775fe03b0f 100644
--- a/packages/server/src/api/controllers/automation.js
+++ b/packages/server/src/api/controllers/automation.js
@@ -21,7 +21,6 @@ const {
 const { events } = require("@budibase/backend-core")
 const { app } = require("@budibase/backend-core/cache")
 const { automations } = require("@budibase/pro")
-const { clearOldHistory } = require("../../automations/logging")
 
 const ACTION_DEFS = removeDeprecated(actions.ACTION_DEFINITIONS)
 const TRIGGER_DEFS = removeDeprecated(triggers.TRIGGER_DEFINITIONS)
@@ -195,15 +194,7 @@ exports.destroy = async function (ctx) {
 }
 
 exports.logSearch = async function (ctx) {
-  let { automationId, status, page, startDate } = ctx.request.body
-  // before querying logs, make sure old logs are cleared out
-  await clearOldHistory()
-  ctx.body = await automations.logs.getLogs(
-    startDate,
-    status,
-    automationId,
-    page
-  )
+  ctx.body = await automations.logs.logSearch(ctx.request.body)
 }
 
 exports.clearLogError = async function (ctx) {
diff --git a/packages/server/src/automations/logging/index.ts b/packages/server/src/automations/logging/index.ts
index b61c65223e..f3c149d5ea 100644
--- a/packages/server/src/automations/logging/index.ts
+++ b/packages/server/src/automations/logging/index.ts
@@ -1,132 +1,35 @@
-import { getAppId, getProdAppDB } from "@budibase/backend-core/context"
-import {
-  DocumentTypes,
-  generateAutomationLogID,
-  isProdAppID,
-  SEPARATOR,
-} from "../../db/utils"
-import { Automation } from "../../definitions/common"
-import { app } from "@budibase/backend-core/cache"
-import { backOff } from "../../utilities"
 import * as env from "../../environment"
+import { AutomationResults, Automation, App } from "@budibase/types"
 import { automations } from "@budibase/pro"
-import { AppMetadataErrors } from "@budibase/types"
-import { AutomationResults, AutomationStatus } from "@budibase/types"
-
-const { logAlert } = require("@budibase/backend-core/logging")
-
-function getStatus(results: AutomationResults) {
-  let status = AutomationStatus.SUCCESS
-  let first = true
-  for (let step of results.steps) {
-    // skip the trigger, its always successful if automation ran
-    if (first) {
-      first = false
-      continue
-    }
-    if (!step.outputs?.success) {
-      status = AutomationStatus.ERROR
-      break
-    } else if (step.outputs?.status?.toLowerCase() === "stopped") {
-      status = AutomationStatus.STOPPED
-      break
-    }
-  }
-  return status
-}
-
-export async function clearOldHistory() {
-  const db = getProdAppDB()
-  try {
-    const expired = await automations.logs.getExpiredLogs()
-    const toDelete = expired.data.map((doc: any) => ({
-      _id: doc.id,
-      _rev: doc.value.rev,
-      _deleted: true,
-    }))
-    const errorLogIds = expired.data
-      .filter((doc: any) => {
-        const parts = doc.id.split(SEPARATOR)
-        const status = parts[parts.length - 1]
-        return status === AutomationStatus.ERROR
-      })
-      .map((doc: any) => doc.id)
-    await db.bulkDocs(toDelete)
-    if (errorLogIds.length) {
-      await updateAppMetadataWithErrors(errorLogIds, { clearing: true })
-    }
-  } catch (err) {
-    logAlert(`Failed to cleanup automation log history - Database "${db.name}"`)
-  }
-}
-
-async function updateAppMetadataWithErrors(
-  logIds: string[],
-  { clearing } = { clearing: false }
-) {
-  const db = getProdAppDB()
-  // this will try multiple times with a delay between to update the metadata
-  await backOff(async () => {
-    const metadata = await db.get(DocumentTypes.APP_METADATA)
-    for (let logId of logIds) {
-      const parts = logId.split(SEPARATOR)
-      const autoId = `${parts[parts.length - 3]}${SEPARATOR}${
-        parts[parts.length - 2]
-      }`
-      let errors: AppMetadataErrors = {}
-      if (metadata.automationErrors) {
-        errors = metadata.automationErrors as AppMetadataErrors
-      }
-      if (!Array.isArray(errors[autoId])) {
-        errors[autoId] = []
-      }
-      const idx = errors[autoId].indexOf(logId)
-      if (clearing && idx !== -1) {
-        errors[autoId].splice(idx, 1)
-      } else {
-        errors[autoId].push(logId)
-      }
-      // if clearing and reach zero, this will pass and will remove the element
-      if (errors[autoId].length === 0) {
-        delete errors[autoId]
-      }
-      metadata.automationErrors = errors
-    }
-    await db.put(metadata)
-    // don't update cache until after DB put, make sure it has been stored successfully
-    await app.invalidateAppMetadata(metadata.appId, metadata)
-  }, "Failed to update app metadata with automation log error")
-}
+import { db as dbUtils } from "@budibase/backend-core"
 
 export async function storeLog(
   automation: Automation,
   results: AutomationResults
 ) {
   // can disable this if un-needed in self-host, also only do this for prod apps
-  if (env.DISABLE_AUTOMATION_LOGS || !isProdAppID(getAppId())) {
+  if (env.DISABLE_AUTOMATION_LOGS) {
     return
   }
-  const db = getProdAppDB()
-  const automationId = automation._id
-  const name = automation.name
-  const status = getStatus(results)
-  const isoDate = new Date().toISOString()
-  const id = generateAutomationLogID(isoDate, status, automationId)
-  await db.put({
-    // results contain automationId and status for view
-    ...results,
-    automationId,
-    status,
-    automationName: name,
-    createdAt: isoDate,
-    _id: id,
-  })
-
-  // need to note on the app metadata that there is an error, store what the error is
-  if (status === AutomationStatus.ERROR) {
-    await updateAppMetadataWithErrors([id])
-  }
-
-  // clear up old logging for app
-  await clearOldHistory()
+  await automations.logs.storeLog(automation, results)
+}
+
+export async function checkAppMetadata(apps: App[]) {
+  const maxStartDate = await automations.logs.oldestLogDate()
+  for (let metadata of apps) {
+    if (!metadata.automationErrors) {
+      continue
+    }
+    for (let [key, errors] of Object.entries(metadata.automationErrors)) {
+      const updated = []
+      for (let error of errors) {
+        const startDate = error.split(dbUtils.SEPARATOR)[2]
+        if (startDate > maxStartDate) {
+          updated.push(error)
+        }
+      }
+      metadata.automationErrors[key] = updated
+    }
+  }
+  return apps
 }
diff --git a/packages/server/src/db/utils.js b/packages/server/src/db/utils.js
index 99831e4ca3..152b0e9d33 100644
--- a/packages/server/src/db/utils.js
+++ b/packages/server/src/db/utils.js
@@ -354,10 +354,6 @@ exports.getMemoryViewParams = (otherProps = {}) => {
   return getDocParams(DocumentTypes.MEM_VIEW, null, otherProps)
 }
 
-exports.generateAutomationLogID = (isoDate, status, automationId) => {
-  return `${DocumentTypes.AUTOMATION_LOG}${SEPARATOR}${isoDate}${SEPARATOR}${automationId}${SEPARATOR}${status}`
-}
-
 /**
  * This can be used with the db.allDocs to get a list of IDs
  */
diff --git a/packages/server/src/utilities/index.js b/packages/server/src/utilities/index.js
index 723c5332eb..0fc18a1ae6 100644
--- a/packages/server/src/utilities/index.js
+++ b/packages/server/src/utilities/index.js
@@ -4,7 +4,6 @@ const { sanitizeKey } = require("@budibase/backend-core/objectStore")
 const { generateMetadataID } = require("../db/utils")
 const Readable = require("stream").Readable
 const { getAppDB } = require("@budibase/backend-core/context")
-const { logAlert } = require("@budibase/backend-core/logging")
 
 const BB_CDN = "https://cdn.budi.live"
 
@@ -14,42 +13,6 @@ exports.isDev = env.isDev
 
 exports.NUMBER_REGEX = /^[+-]?([0-9]*[.])?[0-9]+$/g
 
-exports.randomDelay = fn => {
-  return new Promise((resolve, reject) => {
-    setTimeout(async () => {
-      try {
-        resolve(await fn())
-      } catch (err) {
-        reject(err)
-      }
-    }, Math.floor(Math.random() * 1000))
-  })
-}
-
-exports.backOff = async (fn, errMsg) => {
-  let attempts = 5,
-    success = false,
-    response,
-    first = true
-  for (; attempts > 0; attempts--) {
-    try {
-      if (first) {
-        response = await fn()
-      } else {
-        response = await exports.randomDelay(fn)
-      }
-      success = true
-      break
-    } catch (err) {
-      // ignore error here
-    }
-  }
-  if (!success) {
-    logAlert("Failed to backoff - ", errMsg)
-  }
-  return response
-}
-
 exports.removeFromArray = (array, element) => {
   const index = array.indexOf(element)
   if (index !== -1) {
diff --git a/packages/types/src/documents/app/automation.ts b/packages/types/src/documents/app/automation.ts
index 9b8b573b66..97248ff173 100644
--- a/packages/types/src/documents/app/automation.ts
+++ b/packages/types/src/documents/app/automation.ts
@@ -6,6 +6,7 @@ export interface Automation extends Document {
     trigger: AutomationTrigger
   }
   appId: string
+  name: string
 }
 
 export interface AutomationStep {
@@ -40,7 +41,8 @@ export interface AutomationResults {
 }
 
 export interface AutomationLog extends AutomationResults, Document {
-  _rev: string
+  automationName: string
+  _rev?: string
 }
 
 export interface AutomationLogPage {
diff --git a/scripts/link-dependencies.sh b/scripts/link-dependencies.sh
index 448a48feb0..052f8aed8e 100755
--- a/scripts/link-dependencies.sh
+++ b/scripts/link-dependencies.sh
@@ -29,6 +29,9 @@ if [ -d "../budibase-pro" ]; then
   echo "Linking backend-core to pro"
   yarn link '@budibase/backend-core'
 
+  echo "Linking types to pro"
+  yarn link '@budibase/types'
+
   cd ../../../budibase
 
   echo "Linking pro to worker"