@budibase/backend-core 2.9.19 → 2.9.20

package/src/accounts/accounts.ts

@@ -1,82 +0,0 @@
-import API from "./api"
-import env from "../environment"
-import { Header } from "../constants"
-import { CloudAccount, HealthStatusResponse } from "@budibase/types"
-
-const api = new API(env.ACCOUNT_PORTAL_URL)
-
-/**
- * This client is intended to be used in a cloud hosted deploy only.
- * Rather than relying on each consumer to perform the necessary environmental checks
- * we use the following check to exit early with a undefined response which should be
- * handled by the caller.
- */
-const EXIT_EARLY = env.SELF_HOSTED || env.DISABLE_ACCOUNT_PORTAL
-
-export const getAccount = async (
-  email: string
-): Promise<CloudAccount | undefined> => {
-  if (EXIT_EARLY) {
-    return
-  }
-  const payload = {
-    email,
-  }
-  const response = await api.post(`/api/accounts/search`, {
-    body: payload,
-    headers: {
-      [Header.API_KEY]: env.ACCOUNT_PORTAL_API_KEY,
-    },
-  })
-
-  if (response.status !== 200) {
-    throw new Error(`Error getting account by email ${email}`)
-  }
-
-  const json: CloudAccount[] = await response.json()
-  return json[0]
-}
-
-export const getAccountByTenantId = async (
-  tenantId: string
-): Promise<CloudAccount | undefined> => {
-  if (EXIT_EARLY) {
-    return
-  }
-  const payload = {
-    tenantId,
-  }
-  const response = await api.post(`/api/accounts/search`, {
-    body: payload,
-    headers: {
-      [Header.API_KEY]: env.ACCOUNT_PORTAL_API_KEY,
-    },
-  })
-
-  if (response.status !== 200) {
-    throw new Error(`Error getting account by tenantId ${tenantId}`)
-  }
-
-  const json: CloudAccount[] = await response.json()
-  return json[0]
-}
-
-export const getStatus = async (): Promise<
-  HealthStatusResponse | undefined
-> => {
-  if (EXIT_EARLY) {
-    return
-  }
-  const response = await api.get(`/api/status`, {
-    headers: {
-      [Header.API_KEY]: env.ACCOUNT_PORTAL_API_KEY,
-    },
-  })
-  const json = await response.json()
-
-  if (response.status !== 200) {
-    throw new Error(`Error getting status`)
-  }
-
-  return json
-}

package/src/accounts/api.ts

@@ -1,59 +0,0 @@
-import fetch from "node-fetch"
-import * as logging from "../logging"
-
-export default class API {
-  host: string
-
-  constructor(host: string) {
-    this.host = host
-  }
-
-  async apiCall(method: string, url: string, options?: any) {
-    if (!options.headers) {
-      options.headers = {}
-    }
-
-    if (!options.headers["Content-Type"]) {
-      options.headers = {
-        "Content-Type": "application/json",
-        Accept: "application/json",
-        ...options.headers,
-      }
-    }
-
-    let json = options.headers["Content-Type"] === "application/json"
-
-    // add x-budibase-correlation-id header
-    logging.correlation.setHeader(options.headers)
-
-    const requestOptions = {
-      method: method,
-      body: json ? JSON.stringify(options.body) : options.body,
-      headers: options.headers,
-      // TODO: See if this is necessary
-      credentials: "include",
-    }
-
-    return await fetch(`${this.host}${url}`, requestOptions)
-  }
-
-  async post(url: string, options?: any) {
-    return this.apiCall("POST", url, options)
-  }
-
-  async get(url: string, options?: any) {
-    return this.apiCall("GET", url, options)
-  }
-
-  async patch(url: string, options?: any) {
-    return this.apiCall("PATCH", url, options)
-  }
-
-  async del(url: string, options?: any) {
-    return this.apiCall("DELETE", url, options)
-  }
-
-  async put(url: string, options?: any) {
-    return this.apiCall("PUT", url, options)
-  }
-}

package/src/accounts/index.ts

@@ -1 +0,0 @@
-export * from "./accounts"

package/src/auth/auth.ts

