@budibase/backend-core 3.2.4 → 3.2.6

package/src/migrations/tests/migrations.spec.ts

@@ -1,64 +0,0 @@
-import { testEnv, DBTestConfiguration } from "../../../tests/extra"
-import * as migrations from "../index"
-import * as context from "../../context"
-import { MigrationType } from "@budibase/types"
-
-testEnv.multiTenant()
-
-describe("migrations", () => {
-  const config = new DBTestConfiguration()
-
-  const migrationFunction = jest.fn()
-
-  const MIGRATIONS = [
-    {
-      type: MigrationType.GLOBAL,
-      name: "test" as any,
-      fn: migrationFunction,
-    },
-  ]
-
-  beforeEach(() => {
-    config.newTenant()
-  })
-
-  afterEach(async () => {
-    jest.clearAllMocks()
-  })
-
-  const migrate = () => {
-    return migrations.runMigrations(MIGRATIONS, {
-      tenantIds: [config.tenantId],
-    })
-  }
-
-  it("should run a new migration", async () => {
-    await config.doInTenant(async () => {
-      await migrate()
-      expect(migrationFunction).toHaveBeenCalled()
-      const db = context.getGlobalDB()
-      const doc = await migrations.getMigrationsDoc(db)
-      expect(doc.test).toBeDefined()
-    })
-  })
-
-  it("should match snapshot", async () => {
-    await config.doInTenant(async () => {
-      await migrate()
-      const doc = await migrations.getMigrationsDoc(context.getGlobalDB())
-      expect(doc).toMatchSnapshot()
-    })
-  })
-
-  it("should skip a previously run migration", async () => {
-    await config.doInTenant(async () => {
-      const db = context.getGlobalDB()
-      await migrate()
-      const previousDoc = await migrations.getMigrationsDoc(db)
-      await migrate()
-      const currentDoc = await migrations.getMigrationsDoc(db)
-      expect(migrationFunction).toHaveBeenCalledTimes(1)
-      expect(currentDoc.test).toBe(previousDoc.test)
-    })
-  })
-})

package/src/objectStore/buckets/app.ts

@@ -1,53 +0,0 @@
-import env from "../../environment"
-import * as objectStore from "../objectStore"
-import * as cloudfront from "../cloudfront"
-import qs from "querystring"
-import { DEFAULT_TENANT_ID, getTenantId } from "../../context"
-
-export function clientLibraryPath(appId: string) {
-  return `${objectStore.sanitizeKey(appId)}/budibase-client.js`
-}
-
-/**
- * Previously we used to serve the client library directly from Cloudfront, however
- * due to issues with the domain we were unable to continue doing this - keeping
- * incase we are able to switch back to CDN path again in future.
- */
-export function clientLibraryCDNUrl(appId: string, version: string) {
-  let file = clientLibraryPath(appId)
-  if (env.CLOUDFRONT_CDN) {
-    // append app version to bust the cache
-    if (version) {
-      file += `?v=${version}`
-    }
-    // don't need to use presigned for client with cloudfront
-    // file is public
-    return cloudfront.getUrl(file)
-  } else {
-    return objectStore.getPresignedUrl(env.APPS_BUCKET_NAME, file)
-  }
-}
-
-export function clientLibraryUrl(appId: string, version: string) {
-  let tenantId, qsParams: { appId: string; version: string; tenantId?: string }
-  try {
-    tenantId = getTenantId()
-  } finally {
-    qsParams = {
-      appId,
-      version,
-    }
-  }
-  if (tenantId && tenantId !== DEFAULT_TENANT_ID) {
-    qsParams.tenantId = tenantId
-  }
-  return `/api/assets/client?${qs.encode(qsParams)}`
-}
-
-export function getAppFileUrl(s3Key: string) {
-  if (env.CLOUDFRONT_CDN) {
-    return cloudfront.getPresignedUrl(s3Key)
-  } else {
-    return objectStore.getPresignedUrl(env.APPS_BUCKET_NAME, s3Key)
-  }
-}

package/src/objectStore/buckets/global.ts

