@budibase/server 2.5.6-alpha.14 → 2.5.6-alpha.16

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "2.5.6-alpha.14",
+  "version": "2.5.6-alpha.16",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -45,12 +45,12 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@budibase/backend-core": "2.5.6-alpha.14",
-    "@budibase/client": "2.5.6-alpha.14",
-    "@budibase/pro": "2.5.6-alpha.13",
-    "@budibase/shared-core": "2.5.6-alpha.14",
-    "@budibase/string-templates": "2.5.6-alpha.14",
-    "@budibase/types": "2.5.6-alpha.14",
+    "@budibase/backend-core": "2.5.6-alpha.16",
+    "@budibase/client": "2.5.6-alpha.16",
+    "@budibase/pro": "2.5.6-alpha.15",
+    "@budibase/shared-core": "2.5.6-alpha.16",
+    "@budibase/string-templates": "2.5.6-alpha.16",
+    "@budibase/types": "2.5.6-alpha.16",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -176,5 +176,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "0ef74d04e29e43ce5483de5e08a373d78d908829"
+  "gitHead": "5d2b4112effb2cc3dbb67a95f60e38ae0f672559"
 }

package/src/api/index.ts

@@ -4,7 +4,6 @@ import currentApp from "../middleware/currentapp"
 import zlib from "zlib"
 import { mainRoutes, staticRoutes, publicRoutes } from "./routes"
 import pkg from "../../package.json"
-import env from "../environment"
 import { middleware as pro } from "@budibase/pro"
 export { shutdown } from "./routes/public"
 const compress = require("koa-compress")

package/src/api/routes/index.ts

@@ -22,7 +22,6 @@ import queryRoutes from "./query"
 import backupRoutes from "./backup"
 import metadataRoutes from "./metadata"
 import devRoutes from "./dev"
-import cloudRoutes from "./cloud"
 import migrationRoutes from "./migrations"
 import pluginRoutes from "./plugin"
 import opsRoutes from "./ops"
@@ -60,7 +59,6 @@ export const mainRoutes: Router[] = [
   queryRoutes,
   metadataRoutes,
   devRoutes,
-  cloudRoutes,
   rowRoutes,
   migrationRoutes,
   pluginRoutes,

package/src/sdk/app/backups/exports.ts

@@ -148,41 +148,6 @@ export async function exportApp(appId: string, config?: ExportOpts) {
   }
 }
 