@@ -1,208 +0,0 @@
-const _passport = require("koa-passport")
-const LocalStrategy = require("passport-local").Strategy
-import { getGlobalDB } from "../context"
-import { Cookie } from "../constants"
-import { getSessionsForUser, invalidateSessions } from "../security/sessions"
-import {
-  authenticated,
-  csrf,
-  google,
-  local,
-  oidc,
-  tenancy,
-} from "../middleware"
-import * as userCache from "../cache/user"
-import { invalidateUser } from "../cache/user"
-import {
-  ConfigType,
-  GoogleInnerConfig,
-  OIDCInnerConfig,
-  PlatformLogoutOpts,
-  SSOProviderType,
-} from "@budibase/types"
-import * as events from "../events"
-import * as configs from "../configs"
-import { clearCookie, getCookie } from "../utils"
-import { ssoSaveUserNoOp } from "../middleware/passport/sso/sso"
-
-const refresh = require("passport-oauth2-refresh")
-export {
-  auditLog,
-  authError,
-  internalApi,
-  ssoCallbackUrl,
-  adminOnly,
-  builderOnly,
-  builderOrAdmin,
-  joiValidator,
-  google,
-  oidc,
-} from "../middleware"
-export const buildAuthMiddleware = authenticated
-export const buildTenancyMiddleware = tenancy
-export const buildCsrfMiddleware = csrf
-export const passport = _passport
-export const jwt = require("jsonwebtoken")
-
-// Strategies
-_passport.use(new LocalStrategy(local.options, local.authenticate))
-
-async function refreshOIDCAccessToken(
-  chosenConfig: OIDCInnerConfig,
-  refreshToken: string
-): Promise<RefreshResponse> {
-  const callbackUrl = await oidc.getCallbackUrl()
-  let enrichedConfig: any
-  let strategy: any
-
-  try {
-    enrichedConfig = await oidc.fetchStrategyConfig(chosenConfig, callbackUrl)
-    if (!enrichedConfig) {
-      throw new Error("OIDC Config contents invalid")
-    }
-    strategy = await oidc.strategyFactory(enrichedConfig, ssoSaveUserNoOp)
-  } catch (err) {
-    console.error(err)
-    throw new Error("Could not refresh OAuth Token")
-  }
-
-  refresh.use(strategy, {
-    setRefreshOAuth2() {
-      return strategy._getOAuth2Client(enrichedConfig)
-    },
-  })
-
-  return new Promise(resolve => {
-    refresh.requestNewAccessToken(
-      ConfigType.OIDC,
-      refreshToken,
-      (err: any, accessToken: string, refreshToken: any, params: any) => {
-        resolve({ err, accessToken, refreshToken, params })
-      }
-    )
-  })
-}
-
-async function refreshGoogleAccessToken(
-  config: GoogleInnerConfig,
-  refreshToken: any
-): Promise<RefreshResponse> {
-  let callbackUrl = await google.getCallbackUrl(config)
-
-  let strategy
-  try {
-    strategy = await google.strategyFactory(
-      config,
-      callbackUrl,
-      ssoSaveUserNoOp
-    )
-  } catch (err: any) {
-    console.error(err)
-    throw new Error(
-      `Error constructing OIDC refresh strategy: message=${err.message}`
-    )
-  }
-
-  refresh.use(strategy)
-
-  return new Promise(resolve => {
-    refresh.requestNewAccessToken(
-      ConfigType.GOOGLE,
-      refreshToken,
-      (err: any, accessToken: string, refreshToken: string, params: any) => {
-        resolve({ err, accessToken, refreshToken, params })
-      }
-    )
-  })
-}
-
-interface RefreshResponse {
-  err?: {
-    data?: string
-  }
-  accessToken?: string
-  refreshToken?: string
-  params?: any
-}
-
-export async function refreshOAuthToken(
-  refreshToken: string,
-  providerType: SSOProviderType,
-  configId?: string
-): Promise<RefreshResponse> {
-  switch (providerType) {
-    case SSOProviderType.OIDC:
-      if (!configId) {
-        return { err: { data: "OIDC config id not provided" } }
-      }
-      const oidcConfig = await configs.getOIDCConfigById(configId)
-      if (!oidcConfig) {
-        return { err: { data: "OIDC configuration not found" } }
-      }
-      return refreshOIDCAccessToken(oidcConfig, refreshToken)
-    case SSOProviderType.GOOGLE:
-      let googleConfig = await configs.getGoogleConfig()
-      if (!googleConfig) {
-        return { err: { data: "Google configuration not found" } }
-      }
-      return refreshGoogleAccessToken(googleConfig, refreshToken)
-  }
-}
-
-// TODO: Refactor to use user save function instead to prevent the need for
-// manually saving and invalidating on callback
-export async function updateUserOAuth(userId: string, oAuthConfig: any) {
-  const details = {
-    accessToken: oAuthConfig.accessToken,
-    refreshToken: oAuthConfig.refreshToken,
-  }
-
-  try {
-    const db = getGlobalDB()
-    const dbUser = await db.get<any>(userId)
-
-    //Do not overwrite the refresh token if a valid one is not provided.
-    if (typeof details.refreshToken !== "string") {
-      delete details.refreshToken
-    }
-
-    dbUser.oauth2 = {
-      ...dbUser.oauth2,
-      ...details,
-    }
-
-    await db.put(dbUser)
-
-    await invalidateUser(userId)
-  } catch (e) {
-    console.error("Could not update OAuth details for current user", e)
-  }
-}
-
-/**
- * Logs a user out from budibase. Re-used across account portal and builder.
- */
-export async function platformLogout(opts: PlatformLogoutOpts) {
-  const ctx = opts.ctx
-  const userId = opts.userId
-  const keepActiveSession = opts.keepActiveSession
-
-  if (!ctx) throw new Error("Koa context must be supplied to logout.")
-
-  const currentSession = getCookie(ctx, Cookie.Auth)
-  let sessions = await getSessionsForUser(userId)
-
-  if (keepActiveSession) {
-    sessions = sessions.filter(
-      session => session.sessionId !== currentSession.sessionId
-    )
-  } else {
-    // clear cookies
-    clearCookie(ctx, Cookie.Auth)
-  }
-
-  const sessionIds = sessions.map(({ sessionId }) => sessionId)
-  await invalidateSessions(userId, { sessionIds, reason: "logout" })
-  await events.auth.logout(ctx.user?.email)
-  await userCache.invalidateUser(userId)
-}

