Merge pull request #14 from ubccsss/daniel/node-pg-tests

Added tests for CRUD query functions and implemented DB helpers/ItemIndividualQuery

Author: daniel-panhead

.env.test

@@ -1,5 +1,7 @@
 POSTGRES_USER=admin
 POSTGRES_PASSWORD=root
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
 POSTGRES_DB=test_data
 POSTGRES_DATA_PATH="database/test_data" # Relative path to directory holding DB data
 POSTGRES_INIT_PATH="database/init_test" # Relative path to directory containing init files

.kanelrc.js

@@ -27,21 +27,9 @@ module.exports = {
   preDeleteOutputFolder: true,
   outputPath: "./src/types/db",
 
-  // Postgres bigints are assumed to represent monetary values and converted to Dinero.js objects
+  // Postgres bigints are mapped to JS bigints
   customTypeMap: {
-    "pg_catalog.tsvector": "string",
-    "pg_catalog.bpchar": "string",
-    "pg_catalog.int8": {
-      name: "Dinero",
-      typeImports: [
-        {
-          name: "Dinero",
-          path: "dinero.js",
-          isAbsolute: true,
-          isDefault: false
-        }
-      ]
-    }
+    "pg_catalog.int8": "bigint"
   },
 
   // This implementation will generate flavored instead of branded types.

database/README.md

@@ -11,6 +11,8 @@ When setting up the `.env` file, take care to use the correct database names sin
 ```bash
 POSTGRES_USER="<username>"
 POSTGRES_PASSWORD="<password>"
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
 POSTGRES_DB=["cube_data"|"test_data"]
 POSTGRES_DATA_PATH=["database/data"|"database/test_data"]
 POSTGRES_INIT_PATH=["database/init"|"database/init_test"]

docker-compose.yaml

@@ -5,7 +5,7 @@ services:
     image: postgres
     hostname: localhost
     ports:
-      - "5432:5432"
+      - "5432:${POSTGRES_PORT}"
     environment:
       POSTGRES_USER: ${POSTGRES_USER}
       POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}

package-lock.json

@@ -19,6 +19,7 @@
     "chai": "^5.0.0",
     "cors": "^2.8.5",
     "dinero.js": "^1.9.1",
+    "dotenv": "^16.4.1",
     "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jsdoc": "^48.0.2",
@@ -34,7 +35,7 @@
   "scripts": {
     "start": "tsx src/App.ts",
     "lint": "eslint src test --ext .ts",
-    "test": "mocha --require tsx --timeout 10000 --extension .spec.ts --recursive test",
+    "test": "mocha --require tsx --require dotenv/config --timeout 10000 --extension .spec.ts --recursive test --exit dotenv_config_path=./.env.test",
     "fix": "npm run lint -- --fix"
   },
   "description": "### What will you be building, and how will it be used?",

package.json

@@ -1,4 +1,5 @@
 import Server from "./rest/Server";
+import "dotenv/config";
 
 /**
  * Main app class that is run with the node command. Starts the server.

src/App.ts

@@ -1,15 +1,26 @@
-import {Pool} from "pg";
+import {Pool, types} from "pg";
 import type {QueryResult} from "pg";
 
-export default class DB {
-	private pool: Pool;
+const UINT8_OID = 20;
+types.setTypeParser(UINT8_OID, (val) => BigInt(val));
 
-	constructor() {
-		this.pool = new Pool();
-	}
 
-	public query(text: string, params: any[]): Promise<QueryResult> {
-		return this.pool.query(text, params);
-	}
+const pool = new Pool({
+	user: process.env.POSTGRES_USER,
+	password: process.env.POSTGRES_PASSWORD,
+	host: process.env.POSTGRES_HOST,
+	port: process.env.POSTGRES_PORT,
+	database: process.env.POSTGRES_DB,
+});
 
-}
+pool.on("error", (err, client) => {
+	console.log(`Client in pool experienced error: ${err}`);
+});
+
+export const query = async (text: string, params?: any[]): Promise<QueryResult<any>> => {
+	return await pool.query(text, params);
+};
+
+export const checkoutClient = async () => {
+	return await pool.connect();
+};

src/db/DB.ts

@@ -2,27 +2,69 @@ import ItemIndividual,
 {ItemId, ItemIndividualInitializer, ItemIndividualMutator} from "../../types/db/public/ItemIndividual";
 import {Category} from "../../types/db/public/ValidCategory";
 import {SimpleCrudQueryable} from "../Queryable";
+import * as DB from "../../db/DB";
 
 const simpleCrudQueries:
 SimpleCrudQueryable<ItemIndividual, ItemIndividualInitializer, ItemIndividualMutator, ItemId> = {
 	async create(object: ItemIndividualInitializer): Promise<ItemIndividual> {
-		throw new Error("Method not implemented.");
+		// Object.keys and Object.values return things in the same order so this is safe
+		const keys = Object.keys(object);
+		const values = Object.values(object);
+
+		const queryResponse = await DB.query(
+			`INSERT INTO item_individual (${keys.join(",")})` +
+			`VALUES (${keys.map((prop, i) => `$${i + 1}`).join(",")})` +
+			"RETURNING *",
+			values
+		);
+		if (queryResponse.rows.length === 1) {
+			return queryResponse.rows[0];
+		} else {
+			return null;
+		}
 	},
 
 	async read(itemId: ItemId): Promise<ItemIndividual> {
-		throw new Error("Method not implemented.");
+		const queryResponse = await DB.query(
+			"SELECT * FROM item_individual WHERE item_id=$1",
+			[itemId]
+		);
+		if (queryResponse.rows.length === 1) {
+			return queryResponse.rows[0];
+		} else {
+			return null;
+		}
 	},
 
 	async readAll(): Promise<ItemIndividual[]> {
-		throw new Error("Method not implemented.");
+		const queryResponse = await DB.query("SELECT * FROM item_individual");
+		return queryResponse.rows;
 	},
 
 	async update(itemId: ItemId, mutateObject: ItemIndividualMutator): Promise<ItemIndividual> {
-		throw new Error("Method not implemented.");
+		if (Object.keys(mutateObject).length === 0) {
+			return null;
+		}
+
+		// Use i+2 for parameter so that $1 is reserved for the item id
+		const keys = Object.keys(mutateObject).map((prop, i) => `${prop}=$${i + 2}`);
+		const queryResponse = await DB.query(
+			`UPDATE item_individual SET ${keys.join(",")} WHERE item_id=$1 RETURNING *`,
+			[itemId, ...Object.values(mutateObject)]
+		);
+		if (queryResponse.rows.length === 1) {
+			return queryResponse.rows[0];
+		} else {
+			return null;
+		}
 	},
 
 	async delete(itemId: ItemId): Promise<boolean> {
-		throw new Error("Method not implemented.");
+		const queryResponse = await DB.query(
+			"DELETE FROM item_individual WHERE item_id=$1",
+			[itemId]
+		);
+		return queryResponse.rowCount === 1;
 	}
 };
 

src/db/queries/ItemIndividualQuery.ts

@@ -0,0 +1,17 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      POSTGRES_USER: string;
+      POSTGRES_PASSWORD: string;
+      POSTGRES_HOST: string;
+      POSTGRES_PORT: number;
+      POSTGRES_DB: string;
+      POSTGRES_DATA_PATH: string;
+      POSTGRES_INIT_PATH: string;
+    }
+  }
+}
+
+// If this file has no import/export statements (i.e. is a script)
+// convert it into a module by adding an empty export statement.
+export {};