-/**
- * Export all apps + global DB (if supplied) to a single tarball, this includes
- * the attachments for each app as well.
- * @param {object[]} appMetadata The IDs and names of apps to export.
- * @param {string} globalDbContents The contents of the global DB to export as well.
- * @return {string} The path to the tarball.
- */
-export async function exportMultipleApps(
-  appMetadata: { appId: string; name: string }[],
-  globalDbContents?: string
-) {
-  const tmpPath = join(budibaseTempDir(), uuid())
-  fs.mkdirSync(tmpPath)
-  let exportPromises: Promise<void>[] = []
-  // export each app to a directory, then move it into the complete export
-  const exportAndMove = async (appId: string, appName: string) => {
-    const path = await exportApp(appId)
-    await fs.promises.rename(path, join(tmpPath, appName))
-  }
-  for (let metadata of appMetadata) {
-    exportPromises.push(exportAndMove(metadata.appId, metadata.name))
-  }
-  // wait for all exports to finish
-  await Promise.all(exportPromises)
-  // add the global DB contents
-  if (globalDbContents) {
-    fs.writeFileSync(join(tmpPath, GLOBAL_DB_EXPORT_FILE), globalDbContents)
-  }
-  const appNames = appMetadata.map(metadata => metadata.name)
-  const tarPath = tarFilesToTmp(tmpPath, [...appNames, GLOBAL_DB_EXPORT_FILE])
-  // clear up the tmp path now tarball generated
-  fs.rmSync(tmpPath, { recursive: true, force: true })
-  return tarPath
-}
-
 /**
  * Streams a backup of the database state for an app
  * @param {string} appId The ID of the app which is to be backed up.

package/dist/api/controllers/cloud.js

@@ -1,130 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.importApps = exports.hasBeenImported = exports.exportApps = void 0;
-const environment_1 = __importDefault(require("../../environment"));
-const backend_core_1 = require("@budibase/backend-core");
-const fileSystem_1 = require("../../utilities/fileSystem");
-const utilities_1 = require("../../utilities");
-const utils_1 = require("../../db/utils");
-const application_1 = require("./application");
-const path_1 = require("path");
-const sdk_1 = __importDefault(require("../../sdk"));
-function createApp(appName, appDirectory) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const ctx = {
-            request: {
-                body: {
-                    useTemplate: true,
-                    name: appName,
-                },
-                files: {
-                    templateFile: {
-                        path: appDirectory,
-                    },
-                },
-            },
-        };
-        // @ts-ignore
-        return (0, application_1.create)(ctx);
-    });
-}
-function getAllDocType(db, docType) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const response = yield db.allDocs((0, utils_1.getDocParams)(docType, null, {
-            include_docs: true,
-        }));
-        return response.rows.map(row => row.doc);
-    });
-}
-function exportApps(ctx) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (environment_1.default.SELF_HOSTED || !environment_1.default.MULTI_TENANCY) {
-            ctx.throw(400, "Exporting only allowed in multi-tenant cloud environments.");
-        }
-        const apps = (yield backend_core_1.db.getAllApps({ all: true }));
-        const globalDBString = yield sdk_1.default.backups.exportDB(backend_core_1.db.getGlobalDBName(), {
-            filter: (doc) => !doc._id.startsWith(utils_1.DocumentType.USER),
-        });
-        // only export the dev apps as they will be the latest, the user can republish the apps
-        // in their self-hosted environment
-        let appMetadata = apps
-            .filter((app) => (0, utils_1.isDevAppID)(app.appId || app._id))
-            .map((app) => ({ appId: (app.appId || app._id), name: app.name }));
-        const tmpPath = yield sdk_1.default.backups.exportMultipleApps(appMetadata, globalDBString);
-        const filename = `cloud-export-${new Date().getTime()}.tar.gz`;
-        ctx.attachment(filename);
-        ctx.body = (0, fileSystem_1.streamFile)(tmpPath);
-    });
-}
-exports.exportApps = exportApps;
-function checkHasBeenImported() {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!environment_1.default.SELF_HOSTED) {
-            return true;
-        }
-        const apps = yield backend_core_1.db.getAllApps({ all: true });
-        return apps.length !== 0;
-    });
-}
-function hasBeenImported(ctx) {
-    return __awaiter(this, void 0, void 0, function* () {
-        ctx.body = {
-            imported: yield checkHasBeenImported(),
-        };
-    });
-}
-exports.hasBeenImported = hasBeenImported;
-function importApps(ctx) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!environment_1.default.SELF_HOSTED) {
-            ctx.throw(400, "Importing only allowed in self hosted environments.");
-        }
-        const beenImported = yield checkHasBeenImported();
-        if (beenImported || !ctx.request.files || !ctx.request.files.importFile) {
-            ctx.throw(400, "Import file is required and environment must be fresh to import apps.");
-        }
-        const file = ctx.request.files.importFile;
-        if (Array.isArray(file)) {
-            ctx.throw(400, "Single file is required");
-        }
-        if (file.type !== "application/gzip" && file.type !== "application/x-gzip") {
-            ctx.throw(400, "Import file must be a gzipped tarball.");
-        }
-        // initially get all the app databases out of the tarball
-        const tmpPath = sdk_1.default.backups.untarFile(file);
-        const globalDbImport = sdk_1.default.backups.getGlobalDBFile(tmpPath);
-        const appNames = sdk_1.default.backups.getListOfAppsInMulti(tmpPath);
-        const globalDb = backend_core_1.tenancy.getGlobalDB();
-        // load the global db first
-        yield globalDb.load((0, utilities_1.stringToReadStream)(globalDbImport));
-        for (let appName of appNames) {
-            yield createApp(appName, (0, path_1.join)(tmpPath, appName));
-        }
-        // if there are any users make sure to remove them
-        let users = yield getAllDocType(globalDb, utils_1.DocumentType.USER);
-        let userDeletionPromises = [];
-        for (let user of users) {
-            userDeletionPromises.push(globalDb.remove(user._id, user._rev));
-        }
-        if (userDeletionPromises.length > 0) {
-            yield Promise.all(userDeletionPromises);
-        }
-        yield globalDb.bulkDocs(users);
-        ctx.body = {
-            message: "Apps successfully imported.",
-        };
-    });
-}
-exports.importApps = importApps;

package/dist/api/routes/cloud.js

@@ -1,39 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const router_1 = __importDefault(require("@koa/router"));
-const controller = __importStar(require("../controllers/cloud"));
-const authorized_1 = __importDefault(require("../../middleware/authorized"));
-const backend_core_1 = require("@budibase/backend-core");
-const router = new router_1.default();
-router
-    .get("/api/cloud/export", (0, authorized_1.default)(backend_core_1.permissions.BUILDER), controller.exportApps)
-    // has to be public, only run if apps don't exist
-    .post("/api/cloud/import", controller.importApps)
-    .get("/api/cloud/import/complete", controller.hasBeenImported);
-exports.default = router;

package/src/api/controllers/cloud.ts

@@ -1,119 +0,0 @@
-import env from "../../environment"
-import { db as dbCore, tenancy } from "@budibase/backend-core"
-import { streamFile } from "../../utilities/fileSystem"
-import { stringToReadStream } from "../../utilities"
-import { getDocParams, DocumentType, isDevAppID } from "../../db/utils"
-import { create } from "./application"
-import { join } from "path"
-import sdk from "../../sdk"
-import { App, Ctx, Database } from "@budibase/types"
-
-async function createApp(appName: string, appDirectory: string) {
-  const ctx = {
-    request: {
-      body: {
-        useTemplate: true,
-        name: appName,
-      },
-      files: {
-        templateFile: {
-          path: appDirectory,
-        },
-      },
-    },
-  }
-  // @ts-ignore
-  return create(ctx)
-}
-
-async function getAllDocType(db: Database, docType: string) {
-  const response = await db.allDocs(
-    getDocParams(docType, null, {
-      include_docs: true,
-    })
-  )
-  return response.rows.map(row => row.doc)
-}
-
-export async function exportApps(ctx: Ctx) {
-  if (env.SELF_HOSTED || !env.MULTI_TENANCY) {
-    ctx.throw(400, "Exporting only allowed in multi-tenant cloud environments.")
-  }
-  const apps = (await dbCore.getAllApps({ all: true })) as App[]
-  const globalDBString = await sdk.backups.exportDB(dbCore.getGlobalDBName(), {
-    filter: (doc: any) => !doc._id.startsWith(DocumentType.USER),
-  })
-  // only export the dev apps as they will be the latest, the user can republish the apps
-  // in their self-hosted environment
-  let appMetadata = apps
-    .filter((app: App) => isDevAppID(app.appId || app._id))
-    .map((app: App) => ({ appId: (app.appId || app._id)!, name: app.name }))
-  const tmpPath = await sdk.backups.exportMultipleApps(
-    appMetadata,
-    globalDBString
-  )
-  const filename = `cloud-export-${new Date().getTime()}.tar.gz`
-  ctx.attachment(filename)
-  ctx.body = streamFile(tmpPath)
-}
-
-async function checkHasBeenImported() {
-  if (!env.SELF_HOSTED) {
-    return true
-  }
-  const apps = await dbCore.getAllApps({ all: true })
-  return apps.length !== 0
-}
-
-export async function hasBeenImported(ctx: Ctx) {
-  ctx.body = {
-    imported: await checkHasBeenImported(),
-  }
-}
-
-export async function importApps(ctx: Ctx) {
-  if (!env.SELF_HOSTED) {
-    ctx.throw(400, "Importing only allowed in self hosted environments.")
-  }
-  const beenImported = await checkHasBeenImported()
-  if (beenImported || !ctx.request.files || !ctx.request.files.importFile) {
-    ctx.throw(
-      400,
-      "Import file is required and environment must be fresh to import apps."
-    )
-  }
-  const file = ctx.request.files.importFile as any
-  if (Array.isArray(file)) {
-    ctx.throw(400, "Single file is required")
-  }
-  if (file.type !== "application/gzip" && file.type !== "application/x-gzip") {
-    ctx.throw(400, "Import file must be a gzipped tarball.")
-  }
-
-  // initially get all the app databases out of the tarball
-  const tmpPath = sdk.backups.untarFile(file)
-  const globalDbImport = sdk.backups.getGlobalDBFile(tmpPath)
-  const appNames = sdk.backups.getListOfAppsInMulti(tmpPath)
-
-  const globalDb = tenancy.getGlobalDB()
-  // load the global db first
-  await globalDb.load(stringToReadStream(globalDbImport))
-  for (let appName of appNames) {
-    await createApp(appName, join(tmpPath, appName))
-  }
-
-  // if there are any users make sure to remove them
-  let users = await getAllDocType(globalDb, DocumentType.USER)
-  let userDeletionPromises = []
-  for (let user of users) {
-    userDeletionPromises.push(globalDb.remove(user._id, user._rev))
-  }
-  if (userDeletionPromises.length > 0) {
-    await Promise.all(userDeletionPromises)
-  }
-
-  await globalDb.bulkDocs(users)
-  ctx.body = {
-    message: "Apps successfully imported.",
-  }
-}

package/src/api/routes/cloud.ts

@@ -1,18 +0,0 @@
-import Router from "@koa/router"
-import * as controller from "../controllers/cloud"
-import authorized from "../../middleware/authorized"
-import { permissions } from "@budibase/backend-core"
-
-const router: Router = new Router()
-
-router
-  .get(
-    "/api/cloud/export",
-    authorized(permissions.BUILDER),
-    controller.exportApps
-  )
-  // has to be public, only run if apps don't exist
-  .post("/api/cloud/import", controller.importApps)
-  .get("/api/cloud/import/complete", controller.hasBeenImported)
-
-export default router

package/src/api/routes/tests/cloud.spec.ts

@@ -1,54 +0,0 @@
-import { App } from "@budibase/types"
-
-jest.setTimeout(30000)
-
-import { AppStatus } from "../../../db/utils"
-
-import * as setup from "./utilities"
-
-import { wipeDb } from "./utilities/TestFunctions"
-import { tenancy } from "@budibase/backend-core"
-
-describe("/cloud", () => {
-  let request = setup.getRequest()!
-  let config = setup.getConfig()
-
-  afterAll(setup.afterAll)
-
-  beforeAll(async () => {
-    // Importing is only allowed in self hosted environments
-    await config.init()
-    config.modeSelf()
-  })
-
-  describe("import", () => {
-    it("should be able to import apps", async () => {
-      // first we need to delete any existing apps on the system so it looks clean otherwise the
-      // import will not run
-      await wipeDb()
-
-      // Perform the import
-      const res = await request
-        .post(`/api/cloud/import`)
-        .set(config.publicHeaders())
-        .attach("importFile", "src/api/routes/tests/data/export-test.tar.gz")
-        .expect(200)
-      expect(res.body.message).toEqual("Apps successfully imported.")
-
-      // get a count of apps after the import
-      const postImportApps = await request
-        .get(`/api/applications?status=${AppStatus.ALL}`)
-        .set(config.publicHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-
-      const apps = postImportApps.body as App[]
-      // There are two apps in the file that was imported so check for this
-      expect(apps.length).toEqual(2)
-      // The new tenant id was assigned to the imported apps
-      expect(tenancy.getTenantIDFromAppID(apps[0].appId)).toBe(
-        config.getTenantId()
-      )
-    })
-  })
-})