refactor: Fixed sonarjs lint warnings (#254)

* Fixed sonarjs/prefer-immediate-return warnings * Fixed eqeqeq warnings * Fixed sonarjs/no-collapsible-if warnings * Standardized expected exceptions in unit tests * Removed warnings report * Added standard exceptions.js * Added file links to keymaster-app * Refactored wallet exceptions * Refactored createDID exceptions * Consolidated gatekeeper exceptions * Consolidated keymaster exceptions * Added @babel dependency to remove warning * Consolidated poll exceptions * Consolidated more keymaster exceptions * Removed wallet exception * Fixed gk build * Fixed CLI error messages * Consolidated CLI status messages * Refactored isEmpty * Rephrased test descriptions * Refactored jest config * Removed last lint warning * Removed 'only-warn' from lint reporting
KeychainMDIP · Jul 25, 2024 · cf2c41f · cf2c41f
1 parent 69c5eb9
commit cf2c41f
Show file tree

Hide file tree

Showing 28 changed files with 826 additions and 682 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 data/
-keymaster-app/
+src/kc-app/build/
+src/keymaster-app/build/
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -5,7 +5,7 @@
         "node": true,
         "jest": true
     },
-    "plugins": ["sonarjs", "only-warn"],
+    "plugins": ["sonarjs"],
     "extends": ["plugin:sonarjs/recommended-legacy","react-app"],
     "parserOptions": {
         "ecmaVersion": "latest",
@@ -16,6 +16,5 @@
             "error",
             4
         ]
-
     }
-}
+}
diff --git a/Dockerfile.gatekeeper b/Dockerfile.gatekeeper
@@ -16,6 +16,8 @@ RUN cd keymaster-app && npm ci
 
 COPY src/keymaster-app/public ./keymaster-app/public/
 COPY src/keymaster-app/src ./keymaster-app/src/
+COPY src/keymaster-lib.js ./keymaster-app/src/
+COPY src/exceptions.js ./keymaster-app/src/
 RUN cd keymaster-app && npm run build
 
 # Copy app

