npm - @budibase/server - Versions diffs - 2.4.11 → 2.4.12-alpha.1 - Mend

@budibase/server 2.4.11 → 2.4.12-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (29) hide show

package/builder/assets/{index.83bb8d3b.js → index.72dd0c27.js} +375 -375
package/builder/assets/{index.b0e3aca6.css → index.af76a09d.css} +2 -2
package/builder/index.html +2 -2
package/dist/api/controllers/public/metrics.js +113 -0
package/dist/api/controllers/row/ExternalRequest.js +10 -2
package/dist/api/controllers/row/external.js +1 -1
package/dist/api/routes/public/index.js +8 -0
package/dist/api/routes/public/metrics.js +30 -0
package/dist/integrations/base/sql.js +1 -1
package/dist/integrations/googlesheets.js +14 -3
package/dist/package.json +7 -6
package/dist/tsconfig.build.tsbuildinfo +1 -1
package/jest.config.ts +1 -0
package/package.json +8 -7
package/specs/openapi.json +39 -0
package/specs/openapi.yaml +169 -0
package/specs/resources/application.ts +11 -0
package/specs/resources/index.ts +2 -0
package/specs/resources/metrics.ts +81 -0
package/src/api/controllers/public/metrics.ts +251 -0
package/src/api/controllers/row/ExternalRequest.ts +12 -2
package/src/api/controllers/row/external.ts +3 -3
package/src/api/routes/public/index.ts +10 -1
package/src/api/routes/public/metrics.ts +28 -0
package/src/api/routes/public/tests/metrics.spec.js +34 -0
package/src/definitions/openapi.ts +15 -0
package/src/integrations/base/sql.ts +2 -1
package/src/integrations/googlesheets.ts +30 -4
package/tsconfig.json +5 -10

package/builder/index.html CHANGED Viewed

@@ -10,8 +10,8 @@
 		href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap"
 		rel="stylesheet"
 	/>
-  <script type="module" crossorigin src="/builder/assets/index.83bb8d3b.js"></script>
-  <link rel="stylesheet" href="/builder/assets/index.b0e3aca6.css">
+  <script type="module" crossorigin src="/builder/assets/index.72dd0c27.js"></script>
+  <link rel="stylesheet" href="/builder/assets/index.af76a09d.css">
 </head>
 <body id="app">

package/dist/api/controllers/public/metrics.js ADDED Viewed