package/src/auth/index.ts

@@ -1 +0,0 @@
-export * from "./auth"

package/src/auth/tests/auth.spec.ts

@@ -1,14 +0,0 @@
-import { structures } from "../../../tests"
-import { testEnv } from "../../../tests/extra"
-import * as auth from "../auth"
-import * as events from "../../events"
-
-describe("platformLogout", () => {
-  it("should call platform logout", async () => {
-    await testEnv.withTenant(async () => {
-      const ctx = structures.koa.newContext()
-      await auth.platformLogout({ ctx, userId: "test" })
-      expect(events.auth.logout).toBeCalledTimes(1)
-    })
-  })
-})

package/src/blacklist/blacklist.ts

@@ -1,54 +0,0 @@
-import dns from "dns"
-import net from "net"
-import env from "../environment"
-import { promisify } from "util"
-
-let blackListArray: string[] | undefined
-const performLookup = promisify(dns.lookup)
-
-async function lookup(address: string): Promise<string[]> {
-  if (!net.isIP(address)) {
-    // need this for URL parsing simply
-    if (!address.startsWith("http")) {
-      address = `https://${address}`
-    }
-    address = new URL(address).hostname
-  }
-  const addresses = await performLookup(address, {
-    all: true,
-  })
-  return addresses.map(addr => addr.address)
-}
-
-export async function refreshBlacklist() {
-  const blacklist = env.BLACKLIST_IPS
-  const list = blacklist?.split(",") || []
-  let final: string[] = []
-  for (let addr of list) {
-    const trimmed = addr.trim()
-    if (!net.isIP(trimmed)) {
-      const addresses = await lookup(trimmed)
-      final = final.concat(addresses)
-    } else {
-      final.push(trimmed)
-    }
-  }
-  blackListArray = final
-}
-
-export async function isBlacklisted(address: string): Promise<boolean> {
-  if (!blackListArray) {
-    await refreshBlacklist()
-  }
-  if (blackListArray?.length === 0) {
-    return false
-  }
-  // no need for DNS
-  let ips: string[]
-  if (!net.isIP(address)) {
-    ips = await lookup(address)
-  } else {
-    ips = [address]
-  }
-  return !!blackListArray?.find(addr => ips.includes(addr))
-}

