Merge branch 'PalisadoesFoundation:develop' into develop

Author: AdityaRaimec22

.env.sample

@@ -49,6 +49,12 @@ SMTP_USERNAME=
 SMTP_PORT=
 SMTP_SSL_TLS=
 
+# Enable or disable the storage of logs
+LOG=false
+
+
+# Path of file that will store logs
+LOG_PATH=./logs/transaction.log
 
 # Email for the first user who will be super admin
 # The user with the email address set with this parameter will automatically be elevated to Super Admin status on registration. 

.github/workflows/push.yml

@@ -155,7 +155,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: dmnemec/[email protected]
       env:
-        API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}    
+        API_TOKEN_GITHUB: ${{secrets.API_TOKEN_GITHUB}}    
       with:
         source_file: 'talawa-api-docs/'
         destination_repo: 'PalisadoesFoundation/talawa-docs'

.gitignore

@@ -22,6 +22,11 @@ images/**
 video/**
 videos/**
 
+# Ignore log files
+logs/*
+!logs/README.md
+*.log
+
 # Don't ignore any .gitignore files in any location
 !.gitignore
 

CONTRIBUTING.md

@@ -94,11 +94,11 @@ Make sure you have read the [Documentation for Setting up the Project](INSTALLAT
 The process of proposing a change to Talawa API can be summarized as:
 
 1. Fork the Talawa API repository and branch off `develop`.
-2. The repository can be cloned locally using `git clone <forked repo url>`.
-3. Make sure your code is up-to-date with the main source main. A detailed guide on the same can be found in the [Upgrading Code Section](#upgrading-code).
-4. Make the desired changes to the Talawa API source.
-5. Run the app and test your changes.
-6. If you've added code, then test suites must be added.
+1. Your newly forked repository can be cloned locally using `git clone <YOUR FORKED REPO URL>`.
+1. Make the Palisadoes Foundation's repo your `git upstream` for your local repo.
+1. Make the desired changes to the Talawa API source.
+1. Run the app and test your changes.
+1. If you've added code, then test suites must be added.
    1. **_General_:**
       1. We need to get to 100% test coverage for the app. We periodically increase the desired test coverage for our pull requests to meet this goal.
       2. Pull requests that don't meet the minimum test coverage levels will not be accepted. This may mean that you will have to create tests for code you did not write. You can decide which part of the code base needs additional tests if this happens to you.
@@ -314,4 +314,4 @@ If you are participating in any of the various internship programs we ar members
 There are many ways to communicate with the community.
 
 1. The Palisadoes Foundation has a Slack channel where members can assist with support and clarification. Visit the [Talawa GitHub repository home page](https://github.com/PalisadoesFoundation/talawa) for the link to join our slack channel.
-1. We also have a technical email list run by [freelists.org](https://www.freelists.org/). Search for "palisadoes" and join. Members on this list are also periodically added to our marketing email list that focuses on less technical aspects of our work.
+1. We also have a technical email list run by [freelists.org](https://www.freelists.org/). Search for "palisadoes" and join. Members on this list are also periodically added to our marketing email list that focuses on less technical aspects of our work.

logs/.gitignore

@@ -0,0 +1,2 @@
+# DO NOT REMOVE
+# This is required to maintain the logs/ directory in the repo

logs/README.md

@@ -0,0 +1,17 @@
+# Logs Directory
+
+## Overview
+
+This directory is the default location for the logs generated by the audit trailing mechanism of our application. The logging system is designed to provide a comprehensive and chronological record of events, actions, and operations performed within the application, offering transparency and accountability.
+
+## Setup Instructions
+
+### Initial Setup
+
+To initialize the logging system and ensure that all necessary configurations are correctly established, please run the following command from the root of the project:
+
+```bash
+
+npm  run  setup
+
+```

package-lock.json

@@ -109,11 +109,12 @@
     "@types/express-rate-limit": "^6.0.0",
     "@types/graphql-depth-limit": "^1.1.6",
     "@types/i18n": "^0.13.10",
+    "@types/inquirer": "^9.0.7",
     "@types/jsonwebtoken": "^9.0.5",
     "@types/lodash": "^4.14.202",
     "@types/mongoose-paginate-v2": "^1.6.5",
     "@types/morgan": "^1.9.9",
-    "@types/node": "^20.11.5",
+    "@types/node": "^20.11.7",
     "@types/nodemailer": "^6.4.14",
     "@types/shortid": "^0.0.32",
     "@types/uuid": "^9.0.7",

package.json

@@ -1,11 +1,13 @@
-const dotenv = require("dotenv");
-const fs = require("fs");
-const cryptolib = require("crypto");
-const inquirer = require("inquirer");
-const mongodb = require("mongodb");
-const redis = require("redis");
-const { exec } = require("child_process");
-const nodemailer = require("nodemailer");
+import dotenv from "dotenv";
+import fs from "fs";
+import path from "path";
+import * as cryptolib from "crypto";
+import inquirer from "inquirer";
+import mongodb from "mongodb";
+import * as redis from "redis";
+import { exec } from "child_process";
+import nodemailer from "nodemailer";
+import type { ExecException } from "child_process";
 
 dotenv.config();
 
@@ -114,6 +116,70 @@ async function accessAndRefreshTokens(
   }
 }
 
+function transactionLogPath(logPath: string | null): void {
+  const config = dotenv.parse(fs.readFileSync(".env"));
+  config.LOG = "true";
+  if (!logPath) {
+    // Check if the logs/transaction.log file exists, if not, create it
+    const defaultLogPath = path.resolve(__dirname, "logs");
+    const defaultLogFile = path.join(defaultLogPath, "transaction.log");
+    if (!fs.existsSync(defaultLogPath)) {
+      console.log("Creating logs/transaction.log file...");
+      fs.mkdirSync(defaultLogPath);
+    }
+
+    config.LOG_PATH = defaultLogFile;
+  } else {
+    // Remove the logs files, if exists
+    const logsDirPath = path.resolve(__dirname, "logs");
+    if (fs.existsSync(logsDirPath)) {
+      fs.readdirSync(logsDirPath).forEach((file: string) => {
+        if (file !== "README.md") {
+          const curPath = path.join(logsDirPath, file);
+          fs.unlinkSync(curPath);
+        }
+      });
+    }
+    config.LOG_PATH = logPath;
+  }
+  fs.writeFileSync(".env", "");
+  for (const key in config) {
+    fs.appendFileSync(".env", `${key}=${config[key]}\n`);
+  }
+}
+
+async function askForTransactionLogPath(): Promise<string> {
+  let logPath: string | null;
+  // Keep asking for path, until user gives a valid path
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    const response = await inquirer.prompt([
+      {
+        type: "input",
+        name: "logPath",
+        message: "Enter absolute path of log file:",
+        default: null,
+      },
+    ]);
+    logPath = response.logPath;
+    if (logPath && fs.existsSync(logPath)) {
+      try {
+        fs.accessSync(logPath, fs.constants.R_OK | fs.constants.W_OK);
+        break;
+      } catch {
+        console.error(
+          "The file is not readable/writable. Please enter a valid file path."
+        );
+      }
+    } else {
+      console.error(
+        "Invalid path or file does not exist. Please enter a valid file path."
+      );
+    }
+  }
+  return logPath;
+}
+
 // Check connection to Redis with the specified URL.
 /**
  * The function `checkRedisConnection` checks if a connection to Redis can be established using the
@@ -253,7 +319,7 @@ async function redisConfiguration(): Promise<void> {
     // Update the .env file
     const config = dotenv.parse(fs.readFileSync(".env"));
     config.REDIS_HOST = host;
-    config.REDIS_PORT = port;
+    config.REDIS_PORT = port.toString();
     config.REDIS_PASSWORD = password;
     updateEnvVariable(config);
   } catch (err) {
@@ -640,7 +706,7 @@ async function importData(): Promise<void> {
     console.log("Importing sample data...");
     await exec(
       "npm run import:sample-data",
-      (error: { message: string }, stdout: string, stderr: string) => {
+      (error: ExecException | null, stdout: string, stderr: string) => {
         if (error) {
           console.error(`Error: ${error.message}`);
           abort();
@@ -657,7 +723,7 @@ async function importData(): Promise<void> {
 
 type VerifySmtpConnectionReturnType = {
   success: boolean;
-  error: any;
+  error: unknown;
 };
 
 /**
@@ -687,7 +753,7 @@ async function verifySmtpConnection(
     await transporter.verify();
     console.log("SMTP connection verified successfully.");
     return { success: true, error: null };
-  } catch (error: any) {
+  } catch (error: unknown) {
     console.error("SMTP connection verification failed:");
     return { success: false, error };
   } finally {
@@ -749,7 +815,9 @@ async function configureSmtp(): Promise<void> {
     console.error(
       "SMTP configuration verification failed. Please check your SMTP settings."
     );
-    console.log(error.message);
+    if (error instanceof Error) {
+      console.log(error.message);
+    }
     return;
   }
 
@@ -815,6 +883,33 @@ async function main(): Promise<void> {
 
   accessAndRefreshTokens(accessToken, refreshToken);
 
+  const { shouldLog } = await inquirer.prompt({
+    type: "confirm",
+    name: "shouldLog",
+    message: "Would you like to enable logging for the database transactions?",
+    default: true,
+  });
+
+  if (shouldLog) {
+    if (process.env.LOG_PATH) {
+      console.log(
+        `\n Log path already exists with the value:\n${process.env.LOG_PATH}`
+      );
+    }
+    let logPath: string | null = null;
+    const { shouldUseCustomLogPath } = await inquirer.prompt({
+      type: "confirm",
+      name: "shouldUseCustomLogPath",
+      message: "Would you like to provide a custom path for storing logs?",
+      default: false,
+    });
+
+    if (shouldUseCustomLogPath) {
+      logPath = await askForTransactionLogPath();
+    }
+    transactionLogPath(logPath);
+  }
+
   const { isDockerInstallation } = await inquirer.prompt({
     type: "confirm",
     name: "isDockerInstallation",

setup.ts

@@ -474,5 +474,15 @@ export const REDIS_HOST = process.env.REDIS_HOST || "";
 export const REDIS_PORT = Number(process.env.REDIS_PORT);
 export const REDIS_PASSWORD = process.env.REDIS_PASSWORD;
 
-export const key = process.env.ENCRYPTION_KEY as string;
+export const key = ENV.ENCRYPTION_KEY as string;
 export const iv = crypto.randomBytes(16).toString("hex");
+
+export const LOG = ENV.LOG === "true";
+
+export const LOG_PATH = ENV.LOG_PATH;
+
+export enum TransactionLogTypes {
+  CREATE = "CREATE",
+  UPDATE = "UPDATE",
+  DELETE = "DELETE",
+}