@budibase/server 2.2.12-alpha.5 → 2.2.13

package/dist/utilities/fileSystem/filesystem.js

@@ -1,182 +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.deleteFolderFileSystem = exports.findFileRec = exports.extractTarball = exports.createTempFolder = exports.readFileSync = exports.sendTempFile = exports.stringToFileStream = exports.storeTempFile = exports.streamFile = exports.apiFileReturn = exports.loadHandlebarsFile = exports.checkDevelopmentEnvironment = exports.init = exports.TOP_LEVEL_PATH = void 0;
-const { budibaseTempDir } = require("../budibaseDir");
-const fs = require("fs");
-const { join } = require("path");
-const uuid = require("uuid/v4");
-const env = require("../../environment");
-const tar_1 = __importDefault(require("tar"));
-exports.TOP_LEVEL_PATH = join(__dirname, "..", "..", "..");
-/**
- * Upon first startup of instance there may not be everything we need in tmp directory, set it up.
- */
-const init = () => {
-    const tempDir = budibaseTempDir();
-    if (!fs.existsSync(tempDir)) {
-        // some test cases fire this quickly enough that
-        // synchronous cases can end up here at the same time
-        try {
-            fs.mkdirSync(tempDir);
-        }
-        catch (err) {
-            if (!err || err.code !== "EEXIST") {
-                throw err;
-            }
-        }
-    }
-    const clientLibPath = join(budibaseTempDir(), "budibase-client.js");
-    if (env.isTest() && !fs.existsSync(clientLibPath)) {
-        fs.copyFileSync(require.resolve("@budibase/client"), clientLibPath);
-    }
-};
-exports.init = init;
-/**
- * Checks if the system is currently in development mode and if it is makes sure
- * everything required to function is ready.
- */
-const checkDevelopmentEnvironment = () => {
-    if (!env.isDev() || env.isTest()) {
-        return;
-    }
-    if (!fs.existsSync(budibaseTempDir())) {
-        fs.mkdirSync(budibaseTempDir());
-    }
-    let error;
-    if (!fs.existsSync(join(process.cwd(), ".env"))) {
-        error = "Must run via yarn once to generate environment.";
-    }
-    if (error) {
-        console.error(error);
-        process.exit(-1);
-    }
-};
-exports.checkDevelopmentEnvironment = checkDevelopmentEnvironment;
-/**
- * Used to retrieve a handlebars file from the system which will be used as a template.
- * This is allowable as the template handlebars files should be static and identical across
- * the cluster.
- * @param {string} path The path to the handlebars file which is to be loaded.
- * @returns {string} The loaded handlebars file as a string - loaded as utf8.
- */
-const loadHandlebarsFile = (path) => {
-    return fs.readFileSync(path, "utf8");
-};
-exports.loadHandlebarsFile = loadHandlebarsFile;
-/**
- * When return a file from the API need to write the file to the system temporarily so we
- * can create a read stream to send.
- * @param {string} contents the contents of the file which is to be returned from the API.
- * @return {Object} the read stream which can be put into the koa context body.
- */
-const apiFileReturn = (contents) => {
-    const path = join(budibaseTempDir(), uuid());
-    fs.writeFileSync(path, contents);
-    return fs.createReadStream(path);
-};
-exports.apiFileReturn = apiFileReturn;
-const streamFile = (path) => {
-    return fs.createReadStream(path);
-};
-exports.streamFile = streamFile;
-/**
- * Writes the provided contents to a temporary file, which can be used briefly.
- * @param {string} fileContents contents which will be written to a temp file.
- * @return {string} the path to the temp file.
- */
-const storeTempFile = (fileContents) => {
-    const path = join(budibaseTempDir(), uuid());
-    fs.writeFileSync(path, fileContents);
-    return path;
-};
-exports.storeTempFile = storeTempFile;
-/**
- * Utility function for getting a file read stream - a simple in memory buffered read
- * stream doesn't work for pouchdb.
- */
-const stringToFileStream = (contents) => {
-    const path = (0, exports.storeTempFile)(contents);
-    return fs.createReadStream(path);
-};
-exports.stringToFileStream = stringToFileStream;
-/**
- * Creates a temp file and returns it from the API.
- * @param {string} fileContents the contents to be returned in file.
- */
-const sendTempFile = (fileContents) => {
-    const path = (0, exports.storeTempFile)(fileContents);
-    return fs.createReadStream(path);
-};
-exports.sendTempFile = sendTempFile;
-/**
- * All file reads come through here just to make sure all of them make sense
- * allows a centralised location to check logic is all good.
- */
-const readFileSync = (filepath, options = "utf8") => {
-    return fs.readFileSync(filepath, options);
-};
-exports.readFileSync = readFileSync;
-const createTempFolder = (item) => {
-    const path = join(budibaseTempDir(), item);
-    try {
-        // remove old tmp directories automatically - don't combine
-        if (fs.existsSync(path)) {
-            fs.rmSync(path, { recursive: true, force: true });
-        }
-        fs.mkdirSync(path);
-    }
-    catch (err) {
-        throw new Error(`Path cannot be created: ${err.message}`);
-    }
-    return path;
-};
-exports.createTempFolder = createTempFolder;
-const extractTarball = (fromFilePath, toPath) => __awaiter(void 0, void 0, void 0, function* () {
-    yield tar_1.default.extract({
-        file: fromFilePath,
-        C: toPath,
-    });
-});
-exports.extractTarball = extractTarball;
-/**
- * Find for a file recursively from start path applying filter, return first match
- */
-const findFileRec = (startPath, filter) => {
-    if (!fs.existsSync(startPath)) {
-        return;
-    }
-    const files = fs.readdirSync(startPath);
-    for (let i = 0, len = files.length; i < len; i++) {
-        const filename = join(startPath, files[i]);
-        const stat = fs.lstatSync(filename);
-        if (stat.isDirectory()) {
-            return (0, exports.findFileRec)(filename, filter);
-        }
-        else if (filename.endsWith(filter)) {
-            return filename;
-        }
-    }
-};
-exports.findFileRec = findFileRec;
-/**
- * Remove a folder which is not empty from the file system
- */
-const deleteFolderFileSystem = (path) => {
-    if (!fs.existsSync(path)) {
-        return;
-    }
-    fs.rmSync(path, { recursive: true, force: true });
-};
-exports.deleteFolderFileSystem = deleteFolderFileSystem;

