@budibase/server 1.0.105-alpha.34 → 1.0.105-alpha.37

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "1.0.105-alpha.34",
+  "version": "1.0.105-alpha.37",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -68,10 +68,10 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.0.3",
-    "@budibase/backend-core": "^1.0.105-alpha.34",
-    "@budibase/client": "^1.0.105-alpha.34",
-    "@budibase/pro": "^1.0.0",
-    "@budibase/string-templates": "^1.0.105-alpha.34",
+    "@budibase/backend-core": "^1.0.105-alpha.37",
+    "@budibase/client": "^1.0.105-alpha.37",
+    "@budibase/pro": "1.0.105-alpha.34",
+    "@budibase/string-templates": "^1.0.105-alpha.37",
     "@bull-board/api": "^3.7.0",
     "@bull-board/koa": "^3.7.0",
     "@elastic/elasticsearch": "7.10.0",
@@ -160,6 +160,7 @@
     "copyfiles": "^2.4.1",
     "docker-compose": "^0.23.6",
     "eslint": "^6.8.0",
+    "ioredis-mock": "^7.2.0",
     "is-wsl": "^2.2.0",
     "jest": "^27.0.5",
     "jest-openapi": "^0.14.2",
@@ -179,5 +180,5 @@
   "optionalDependencies": {
     "oracledb": "^5.3.0"
   },
-  "gitHead": "2ef5d7ba780f5d95f77337c64407c3b0879e1935"
+  "gitHead": "8a4ad5e128a4683379c91206dc0dc73f9408abf7"
 }

package/src/definitions/datasource.ts