package/src/blacklist/index.ts

@@ -1 +0,0 @@
-export * from "./blacklist"

package/src/blacklist/tests/blacklist.spec.ts

@@ -1,46 +0,0 @@
-import { refreshBlacklist, isBlacklisted } from ".."
-import env from "../../environment"
-
-describe("blacklist", () => {
-  beforeAll(async () => {
-    env._set(
-      "BLACKLIST_IPS",
-      "www.google.com,192.168.1.1, 1.1.1.1,2.2.2.2/something"
-    )
-    await refreshBlacklist()
-  })
-
-  it("should blacklist 192.168.1.1", async () => {
-    expect(await isBlacklisted("192.168.1.1")).toBe(true)
-  })
-
-  it("should allow 192.168.1.2", async () => {
-    expect(await isBlacklisted("192.168.1.2")).toBe(false)
-  })
-
-  it("should blacklist www.google.com", async () => {
-    expect(await isBlacklisted("www.google.com")).toBe(true)
-  })
-
-  it("should handle a complex domain", async () => {
-    expect(
-      await isBlacklisted("https://www.google.com/derp/?something=1")
-    ).toBe(true)
-  })
-
-  it("should allow www.microsoft.com", async () => {
-    expect(await isBlacklisted("www.microsoft.com")).toBe(false)
-  })
-
-  it("should blacklist an IP that needed trimming", async () => {
-    expect(await isBlacklisted("1.1.1.1")).toBe(true)
-  })
-
-  it("should blacklist 1.1.1.1/something", async () => {
-    expect(await isBlacklisted("1.1.1.1/something")).toBe(true)
-  })
-
-  it("should blacklist 2.2.2.2", async () => {
-    expect(await isBlacklisted("2.2.2.2")).toBe(true)
-  })
-})

package/src/cache/appMetadata.ts

@@ -1,88 +0,0 @@
-import { getAppClient } from "../redis/init"
-import { doWithDB, DocumentType } from "../db"
-import { Database, App } from "@budibase/types"
-
-export enum AppState {
-  INVALID = "invalid",
-}
-
-export interface DeletedApp {
-  state: AppState
-}
-
-const EXPIRY_SECONDS = 3600
-
-/**
- * The default populate app metadata function
- */
-async function populateFromDB(appId: string) {
-  return doWithDB(
-    appId,
-    (db: Database) => {
-      return db.get(DocumentType.APP_METADATA)
-    },
-    { skip_setup: true }
-  )
-}
-
-function isInvalid(metadata?: { state: string }) {
-  return !metadata || metadata.state === AppState.INVALID
-}
-
-/**
- * Get the requested app metadata by id.
- * Use redis cache to first read the app metadata.
- * If not present fallback to loading the app metadata directly and re-caching.
- * @param {string} appId the id of the app to get metadata from.
- * @returns {object} the app metadata.
- */
-export async function getAppMetadata(appId: string): Promise<App | DeletedApp> {
-  const client = await getAppClient()
-  // try cache
-  let metadata = await client.get(appId)
-  if (!metadata) {
-    let expiry: number | undefined = EXPIRY_SECONDS
-    try {
-      metadata = await populateFromDB(appId)
-    } catch (err: any) {
-      // app DB left around, but no metadata, it is invalid
-      if (err && err.status === 404) {
-        metadata = { state: AppState.INVALID }
-        // don't expire the reference to an invalid app, it'll only be
-        // updated if a metadata doc actually gets stored (app is remade/reverted)
-        expiry = undefined
-      } else {
-        throw err
-      }
-    }
-    // needed for cypress/some scenarios where the caching happens
-    // so quickly the requests can get slightly out of sync
-    // might store its invalid just before it stores its valid
-    if (isInvalid(metadata)) {
-      const temp = await client.get(appId)
-      if (temp) {
-        metadata = temp
-      }
-    }
-    await client.store(appId, metadata, expiry)
-  }
-
-  return metadata
-}
-
-/**
- * Invalidate/reset the cached metadata when a change occurs in the db.
- * @param appId {string} the cache key to bust/update.
- * @param newMetadata {object|undefined} optional - can simply provide the new metadata to update with.
- * @return {Promise<void>} will respond with success when cache is updated.
- */
-export async function invalidateAppMetadata(appId: string, newMetadata?: any) {
-  if (!appId) {
-    throw "Cannot invalidate if no app ID provided."
-  }
-  const client = await getAppClient()
-  await client.delete(appId)
-  if (newMetadata) {
-    await client.store(appId, newMetadata, EXPIRY_SECONDS)
-  }
-}

