updating validator, transform, and test examples

Author: ChadKluck

application-infrastructure/src/config/validations.js

@@ -29,19 +29,26 @@ const statusCodePathParameter = (code) => {
 	return statusCodes.some((statusCode) => statusCode.code === code);
 };
 
+/**
+ * Ensure id is in 'G-<8-char-hex>' format
+ * @param {string} id - The id to validate
+ * @returns {boolean} - True if the id is valid, false otherwise
+ */
 const idPathParameter = (id) => {
 	if (!id) return false;
-	if (!isString(id)) return false;
-	// separate id by -
-	const [char, gid] = id.split("-");
-	if (!char || !gid) return false;
-	if (!isStringOfNumbers(gid)) return false;
-	// check if char is a letter
-	if (!char.match(/[A-Z]/)) return false;
-	// check if number is a number within range
-	const idNumber = parseInt(gid, 10);
-	if (isNaN(idNumber)) return false; // not a number
-	if (idNumber < 1 || idNumber > 15) return false;
+	if (!char.match(/^G\-[a-f0-9]{8}$/)) return false;
+	return true;
+};
+
+/**
+ * Ensure players is a number between 1 and 10
+ * @param {string} players - The players to validate
+ * @returns {boolean} - True if the players is valid, false otherwise
+ */
+const playersQueryParameter = (players) => {
+	if (!players) return false;
+	if (!isStringOfNumbers(players)) return false;
+	if (players < 1 || players > 10) return false;
 	return true;
 };
 
@@ -55,11 +62,13 @@ module.exports = {
 	parameters: {
 		pathParameters: {
 			code: statusCodePathParameter,
-			id: idPathParameter
-		}
-		//, queryParameter: {}
-		//, headerParameter: {}
-		//, cookieParameter: {}
-		//, bodyParameter: {}		
+			id: idPathParameter,
+		},
+		queryParameters: {
+			players: playersQueryParameter,
+		},
+		// headerParameters: {},
+		// cookieParameters: {},
+		// bodyParameters: {},	
 	}
 };

application-infrastructure/src/models/test-data/example.view.output.json

@@ -1,23 +1,23 @@
 {
   "count": 15,
   "items": [
-    { "game_id": "G-1", "display_name": "Falken's Maze" },
-    { "game_id": "G-2", "display_name": "Black Jack" },
-    { "game_id": "G-3", "display_name": "Gin Rummy" },
-    { "game_id": "G-4", "display_name": "Hearts" },
-    { "game_id": "G-5", "display_name": "Bridge" },
-    { "game_id": "G-6", "display_name": "Checkers" },
-    { "game_id": "G-7", "display_name": "Chess" },
-    { "game_id": "G-8", "display_name": "Poker" },
-    { "game_id": "G-9", "display_name": "Fighter Combat" },
-    { "game_id": "G-10", "display_name": "Guerrilla Engagement" },
-    { "game_id": "G-11", "display_name": "Desert Warfare" },
-    { "game_id": "G-12", "display_name": "Air-To-Ground Actions" },
-    { "game_id": "G-13", "display_name": "Theaterwide Tactical Warfare" },
+    { "id": "G-cea73c4b", "display_name": "Falken's Maze" },
+    { "id": "G-8f494e5b", "display_name": "Black Jack" },
+    { "id": "G-4a09ad1c", "display_name": "Gin Rummy" },
+    { "id": "G-73b8058c", "display_name": "Hearts" },
+    { "id": "G-f1cf6201", "display_name": "Bridge" },
+    { "id": "G-fd325ad0", "display_name": "Checkers" },
+    { "id": "G-c170b666", "display_name": "Chess" },
+    { "id": "G-0ac0647a", "display_name": "Poker" },
+    { "id": "G-c12ac225", "display_name": "Fighter Combat" },
+    { "id": "G-7fb4f254", "display_name": "Guerrilla Engagement" },
+    { "id": "G-f07993c7", "display_name": "Desert Warfare" },
+    { "id": "G-03cbb530", "display_name": "Air-To-Ground Actions" },
+    { "id": "G-603f6cd0", "display_name": "Theaterwide Tactical Warfare" },
     {
-      "game_id": "G-14",
+      "id": "G-2e22e975",
       "display_name": "Theaterwide Biotoxic and Chemical Warfare"
     },
-    { "game_id": "G-15", "display_name": "Global Thermonuclear War" }
+    { "id": "G-dd2ea1b3", "display_name": "Global Thermonuclear War" }
   ]
 }