package/dist/utilities/fileSystem/plugin.js

@@ -1,63 +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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDatasourcePlugin = exports.getPluginMetadata = void 0;
-const { budibaseTempDir } = require("../budibaseDir");
-const fs = require("fs");
-const { join } = require("path");
-const backend_core_1 = require("@budibase/backend-core");
-const DATASOURCE_PATH = join(budibaseTempDir(), "datasource");
-const getPluginMetadata = (path) => __awaiter(void 0, void 0, void 0, function* () {
-    let metadata = {};
-    try {
-        const pkg = fs.readFileSync(join(path, "package.json"), "utf8");
-        const schema = fs.readFileSync(join(path, "schema.json"), "utf8");
-        metadata.schema = JSON.parse(schema);
-        metadata.package = JSON.parse(pkg);
-        if (!metadata.package.name ||
-            !metadata.package.version ||
-            !metadata.package.description) {
-            throw new Error("package.json is missing one of 'name', 'version' or 'description'.");
-        }
-    }
-    catch (err) {
-        throw new Error(`Unable to process schema.json/package.json in plugin. ${err.message}`);
-    }
-    return { metadata, directory: path };
-});
-exports.getPluginMetadata = getPluginMetadata;
-const getDatasourcePlugin = (plugin) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    const hash = (_a = plugin.schema) === null || _a === void 0 ? void 0 : _a.hash;
-    if (!fs.existsSync(DATASOURCE_PATH)) {
-        fs.mkdirSync(DATASOURCE_PATH);
-    }
-    const filename = join(DATASOURCE_PATH, plugin.name);
-    const metadataName = `${filename}.bbmetadata`;
-    if (fs.existsSync(filename)) {
-        const currentHash = fs.readFileSync(metadataName, "utf8");
-        // if hash is the same return the file, otherwise remove it and re-download
-        if (currentHash === hash) {
-            return require(filename);
-        }
-        else {
-            console.log(`Updating plugin: ${plugin.name}`);
-            delete require.cache[require.resolve(filename)];
-            fs.unlinkSync(filename);
-        }
-    }
-    const pluginKey = backend_core_1.objectStore.getPluginJSKey(plugin);
-    const pluginJs = yield backend_core_1.objectStore.retrieve(backend_core_1.objectStore.ObjectStoreBuckets.PLUGINS, pluginKey);
-    fs.writeFileSync(filename, pluginJs);
-    fs.writeFileSync(metadataName, hash);
-    return require(filename);
-});
-exports.getDatasourcePlugin = getDatasourcePlugin;

