Merge pull request #48 from PCOffline/feature/secure-debug

Feature/secure debug

Author: Eldar B

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+### [0.4.2](https://github.com/pcoffline/reset-db/compare/v0.4.1...v0.4.2) (2022-10-08)
+
+
+### Features
+
+* dont log sensitive info by default in debug ([19be06d](https://github.com/pcoffline/reset-db/commit/19be06d89d39049693970f57b2f615037f1b7b64))
 
 ### [0.4.1](https://github.com/pcoffline/reset-db/compare/v0.4.0...v0.4.1) (2022-10-08)
 

README.md

@@ -25,6 +25,7 @@ export default {
   preferPath: true, // When both path and data are provided, ignore the data and only use the path. If false, only the data will be used in such case.
   logLevel: 'info', // 'debug' | 'info' | 'warn' | 'error' | 'silent'
   mongoUri: 'mongodb://localhost:27017/my-database', // Can also be retrieved from environment variable: MONGO_URI, MONGODB_URI, DB_URI, DATABASE_URI or mongoUri
+  sensitiveDebugLog: false, // Log information that is considered sensitive (such as the MongoDB URI) in debug mode.
   collections: {
     collectionName: {
       schema: new Schema({

index.js

@@ -92,9 +92,10 @@ const standardCollections = [];
 
 function logDebugData() {
   if (logLevel > logLevels.debug) return;
+  const { dbUri, ...printableConfig } = config;
 
   logDebug(`[${logDebugData.name}]`, 'Log Level:', logLevel);
-  logDebug(`[${logDebugData.name}]`, 'Config:', JSON.stringify(config));
+  logDebug(`[${logDebugData.name}]`, 'Config:', JSON.stringify(config.insecureDebugLog ? printableConfig : config));
   logDebug(`[${logDebugData.name}]`, 'Standard Collections:', JSON.stringify(standardCollections));
 }
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "reset-db",
   "type": "module",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "A fast and easy way to reset your collections",
   "main": "index.js",
   "scripts": {