Merge pull request #12334 from Budibase/more-db-typing-improvements

Another random assortment of typing improvements

packages/backend-core/src/cache/appMetadata.ts

@@ -19,7 +19,7 @@ async function populateFromDB(appId: string) {
   return doWithDB(
     appId,
     (db: Database) => {
-      return db.get(DocumentType.APP_METADATA)
+      return db.get<App>(DocumentType.APP_METADATA)
     },
     { skip_setup: true }
   )

packages/backend-core/src/context/Context.ts

@@ -4,7 +4,7 @@ import { ContextMap } from "./types"
 export default class Context {
   static storage = new AsyncLocalStorage<ContextMap>()
 
-  static run(context: ContextMap, func: any) {
+  static run<T>(context: ContextMap, func: () => T) {
     return Context.storage.run(context, () => func())
   }
 

packages/backend-core/src/context/mainContext.ts

@@ -98,17 +98,17 @@ function updateContext(updates: ContextMap): ContextMap {
   return context
 }
 
-async function newContext(updates: ContextMap, task: any) {
+async function newContext<T>(updates: ContextMap, task: () => T) {
   // see if there already is a context setup
   let context: ContextMap = updateContext(updates)
   return Context.run(context, task)
 }
 
-export async function doInAutomationContext(params: {
+export async function doInAutomationContext<T>(params: {
   appId: string
   automationId: string
-  task: any
-}): Promise<any> {
+  task: () => T
+}): Promise<T> {
   const tenantId = getTenantIDFromAppID(params.appId)
   return newContext(
     {
@@ -144,10 +144,10 @@ export async function doInTenant<T>(
   return newContext(updates, task)
 }
 
-export async function doInAppContext(
+export async function doInAppContext<T>(
   appId: string | null,
-  task: any
-): Promise<any> {
+  task: () => T
+): Promise<T> {
   if (!appId && !env.isTest()) {
     throw new Error("appId is required")
   }
@@ -165,10 +165,10 @@ export async function doInAppContext(
   return newContext(updates, task)
 }
 
-export async function doInIdentityContext(
+export async function doInIdentityContext<T>(
   identity: IdentityContext,
-  task: any
-): Promise<any> {
+  task: () => T
+): Promise<T> {
   if (!identity) {
     throw new Error("identity is required")
   }
@@ -276,6 +276,9 @@ export function getAuditLogsDB(): Database {
  */
 export function getAppDB(opts?: any): Database {
   const appId = getAppId()
+  if (!appId) {
+    throw new Error("Unable to retrieve app DB - no app ID.")
+  }
   return getDB(appId, opts)
 }
 

packages/backend-core/src/db/couch/DatabaseImpl.ts

@@ -48,10 +48,7 @@ export class DatabaseImpl implements Database {
 
   private readonly couchInfo = getCouchInfo()
 
-  constructor(dbName?: string, opts?: DatabaseOpts, connection?: string) {
-    if (dbName == null) {
-      throw new Error("Database name cannot be undefined.")
-    }
+  constructor(dbName: string, opts?: DatabaseOpts, connection?: string) {
     this.name = dbName
     this.pouchOpts = opts || {}
     if (connection) {

packages/backend-core/src/db/db.ts

@@ -1,10 +1,7 @@
-import env from "../environment"
 import { directCouchQuery, DatabaseImpl } from "./couch"
-import { CouchFindOptions, Database } from "@budibase/types"
+import { CouchFindOptions, Database, DatabaseOpts } from "@budibase/types"
 
-const dbList = new Set()
-
-export function getDB(dbName?: string, opts?: any): Database {
+export function getDB(dbName: string, opts?: DatabaseOpts): Database {
   return new DatabaseImpl(dbName, opts)
 }
 
@@ -14,7 +11,7 @@ export function getDB(dbName?: string, opts?: any): Database {
 export async function doWithDB<T>(
   dbName: string,
   cb: (db: Database) => Promise<T>,
-  opts = {}
+  opts?: DatabaseOpts
 ) {
   const db = getDB(dbName, opts)
   // need this to be async so that we can correctly close DB after all
@@ -22,13 +19,6 @@ export async function doWithDB<T>(
   return await cb(db)
 }
 
-export function allDbs() {
-  if (!env.isTest()) {
-    throw new Error("Cannot be used outside test environment.")
-  }
-  return [...dbList]
-}
-
 export async function directCouchAllDbs(queryString?: string) {
   let couchPath = "/_all_dbs"
   if (queryString) {

packages/server/src/api/controllers/datasource.ts

@@ -337,7 +337,7 @@ export async function destroy(ctx: UserCtx) {
   if (datasource.type === dbCore.BUDIBASE_DATASOURCE_TYPE) {
     await destroyInternalTablesBySourceId(datasourceId)
   } else {
-    const queries = await db.allDocs(getQueryParams(datasourceId, null))
+    const queries = await db.allDocs(getQueryParams(datasourceId))
     await db.bulkDocs(
       queries.rows.map((row: any) => ({
         _id: row.id,

packages/server/src/automations/triggers.ts

@@ -94,7 +94,7 @@ export async function externalTrigger(
   automation: Automation,
   params: { fields: Record<string, any>; timeout?: number },
   { getResponses }: { getResponses?: boolean } = {}
-) {
+): Promise<any> {
   if (
     automation.definition != null &&
     automation.definition.trigger != null &&

packages/server/src/db/utils.ts

@@ -6,6 +6,7 @@ import {
   RelationshipFieldMetadata,
   VirtualDocumentType,
   INTERNAL_TABLE_SOURCE_ID,
+  DatabaseQueryOpts,
 } from "@budibase/types"
 import { FieldTypes } from "../constants"
 export { DocumentType, VirtualDocumentType } from "@budibase/types"
@@ -229,7 +230,10 @@ export function getAutomationMetadataParams(otherProps: any = {}) {
 /**
  * Gets parameters for retrieving a query, this is a utility function for the getDocParams function.
  */
-export function getQueryParams(datasourceId?: Optional, otherProps: any = {}) {
+export function getQueryParams(
+  datasourceId?: Optional,
+  otherProps: Partial<DatabaseQueryOpts> = {}
+) {
   if (datasourceId == null) {
     return getDocParams(DocumentType.QUERY, null, otherProps)
   }
@@ -256,7 +260,7 @@ export function generateMetadataID(type: string, entityId: string) {
 export function getMetadataParams(
   type: string,
   entityId?: Optional,
-  otherProps: any = {}
+  otherProps: Partial<DatabaseQueryOpts> = {}
 ) {
   let docId = `${type}${SEPARATOR}`
   if (entityId != null) {
@@ -269,7 +273,9 @@ export function generateMemoryViewID(viewName: string) {
   return `${DocumentType.MEM_VIEW}${SEPARATOR}${viewName}`
 }
 
-export function getMemoryViewParams(otherProps: any = {}) {
+export function getMemoryViewParams(
+  otherProps: Partial<DatabaseQueryOpts> = {}
+) {
   return getDocParams(DocumentType.MEM_VIEW, null, otherProps)
 }
 

packages/server/src/tests/utilities/TestConfiguration.ts

@@ -510,13 +510,14 @@ class TestConfiguration {
     // create dev app
     // clear any old app
     this.appId = null
-    await context.doInAppContext(null, async () => {
-      this.app = await this._req(
+    this.app = await context.doInAppContext(null, async () => {
+      const app = await this._req(
         { name: appName },
         null,
         controllers.app.create
       )
-      this.appId = this.app?.appId!
+      this.appId = app.appId!
+      return app
     })
     return await context.doInAppContext(this.appId, async () => {
       // create production app
@@ -525,7 +526,7 @@ class TestConfiguration {
       this.allApps.push(this.prodApp)
       this.allApps.push(this.app)
 
-      return this.app
+      return this.app!
     })
   }
 
@@ -537,7 +538,7 @@ class TestConfiguration {
 
     return context.doInAppContext(prodAppId, async () => {
       const db = context.getProdAppDB()
-      return await db.get(dbCore.DocumentType.APP_METADATA)
+      return await db.get<App>(dbCore.DocumentType.APP_METADATA)
     })
   }
 

packages/server/src/threads/automation.ts

@@ -241,7 +241,7 @@ class Orchestrator {
     })
   }
 
-  async execute() {
+  async execute(): Promise<any> {
     // this will retrieve from context created at start of thread
     this._context.env = await sdkUtils.getEnvironmentVariables()
     let automation = this._automation