package/dist/utilities/fileSystem/template.js

@@ -1,44 +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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadTemplate = exports.getTemplateStream = void 0;
-const fs = require("fs");
-const { join } = require("path");
-const constants_1 = require("../../constants");
-const backend_core_1 = require("@budibase/backend-core");
-/**
- * This function manages temporary template files which are stored by Koa.
- * @param {Object} template The template object retrieved from the Koa context object.
- * @returns {Object} Returns an fs read stream which can be loaded into the database.
- */
-const getTemplateStream = (template) => __awaiter(void 0, void 0, void 0, function* () {
-    if (template.file) {
-        return fs.createReadStream(template.file.path);
-    }
-    else {
-        const [type, name] = template.key.split("/");
-        const tmpPath = yield (0, exports.downloadTemplate)(type, name);
-        return fs.createReadStream(join(tmpPath, name, "db", "dump.txt"));
-    }
-});
-exports.getTemplateStream = getTemplateStream;
-/**
- * Retrieves a template and pipes it to minio as well as making it available temporarily.
- * @param {string} type The type of template which is to be retrieved.
- * @param name
- * @return {Promise<*>}
- */
-const downloadTemplate = (type, name) => __awaiter(void 0, void 0, void 0, function* () {
-    const DEFAULT_TEMPLATES_BUCKET = "prod-budi-templates.s3-eu-west-1.amazonaws.com";
-    const templateUrl = `https://${DEFAULT_TEMPLATES_BUCKET}/templates/${type}/${name}.tar.gz`;
-    return backend_core_1.objectStore.downloadTarball(templateUrl, constants_1.ObjectStoreBuckets.TEMPLATES, type);
-});
-exports.downloadTemplate = downloadTemplate;

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

@@ -1,65 +0,0 @@
-import { db as dbCore } from "@budibase/backend-core"
-import { AppStatus } from "../../../db/utils"
-
-import * as setup from "./utilities"
-
-describe("/cloud", () => {
-  let request = setup.getRequest()
-  let config = setup.getConfig()
-
-  afterAll(setup.afterAll)
-
-  beforeEach(async () => {
-    await config.init()
-  })
-
-  afterEach(async () => {
-    // clear all mocks
-    jest.clearAllMocks()
-  })
-
-  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 request
-        .post(
-          `/api/applications/${dbCore.getProdAppID(
-            config.getAppId()
-          )}/unpublish`
-        )
-        .set(config.defaultHeaders())
-        .expect(204)
-      await request
-        .delete(`/api/applications/${config.getAppId()}`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-
-      // get a count of apps before the import
-      const preImportApps = await request
-        .get(`/api/applications?status=${AppStatus.ALL}`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-
-      // Perform the import
-      const res = await request
-        .post(`/api/cloud/import`)
-        .attach("importFile", "src/api/routes/tests/data/export-test.tar.gz")
-        .set(config.defaultHeaders())
-        .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.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-
-      // There are two apps in the file that was imported so check for this
-      expect(postImportApps.body.length).toEqual(2)
-    })
-  })
-})

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

