Merge pull request #47 from cse110-fa22-group29/fix-es6-compatibility

Fix JS unit test ES6 compatibility

.github/workflows/js-unittest.yml

@@ -16,7 +16,9 @@ jobs:
       - name: Install apt updates
         run: sudo apt -y update; sudo apt -y upgrade;
       - name: Install prerequisites
-        run: sudo apt install -y nodejs npm;
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
       - name: Checkout
         uses: actions/checkout@v3
       - name: Install dependencies

package.json

@@ -1,13 +1,15 @@
 {
   "name": "food-journal",
   "version": "1.0.0",
+  "type": "module",
   "scripts": {
-    "test": "mocha --recursive './{,!(node_modules)/**}/*.test.js'",
+    "test": "mocha --recursive --require mock-local-storage './{,!(node_modules)/**}/*.test.js'",
     "lint": "eslint **/*.js",
     "fix-style": "eslint --fix '**/*.js'"
   },
   "devDependencies": {
     "eslint": "^8.27.0",
-    "mocha": "10"
+    "mocha": "10",
+    "mock-local-storage": "^1.1.23"
   }
 }

source/assets/scripts/localStorage.js

@@ -1,6 +1,3 @@
-//
-//module.exports = {getReviewsFromStorage, saveReviewsToStorage};
-
 /**
  * @returns {Array<Object>} An array of reviews found in localStorage
  */

source/assets/scripts/localStorage.test.js

@@ -1,11 +1,9 @@
-const {getReviewsFromStorage, saveReviewsToStorage} = require("./localStorage");
+import {strict as assert} from "node:assert"
-const {environment} = require("./testenv");
+import {describe, it, beforeEach} from "mocha";
-const assert = require("assert");
+import {saveReviewsToStorage, getReviewsFromStorage} from "./localStorage.js";
-const {describe, it, beforeEach} = require("mocha");
 
 beforeEach(() => {
-	window = environment();
+	localStorage.clear();
-	localStorage = window.localStorage;
 });
 
 describe("test app localStorage interaction", () => {
@@ -26,7 +24,8 @@ describe("test app localStorage interaction", () => {
 		assert.deepEqual(getReviewsFromStorage(), reviews);
 	});
 	it("repeated store one more and get", () => {
-		saveReviewsToStorage(reviews);
+		let reviews = [];
+
 		assert.deepEqual(getReviewsFromStorage(), reviews);
 
 		for(let i = 0; i < 1000; i++){

source/assets/scripts/testenv.js

@@ -1,28 +0,0 @@
-module.exports = {environment};
-
-function environment () {
-	const localStorageMock = (function () {
-		let store = {};
-		return {
-			getItem(key) {
-				return store[key];
-			},
-			setItem(key, value) {
-				store[key] = value;
-			},
-			clear() {
-				store = {};
-			},
-			removeItem(key) {
-				delete store[key];
-			},
-			getAll() {
-				return store;
-			},
-		};
-	})();
-
-	let window = {};
-	Object.defineProperty(window, "localStorage", { value: localStorageMock });
-	return window;
-}

testenv/testenv.js

@@ -1,28 +0,0 @@
-module.exports = {environment};
-
-function environment () {
-	const localStorageMock = (function () {
-		let store = {};
-		return {
-			getItem(key) {
-				return store[key];
-			},
-			setItem(key, value) {
-				store[key] = value;
-			},
-			clear() {
-				store = {};
-			},
-			removeItem(key) {
-				delete store[key];
-			},
-			getAll() {
-				return store;
-			},
-		};
-	})();
-
-	let window = {};
-	Object.defineProperty(window, "localStorage", { value: localStorageMock });
-	return window;
-}

testenv/testenv.test.js

@@ -1,81 +0,0 @@
-const {environment} = require("./testenv.js");
-var assert = require("assert");
-var {describe, it, beforeEach} = require("mocha");
-var {saveToLocal, getFromLocal, removeFromLocal, clearLocal} = require("./testenv_helpers");
-
-beforeEach(() => {
-	window = environment();
-});
-
-describe("test localStorage mock", () => {
-	it("test save and fetch", () => {
-		saveToLocal("testkey1", "testvalue1");
-		saveToLocal("testkey2", "testvalue2");
-		saveToLocal("testkey3", "testvalue3");
-		saveToLocal("testkey4", "testvalue4");
-
-		assert.equal(getFromLocal("testkey1"), "testvalue1");
-		assert.equal(getFromLocal("testkey2"), "testvalue2");
-		assert.equal(getFromLocal("testkey3"), "testvalue3");
-		assert.equal(getFromLocal("testkey4"), "testvalue4");
-
-		saveToLocal("testkey6", "testvalue5");
-		assert.equal(getFromLocal("testkey6"), "testvalue5");
-	});
-
-	it("test window locality", () => {
-		assert.equal(getFromLocal("testkey1"), null);
-		assert.equal(getFromLocal("testkey2"), null);
-		assert.equal(getFromLocal("testkey3"), null);
-		assert.equal(getFromLocal("testkey4"), null);
-	});
-
-	it("test delete and fetch", () => {
-		saveToLocal("testkey1", "testvalue1");
-		saveToLocal("testkey2", "testvalue2");
-		saveToLocal("testkey3", "testvalue3");
-		saveToLocal("testkey4", "testvalue4");
-
-		removeFromLocal("testkey3");
-
-		assert.equal(getFromLocal("testkey1"), "testvalue1");
-		assert.equal(getFromLocal("testkey2"), "testvalue2");
-		assert.equal(getFromLocal("testkey3"), null);
-		assert.equal(getFromLocal("testkey4"), "testvalue4");
-
-		removeFromLocal("testkey1");
-
-		assert.equal(getFromLocal("testkey1"), null);
-		assert.equal(getFromLocal("testkey2"), "testvalue2");
-		assert.equal(getFromLocal("testkey3"), null);
-		assert.equal(getFromLocal("testkey4"), "testvalue4");
-
-		removeFromLocal("testkey4");
-		
-		assert.equal(getFromLocal("testkey1"), null);
-		assert.equal(getFromLocal("testkey2"), "testvalue2");
-		assert.equal(getFromLocal("testkey3"), null);
-		assert.equal(getFromLocal("testkey4"), null);
-
-		removeFromLocal("testkey2");
-		
-		assert.equal(getFromLocal("testkey1"), null);
-		assert.equal(getFromLocal("testkey2"), null);
-		assert.equal(getFromLocal("testkey3"), null);
-		assert.equal(getFromLocal("testkey4"), null);
-	});
-
-	it("test clear and fetch", () => {
-		saveToLocal("testkey1", "testvalue1");
-		saveToLocal("testkey2", "testvalue2");
-		saveToLocal("testkey3", "testvalue3");
-		saveToLocal("testkey4", "testvalue4");
-
-		clearLocal();
-
-		assert.equal(getFromLocal("testkey1"), null);
-		assert.equal(getFromLocal("testkey2"), null);
-		assert.equal(getFromLocal("testkey3"), null);
-		assert.equal(getFromLocal("testkey4"), null);
-	});
-});

testenv/testenv_helpers.js

@@ -1,17 +0,0 @@
-module.exports = {saveToLocal, getFromLocal, removeFromLocal, clearLocal};
-
-function saveToLocal (k, v) {
-	window.localStorage.setItem(k, v);
-}
-
-function getFromLocal (k) {
-	return window.localStorage.getItem(k);
-}
-
-function removeFromLocal (k) {
-	window.localStorage.removeItem(k);
-}
-
-function clearLocal () {
-	window.localStorage.clear();
-}