@budibase/server 1.0.78 → 1.0.79-alpha.10

package/dist/utilities/workerRequests.js

@@ -36,10 +36,31 @@ function request(ctx, request) {
         delete request.body;
     }
     if (ctx && ctx.headers) {
-        request.headers.cookie = ctx.headers.cookie;
+        request.headers = ctx.headers;
     }
     return request;
 }
+function checkResponse(response, errorMsg, { ctx } = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (response.status !== 200) {
+            let error;
+            try {
+                error = yield response.json();
+            }
+            catch (err) {
+                error = yield response.text();
+            }
+            const msg = `Unable to ${errorMsg} - ${error.message ? error.message : error}`;
+            if (ctx) {
+                ctx.throw(400, msg);
+            }
+            else {
+                throw msg;
+            }
+        }
+        return response.json();
+    });
+}
 exports.request = request;
 // have to pass in the tenant ID as this could be coming from an automation
 exports.sendSmtpEmail = (to, from, subject, contents, automation) => __awaiter(void 0, void 0, void 0, function* () {
@@ -55,21 +76,14 @@ exports.sendSmtpEmail = (to, from, subject, contents, automation) => __awaiter(v
             automation,
         },
     }));
-    if (response.status !== 200) {
-        const error = yield response.text();
-        throw `Unable to send email - ${error}`;
-    }
-    return response.json();
+    return checkResponse(response, "send email");
 });
 exports.getGlobalSelf = (ctx, appId = null) => __awaiter(void 0, void 0, void 0, function* () {
-    const endpoint = `/api/global/users/self`;
+    const endpoint = `/api/global/self`;
     const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + endpoint), 
     // we don't want to use API key when getting self
     request(ctx, { method: "GET" }));
-    if (response.status !== 200) {
-        ctx.throw(400, "Unable to get self globally.");
-    }
-    let json = yield response.json();
+    let json = yield checkResponse(response, "get self globally", { ctx });
     if (appId) {
         json = updateAppRole(json);
     }
@@ -80,8 +94,29 @@ exports.removeAppFromUserRoles = (ctx, appId) => __awaiter(void 0, void 0, void
     const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + `/api/global/roles/${prodAppId}`), request(ctx, {
         method: "DELETE",
     }));