@@ -1,29 +0,0 @@
-import env from "../../environment"
-import * as context from "../../context"
-import * as objectStore from "../objectStore"
-import * as cloudfront from "../cloudfront"
-
-// URLs
-
-export const getGlobalFileUrl = (type: string, name: string, etag?: string) => {
-  let file = getGlobalFileS3Key(type, name)
-  if (env.CLOUDFRONT_CDN) {
-    if (etag) {
-      file = `${file}?etag=${etag}`
-    }
-    return cloudfront.getPresignedUrl(file)
-  } else {
-    return objectStore.getPresignedUrl(env.GLOBAL_BUCKET_NAME, file)
-  }
-}
-
-// KEYS
-
-export const getGlobalFileS3Key = (type: string, name: string) => {
-  let file = `${type}/${name}`
-  if (env.MULTI_TENANCY) {
-    const tenantId = context.getTenantId()
-    file = `${tenantId}/${file}`
-  }
-  return file
-}

package/src/objectStore/buckets/index.ts

@@ -1,3 +0,0 @@
-export * from "./app"
-export * from "./global"
-export * from "./plugins"

package/src/objectStore/buckets/plugins.ts

@@ -1,71 +0,0 @@
-import env from "../../environment"
-import * as objectStore from "../objectStore"
-import * as context from "../../context"
-import * as cloudfront from "../cloudfront"
-import { Plugin } from "@budibase/types"
-
-// URLS
-
-export function enrichPluginURLs(plugins?: Plugin[]): Plugin[] {
-  if (!plugins || !plugins.length) {
-    return []
-  }
-  return plugins.map(plugin => {
-    const jsUrl = getPluginJSUrl(plugin)
-    const iconUrl = getPluginIconUrl(plugin)
-    return { ...plugin, jsUrl, iconUrl }
-  })
-}
-
-function getPluginJSUrl(plugin: Plugin) {
-  const s3Key = getPluginJSKey(plugin)
-  return getPluginUrl(s3Key)
-}
-
-function getPluginIconUrl(plugin: Plugin): string | undefined {
-  const s3Key = getPluginIconKey(plugin)
-  if (!s3Key) {
-    return
-  }
-  return getPluginUrl(s3Key)
-}
-
-function getPluginUrl(s3Key: string) {
-  if (env.CLOUDFRONT_CDN) {
-    return cloudfront.getPresignedUrl(s3Key)
-  } else {
-    return objectStore.getPresignedUrl(env.PLUGIN_BUCKET_NAME, s3Key)
-  }
-}
-
-// S3 KEYS
-
-export function getPluginJSKey(plugin: Plugin) {
-  return getPluginS3Key(plugin, "plugin.min.js")
-}
-
-export function getPluginIconKey(plugin: Plugin) {
-  // stored iconUrl is deprecated - hardcode to icon.svg in this case
-  const iconFileName = plugin.iconUrl ? "icon.svg" : plugin.iconFileName
-  if (!iconFileName) {
-    return
-  }
-  return getPluginS3Key(plugin, iconFileName)
-}
-
-function getPluginS3Key(plugin: Plugin, fileName: string) {
-  const s3Key = getPluginS3Dir(plugin.name)
-  return `${s3Key}/${fileName}`
-}
-
-export function getPluginS3Dir(pluginName: string) {
-  let s3Key = `${pluginName}`
-  if (env.MULTI_TENANCY) {
-    const tenantId = context.getTenantId()
-    s3Key = `${tenantId}/${s3Key}`
-  }
-  if (env.CLOUDFRONT_CDN) {
-    s3Key = `plugins/${s3Key}`
-  }
-  return s3Key
-}

package/src/objectStore/buckets/tests/app.spec.ts

