@budibase/server 2.2.12-alpha.56 → 2.2.12-alpha.57

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "2.2.12-alpha.56",
+  "version": "2.2.12-alpha.57",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -43,11 +43,11 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@budibase/backend-core": "2.2.12-alpha.56",
-    "@budibase/client": "2.2.12-alpha.56",
-    "@budibase/pro": "2.2.12-alpha.55",
-    "@budibase/string-templates": "2.2.12-alpha.56",
-    "@budibase/types": "2.2.12-alpha.56",
+    "@budibase/backend-core": "2.2.12-alpha.57",
+    "@budibase/client": "2.2.12-alpha.57",
+    "@budibase/pro": "2.2.12-alpha.56",
+    "@budibase/string-templates": "2.2.12-alpha.57",
+    "@budibase/types": "2.2.12-alpha.57",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -169,5 +169,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "4ca1615b1ad55384020e25047b47faee502df863"
+  "gitHead": "8545cc3943a9a8f59a7587d84cd67bf8038d5219"
 }

package/src/integrations/couchdb.ts

@@ -1,11 +1,12 @@
 import {
-  Integration,
   DatasourceFieldType,
-  QueryType,
+  Document,
+  Integration,
   IntegrationBase,
+  QueryType,
 } from "@budibase/types"
-
-const PouchDB = require("pouchdb")
+import { db as dbCore } from "@budibase/backend-core"
+import { DatabaseWithConnection } from "@budibase/backend-core/src/db"
 
 interface CouchDBConfig {
   url: string
@@ -39,6 +40,15 @@ const SCHEMA: Integration = {
     update: {
       type: QueryType.JSON,
     },
+    get: {
+      type: QueryType.FIELDS,
+      fields: {
+        id: {
+          type: DatasourceFieldType.STRING,
+          required: true,
+        },
+      },
+    },
     delete: {
       type: QueryType.FIELDS,
       fields: {
@@ -57,7 +67,7 @@ class CouchDBIntegration implements IntegrationBase {
 
   constructor(config: CouchDBConfig) {
     this.config = config
-    this.client = new PouchDB(`${config.url}/${config.database}`)
+    this.client = dbCore.DatabaseWithConnection(config.database, config.url)
   }
 
   async query(
@@ -66,31 +76,48 @@ class CouchDBIntegration implements IntegrationBase {
     query: { json?: object; id?: string }
   ) {
     try {
-      const response = await this.client[command](query.id || query.json)
-      await this.client.close()
-      return response
+      return await this.client[command](query.id || query.json)
     } catch (err) {
       console.error(errorMsg, err)
       throw err
     }
   }
 
-  async create(query: { json: object }) {
-    return this.query("post", "Error writing to couchDB", query)
+  private parse(query: { json: string | object }) {
+    return typeof query.json === "string" ? JSON.parse(query.json) : query.json
+  }
+
+  async create(query: { json: string | object }) {
+    const parsed = this.parse(query)
+    return this.query("post", "Error writing to couchDB", { json: parsed })
   }
 
-  async read(query: { json: object }) {
+  async read(query: { json: string | object }) {
+    const parsed = this.parse(query)
     const result = await this.query("allDocs", "Error querying couchDB", {
       json: {
         include_docs: true,
-        ...query.json,
+        ...parsed,
       },
     })
     return result.rows.map((row: { doc: object }) => row.doc)
   }
 
-  async update(query: { json: object }) {
-    return this.query("put", "Error updating couchDB document", query)
+  async update(query: { json: string | object }) {
+    const parsed: Document = this.parse(query)
+    if (!parsed?._rev && parsed?._id) {
+      const oldDoc = await this.get({ id: parsed._id })
+      parsed._rev = oldDoc._rev
+    }
+    return this.query("put", "Error updating couchDB document", {
+      json: parsed,
+    })
+  }
+
+  async get(query: { id: string }) {
+    return this.query("get", "Error retrieving couchDB document by ID", {
+      id: query.id,
+    })
   }
 
   async delete(query: { id: string }) {

package/src/integrations/tests/couchdb.spec.ts

@@ -1,23 +1,32 @@
-jest.mock(
-  "pouchdb",
-  () =>
-    function CouchDBMock(this: any) {
-      this.post = jest.fn()
-      this.allDocs = jest.fn(() => ({ rows: [] }))
-      this.put = jest.fn()
-      this.get = jest.fn()
-      this.remove = jest.fn()
-      this.plugin = jest.fn()
-      this.close = jest.fn()
-    }
-)
+import { DatabaseWithConnection } from "@budibase/backend-core/src/db"
+
+jest.mock("@budibase/backend-core", () => {
+  const core = jest.requireActual("@budibase/backend-core")
+  return {
+    ...core,
+    db: {
+      ...core.db,
+      DatabaseWithConnection: function () {
+        return {
+          post: jest.fn(),
+          allDocs: jest.fn().mockReturnValue({ rows: [] }),
+          put: jest.fn(),
+          get: jest.fn().mockReturnValue({ _rev: "a" }),
+          remove: jest.fn(),
+        }
+      },
+    },
+  }
+})
 
 import { default as CouchDBIntegration } from "../couchdb"
 
 class TestConfiguration {
   integration: any
 
-  constructor(config: any = {}) {
+  constructor(
+    config: any = { url: "http://somewhere", database: "something" }
+  ) {
     this.integration = new CouchDBIntegration.integration(config)
   }
 }
@@ -33,8 +42,8 @@ describe("CouchDB Integration", () => {
     const doc = {
       test: 1,
     }
-    const response = await config.integration.create({
-      json: doc,
+    await config.integration.create({
+      json: JSON.stringify(doc),
     })
     expect(config.integration.client.post).toHaveBeenCalledWith(doc)
   })
@@ -44,8 +53,8 @@ describe("CouchDB Integration", () => {
       name: "search",
     }
 
-    const response = await config.integration.read({
-      json: doc,
+    await config.integration.read({
+      json: JSON.stringify(doc),
     })
 
     expect(config.integration.client.allDocs).toHaveBeenCalledWith({
@@ -60,11 +69,14 @@ describe("CouchDB Integration", () => {
       name: "search",
     }
 
-    const response = await config.integration.update({
-      json: doc,
+    await config.integration.update({
+      json: JSON.stringify(doc),
     })
 
-    expect(config.integration.client.put).toHaveBeenCalledWith(doc)
+    expect(config.integration.client.put).toHaveBeenCalledWith({
+      ...doc,
+      _rev: "a",
+    })
   })
 
   it("calls the delete method with the correct params", async () => {