@budibase/server/src/sdk/app/oauth2/crud.ts

Budibase Web Server

import {
  cache,
  context,
  docIds,
  HTTPError,
  utils,
} from "@budibase/backend-core"
import {
  DocumentType,
  OAuth2Config,
  PASSWORD_REPLACEMENT,
  SEPARATOR,
  WithoutDocMetadata,
  WithRequired,
} from "@budibase/types"

type CreatedOAuthConfig = WithRequired<OAuth2Config, "_id" | "_rev">

async function guardName(name: string, id?: string) {
  const existingConfigs = await fetch()

  if (existingConfigs.find(c => c.name === name && c._id !== id)) {
    throw new HTTPError(
      `OAuth2 config with name '${name}' is already taken.`,
      400
    )
  }
}

export async function fetch(): Promise<CreatedOAuthConfig[]> {
  const db = context.getAppDB()
  const docs = await db.allDocs<OAuth2Config>(
    docIds.getOAuth2ConfigParams(null, { include_docs: true })
  )
  const result = docs.rows.map(r => ({
    ...r.doc!,
    _id: r.doc!._id!,
    _rev: r.doc!._rev!,
  }))
  return result
}

export async function create(
  config: WithoutDocMetadata<OAuth2Config>
): Promise<CreatedOAuthConfig> {
  const db = context.getAppDB()

  await guardName(config.name)

  const response = await db.put({
    _id: `${DocumentType.OAUTH2_CONFIG}${SEPARATOR}${utils.newid()}`,
    ...config,
  })
  return {
    _id: response.id!,
    _rev: response.rev!,
    ...config,
  }
}

export async function get(id: string): Promise<OAuth2Config | undefined> {
  const db = context.getAppDB()
  return await db.tryGet(id)
}

export async function update(
  config: CreatedOAuthConfig
): Promise<CreatedOAuthConfig> {
  const db = context.getAppDB()
  await guardName(config.name, config._id)

  const existing = await get(config._id)
  if (!existing) {
    throw new HTTPError(`OAuth2 config with id '${config._id}' not found.`, 404)
  }

  const toUpdate = {
    ...config,
    clientSecret:
      config.clientSecret === PASSWORD_REPLACEMENT
        ? existing.clientSecret
        : config.clientSecret,
  }

  const result = await db.put(toUpdate)

  await cleanCache(config._id)

  return { ...toUpdate, _rev: result.rev }
}

export async function remove(configId: string, _rev: string): Promise<void> {
  const db = context.getAppDB()
  try {
    await db.remove(configId, _rev)
  } catch (e: any) {
    if (e.status === 404) {
      throw new HTTPError(`OAuth2 config with id '${configId}' not found.`, 404)
    }
    throw e
  }

  await cleanCache(configId)

  const usageLog = await db.tryGet(docIds.generateOAuth2LogID(configId))
  if (usageLog) {
    await db.remove(usageLog)
  }
}

async function cleanCache(configId: string) {
  const cacheKey = cache.CacheKey.OAUTH2_TOKEN(configId)
  await cache.destroy(cacheKey)
}