application-infrastructure/src/tests/index.mjs

@@ -8,6 +8,7 @@ import { readFile } from 'fs/promises';
 import { expect } from "chai";
 
 import validations from '../config/validations.js';
+import utils from '../utils/index.js';
 import { view as exampleView } from '../views/example.view.js';
 
 
@@ -53,7 +54,7 @@ describe('Test validations from config/validations.js', () => {
 			});
 		});
 
-		it('should reject invalid org codes', () => {
+		it('should reject invalid status codes', () => {
 			const invalidCodes = ['', '123', 'ABCD', 'A1', '1A', 'AAA'];
 			invalidCodes.forEach(code => {
 				expect(validations.parameters.pathParameters.code(code), `Status code ${code} should be invalid`).to.be.false;
@@ -112,6 +113,41 @@ describe('Test validations from config/validations.js', () => {
 	})
 });
 
+/* ****************************************************************************
+ * Utils
+ */
+
+describe('Test utils', () => {
+	describe('utils.hash.hashLast8', () => {
+		it('should return a string of length 8', () => {
+			const input = 'example';
+			const result = utils.hash.hashLast8(input);
+			expect(result).to.be.a('string');
+			expect(result).to.have.lengthOf(8);
+		});
+
+		it('should return a different string for different inputs', () => {
+			const input1 = 'example1';
+			const input2 = 'example2';
+			const result1 = utils.hash.hashLast8(input1);
+			const result2 = utils.hash.hashLast8(input2);
+			expect(result1).to.not.equal(result2);
+		});
+
+		it('should return the same string for the same input', () => {
+			const input = 'example';
+			const result1 = utils.hash.hashLast8(input);
+			const result2 = utils.hash.hashLast8(input);
+			expect(result1).to.equal(result2);
+		});
+
+		it('should return a string containing only valid characters', () => {
+			const input = 'example';
+			const result = utils.hash.hashLast8(input);
+			expect(result).to.match(/^[a-f0-9]+$/);
+		});
+	});
+});
 
 /* ****************************************************************************
  * Views

application-infrastructure/src/utils/hash.js

@@ -0,0 +1,12 @@
+const crypto = require('crypto');
+
+/**
+ * Hash a string using SHA256 and return the last 8 characters
+ * @param {string} input - The string to hash
+ * @returns {string} The last 8 characters of the SHA256 hash
+ */
+const hashLast8 = (input) => {
+    return crypto.createHash('sha256').update(input).digest('hex').slice(-8);
+};
+
+module.exports = { hashLast8 };

application-infrastructure/src/utils/index.js

@@ -1,6 +1,8 @@
 
 const func = require('./helper-functions.js');
+const hash = require('./hash.js');
 
 module.exports = {
-	func
+	func,
+	hash
 };

application-infrastructure/src/views/example.view.js

@@ -2,8 +2,13 @@
 	A view should be called from the controller, or if the view is cached, from the service.
 */
 
-const { tools: {Timer} } = require("@63klabs/cache-data");
-const { DebugAndLog } = require("@63klabs/cache-data/src/lib/tools");
+const { 
+	tools: {
+		Timer
+	}
+} = require("@63klabs/cache-data");
+
+const utils = require('../utils');
 
 const logIdentifier = "Example View";
 
@@ -18,18 +23,20 @@ const filter = (dataItem = null) => {
 	return include;
 }
 
-// For this data we want to assign an index to each item in the view, so we can track it
-let index = 0;
-
 /**
  * Generic transformer
  * @param {object} data 
  * @returns {object} data
  */
 const transform = (data) => {
 
+	// take data and create an 8 character hash
+	// since we only expect a list of <20 games this is okay for an example
+	// using sha256, create a hash and retain the last 8 characters
+	const hashId = utils.hash.hashLast8(data);
+
 	const returnData = {
-		game_id: `G-${++index}`,
+		game_id: `G-${hashId}`,
 		display_name: data
 	};