-    if (response.status !== 200) {
-        throw "Unable to remove app role";
-    }
-    return response.json();
+    return checkResponse(response, "remove app role");
+});
+exports.allGlobalUsers = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + "/api/global/users"), 
+    // we don't want to use API key when getting self
+    request(ctx, { method: "GET" }));
+    return checkResponse(response, "get users", { ctx });
+});
+exports.saveGlobalUser = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + "/api/global/users"), 
+    // we don't want to use API key when getting self
+    request(ctx, { method: "POST", body: ctx.request.body }));
+    return checkResponse(response, "save user", { ctx });
+});
+exports.deleteGlobalUser = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + `/api/global/users/${ctx.params.userId}`), 
+    // we don't want to use API key when getting self
+    request(ctx, { method: "DELETE" }));
+    return checkResponse(response, "delete user", { ctx, body: ctx.request.body });
+});
+exports.readGlobalUser = (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield fetch(checkSlashesInUrl(env.WORKER_URL + `/api/global/users/${ctx.params.userId}`), 
+    // we don't want to use API key when getting self
+    request(ctx, { method: "GET" }));
+    return checkResponse(response, "get user", { ctx });
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "1.0.78",
+  "version": "1.0.79-alpha.10",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -21,10 +21,8 @@
     "dev:stack:down": "node scripts/dev/manage.js down",
     "dev:stack:nuke": "node scripts/dev/manage.js nuke",
     "dev:builder": "yarn run dev:stack:up && nodemon",
-    "generate:proxy:compose": "node scripts/proxy/generateProxyConfig compose",
-    "generate:proxy:preprod": "node scripts/proxy/generateProxyConfig preprod",
-    "generate:proxy:prod": "node scripts/proxy/generateProxyConfig prod",
     "format": "prettier --config ../../.prettierrc.json 'src/**/*.ts' --write",
+    "specs": "node specs/generate.js && openapi-typescript specs/openapi.yaml --output src/definitions/openapi.ts",
     "lint": "eslint --fix src/",
     "lint:fix": "yarn run format && yarn run lint",
     "initialise": "node scripts/initialise.js",
@@ -73,9 +71,9 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.0.3",
-    "@budibase/backend-core": "^1.0.78",
-    "@budibase/client": "^1.0.78",
-    "@budibase/string-templates": "^1.0.78",
+    "@budibase/backend-core": "^1.0.79-alpha.10",
+    "@budibase/client": "^1.0.79-alpha.10",
+    "@budibase/string-templates": "^1.0.79-alpha.10",
     "@bull-board/api": "^3.7.0",
     "@bull-board/koa": "^3.7.0",
     "@elastic/elasticsearch": "7.10.0",
@@ -157,12 +155,15 @@
     "docker-compose": "^0.23.6",
     "eslint": "^6.8.0",
     "jest": "^27.0.5",
+    "jest-openapi": "^0.14.2",
     "nodemon": "^2.0.4",
     "openapi-types": "^9.3.1",
+    "openapi-typescript": "^5.2.0",
     "path-to-regexp": "^6.2.0",
     "prettier": "^2.3.1",
     "rimraf": "^3.0.2",
     "supertest": "^4.0.2",
+    "swagger-jsdoc": "^6.1.0",
     "ts-jest": "^27.0.3",
     "ts-node": "^10.0.0",
     "typescript": "^4.3.5",
@@ -171,5 +172,5 @@
   "optionalDependencies": {
     "oracledb": "^5.3.0"
   },
-  "gitHead": "457fb4fae186f9257b73e096ade8d4ecfbb5e9de"
+  "gitHead": "ecc99a3eac5f1a501824ff755dfec6e25fec4aa9"
 }

package/scripts/integrations/oracle/oracle.md

@@ -8,9 +8,9 @@
 
 To install oracle express edition simply run `docker-compose up`
 
-- A single instance pluggable database (PDB) will be created named `xepdb`
+- A single instance pluggable database (PDB) will be created named `xepdb1`
 - The default password is configured in the compose file as `oracle`
-  - The `system`, `sys` and `pdbadmin` users all share this password
+  - The `system` and `pdbadmin` users share this password
 
 ## Instant Client 
 

package/scripts/integrations/postgres/init.sql

@@ -1,11 +1,13 @@
 SELECT 'CREATE DATABASE main'
 WHERE NOT EXISTS (SELECT FROM pg_database WHERE datname = 'main')\gexec