@@ -0,0 +1,113 @@
+"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.convertToOpenMetrics = exports.fetch = void 0;
+const backend_core_1 = require("@budibase/backend-core");
+const pro_1 = require("@budibase/pro");
+const os_1 = __importDefault(require("os"));
+function fetch(ctx) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // *** OPERATING SYSTEM ***
+        const freeMem = os_1.default.freemem();
+        const totalMem = os_1.default.totalmem();
+        const usedMem = totalMem - freeMem;
+        const uptime = os_1.default.uptime();
+        // *** APPS ***
+        const allDatabases = yield backend_core_1.db.getAllDbs();
+        const devAppIDs = yield backend_core_1.db.getDevAppIDs();
+        const prodAppIDs = yield backend_core_1.db.getProdAppIDs();
+        const allAppIds = yield backend_core_1.db.getAllApps({ idsOnly: true });
+        // *** USERS ***
+        const usersObject = yield backend_core_1.users.getAllUserIds();
+        // *** QUOTAS ***
+        const usage = yield pro_1.quotas.getQuotaUsage();
+        const license = yield pro_1.licensing.cache.getCachedLicense();
+        const appsQuotaUsage = usage.usageQuota.apps;
+        const rowsQuotaUsage = usage.usageQuota.rows;
+        const pluginsQuotaUsage = usage.usageQuota.plugins;
+        const userGroupsQuotaUsage = usage.usageQuota.userGroups;
+        const queryQuotaUsage = usage.monthly.current.queries;
+        const automationsQuotaUsage = usage.monthly.current.automations;
+        const appsQuotaLimit = license.quotas.usage.static.apps.value;
+        const rowsQuotaLimit = license.quotas.usage.static.rows.value;
+        const userGroupsQuotaLimit = license.quotas.usage.static.userGroups.value;
+        const pluginsQuotaLimit = license.quotas.usage.static.plugins.value;
+        const queryQuotaLimit = license.quotas.usage.monthly.queries.value;
+        const automationsQuotaLimit = license.quotas.usage.monthly.automations.value;
+        // *** BUILD THE OUTPUT STRING ***
+        var outputString = "";
+        // **** budibase_os_uptime ****
+        outputString += convertToOpenMetrics("budibase_os_uptime", "Time in seconds that the host operating system has been up", "counter", uptime);
+        // **** budibase_os_free_mem ****
+        outputString += convertToOpenMetrics("budibase_os_free_mem", "Bytes of memory free for usage on the host operating system", "gauge", freeMem);
+        // **** budibase_os_total_mem ****
+        outputString += convertToOpenMetrics("budibase_os_total_mem", "Total bytes of memory on the host operating system", "gauge", totalMem);
+        // **** budibase_os_used_mem ****
+        outputString += convertToOpenMetrics("budibase_os_used_mem", "Total bytes of memory in use on the host operating system", "gauge", usedMem);
+        // **** budibase_os_load1 ****
+        outputString += convertToOpenMetrics("budibase_os_load1", "Host operating system load average", "gauge", os_1.default.loadavg()[0]);
+        // **** budibase_os_load5 ****
+        outputString += convertToOpenMetrics("budibase_os_load5", "Host operating system load average", "gauge", os_1.default.loadavg()[1]);
+        // **** budibase_os_load15 ****
+        outputString += convertToOpenMetrics("budibase_os_load15", "Host operating system load average", "gauge", os_1.default.loadavg()[2]);
+        // **** budibase_tenant_user_count ****
+        outputString += convertToOpenMetrics("budibase_tenant_user_count", "The number of users created", "gauge", usersObject.length);
+        // **** budibase_tenant_app_count ****
+        outputString += convertToOpenMetrics("budibase_tenant_app_count", "The number of apps created by a user", "gauge", allAppIds.length);
+        // **** budibase_tenant_production_app_count ****
+        outputString += convertToOpenMetrics("budibase_tenant_production_app_count", "The number of apps a user has published", "gauge", prodAppIDs.length);
+        // **** budibase_tenant_dev_app_count ****
+        outputString += convertToOpenMetrics("budibase_tenant_dev_app_count", "The number of apps a user has unpublished in development", "gauge", devAppIDs.length);
+        // **** budibase_tenant_db_count ****
+        outputString += convertToOpenMetrics("budibase_tenant_db_count", "The number of couchdb databases including global tables such as _users", "gauge", allDatabases.length);
+        // **** budibase_quota_usage_apps ****
+        outputString += convertToOpenMetrics("budibase_quota_usage_apps", "The number of apps created", "gauge", appsQuotaUsage);
+        // **** budibase_quota_limit_apps ****
+        outputString += convertToOpenMetrics("budibase_quota_limit_apps", "The limit on the number of apps that can be created", "gauge", appsQuotaLimit == -1 ? Number.MAX_SAFE_INTEGER : appsQuotaLimit);
+        // **** budibase_quota_usage_rows ****
+        outputString += convertToOpenMetrics("budibase_quota_usage_rows", "The number of database rows used from the quota", "gauge", rowsQuotaUsage);
+        // **** budibase_quota_limit_rows ****
+        outputString += convertToOpenMetrics("budibase_quota_limit_rows", "The limit on the number of rows that can be created", "gauge", rowsQuotaLimit == -1 ? Number.MAX_SAFE_INTEGER : rowsQuotaLimit);
+        // **** budibase_quota_usage_plugins ****
+        outputString += convertToOpenMetrics("budibase_quota_usage_plugins", "The number of plugins in use", "gauge", pluginsQuotaUsage);
+        // **** budibase_quota_limit_plugins ****
+        outputString += convertToOpenMetrics("budibase_quota_limit_plugins", "The limit on the number of plugins that can be created", "gauge", pluginsQuotaLimit == -1 ? Number.MAX_SAFE_INTEGER : pluginsQuotaLimit);
+        // **** budibase_quota_usage_user_groups ****
+        outputString += convertToOpenMetrics("budibase_quota_usage_user_groups", "The number of user groups created", "gauge", userGroupsQuotaUsage);
+        // **** budibase_quota_limit_user_groups ****
+        outputString += convertToOpenMetrics("budibase_quota_limit_user_groups", "The limit on the number of user groups that can be created", "gauge", userGroupsQuotaLimit == -1 ? Number.MAX_SAFE_INTEGER : userGroupsQuotaLimit);
+        // **** budibase_quota_usage_queries ****
+        outputString += convertToOpenMetrics("budibase_quota_usage_queries", "The number of queries used in the current month", "gauge", queryQuotaUsage);
+        // **** budibase_quota_limit_queries ****
+        outputString += convertToOpenMetrics("budibase_quota_limit_queries", "The limit on the number of queries for the current month", "gauge", queryQuotaLimit == -1 ? Number.MAX_SAFE_INTEGER : queryQuotaLimit);
+        // **** budibase_quota_usage_automations ****
+        outputString += convertToOpenMetrics("budibase_quota_usage_automations", "The number of automations used in the current month", "gauge", automationsQuotaUsage);
+        // **** budibase_quota_limit_automations ****
+        outputString += convertToOpenMetrics("budibase_quota_limit_automations", "The limit on the number of automations that can be created", "gauge", automationsQuotaLimit == -1
+            ? Number.MAX_SAFE_INTEGER
+            : automationsQuotaLimit);
+        ctx.body = outputString;
+        ctx.set("Content-Type", "text/plain");
+    });
+}
+exports.fetch = fetch;
+function convertToOpenMetrics(metricName, metricHelp, metricType, metricValue) {
+    return `# HELP ${metricName} ${metricHelp}.
+# TYPE ${metricName} ${metricType}
+${metricName} ${metricValue}\n`;
+}
+exports.convertToOpenMetrics = convertToOpenMetrics;
+exports.default = {
+    fetch,
+};

