@budibase/server 2.4.11 → 2.4.12-alpha.1

package/src/api/controllers/row/ExternalRequest.ts

@@ -11,6 +11,8 @@ import {
   Row,
   Table,
   RelationshipTypes,
+  FieldType,
+  SortType,
 } from "@budibase/types"
 import {
   breakRowIdField,
@@ -749,8 +751,16 @@ export class ExternalRequest {
     )
     //if the sort column is a formula, remove it
     for (let sortColumn of Object.keys(sort || {})) {
-      if (table.schema[sortColumn]?.type === "formula") {
-        delete sort?.[sortColumn]
+      if (!sort?.[sortColumn]) {
+        continue
+      }
+      switch (table.schema[sortColumn]?.type) {
+        case FieldType.FORMULA:
+          delete sort?.[sortColumn]
+          break
+        case FieldType.NUMBER:
+          sort[sortColumn].type = SortType.number
+          break
       }
     }
     filters = buildFilters(id, filters || {}, table)

package/src/api/controllers/row/external.ts

@@ -8,7 +8,6 @@ import {
   breakRowIdField,
 } from "../../../integrations/utils"
 import { ExternalRequest, RunConfig } from "./ExternalRequest"
-import { context } from "@budibase/backend-core"
 import * as exporters from "../view/exporters"
 import { apiFileReturn } from "../../../utilities/fileSystem"
 import {
@@ -19,6 +18,7 @@ import {
   Table,
   Datasource,
   IncludeRelationship,
+  SortJson,
 } from "@budibase/types"
 import sdk from "../../../sdk"
 
@@ -142,14 +142,14 @@ export async function search(ctx: BBContext) {
       limit: limit,
     }
   }
-  let sort
+  let sort: SortJson | undefined
   if (params.sort) {
     const direction =
       params.sortOrder === "descending"
         ? SortDirection.DESCENDING
         : SortDirection.ASCENDING
     sort = {
-      [params.sort]: direction,
+      [params.sort]: { direction },
     }
   }
   try {

package/src/api/routes/public/index.ts

@@ -1,4 +1,5 @@
 import appEndpoints from "./applications"
+import metricEndpoints from "./metrics"
 import queryEndpoints from "./queries"
 import tableEndpoints from "./tables"
 import rowEndpoints from "./rows"
@@ -12,7 +13,7 @@ import env from "../../../environment"
 // below imports don't have declaration files
 const Router = require("@koa/router")
 const { RateLimit, Stores } = require("koa2-ratelimit")
-import { redis, permissions } from "@budibase/backend-core"
+import { middleware, redis, permissions } from "@budibase/backend-core"
 const { PermissionType, PermissionLevel } = permissions
 
 const PREFIX = "/api/public/v1"
@@ -91,6 +92,13 @@ function addToRouter(endpoints: any) {
   }
 }
 
+function applyAdminRoutes(endpoints: any) {
+  addMiddleware(endpoints.read, middleware.builderOrAdmin)
+  addMiddleware(endpoints.write, middleware.builderOrAdmin)
+  addToRouter(endpoints.read)
+  addToRouter(endpoints.write)
+}
+
 function applyRoutes(
   endpoints: any,
   permType: string,
@@ -119,6 +127,7 @@ function applyRoutes(
   addToRouter(endpoints.write)
 }
 
+applyAdminRoutes(metricEndpoints)
 applyRoutes(appEndpoints, PermissionType.APP, "appId")
 applyRoutes(tableEndpoints, PermissionType.TABLE, "tableId")
 applyRoutes(userEndpoints, PermissionType.USER, "userId")

package/src/api/routes/public/metrics.ts

@@ -0,0 +1,28 @@
+import controller from "../../controllers/public/metrics"
+import Endpoint from "./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("get", "/metrics", controller.fetch))
+
+export default { read }

package/src/api/routes/public/tests/metrics.spec.js

@@ -0,0 +1,34 @@
+const setup = require("../../tests/utilities")
+
+jest.setTimeout(30000)
+
+describe("/metrics", () => {
+  let request = setup.getRequest()
+  let config = setup.getConfig()
+
+  afterAll(setup.afterAll)
+
+  // For some reason this cannot be a beforeAll or the test "should be able to update the user" fail
+  beforeEach(async () => {
+    await config.init()
+  })
+
+  describe("get", () => {
+    it("returns a list of metrics", async () => {
+      const res = await request
+        .get(`/api/public/v1/metrics`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /text\/plain/)
+        .expect(200)
+      expect(res.text).toContain("budibase_tenant_user_count")
+    })
+
+    it("endpoint should not be publicly exposed", async () => {
+      await request
+      .get(`/api/public/v1/metrics`)
+      .set(config.publicHeaders())
+      .expect(403)
+    })
+  })
+
+})

package/src/definitions/openapi.ts

@@ -22,6 +22,10 @@ export interface paths {
     /** Based on application properties (currently only name) search for applications. */
     post: operations["appSearch"];
   };
+  "/metrics": {
+    /** Output metrics in OpenMetrics format compatible with Prometheus */
+    get: operations["metricsGet"];
+  };
   "/queries/{queryId}": {
     /** Queries which have been created within a Budibase app can be executed using this, */
     post: operations["queryExecute"];
@@ -844,6 +848,17 @@ export interface operations {
       };
     };
   };
+  /** Output metrics in OpenMetrics format compatible with Prometheus */
+  metricsGet: {
+    responses: {
+      /** Returns tenant metrics. */
+      200: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+  };
   /** Queries which have been created within a Budibase app can be executed using this, */
   queryExecute: {
     parameters: {

package/src/integrations/base/sql.ts

@@ -317,7 +317,8 @@ class InternalBuilder {
     const table = json.meta?.table
     if (sort) {
       for (let [key, value] of Object.entries(sort)) {
-        const direction = value === SortDirection.ASCENDING ? "asc" : "desc"
+        const direction =
+          value.direction === SortDirection.ASCENDING ? "asc" : "desc"
         query = query.orderBy(`${table?.name}.${key}`, direction)
       }
     } else if (this.client === SqlClient.MS_SQL && paginate?.limit) {

package/src/integrations/googlesheets.ts

@@ -2,8 +2,11 @@ import {
   DatasourceFieldType,
   DatasourcePlus,
   Integration,
+  PaginationJson,
   QueryJson,
   QueryType,
+  SearchFilters,
+  SortJson,
   Table,
   TableSchema,
 } from "@budibase/types"
@@ -13,6 +16,7 @@ import { DataSourceOperation, FieldTypes } from "../constants"
 import { GoogleSpreadsheet } from "google-spreadsheet"
 import fetch from "node-fetch"
 import { configs, HTTPError } from "@budibase/backend-core"
+import { dataFilters } from "@budibase/shared-core"
 
 interface GoogleSheetsConfig {
   spreadsheetId: string
@@ -237,7 +241,7 @@ class GoogleSheetsIntegration implements DatasourcePlus {
     const handlers = {
       [DataSourceOperation.CREATE]: () =>
         this.create({ sheet, row: json.body }),
-      [DataSourceOperation.READ]: () => this.read({ sheet }),
+      [DataSourceOperation.READ]: () => this.read({ ...json, sheet }),
       [DataSourceOperation.UPDATE]: () =>
         this.update({
           // exclude the header row and zero index
@@ -345,18 +349,40 @@ class GoogleSheetsIntegration implements DatasourcePlus {
     }
   }
 
-  async read(query: { sheet: string }) {
+  async read(query: {
+    sheet: string
+    filters?: SearchFilters
+    sort?: SortJson
+    paginate?: PaginationJson
+  }) {
     try {
       await this.connect()
       const sheet = this.client.sheetsByTitle[query.sheet]
       const rows = await sheet.getRows()
+      const filtered = 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 = dataFilters.luceneSort(
+          response,
+          sortField,
+          sortInfo.direction,
+          sortInfo.type
+        )
+      }
+
       return response
     } catch (err) {
       console.error("Error reading from google sheets", err)

package/tsconfig.json

@@ -9,6 +9,7 @@
       "@budibase/types": ["../types/src"],
       "@budibase/backend-core": ["../backend-core/src"],
       "@budibase/backend-core/*": ["../backend-core/*"],
+      "@budibase/shared-core": ["../shared-core/src"],
       "@budibase/pro": ["../../../budibase-pro/packages/pro/src"]
     }
   },
@@ -19,15 +20,9 @@
   "references": [
     { "path": "../types" },
     { "path": "../backend-core" },
+    { "path": "../shared-core" },
     { "path": "../../../budibase-pro/packages/pro" }
   ],
-  "include": [
-    "src/**/*",
-    "specs",
-    "package.json"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}
+  "include": ["src/**/*", "specs", "package.json"],
+  "exclude": ["node_modules", "dist"]
+}