@@ -1,179 +0,0 @@
-let mockObjectStore = jest.fn().mockImplementation(() => {
-  return [{ name: "test.js" }]
-})
-
-let deleteFolder = jest.fn().mockImplementation()
-jest.mock("@budibase/backend-core", () => {
-  const core = jest.requireActual("@budibase/backend-core")
-  return {
-    ...core,
-    objectStore: {
-      ...core.objectStore,
-      upload: jest.fn(),
-      uploadDirectory: mockObjectStore,
-      deleteFolder: deleteFolder,
-    },
-  }
-})
-
-import { events } from "@budibase/backend-core"
-import * as setup from "./utilities"
-
-describe("/plugins", () => {
-  let request = setup.getRequest()
-  let config = setup.getConfig()
-
-  afterAll(setup.afterAll)
-
-  beforeEach(async () => {
-    await config.init()
-    jest.clearAllMocks()
-  })
-
-  const createPlugin = async (status?: number) => {
-    return request
-      .post(`/api/plugin/upload`)
-      .attach("file", "src/api/routes/tests/data/comment-box-1.0.2.tar.gz")
-      .set(config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(status ? status : 200)
-  }
-
-  const getPlugins = async (status?: number) => {
-    return request
-      .get(`/api/plugin`)
-      .set(config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(status ? status : 200)
-  }
-
-  describe("upload", () => {
-    it("should be able to upload a plugin", async () => {
-      let res = await createPlugin()
-      expect(res.body).toBeDefined()
-      expect(res.body.plugins).toBeDefined()
-      expect(res.body.plugins[0]._id).toEqual("plg_comment-box")
-      expect(events.plugin.imported).toHaveBeenCalledTimes(1)
-    })
-
-    it("should not be able to create a plugin if there is an error", async () => {
-      mockObjectStore.mockImplementationOnce(() => {
-        throw new Error()
-      })
-      let res = await createPlugin(400)
-      expect(res.body.message).toEqual("Failed to import plugin: Error")
-      expect(events.plugin.imported).toHaveBeenCalledTimes(0)
-    })
-  })
-
-  describe("fetch", () => {
-    it("should be able to fetch plugins", async () => {
-      await createPlugin()
-      const res = await getPlugins()
-      expect(res.body).toBeDefined()
-      expect(res.body[0]._id).toEqual("plg_comment-box")
-    })
-  })
-
-  describe("destroy", () => {
-    it("should be able to delete a plugin", async () => {
-      await createPlugin()
-      const res = await request
-        .delete(`/api/plugin/plg_comment-box`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-      expect(res.body).toBeDefined()
-      expect(res.body.message).toEqual("Plugin plg_comment-box deleted.")
-
-      const plugins = await getPlugins()
-      expect(plugins.body).toBeDefined()
-      expect(plugins.body.length).toEqual(0)
-      expect(events.plugin.deleted).toHaveBeenCalledTimes(1)
-    })
-    it("should handle an error deleting a plugin", async () => {
-      deleteFolder.mockImplementationOnce(() => {
-        throw new Error()
-      })
-
-      await createPlugin()
-      const res = await request
-        .delete(`/api/plugin/plg_comment-box`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(400)
-
-      expect(res.body.message).toEqual("Failed to delete plugin: Error")
-      expect(events.plugin.deleted).toHaveBeenCalledTimes(0)
-      const plugins = await getPlugins()
-      expect(plugins.body).toBeDefined()
-      expect(plugins.body.length).toEqual(1)
-    })
-  })
-
-  describe("github", () => {
-    const createGithubPlugin = async (status?: number, url?: string) => {
-      return await request
-        .post(`/api/plugin`)
-        .send({
-          source: "Github",
-          url,
-          githubToken: "token",
-        })
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(status ? status : 200)
-    }
-    it("should be able to create a plugin from github", async () => {
-      const res = await createGithubPlugin(
-        200,
-        "https://github.com/my-repo/budibase-comment-box.git"
-      )
-      expect(res.body).toBeDefined()
-      expect(res.body.plugin).toBeDefined()
-      expect(res.body.plugin._id).toEqual("plg_comment-box")
-    })
-    it("should fail if the url is not from github", async () => {
-      const res = await createGithubPlugin(
-        400,
-        "https://notgithub.com/my-repo/budibase-comment-box"
-      )
-      expect(res.body.message).toEqual(
-        "Failed to import plugin: The plugin origin must be from Github"
-      )
-    })
-  })
-  describe("npm", () => {
-    it("should be able to create a plugin from npm", async () => {
-      const res = await request
-        .post(`/api/plugin`)
-        .send({
-          source: "NPM",
-          url: "https://www.npmjs.com/package/budibase-component",
-        })
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-      expect(res.body).toBeDefined()
-      expect(res.body.plugin._id).toEqual("plg_budibase-component")
-      expect(events.plugin.imported).toHaveBeenCalled()
-    })
-  })
-
-  describe("url", () => {
-    it("should be able to create a plugin from a URL", async () => {
-      const res = await request
-        .post(`/api/plugin`)
-        .send({
-          source: "URL",
-          url: "https://www.someurl.com/comment-box/comment-box-1.0.2.tar.gz",
-        })
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-      expect(res.body).toBeDefined()
-      expect(res.body.plugin._id).toEqual("plg_comment-box")
-      expect(events.plugin.imported).toHaveBeenCalledTimes(1)
-    })
-  })
-})

package/src/automations/tests/bash.spec.js

@@ -1,34 +0,0 @@
-const setup = require("./utilities")
-
-describe("test the bash action", () => {
-    let config = setup.getConfig()
-
-    beforeEach(async () => {
-        await config.init()
-    })
-    afterAll(setup.afterAll)
-
-    it("should be able to execute a script", async () => {
-
-        let res = await setup.runStep("EXECUTE_BASH",
-            inputs = {
-                code: "echo 'test'"
-            }
-
-        )
-        expect(res.stdout).toEqual("test\n")
-        expect(res.success).toEqual(true)
-    })
-
-    it("should handle a null value", async () => {
-
-        let res = await setup.runStep("EXECUTE_BASH",
-            inputs = {
-                code: null
-            }
-
-
-        )
-        expect(res.stdout).toEqual("Budibase bash automation failed: Invalid inputs")
-    })
-})

package/src/automations/tests/discord.spec.js

@@ -1,27 +0,0 @@
-const setup = require("./utilities")
-const fetch = require("node-fetch")
-
-jest.mock("node-fetch")
-
-describe("test the outgoing webhook action", () => {
-    let inputs
-    let config = setup.getConfig()
-
-    beforeEach(async () => {
-        await config.init()
-        inputs = {
-            username: "joe_bloggs",
-            url: "http://www.test.com",
-        }
-    })
-
-    afterAll(setup.afterAll)
-
-    it("should be able to run the action", async () => {
-        const res = await setup.runStep(setup.actions.discord.stepId, inputs)
-        expect(res.response.url).toEqual("http://www.test.com")
-        expect(res.response.method).toEqual("post")
-        expect(res.success).toEqual(true)
-    })
-
-})

package/src/automations/tests/executeQuery.spec.js

@@ -1,49 +0,0 @@
-const setup = require("./utilities")
-
-describe("test the execute query action", () => {
-    let datasource
-    let config = setup.getConfig()
-
-    beforeEach(async () => {
-        await config.init()
-
-        await config.createDatasource()
-        query = await config.createQuery()
-
-    })
-
-    afterAll(setup.afterAll)
-
-    it("should be able to execute a query", async () => {
-        let res = await setup.runStep(setup.actions.EXECUTE_QUERY.stepId,
-            inputs = {
-                query: { queryId: query._id }
-            }
-        )
-        expect(res.response).toEqual([{ a: 'string', b: 1 }])
-        expect(res.success).toEqual(true)
-    })
-
-    it("should handle a null query value", async () => {
-        let res = await setup.runStep(setup.actions.EXECUTE_QUERY.stepId,
-            inputs = {
-                query: null
-            }
-        )
-        expect(res.response.message).toEqual("Invalid inputs")
-        expect(res.success).toEqual(false)
-    })
-
-
-    it("should handle an error executing a query", async () => {
-        let res = await setup.runStep(setup.actions.EXECUTE_QUERY.stepId,
-            inputs = {
-                query: { queryId: "wrong_id" }
-            }
-        )
-        expect(res.response).toEqual('{"status":404,"name":"not_found","message":"missing","reason":"missing"}')
-        expect(res.success).toEqual(false)
-    })
-
-
-})