package/dist/api/controllers/row/ExternalRequest.js CHANGED Viewed

@@ -614,8 +614,16 @@ class ExternalRequest {
             let { id, row, filters, sort, paginate, rows } = cleanupConfig(config, table);
             //if the sort column is a formula, remove it
             for (let sortColumn of Object.keys(sort || {})) {
-                if (((_a = table.schema[sortColumn]) === null || _a === void 0 ? void 0 : _a.type) === "formula") {
-                    sort === null || sort === void 0 ? true : delete sort[sortColumn];
+                if (!(sort === null || sort === void 0 ? void 0 : sort[sortColumn])) {
+                    continue;
+                }
+                switch ((_a = table.schema[sortColumn]) === null || _a === void 0 ? void 0 : _a.type) {
+                    case types_1.FieldType.FORMULA:
+                        sort === null || sort === void 0 ? true : delete sort[sortColumn];
+                        break;
+                    case types_1.FieldType.NUMBER:
+                        sort[sortColumn].type = types_1.SortType.number;
+                        break;
                 }
             }
             filters = buildFilters(id, filters || {}, table);

package/dist/api/controllers/row/external.js CHANGED Viewed

@@ -188,7 +188,7 @@ function search(ctx) {
                 ? constants_1.SortDirection.DESCENDING
                 : constants_1.SortDirection.ASCENDING;
             sort = {
-                [params.sort]: direction,
+                [params.sort]: { direction },
             };
         }
         try {

package/dist/api/routes/public/index.js CHANGED Viewed

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.shutdown = void 0;
 const applications_1 = __importDefault(require("./applications"));
+const metrics_1 = __importDefault(require("./metrics"));
 const queries_1 = __importDefault(require("./queries"));
 const tables_1 = __importDefault(require("./tables"));
 const rows_1 = __importDefault(require("./rows"));
@@ -86,6 +87,12 @@ function addToRouter(endpoints) {
         }
     }
 }
+function applyAdminRoutes(endpoints) {
+    addMiddleware(endpoints.read, backend_core_1.middleware.builderOrAdmin);
+    addMiddleware(endpoints.write, backend_core_1.middleware.builderOrAdmin);
+    addToRouter(endpoints.read);
+    addToRouter(endpoints.write);
+}
 function applyRoutes(endpoints, permType, resource, subResource) {
     const paramMiddleware = subResource
         ? (0, resourceId_1.paramSubResource)(resource, subResource)
@@ -107,6 +114,7 @@ function applyRoutes(endpoints, permType, resource, subResource) {
     addToRouter(endpoints.read);
     addToRouter(endpoints.write);
 }
+applyAdminRoutes(metrics_1.default);
 applyRoutes(applications_1.default, PermissionType.APP, "appId");
 applyRoutes(tables_1.default, PermissionType.TABLE, "tableId");
 applyRoutes(users_1.default, PermissionType.USER, "userId");

package/dist/api/routes/public/metrics.js ADDED Viewed

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const metrics_1 = __importDefault(require("../../controllers/public/metrics"));
+const Endpoint_1 = __importDefault(require("./utils/Endpoint"));
+const read = [];
+/**
+ * @openapi
+ * /metrics:
+ *   get:
+ *     operationId: metricsGet
+ *     summary: Retrieve Budibase tenant metrics
+ *     description: Output metrics in OpenMetrics format compatible with Prometheus
+ *     tags:
+ *       - metrics
+ *     responses:
+ *       200:
+ *         description: Returns tenant metrics.
+ *         content:
+ *           text/plain:
+ *             schema:
+ *               type: string
+ *             examples:
+ *               metrics:
+ *                 $ref: '#/components/examples/metrics'
+ */
+read.push(new Endpoint_1.default("get", "/metrics", metrics_1.default.fetch));
+exports.default = { read };

package/dist/integrations/base/sql.js CHANGED Viewed

@@ -293,7 +293,7 @@ class InternalBuilder {
         const table = (_a = json.meta) === null || _a === void 0 ? void 0 : _a.table;
         if (sort) {
             for (let [key, value] of Object.entries(sort)) {
-                const direction = value === types_1.SortDirection.ASCENDING ? "asc" : "desc";
+                const direction = value.direction === types_1.SortDirection.ASCENDING ? "asc" : "desc";
                 query = query.orderBy(`${table === null || table === void 0 ? void 0 : table.name}.${key}`, direction);
             }
         }

package/dist/integrations/googlesheets.js CHANGED Viewed

@@ -19,6 +19,7 @@ const constants_1 = require("../constants");
 const google_spreadsheet_1 = require("google-spreadsheet");
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const backend_core_1 = require("@budibase/backend-core");
+const shared_core_1 = require("@budibase/shared-core");
 const SCHEMA = {
     plus: true,
     auth: {
@@ -196,7 +197,7 @@ class GoogleSheetsIntegration {
             const sheet = json.endpoint.entityId;
             const handlers = {
                 [constants_1.DataSourceOperation.CREATE]: () => this.create({ sheet, row: json.body }),
-                [constants_1.DataSourceOperation.READ]: () => this.read({ sheet }),
+                [constants_1.DataSourceOperation.READ]: () => this.read(Object.assign(Object.assign({}, json), { sheet })),
                 [constants_1.DataSourceOperation.UPDATE]: () => {
                     var _a, _b, _c;
                     return this.update({
@@ -312,11 +313,21 @@ class GoogleSheetsIntegration {
                 yield this.connect();
                 const sheet = this.client.sheetsByTitle[query.sheet];
                 const rows = yield sheet.getRows();
+                const filtered = shared_core_1.dataFilters.runLuceneQuery(rows, query.filters);
                 const headerValues = sheet.headerValues;
-                const response = [];
-                for (let row of rows) {
+                let response = [];
+                for (let row of filtered) {
                     response.push(this.buildRowObject(headerValues, row._rawData, row._rowNumber));
                 }
+                if (query.sort) {
+                    if (Object.keys(query.sort).length !== 1) {
+                        console.warn("Googlesheets does not support multiple sorting", {
+                            sortInfo: query.sort,
+                        });
+                    }
+                    const [sortField, sortInfo] = Object.entries(query.sort)[0];
+                    response = shared_core_1.dataFilters.luceneSort(response, sortField, sortInfo.direction, sortInfo.type);
+                }
                 return response;
             }
             catch (err) {

package/dist/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
     "name": "@budibase/server",
     "email": "hi@budibase.com",
-    "version": "2.4.10",
+    "version": "2.4.12-alpha.0",
     "description": "Budibase Web Server",
     "main": "src/index.ts",
     "repository": {
@@ -43,11 +43,12 @@
     "license": "GPL-3.0",
     "dependencies": {
         "@apidevtools/swagger-parser": "10.0.3",
-        "@budibase/backend-core": "^2.4.10",
-        "@budibase/client": "^2.4.10",
-        "@budibase/pro": "2.4.10",
-        "@budibase/string-templates": "^2.4.10",
-        "@budibase/types": "^2.4.10",
+        "@budibase/backend-core": "2.4.12-alpha.0",
+        "@budibase/client": "2.4.12-alpha.0",
+        "@budibase/pro": "2.4.12-alpha.0",
+        "@budibase/shared-core": "2.4.12-alpha.0",
+        "@budibase/string-templates": "2.4.12-alpha.0",
+        "@budibase/types": "2.4.12-alpha.0",
         "@bull-board/api": "3.7.0",
         "@bull-board/koa": "3.9.4",
         "@elastic/elasticsearch": "7.10.0",