package/src/cache/base/index.ts

@@ -1,92 +0,0 @@
-import { getTenantId } from "../../context"
-import * as redis from "../../redis/init"
-import { Client } from "../../redis"
-
-function generateTenantKey(key: string) {
-  const tenantId = getTenantId()
-  return `${key}:${tenantId}`
-}
-
-export default class BaseCache {
-  client: Client | undefined
-
-  constructor(client: Client | undefined = undefined) {
-    this.client = client
-  }
-
-  async getClient() {
-    return !this.client ? await redis.getCacheClient() : this.client
-  }
-
-  async keys(pattern: string) {
-    const client = await this.getClient()
-    return client.keys(pattern)
-  }
-
-  /**
-   * Read only from the cache.
-   */
-  async get(key: string, opts = { useTenancy: true }) {
-    key = opts.useTenancy ? generateTenantKey(key) : key
-    const client = await this.getClient()
-    return client.get(key)
-  }
-
-  /**
-   * Write to the cache.
-   */
-  async store(
-    key: string,
-    value: any,
-    ttl: number | null = null,
-    opts = { useTenancy: true }
-  ) {
-    key = opts.useTenancy ? generateTenantKey(key) : key
-    const client = await this.getClient()
-    await client.store(key, value, ttl)
-  }
-
-  /**
-   * Remove from cache.
-   */
-  async delete(key: string, opts = { useTenancy: true }) {
-    key = opts.useTenancy ? generateTenantKey(key) : key
-    const client = await this.getClient()
-    return client.delete(key)
-  }
-
-  /**
-   * Read from the cache. Write to the cache if not exists.
-   */
-  async withCache(
-    key: string,
-    ttl: number,
-    fetchFn: any,
-    opts = { useTenancy: true }
-  ) {
-    const cachedValue = await this.get(key, opts)
-    if (cachedValue) {
-      return cachedValue
-    }
-
-    try {
-      const fetchedValue = await fetchFn()
-
-      await this.store(key, fetchedValue, ttl, opts)
-      return fetchedValue
-    } catch (err) {
-      console.error("Error fetching before cache - ", err)
-      throw err
-    }
-  }
-
-  async bustCache(key: string, opts = { client: null }) {
-    const client = await this.getClient()
-    try {
-      await client.delete(generateTenantKey(key))
-    } catch (err) {
-      console.error("Error busting cache - ", err)
-      throw err
-    }
-  }
-}

package/src/cache/generic.ts

@@ -1,30 +0,0 @@
-const BaseCache = require("./base")
-
-const GENERIC = new BaseCache.default()
-
-export enum CacheKey {
-  CHECKLIST = "checklist",
-  INSTALLATION = "installation",
-  ANALYTICS_ENABLED = "analyticsEnabled",
-  UNIQUE_TENANT_ID = "uniqueTenantId",
-  EVENTS = "events",
-  BACKFILL_METADATA = "backfillMetadata",
-  EVENTS_RATE_LIMIT = "eventsRateLimit",
-}
-
-export enum TTL {
-  ONE_MINUTE = 600,
-  ONE_HOUR = 3600,
-  ONE_DAY = 86400,
-}
-
-function performExport(funcName: string) {
-  return (...args: any) => GENERIC[funcName](...args)
-}
-
-export const keys = performExport("keys")
-export const get = performExport("get")
-export const store = performExport("store")
-export const destroy = performExport("delete")
-export const withCache = performExport("withCache")
-export const bustCache = performExport("bustCache")

package/src/cache/index.ts

@@ -1,5 +0,0 @@
-export * as generic from "./generic"
-export * as user from "./user"
-export * as app from "./appMetadata"
-export * as writethrough from "./writethrough"
-export * from "./generic"