@budibase/server 1.0.19-alpha.2 → 1.0.19-alpha.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "1.0.19-alpha.2",
+  "version": "1.0.19-alpha.3",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -70,9 +70,9 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.0.3",
-    "@budibase/auth": "^1.0.19-alpha.2",
-    "@budibase/client": "^1.0.19-alpha.2",
-    "@budibase/string-templates": "^1.0.19-alpha.2",
+    "@budibase/auth": "^1.0.19-alpha.3",
+    "@budibase/client": "^1.0.19-alpha.3",
+    "@budibase/string-templates": "^1.0.19-alpha.3",
     "@bull-board/api": "^3.7.0",
     "@bull-board/koa": "^3.7.0",
     "@elastic/elasticsearch": "7.10.0",
@@ -162,5 +162,5 @@
   "optionalDependencies": {
     "oracledb": "^5.3.0"
   },
-  "gitHead": "13dd988c51c1fd2ebfddeac8476577f52e4516cf"
+  "gitHead": "c9f8ffdd5c30919e4d3e765b248953d754530915"
 }

package/src/api/controllers/query/import/index.ts

@@ -3,7 +3,7 @@ import { queryValidation } from "../validation"
 import { generateQueryID } from "../../../../db/utils"
 import { ImportInfo, ImportSource } from "./sources/base"
 import { OpenAPI2 } from "./sources/openapi2"