diff --git a/jest.config.js b/jest.config.js
@@ -1,4 +1,4 @@
-export default {
+const config = {
     transform: {},
     testEnvironment: 'node',
     moduleFileExtensions: ['js', 'mjs'],
@@ -8,3 +8,5 @@ export default {
         "/keymaster-app/"
     ],
 };
+
+export default config;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
+    "@babel/plugin-proposal-private-property-in-object": "^7.21.11",
     "eslint": "^8.57.0",
     "eslint-config-react-app": "^7.0.1",
     "eslint-plugin-only-warn": "^1.1.0",

diff --git a/rebuildGatekeeper b/rebuildGatekeeper
@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 set -e
 
+cp src/exceptions.js src/keymaster-app/src
+cp src/keymaster-lib.js src/keymaster-app/src
 npm --prefix src/keymaster-app run build
 node src/gatekeeper-api.js
diff --git a/src/cipher-lib.js b/src/cipher-lib.js
@@ -23,8 +23,7 @@ export function generateMnemonic() {
 
 export function generateHDKey(mnemonic) {
     const seed = bip39.mnemonicToSeedSync(mnemonic);
-    const hdkey = HDKey.fromMasterSeed(seed);
-    return hdkey;
+    return HDKey.fromMasterSeed(seed);
 }
 
 export function generateHDKeyJSON(json) {
@@ -76,8 +75,7 @@ export function convertJwkToCompressedBytes(jwk) {
 
 export function hashMessage(msg) {
     const hash = sha256(msg);
-    const msgHash = Buffer.from(hash).toString('hex');
-    return msgHash;
+    return Buffer.from(hash).toString('hex');
 }
 
 export function hashJSON(json) {
@@ -87,15 +85,15 @@ export function hashJSON(json) {
 export function signHash(msgHash, privateJwk) {
     const privKey = base64url.baseDecode(privateJwk.d);
     const signature = secp.sign(msgHash, privKey);
-    const sigHex = signature.toCompactHex();
-    return sigHex;
+
+    return signature.toCompactHex();
 }
 
 export function verifySig(msgHash, sigHex, publicJwk) {
     const compressedPublicKeyBytes = convertJwkToCompressedBytes(publicJwk);
     const signature = secp.Signature.fromCompact(sigHex);
-    const isValid = secp.verify(signature, msgHash, compressedPublicKeyBytes);
-    return isValid;
+
+    return secp.verify(signature, msgHash, compressedPublicKeyBytes);
 }
 
 export function encryptMessage(pubKey, privKey, message) {

diff --git a/src/db-json.js b/src/db-json.js
@@ -1,4 +1,5 @@
 import fs from 'fs';
+import * as exceptions from './exceptions.js';
 
 const dataFolder = 'data';
 let dbName;
@@ -39,7 +40,7 @@ export async function addEvent(did, event) {
     const db = loadDb();
 
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     const suffix = did.split(':').pop();
@@ -74,7 +75,7 @@ export async function getEvents(did) {
 
 export async function setEvents(did, events) {
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     const db = loadDb();
@@ -156,6 +157,5 @@ export async function clearQueue(registry, batch) {
 
 export async function getAllKeys() {
     const db = loadDb();
-    const ids = Object.keys(db.dids);
-    return ids;
+    return Object.keys(db.dids);
 }
diff --git a/src/db-mongodb.js b/src/db-mongodb.js
@@ -1,5 +1,6 @@
 import { MongoClient } from 'mongodb';
 import config from './config.js';
+import * as exceptions from './exceptions.js';
 
 let client;
 let db;
@@ -21,7 +22,7 @@ export async function resetDb() {
 
 export async function addEvent(did, event) {
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     const id = did.split(':').pop();
@@ -37,7 +38,7 @@ export async function addEvent(did, event) {
 
 export async function getEvents(did) {
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     try {
@@ -54,7 +55,7 @@ export async function getEvents(did) {
 
 export async function deleteEvents(did) {
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     const id = did.split(':').pop();
@@ -63,8 +64,7 @@ export async function deleteEvents(did) {
 
 export async function getAllKeys() {
     const rows = await db.collection('dids').find().toArray();
-    const ids = rows.map(row => row.id);
-    return ids;
+    return rows.map(row => row.id);
 }
 
 export async function queueOperation(registry, op) {

diff --git a/src/db-sqlite.js b/src/db-sqlite.js
@@ -1,5 +1,6 @@
 import * as sqlite from 'sqlite';
 import sqlite3 from 'sqlite3';
+import * as exceptions from './exceptions.js';
 
 const dataFolder = 'data';
 
@@ -34,7 +35,7 @@ export async function resetDb() {
 
 export async function addEvent(did, event) {
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     const events = await getEvents(did);
@@ -49,16 +50,15 @@ export async function addEvent(did, event) {
 
 export async function getEvents(did) {
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     try {
         const id = did.split(':').pop();
         console.time("SELECT");
         const row = await db.get('SELECT * FROM dids WHERE id = ?', id);
         console.timeEnd("SELECT");
-        const events = JSON.parse(row.events);
-        return events;
+        return JSON.parse(row.events);
     }
     catch {
         return [];
@@ -67,7 +67,7 @@ export async function getEvents(did) {
 
 export async function deleteEvents(did) {
     if (!did) {
-        throw "Invalid DID";
+        throw exceptions.INVALID_DID;
     }
 
     const id = did.split(':').pop();
@@ -90,8 +90,7 @@ export async function getQueue(registry) {
             return [];
         }
 
-        const ops = JSON.parse(row.ops);
-        return ops;
+        return JSON.parse(row.ops);
     }
     catch {
         return [];
@@ -114,6 +113,5 @@ export async function clearQueue(registry, batch) {
 
 export async function getAllKeys() {
     const rows = await db.all('SELECT id FROM dids');
-    const ids = rows.map(row => row.id);
-    return ids;
+    return rows.map(row => row.id);
 }
diff --git a/src/db-wallet-json.js b/src/db-wallet-json.js
@@ -1,5 +1,6 @@
 import fs from 'fs';
 import * as cipher from './cipher-lib.js';
+import * as exceptions from './exceptions.js';
 
 const dataFolder = 'data';
 const walletName = `${dataFolder}/wallet.json`;
@@ -25,7 +26,7 @@ export function loadWallet() {
 
 export function newWallet(mnemonic, overwrite) {
     if (fs.existsSync(walletName) && !overwrite) {
-        throw "Wallet already exists";
+        throw exceptions.UPDATE_FAILED;
     }
 
     try {
@@ -49,6 +50,6 @@ export function newWallet(mnemonic, overwrite) {
         return wallet;
     }
     catch (error) {
-        throw "Invalid mnemonic";
+        throw exceptions.INVALID_PARAMETER;
     }
 }
diff --git a/src/exceptions.js b/src/exceptions.js
@@ -0,0 +1,11 @@
+export const INVALID_DID = new Error('Invalid DID');
+export const UNKNOWN_DID = new Error('Unknown DID');
+export const UNKNOWN_ID = new Error('Unknown ID');
+export const INVALID_UPDATE = new Error('Invalid update');
+export const INVALID_OPERATION = new Error('Invalid operation');
+export const INVALID_VERSION = new Error('Invalid version');
+export const INVALID_TYPE = new Error('Invalid type');
+export const INVALID_REGISTRY = new Error('Invalid registry');
+export const INVALID_PARAMETER = new Error('Invalid parameter');
+export const UPDATE_FAILED = new Error('Update failed');
+export const EXPECTED_EXCEPTION = new Error('Expected to throw an exception');