Merge to master for v1.1.4 release

Pull request for merging v1.1.4 changes to master

Author: neel1996

API/addRepoApi.js

@@ -3,20 +3,17 @@ const path = require("path");
 const util = require("util");
 const execPromisified = util.promisify(exec);
 const fs = require("fs");
-
-function getEnvData() {
-  const envFileData = fs.readFileSync(
-    path.join(__dirname, "..", "env_config.json")
-  );
-
-  const envContent = envFileData.toString();
-  let envData = JSON.parse(envContent)[0];
-
-  return {
-    DATABASE_FILE: envData.databaseFile,
-    GITCONVEX_PORT: envData.port,
-  };
-}
+const { getEnvData } = require("../utils/getEnvData");
+const { gitCommitLogToDb } = require("../utils/sqliteDbAccess");
+
+/**
+ * @param  {String} repoName - Name of the repository
+ * @param  {String} repoPath - Path were the repo is residing or where it should be cloned / initialized
+ * @param  {boolean} initCheck - Switch to check if user has selected repo init option
+ * @param  {boolean} cloneCheck - Switch to check if user has selected repo cloning option
+ * @param  {String} cloneUrl - The If cloning switch is true, then this holds the URL of the remote repo
+ * @returns {Object} - created a new entry in the data file and retusn the status
+ */
 
 async function addRepoHandler(
   repoName,
@@ -35,44 +32,58 @@ async function addRepoHandler(
   }
 
   function successResponse() {
+    gitCommitLogToDb();
     return {
       message: "REPO_DATA_UPDATED",
       repoId: id,
     };
   }
 
   if (cloneCheck) {
-    const cloneStatus = await execPromisified(
-      `git clone "${cloneUrl}" "./${repoName}"`,
-      {
-        cwd: repoPath,
-        windowsHide: true,
+    try {
+      if (cloneUrl.match(/[^a-zA-Z0-9-_.~@#$%:/]/gi)) {
+        throw new Error("Invalid clone URL string!");
+      }
+
+      if (repoName.match(/[^a-zA-Z0-9-_.\\s]/gi)) {
+        throw new Error("Invalid repo name string!");
       }
-    )
-      .then(({ stdout, stderr }) => {
-        console.log(stdout);
-        console.log(stderr);
-        if (stdout || stderr) {
+
+      const cloneStatus = await execPromisified(
+        `git clone "${cloneUrl}" "./${repoName}"`,
+        {
+          cwd: repoPath,
+          windowsHide: true,
+        }
+      )
+        .then(({ stdout, stderr }) => {
           console.log(stdout);
-          return true;
-        } else {
+          console.log(stderr);
+          if (stdout || stderr) {
+            console.log(stdout);
+            return true;
+          } else {
+            return false;
+          }
+        })
+        .catch((err) => {
+          console.log(err);
           return false;
-        }
-      })
-      .catch((err) => {
-        console.log(err);
-        return false;
-      });
+        });
 
-    console.log("CLONE STAT : ", cloneStatus);
+      console.log("CLONE STAT : ", cloneStatus);
 
-    if (cloneStatus) {
-      if (repoPath.includes("\\")) {
-        repoPath = repoPath + "\\" + repoName;
+      if (cloneStatus) {
+        if (repoPath.includes("\\")) {
+          repoPath = repoPath + "\\" + repoName;
+        } else {
+          repoPath = repoPath + "/" + repoName;
+        }
       } else {
-        repoPath = repoPath + "/" + repoName;
+        return errorResponse();
       }
-    } else {
+    } catch (err) {
+      console.log(err);
       return errorResponse();
     }
   }

API/commitLogSearchApi.js

@@ -0,0 +1,53 @@
+const sqlite = require("sqlite3").verbose();
+const path = require("path");
+const db = new sqlite.Database(
+  path.join(__dirname, "..", "/database/commitLogs.sqlite")
+);
+const { gitCommitLogSearchHandler } = require("../git/gitCommitLogSearchApi");
+
+async function gitCommitLogDbSerchApi(repoId, searchCategory, searchKey) {
+  let searchQuery = "";
+
+  switch (searchCategory) {
+    case "hash":
+      searchQuery = `SELECT * FROM commitLog_${repoId} WHERE hash LIKE "${searchKey}%" LIMIT 10`;
+      break;
+    case "message":
+      searchQuery = `SELECT * FROM commitLog_${repoId} WHERE commit_message LIKE "%${searchKey}%" LIMIT 10`;
+      break;
+    case "user":
+      searchQuery = `SELECT * FROM commitLog_${repoId} WHERE author LIKE "%${searchKey}%" LIMIT 10`;
+      break;
+    default:
+      searchQuery = `SELECT * FROM commitLog_${repoId} WHERE commit_message LIKE "%${searchKey}%" LIMIT 10`;
+      break;
+  }
+
+  return new Promise((resolve, reject) => {
+    db.all(searchQuery, [], async (err, rows) => {
+      if (err) {
+        console.log(err);
+        reject("Database fetch error");
+      }
+      if (rows) {
+        const hashArray = rows.map((row) => {
+          return row.hash;
+        });
+        const commits = await gitCommitLogSearchHandler(repoId, hashArray)
+          .then(async (res) => {
+            console.log(await res.commits);
+            return Promise.all(res.commits).then((commit) => {
+              return commit;
+            });
+          })
+          .catch((err) => {
+            console.log(err);
+            return [];
+          });
+        resolve(commits);
+      }
+    });
+  });
+}
+
+module.exports.gitCommitLogDbSerchApi = gitCommitLogDbSerchApi;

API/deleteRepoApi.js

@@ -1,21 +1,13 @@
 const fs = require("fs");
 const path = require("path");
+const { getEnvData } = require("../utils/getEnvData");
 
-function getEnvData() {
-  const envFileData = fs.readFileSync(
-    path.join(__dirname, "..", "env_config.json")
-  );
+/**
+ * @param  {String} repoId - ID of the repo stored in the data file
+ */
 
-  const envContent = envFileData.toString();
-  let envData = JSON.parse(envContent)[0];
 
-  return {
-    DATABASE_FILE: envData.databaseFile,
-    GITCONVEX_PORT: envData.port,
-  };
-}
-
-async function deleteRepoApi(repoId) {
+ async function deleteRepoApi(repoId) {
   const dataStoreFile = getEnvData().DATABASE_FILE;
 
   return await fs.promises

API/fetchRepoApi.js

@@ -1,19 +1,10 @@
 const fs = require("fs");
 const path = require("path");
+const { getEnvData } = require("../utils/getEnvData");
 
-function getEnvData() {
-  const envFileData = fs.readFileSync(
-    path.join(__dirname, "..", "env_config.json")
-  );
-
-  const envContent = envFileData.toString();
-  let envData = JSON.parse(envContent)[0];
-
-  return {
-    DATABASE_FILE: envData.databaseFile,
-    GITCONVEX_PORT: envData.port,
-  };
-}
+/**
+ * @returns {Object} - details about all the repos stored in the data file
+ */
 
 async function fetchRepoHandler() {
   var repoDSContent = fs.readFileSync(getEnvData().DATABASE_FILE);

API/healthcheckApi.js

@@ -3,6 +3,10 @@ const util = require("util");
 const execPromise = util.promisify(exec);
 const os = require("os");
 
+/**
+ * @returns {Object} - Version of the required software and the platform on which the app is running
+ */
+
 async function healthCheckHandler() {
   let healthCheckResults = {
     osCheck: "",
@@ -23,6 +27,11 @@ async function healthCheckHandler() {
   return { ...healthCheckResults };
 }
 
+/**
+ * @param  {String} param
+ * @returns {Object} - Executes the shell command and returns the results 
+ */
+
 async function checkStatus(param) {
   var commandString = "";
 
@@ -34,7 +43,7 @@ async function checkStatus(param) {
       commandString = `node --version`;
       break;
     default:
-      commandString = `echo 'NO_COMMAND'`;
+      commandString = ` `;
   }
 
   return await execPromise(commandString, { windowsHide: true }).then((res) => {

API/settingsApi.js

@@ -1,19 +1,10 @@
 const fs = require("fs");
 const path = require("path");
+const { getEnvData } = require("../utils/getEnvData");
 
-function getEnvData() {
-  const envFileData = fs.readFileSync(
-    path.join(__dirname, "..", "env_config.json")
-  );
-
-  const envContent = envFileData.toString();
-  let envData = JSON.parse(envContent)[0];
-
-  return {
-    DATABASE_FILE: envData.databaseFile,
-    GITCONVEX_PORT: envData.port,
-  };
-}
+/**
+ * @returns {Object} - Path where the Data file is stored
+ */
 
 const fetchDatabaseFile = async () => {
   const dbPath = getEnvData().DATABASE_FILE || "NO_DATABASE_FILE";
@@ -23,6 +14,10 @@ const fetchDatabaseFile = async () => {
   };
 };
 
+/**
+ * @returns {Array} - The array containing the list of all repos stored in the data file
+ */
+
 const fetchRepoDetails = async () => {
   return await fs.promises
     .readFile(getEnvData().DATABASE_FILE)
@@ -57,6 +52,11 @@ const fetchRepoDetails = async () => {
     });
 };
 
+/**
+ * @param  {String} newFileName - A new JSON file for storing repo information
+ * @returns {String} - updates the data file in config file and returns the status as string
+ */
+
 const updateDbFile = async (newFileName) => {
   console.log("FILE NAME : ", newFileName);
 
@@ -95,6 +95,11 @@ const getPortDetails = async () => {
   return { settingsPortDetails: Number(getEnvData().GITCONVEX_PORT) };
 };
 
+/**
+ * @param  {number} newPort - new port number for running gitconvex
+ * @returns {String} - status string for updating the port
+ */
+
 const updatePortDetails = async (newPort) => {
   if (!isNaN(newPort)) {
     const envContent = fs

README.md

@@ -13,9 +13,9 @@
 
 > Use any of the below options to get gitconvex for your system
 
-[![gitconvex npm package](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.3&color=red&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@itassistors/gitconvex)
-[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.3&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
-[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.3&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
+[![gitconvex npm package](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=red&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@itassistors/gitconvex)
+[![github release](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=green&style=for-the-badge&logo=github)](https://github.com/neel1996/gitconvex-package/releases)
+[![docker image](https://img.shields.io/static/v1?label=gitconvex&message=v1.1.4&color=blue&style=for-the-badge&logo=docker)](https://hub.docker.com/repository/docker/itassistors/gitconvex)
 [![License](https://img.shields.io/static/v1?label=LICENSE&message=Apache-2.0&color=yellow&style=for-the-badge)](LICENSE)
 
 - **Option - 1** Cloning repo from **github**
@@ -91,3 +91,4 @@ Refer the detailed [Documentation](DOCUMENTATION.md) for how to setup and use th
 # License
 
 See [LICENSE ](LICENSE) info for more
+