-import { Query } from './../../../../definitions/common';
+import { Query } from "./../../../../definitions/common"
 import { Curl } from "./sources/curl"
 interface ImportResult {
   errorQueries: Query[]

package/src/api/controllers/query/import/sources/curl.ts

@@ -29,7 +29,7 @@ const parseBody = (curl: any) => {
 }
 
 const parseCookie = (curl: any) => {
-  if (curl.cookies){
+  if (curl.cookies) {
     return Object.entries(curl.cookies).reduce((acc, entry) => {
       const [key, value] = entry
       return acc + `${key}=${value}; `

package/src/definitions/datasource.ts

@@ -196,6 +196,27 @@ export interface Datasource extends Base {
   }
 }
 
+export enum AuthType {
+  BASIC = "basic",
+  BEARER = "bearer",
+}
+
+interface AuthConfig {
+  _id: string
+  name: string
+  type: AuthType
+  config: BasicAuthConfig | BearerAuthConfig
+}
+
+export interface BasicAuthConfig {
+  username: string
+  password: string
+}
+
+export interface BearerAuthConfig {
+  token: string
+}
+
 export interface QueryParameter {
   name: string
   default: string
@@ -210,6 +231,7 @@ export interface RestQueryFields {
   bodyType: string
   json: object
   method: string
+  authConfigId: string
 }
 
 export interface RestConfig {
@@ -217,6 +239,7 @@ export interface RestConfig {
   defaultHeaders: {
     [key: string]: any
   }
+  authConfigs: AuthConfig[]
 }
 
 export interface Query {

package/src/integrations/base/IntegrationBase.ts

@@ -1,6 +1,6 @@
 export interface IntegrationBase {
-  create?(query: any): Promise<any[]|any>
-  read?(query: any): Promise<any[]|any>
-  update?(query: any): Promise<any[]|any>
-  delete?(query: any): Promise<any[]|any>
+  create?(query: any): Promise<any[] | any>
+  read?(query: any): Promise<any[] | any>
+  update?(query: any): Promise<any[] | any>
+  delete?(query: any): Promise<any[] | any>
 }

package/src/integrations/rest.ts

@@ -4,6 +4,9 @@ import {
   QueryTypes,
   RestConfig,
   RestQueryFields as RestQuery,
+  AuthType,
+  BasicAuthConfig,
+  BearerAuthConfig
 } from "../definitions/datasource"
 import { IntegrationBase } from "./base/IntegrationBase"
 
@@ -147,11 +150,43 @@ module RestModule {
       return complete
     }
 
+    getAuthHeaders(authConfigId: string): { [key: string]: any }{
+      let headers: any = {}
+
+      if (this.config.authConfigs && authConfigId) {
+        const authConfig = this.config.authConfigs.filter(
+          c => c._id === authConfigId
+        )[0]
+        // check the config still exists before proceeding
+        // if not - do nothing
+        if (authConfig) {
+          let config
+          switch (authConfig.type) {
+            case AuthType.BASIC:
+              config = authConfig.config as BasicAuthConfig
+              headers.Authorization = `Basic ${Buffer.from(
+                `${config.username}:${config.password}`
+              ).toString("base64")}`
+              break
+            case AuthType.BEARER:
+              config = authConfig.config as BearerAuthConfig
+              headers.Authorization = `Bearer ${config.token}`
+              break
+          }
+        }
+      }
+
+      return headers
+    }
+
     async _req(query: RestQuery) {
-      const { path = "", queryString = "", headers = {}, method = "GET", disabledHeaders, bodyType, requestBody } = query
+      const { path = "", queryString = "", headers = {}, method = "GET", disabledHeaders, bodyType, requestBody, authConfigId } = query
+      const authHeaders = this.getAuthHeaders(authConfigId)
+
       this.headers = {
         ...this.config.defaultHeaders,
         ...headers,
+        ...authHeaders,
       }
 
       if (disabledHeaders) {
@@ -177,7 +212,8 @@ module RestModule {
       }
 
       this.startTimeMs = performance.now()
-      const response = await fetch(this.getUrl(path, queryString), input)
+      const url = this.getUrl(path, queryString)
+      const response = await fetch(url, input)
       return await this.parseResponse(response)
     }
 
@@ -205,5 +241,6 @@ module RestModule {
   module.exports = {
     schema: SCHEMA,
     integration: RestIntegration,
+    AuthType,
   }
 }

package/src/integrations/tests/rest.spec.js

@@ -12,6 +12,7 @@ jest.mock("node-fetch", () =>
 )
 const fetch = require("node-fetch")
 const RestIntegration = require("../rest")
+const { AuthType } = require("../rest")
 
 class TestConfiguration {
   constructor(config = {}) {
@@ -112,4 +113,58 @@ describe("REST Integration", () => {
       body: '{"name":"test"}',
     })
   })
+
+  describe("authentication", () => {
+    const basicAuth = {
+      _id: "c59c14bd1898a43baa08da68959b24686",
+      name: "basic-1",
+      type : AuthType.BASIC,
+      config : {
+        username: "user",
+        password: "password"
+      }
+    }
+    
+    const bearerAuth = {
+      _id: "0d91d732f34e4befabeff50b392a8ff3",
+      name: "bearer-1",
+      type : AuthType.BEARER,
+      config : {
+        "token": "mytoken"
+      }
+    }
+
+    beforeEach(() => {
+      config = new TestConfiguration({
+        url: BASE_URL,
+        authConfigs : [basicAuth, bearerAuth]
+      })
+    })
+
+    it("adds basic auth", async () => {
+      const query = {
+        authConfigId: "c59c14bd1898a43baa08da68959b24686"
+      }
+      await config.integration.read(query)
+      expect(fetch).toHaveBeenCalledWith(`${BASE_URL}/?`, {
+        method: "GET",
+        headers: {
+          Authorization: "Basic dXNlcjpwYXNzd29yZA=="
+        },
+      })
+    })
+
+    it("adds bearer auth", async () => {
+      const query = {
+        authConfigId: "0d91d732f34e4befabeff50b392a8ff3"
+      }
+      await config.integration.read(query)
+      expect(fetch).toHaveBeenCalledWith(`${BASE_URL}/?`, {
+        method: "GET",
+        headers: {
+          Authorization: "Bearer mytoken"
+        },
+      })
+    })
+  })
 })