@@ -1,161 +0,0 @@
-import * as app from "../app"
-import { testEnv } from "../../../../tests/extra"
-
-describe("app", () => {
-  beforeEach(() => {
-    testEnv.nodeJest()
-  })
-
-  function baseCheck(url: string, tenantId?: string) {
-    expect(url).toContain("/api/assets/client")
-    if (tenantId) {
-      expect(url).toContain(`tenantId=${tenantId}`)
-    }
-    expect(url).toContain("appId=app_123")
-    expect(url).toContain("version=2.0.0")
-  }
-
-  describe("clientLibraryUrl", () => {
-    function getClientUrl() {
-      return app.clientLibraryUrl("app_123/budibase-client.js", "2.0.0")
-    }
-
-    describe("single tenant", () => {
-      beforeAll(() => {
-        testEnv.singleTenant()
-      })
-
-      it("gets url in dev", () => {
-        testEnv.nodeDev()
-        const url = getClientUrl()
-        baseCheck(url)
-      })
-
-      it("gets url with custom S3", () => {
-        testEnv.withS3()
-        const url = getClientUrl()
-        baseCheck(url)
-      })
-
-      it("gets url with cloudfront + s3", () => {
-        testEnv.withCloudfront()
-        const url = getClientUrl()
-        baseCheck(url)
-      })
-    })
-
-    describe("multi tenant", () => {
-      beforeAll(() => {
-        testEnv.multiTenant()
-      })
-
-      it("gets url in dev", async () => {
-        testEnv.nodeDev()
-        await testEnv.withTenant(tenantId => {
-          const url = getClientUrl()
-          baseCheck(url, tenantId)
-        })
-      })
-
-      it("gets url with embedded minio", async () => {
-        await testEnv.withTenant(tenantId => {
-          testEnv.withMinio()
-          const url = getClientUrl()
-          baseCheck(url, tenantId)
-        })
-      })
-
-      it("gets url with custom S3", async () => {
-        await testEnv.withTenant(tenantId => {
-          testEnv.withS3()
-          const url = getClientUrl()
-          baseCheck(url, tenantId)
-        })
-      })
-
-      it("gets url with cloudfront + s3", async () => {
-        await testEnv.withTenant(tenantId => {
-          testEnv.withCloudfront()
-          const url = getClientUrl()
-          baseCheck(url, tenantId)
-        })
-      })
-    })
-  })
-
-  describe("getAppFileUrl", () => {
-    function getAppFileUrl() {
-      return app.getAppFileUrl("app_123/attachments/image.jpeg")
-    }
-
-    describe("single tenant", () => {
-      beforeAll(() => {
-        testEnv.multiTenant()
-      })
-
-      it("gets url with embedded minio", () => {
-        testEnv.withMinio()
-        const url = getAppFileUrl()
-        expect(url).toBe(
-          "/files/signed/prod-budi-app-assets/app_123/attachments/image.jpeg"
-        )
-      })
-
-      it("gets url with custom S3", () => {
-        testEnv.withS3()
-        const url = getAppFileUrl()
-        expect(url).toBe(
-          "http://s3.example.com/prod-budi-app-assets/app_123/attachments/image.jpeg"
-        )
-      })
-
-      it("gets url with cloudfront + s3", () => {
-        testEnv.withCloudfront()
-        const url = getAppFileUrl()
-        // omit rest of signed params
-        expect(
-          url.includes("http://cf.example.com/app_123/attachments/image.jpeg?")
-        ).toBe(true)
-      })
-    })
-
-    describe("multi tenant", () => {
-      beforeAll(() => {
-        testEnv.multiTenant()
-      })
-
-      it("gets url with embedded minio", async () => {
-        testEnv.withMinio()
-        await testEnv.withTenant(() => {
-          const url = getAppFileUrl()
-          expect(url).toBe(
-            "/files/signed/prod-budi-app-assets/app_123/attachments/image.jpeg"
-          )
-        })
-      })
-
-      it("gets url with custom S3", async () => {
-        testEnv.withS3()
-        await testEnv.withTenant(() => {
-          const url = getAppFileUrl()
-          expect(url).toBe(
-            "http://s3.example.com/prod-budi-app-assets/app_123/attachments/image.jpeg"
-          )
-        })
-      })
-
-      it("gets url with cloudfront + s3", async () => {
-        testEnv.withCloudfront()
-        await testEnv.withTenant(() => {
-          const url = getAppFileUrl()
-          // omit rest of signed params
-          expect(
-            url.includes(
-              "http://cf.example.com/app_123/attachments/image.jpeg?"
-            )
-          ).toBe(true)
-        })
-      })
-    })
-  })
-})