+CREATE TYPE person_job AS ENUM ('qa', 'programmer', 'designer');
 CREATE TABLE Persons (
     PersonID SERIAL PRIMARY KEY,
     LastName varchar(255),
     FirstName varchar(255),
     Address varchar(255),
-    City varchar(255) DEFAULT 'Belfast'
+    City varchar(255) DEFAULT 'Belfast',
+    Type person_job
 );
 CREATE TABLE Tasks (
     TaskID SERIAL PRIMARY KEY,
@@ -35,8 +37,8 @@ CREATE TABLE Products_Tasks (
             REFERENCES Tasks(TaskID),
     PRIMARY KEY (ProductID, TaskID)
 );
-INSERT INTO Persons (FirstName, LastName, Address, City) VALUES ('Mike', 'Hughes', '123 Fake Street', 'Belfast');
-INSERT INTO Persons (FirstName, LastName, Address, City) Values ('John', 'Smith', '64 Updown Road', 'Dublin');
+INSERT INTO Persons (FirstName, LastName, Address, City, Type) VALUES ('Mike', 'Hughes', '123 Fake Street', 'Belfast', 'qa');
+INSERT INTO Persons (FirstName, LastName, Address, City, Type) VALUES ('John', 'Smith', '64 Updown Road', 'Dublin', 'programmer');
 INSERT INTO Tasks (ExecutorID, QaID, TaskName, Completed) VALUES (1, 2, 'assembling', TRUE);
 INSERT INTO Tasks (ExecutorID, QaID, TaskName, Completed) VALUES (2, 1, 'processing', FALSE);
 INSERT INTO Products (ProductName) VALUES ('Computers');

package/scripts/likeCypress.ts

@@ -2,14 +2,13 @@
  * This script just makes it easy to re-create        *
  * a cypress like environment for testing the backend *
  ******************************************************/
-const path = require("path")
+import path from "path"
 const tmpdir = path.join(require("os").tmpdir(), ".budibase")
 
-const MAIN_PORT = "10001"
-const WORKER_PORT = "10002"
+const SERVER_PORT = "4100"
+const WORKER_PORT = "4200"
 
 // @ts-ignore
-process.env.PORT = MAIN_PORT
 process.env.BUDIBASE_API_KEY = "6BE826CB-6B30-4AEC-8777-2E90464633DE"
 process.env.NODE_ENV = "cypress"
 process.env.ENABLE_ANALYTICS = "false"
@@ -27,7 +26,11 @@ process.env.ALLOW_DEV_AUTOMATIONS = "1"
 
 // don't make this a variable or top level require
 // it will cause environment module to be loaded prematurely
-const server = require("../src/app")
+
+// override the port with the worker port temporarily
 process.env.PORT = WORKER_PORT
 const worker = require("../../worker/src/index")
-process.env.PORT = MAIN_PORT
+
+// override the port with the server port
+process.env.PORT = SERVER_PORT
+const server = require("../src/app")

package/specs/generate.js

@@ -0,0 +1,83 @@
+const swaggerJsdoc = require("swagger-jsdoc")
+const { join } = require("path")
+const { writeFileSync } = require("fs")
+const { examples, schemas } = require("./resources")
+const parameters = require("./parameters")
+const security = require("./security")
+
+const VARIABLES = {}
+
+const options = {
+  definition: {
+    openapi: "3.0.0",
+    info: {
+      title: "Budibase API",
+      description: "The public API for Budibase apps and its services.",
+      version: "1.0.0",
+    },
+    servers: [
+      {
+        url: "http://budibase.app/api/public/v1",
+        description: "Budibase Cloud API",
+      },
+      {
+        url: "{protocol}://{hostname}:10000/api/public/v1",
+        description: "Budibase self hosted API",
+      },
+    ],
+    components: {
+      parameters: {
+        ...parameters,
+      },
+      examples: {
+        ...examples,
+      },
+      securitySchemes: {
+        ...security,
+      },
+      schemas: {
+        ...schemas,
+      },
+    },
+    security: [
+      {
+        ApiKeyAuth: [],
+      },
+    ],
+  },
+  format: ".json",
+  apis: [join(__dirname, "..", "src", "api", "routes", "public", "*.ts")],
+}
+
+function writeFile(output, filename) {
+  try {
+    const path = join(__dirname, filename)
+    let spec = output
+    if (filename.endsWith("json")) {
+      spec = JSON.stringify(output, null, 2)
+    }
+    // input the static variables
+    for (let [key, replacement] of Object.entries(VARIABLES)) {
+      spec = spec.replace(new RegExp(`{${key}}`, "g"), replacement)
+    }
+    writeFileSync(path, spec)
+    console.log(`Wrote spec to ${path}`)
+    return path
+  } catch (err) {
+    console.error(err)
+  }
+}
+
+function run() {
+  const outputJSON = swaggerJsdoc(options)
+  options.format = ".yaml"
+  const outputYAML = swaggerJsdoc(options)
+  writeFile(outputJSON, "openapi.json")
+  return writeFile(outputYAML, "openapi.yaml")
+}
+
+if (require.main === module) {
+  run()
+}
+
+module.exports = run