Merge pull request #534 from oscar-ekeyekwu/v2

chore: encapsulate DB connection function for use in controller methods

Author: simply-alliv

.env.sample .env.example.env.sample renamed to .env.example

@@ -39,6 +39,7 @@
     "express": "^4.17.1",
     "express-jwt": "^5.3.3",
     "jsonwebtoken": "^8.5.1",
+    "mongoose": "^5.9.27",
     "swagger-jsdoc": "^4.0.0",
     "swagger-ui-express": "^4.1.4"
   },

package-lock.json

@@ -0,0 +1,48 @@
+const mongoose = require("mongoose");
+const IndexModel = require("../../models/index");
+const { connect, disconnect } = require("../database");
+require("dotenv").config();
+
+describe("INSERT", () => {
+  test("Should confirm mongodb works by adding a record", async () => {
+    console.log("Attempting to connect to database...");
+    await connect(
+      "mongodb+srv://microapi:secret123@cluster0.japiw.mongodb.net/microapi?retryWrites=true&w=majority"
+    );
+    const id = mongoose.Types.ObjectId();
+    const mockData = new IndexModel({
+      _id: id,
+      name: "Oscar",
+    });
+    await mockData.save();
+    const insertedData = await IndexModel.findById(id);
+    expect(insertedData.id).toEqual(mockData.id);
+    expect(insertedData.name).toEqual(mockData.name);
+
+    await disconnect();
+  });
+
+  test("Should catch connection string error", async () => {
+    console.log("Attempting to connect to database...");
+    expect(await connect("")).toEqual(Error("Invalid connection string"));
+  });
+
+  test("Should return error for existing connections", async () => {
+    console.log("Attempting to connect to database...");
+    mongoose.connection.readyState = 1;
+    expect(
+      await connect(
+        "mongodb+srv://microapi:secret123@cluster0.japiw.mongodb.net/microapi?retryWrites=true&w=majority"
+      )
+    ).toEqual(Error("Connection already Established"));
+  });
+
+  test("Should return error for non-existing connections on disconnec", async () => {
+    console.log("Attempting to connect to database...");
+    await connect(
+      "mongodb+srv://microapi:secret123@cluster0.japiw.mongodb.net/microapi?retryWrites=true&w=majority"
+    );
+    mongoose.connection.readyState = 0;
+    expect(await disconnect()).toEqual(Error("No open connection(s)"));
+  });
+});

package.json

@@ -0,0 +1,31 @@
+const mongoose = require("mongoose");
+
+const connect = async (connectionUri) => {
+  if (mongoose.connection.readyState === 0) {
+    try {
+      await mongoose.connect(connectionUri, {
+        useNewUrlParser: true,
+        useCreateIndex: true,
+        useFindAndModify: false,
+        useUnifiedTopology: true,
+      });
+    } catch (err) {
+      return new Error(err.message);
+    }
+  } else {
+    return new Error("Connection already Established");
+  }
+};
+
+const disconnect = async () => {
+  if (mongoose.connection.readyState !== 0) {
+    await mongoose.disconnect();
+  } else {
+    return new Error("No open connection(s)");
+  }
+};
+
+module.exports = {
+  connect,
+  disconnect,
+};

src/db/__test__/config/setup.js

@@ -0,0 +1,11 @@
+const mongoose = require("mongoose");
+const Schema = mongoose.Schema;
+
+const IndexSchema = new Schema({
+  name: {
+    type: String,
+    default: "A name",
+  },
+});
+
+module.exports = mongoose.model("Index", IndexSchema);