package/src/objectStore/buckets/tests/global.spec.ts

@@ -1,74 +0,0 @@
-import * as global from "../global"
-import { testEnv } from "../../../../tests/extra"
-
-describe("global", () => {
-  describe("getGlobalFileUrl", () => {
-    function getGlobalFileUrl() {
-      return global.getGlobalFileUrl("settings", "logoUrl", "etag")
-    }
-
-    describe("single tenant", () => {
-      beforeAll(() => {
-        testEnv.singleTenant()
-      })
-
-      it("gets url with embedded minio", () => {
-        testEnv.withMinio()
-        const url = getGlobalFileUrl()
-        expect(url).toBe("/files/signed/global/settings/logoUrl")
-      })
-
-      it("gets url with custom S3", () => {
-        testEnv.withS3()
-        const url = getGlobalFileUrl()
-        expect(url).toBe("http://s3.example.com/global/settings/logoUrl")
-      })
-
-      it("gets url with cloudfront + s3", () => {
-        testEnv.withCloudfront()
-        const url = getGlobalFileUrl()
-        // omit rest of signed params
-        expect(
-          url.includes("http://cf.example.com/settings/logoUrl?etag=etag&")
-        ).toBe(true)
-      })
-    })
-
-    describe("multi tenant", () => {
-      beforeAll(() => {
-        testEnv.multiTenant()
-      })
-
-      it("gets url with embedded minio", async () => {
-        testEnv.withMinio()
-        await testEnv.withTenant(tenantId => {
-          const url = getGlobalFileUrl()
-          expect(url).toBe(`/files/signed/global/${tenantId}/settings/logoUrl`)
-        })
-      })
-
-      it("gets url with custom S3", async () => {
-        testEnv.withS3()
-        await testEnv.withTenant(tenantId => {
-          const url = getGlobalFileUrl()
-          expect(url).toBe(
-            `http://s3.example.com/global/${tenantId}/settings/logoUrl`
-          )
-        })
-      })
-
-      it("gets url with cloudfront + s3", async () => {
-        testEnv.withCloudfront()
-        await testEnv.withTenant(tenantId => {
-          const url = getGlobalFileUrl()
-          // omit rest of signed params
-          expect(
-            url.includes(
-              `http://cf.example.com/${tenantId}/settings/logoUrl?etag=etag&`
-            )
-          ).toBe(true)
-        })
-      })
-    })
-  })
-})

package/src/objectStore/buckets/tests/plugins.spec.ts