@@ -49,6 +49,7 @@ export enum SourceNames {
   ORACLE = "ORACLE",
   GOOGLE_SHEETS = "GOOGLE_SHEETS",
   FIREBASE = "FIREBASE",
+  REDIS = "REDIS",
 }
 
 export enum IncludeRelationships {

package/src/integrations/index.ts

@@ -11,6 +11,7 @@ const arangodb = require("./arangodb")
 const rest = require("./rest")
 const googlesheets = require("./googlesheets")
 const firebase = require("./firebase")
+const redis = require("./redis")
 const { SourceNames } = require("../definitions/datasource")
 const environment = require("../environment")
 
@@ -26,6 +27,8 @@ const DEFINITIONS = {
   [SourceNames.MYSQL]: mysql.schema,
   [SourceNames.ARANGODB]: arangodb.schema,
   [SourceNames.REST]: rest.schema,
+  [SourceNames.FIREBASE]: firebase.schema,
+  [SourceNames.REDIS]: redis.schema,
 }
 
 const INTEGRATIONS = {
@@ -42,6 +45,7 @@ const INTEGRATIONS = {
   [SourceNames.REST]: rest.integration,
   [SourceNames.FIREBASE]: firebase.integration,
   [SourceNames.GOOGLE_SHEETS]: googlesheets.integration,
+  [SourceNames.REDIS]: redis.integration,
 }
 
 // optionally add oracle integration if the oracle binary can be installed

package/src/integrations/redis.ts

@@ -0,0 +1,152 @@
+import {
+  DatasourceFieldTypes,
+  Integration,
+  QueryTypes,
+} from "../definitions/datasource"
+import Redis from "ioredis"
+
+module RedisModule {
+  interface RedisConfig {
+    host: string
+    port: number
+    username: string
+    password?: string
+  }
+
+  const SCHEMA: Integration = {
+    docs: "https://redis.io/docs/",
+    description: "",
+    friendlyName: "Redis",
+    datasource: {
+      host: {
+        type: "string",
+        required: true,
+        default: "localhost",
+      },
+      port: {
+        type: "number",
+        required: true,
+        default: 6379,
+      },
+      username: {
+        type: "string",
+        required: false,
+      },
+      password: {
+        type: "password",
+        required: false,
+      },
+    },
+    query: {
+      create: {
+        type: QueryTypes.FIELDS,
+        fields: {
+          key: {
+            type: DatasourceFieldTypes.STRING,
+            required: true,
+          },
+          value: {
+            type: DatasourceFieldTypes.STRING,
+            required: true,
+          },
+          ttl: {
+            type: DatasourceFieldTypes.NUMBER,
+          },
+        },
+      },
+      read: {
+        readable: true,
+        type: QueryTypes.FIELDS,
+        fields: {
+          key: {
+            type: DatasourceFieldTypes.STRING,
+            required: true,
+          },
+        },
+      },
+      delete: {
+        type: QueryTypes.FIELDS,
+        fields: {
+          key: {
+            type: DatasourceFieldTypes.STRING,
+            required: true,
+          },
+        },
+      },
+      command: {
+        readable: true,
+        displayName: "Redis Command",
+        type: QueryTypes.JSON,
+      },
+    },
+  }
+
+  class RedisIntegration {
+    private readonly config: RedisConfig
+    private client: any
+
+    constructor(config: RedisConfig) {
+      this.config = config
+      this.client = new Redis({
+        host: this.config.host,
+        port: this.config.port,
+        username: this.config.username,
+        password: this.config.password,
+      })
+    }
+
+    async disconnect() {
+      this.client.disconnect()
+    }
+
+    async redisContext(query: Function) {
+      try {
+        return await query()
+      } catch (err) {
+        throw new Error(`Redis error: ${err}`)
+      } finally {
+        this.disconnect()
+      }
+    }
+
+    async create(query: { key: string; value: string; ttl: number }) {
+      return this.redisContext(async () => {
+        const response = await this.client.set(query.key, query.value)
+        if (query.ttl) {
+          await this.client.expire(query.key, query.ttl)
+        }
+        return response
+      })
+    }
+
+    async read(query: { key: string }) {
+      return this.redisContext(async () => {
+        const response = await this.client.get(query.key)
+        return response
+      })
+    }
+
+    async delete(query: { key: string }) {
+      return this.redisContext(async () => {
+        const response = await this.client.del(query.key)
+        return response
+      })
+    }
+
+    async command(query: { json: string }) {
+      return this.redisContext(async () => {
+        const commands = query.json.trim().split(" ")
+        const pipeline = this.client.pipeline([commands])
+        const result = await pipeline.exec()
+        return {
+          response: result[0][1],
+        }
+      })
+    }
+  }
+
+  module.exports = {
+    schema: SCHEMA,
+    integration: RedisIntegration,
+  }
+}

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

@@ -0,0 +1,60 @@
+const Redis = require("ioredis-mock")
+const RedisIntegration = require("../redis")
+
+class TestConfiguration {
+  constructor(config = {}) {
+    this.integration = new RedisIntegration.integration(config) 
+    this.redis = new Redis({
+      data: {
+        test: 'test',
+        result: "1"
+      },
+    })
+    this.integration.client = this.redis
+  }
+}
+
+describe("Redis Integration", () => {
+  let config 
+
+  beforeEach(() => {
+    config = new TestConfiguration()
+  })
+
+  it("calls the create method with the correct params", async () => {
+    const body = {
+      key: "key",
+      value: "value"
+    }
+    const response = await config.integration.create(body)
+    expect(await config.redis.get("key")).toEqual("value")
+  })
+
+  it("calls the read method with the correct params", async () => {
+    const body = {
+      key: "test"
+    }
+    const response = await config.integration.read(body)
+    expect(response).toEqual("test")
+  })
+
+  it("calls the delete method with the correct params", async () => {
+    const body = {
+      key: "test"
+    }
+    await config.integration.delete(body)
+    expect(await config.redis.get(body.key)).toEqual(null)
+  })
+
+  it("calls the command method with the correct params", async () => {
+    const body = {
+      json: "KEYS *"
+    }
+
+    // ioredis-mock doesn't support pipelines
+    config.integration.client.pipeline = jest.fn(() => ({ exec: jest.fn(() => [[]]) }))
+
+    await config.integration.command(body)
+    expect(config.integration.client.pipeline).toHaveBeenCalledWith([["KEYS", "*"]])
+  })
+})

package/src/threads/utils.js

@@ -72,6 +72,7 @@ exports.hasExtraData = response => {
   return (
     typeof response === "object" &&
     !Array.isArray(response) &&
+    response &&
     response.data != null &&
     response.info != null
   )