@@ -1,111 +0,0 @@
-import * as plugins from "../plugins"
-import { structures } from "../../../../tests"
-import { testEnv } from "../../../../tests/extra"
-
-describe("plugins", () => {
-  describe("enrichPluginURLs", () => {
-    const plugin = structures.plugins.plugin()
-
-    function getEnrichedPluginUrls() {
-      const enriched = plugins.enrichPluginURLs([plugin])[0]
-      return {
-        jsUrl: enriched.jsUrl!,
-        iconUrl: enriched.iconUrl!,
-      }
-    }
-
-    describe("single tenant", () => {
-      beforeAll(() => {
-        testEnv.singleTenant()
-      })
-
-      it("gets url with embedded minio", () => {
-        testEnv.withMinio()
-        const urls = getEnrichedPluginUrls()
-        expect(urls.jsUrl).toBe(
-          `/files/signed/plugins/${plugin.name}/plugin.min.js`
-        )
-        expect(urls.iconUrl).toBe(
-          `/files/signed/plugins/${plugin.name}/icon.svg`
-        )
-      })
-
-      it("gets url with custom S3", () => {
-        testEnv.withS3()
-        const urls = getEnrichedPluginUrls()
-        expect(urls.jsUrl).toBe(
-          `http://s3.example.com/plugins/${plugin.name}/plugin.min.js`
-        )
-        expect(urls.iconUrl).toBe(
-          `http://s3.example.com/plugins/${plugin.name}/icon.svg`
-        )
-      })
-
-      it("gets url with cloudfront + s3", () => {
-        testEnv.withCloudfront()
-        const urls = getEnrichedPluginUrls()
-        // omit rest of signed params
-        expect(
-          urls.jsUrl.includes(
-            `http://cf.example.com/plugins/${plugin.name}/plugin.min.js?`
-          )
-        ).toBe(true)
-        expect(
-          urls.iconUrl.includes(
-            `http://cf.example.com/plugins/${plugin.name}/icon.svg?`
-          )
-        ).toBe(true)
-      })
-    })
-
-    describe("multi tenant", () => {
-      beforeAll(() => {
-        testEnv.multiTenant()
-      })
-
-      it("gets url with embedded minio", async () => {
-        testEnv.withMinio()
-        await testEnv.withTenant(tenantId => {
-          const urls = getEnrichedPluginUrls()
-          expect(urls.jsUrl).toBe(
-            `/files/signed/plugins/${tenantId}/${plugin.name}/plugin.min.js`
-          )
-          expect(urls.iconUrl).toBe(
-            `/files/signed/plugins/${tenantId}/${plugin.name}/icon.svg`
-          )
-        })
-      })
-
-      it("gets url with custom S3", async () => {
-        testEnv.withS3()
-        await testEnv.withTenant(tenantId => {
-          const urls = getEnrichedPluginUrls()
-          expect(urls.jsUrl).toBe(
-            `http://s3.example.com/plugins/${tenantId}/${plugin.name}/plugin.min.js`
-          )
-          expect(urls.iconUrl).toBe(
-            `http://s3.example.com/plugins/${tenantId}/${plugin.name}/icon.svg`
-          )
-        })
-      })
-
-      it("gets url with cloudfront + s3", async () => {
-        testEnv.withCloudfront()
-        await testEnv.withTenant(tenantId => {
-          const urls = getEnrichedPluginUrls()
-          // omit rest of signed params
-          expect(
-            urls.jsUrl.includes(
-              `http://cf.example.com/plugins/${tenantId}/${plugin.name}/plugin.min.js?`
-            )
-          ).toBe(true)
-          expect(
-            urls.iconUrl.includes(
-              `http://cf.example.com/plugins/${tenantId}/${plugin.name}/icon.svg?`
-            )
-          ).toBe(true)
-        })
-      })
-    })
-  })
-})

package/src/objectStore/cloudfront.ts

@@ -1,41 +0,0 @@
-import env from "../environment"
-import * as cfsign from "aws-cloudfront-sign"
-
-let PRIVATE_KEY: string | undefined
-
-function getPrivateKey() {
-  if (!env.CLOUDFRONT_PRIVATE_KEY_64) {
-    throw new Error("CLOUDFRONT_PRIVATE_KEY_64 is not set")
-  }
-
-  if (PRIVATE_KEY) {
-    return PRIVATE_KEY
-  }
-
-  PRIVATE_KEY = Buffer.from(env.CLOUDFRONT_PRIVATE_KEY_64, "base64").toString(
-    "utf-8"
-  )
-
-  return PRIVATE_KEY
-}
-
-const getCloudfrontSignParams = () => {
-  return {
-    keypairId: env.CLOUDFRONT_PUBLIC_KEY_ID!,
-    privateKeyString: getPrivateKey(),
-    expireTime: new Date().getTime() + 1000 * 60 * 60 * 24, // 1 day
-  }
-}
-
-export const getPresignedUrl = (s3Key: string) => {
-  const url = getUrl(s3Key)
-  return cfsign.getSignedUrl(url, getCloudfrontSignParams())
-}
-
-export const getUrl = (s3Key: string) => {
-  let prefix = "/"
-  if (s3Key.startsWith("/")) {
-    prefix = ""
-  }
-  return `${env.CLOUDFRONT_CDN}${prefix}${s3Key}`
-}

package/src/objectStore/index.ts

@@ -1,3 +0,0 @@
-export * from "./objectStore"
-export * from "./utils"
-export * from "./buckets"