scharff 1.0.0 → 1.0.4

package/README.md

@@ -1,19 +1,46 @@
 # Scharff Logger
-This project was created by Michael Scharff for logging purposes.
-The project is using the fetch-intercept NPM package.
+Scharff is a lightweight and versatile Node.js package designed to enhance your application's logging capabilities by seamlessly integrating a powerful outgoing request logger. With Scharff, you can effortlessly gain insights into the interactions your application has with external services, APIs, and resources.
 
 ## Installation
 1) run `npm install scharff`.
 2) fork the git repository `https://github.com/Minka1902/scharff.git`, and place it next to your project.
 
 ## Usage
-1) in your entry point, import unregister from the package: `const { unregister } = require('../../scharff/index');`
-2) to stop the logger just run the unregister function: `unregister()`
+1) in your entry point, import unregister from the package: `const { unregister } = require('scharff');`
+2) to stop the logger just run the unregister function: `unregister()`, or `npm uninstall scharff`.
 
 ## What to expect
-The package will create a outgoingRequest.log file and start logging the requests to the file.
+1) The package will create a outgoingRequest.log file and start logging the requests to the file.
+2) In there you can see the fetch requests you sent.
+3) The request will be in the format below:</br>
+{</br>
+&nbsp;&nbsp;&nbsp;&nbsp;"url":"http://666.777.888.999:3000/update/www.exampe.com",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;"ip":"130.130.130.130",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;"date":{</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;date:"20/20/2020",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;time:"20:20:20 PM"</br>
+&nbsp;&nbsp;&nbsp;&nbsp;},</br>
+&nbsp;&nbsp;&nbsp;&nbsp;"originUrl":"/update/www.example.com",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;"method":"PUT",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;"headers":{</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Content-Type":"application/json",</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Access-Control-Allow-Origin":"*"</br>
+&nbsp;&nbsp;&nbsp;&nbsp;},</br>
+&nbsp;&nbsp;&nbsp;&nbsp;"body":{</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"isActive":true,</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":200,</br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"lastChecked":"2020-20-20T20:20:20.200Z"</br>
+&nbsp;&nbsp;&nbsp;&nbsp;}</br>
+}
+
+## New in this release
+1) New date log.
+
+
+## Requirements
+1) nodejs version >= v18.0.0
 
 ## Future additions
 1) We will add a request error logger.
 2) We will add a response logger.
-3) We will add a response error logger.
+3) We will add a response error logger.

package/index.js

@@ -1,12 +1,24 @@
+const { removeBaseUrl } = require('./constants/functions');
 const fetchIntercept = require('fetch-intercept');
 const fs = require('fs');
-const { removeBaseUrl } = require('./constants/functions');
+const os = require('os');
 
 module.exports.unregister = fetchIntercept.register({
   request: function (url, config) {
+    const interfaces = os.networkInterfaces();
+    let addresses = [];
     let tempUrl = url;
+    for (let i in interfaces) {
+      for (var i2 in interfaces[i]) {
+        var address = interfaces[i][i2];
+        if (address.family === 'IPv4' && !address.internal) {
+          addresses.push(address.address);
+        }
+      }
+    }
+    let tempReq = { type: 'Outgoing_Request', url, ip: addresses[0] };
+    tempReq.date = { date: new Date().toLocaleDateString(), time: new Date().toLocaleTimeString() };
     tempUrl = removeBaseUrl(tempUrl);
-    let tempReq = { url };
     if (tempUrl !== url) {
       tempReq.originUrl = tempUrl;
     }
@@ -42,7 +54,35 @@ module.exports.unregister = fetchIntercept.register({
   // },
 
   // response: function (response) {
-  //   // Modify the response object
+  //   let tempRes = { incomingTime: new Date() };
+  //   if (response) {
+  //     if (response.status) {
+  //       tempRes.status = { status: response.status, statusText: response.statusText };
+  //     }
+  //     if (response.request) {
+  //       tempRes.request = { method: response.request.method, originalUrl: response.request.url, mode: response.request.mode };
+  //     }
+  //     if (response.type) {
+  //       tempRes.type = response.type;
+  //     }
+  //     if (response.redirected) {
+  //       tempRes.redirected = response.redirected;
+  //     }
+  //     if (response.url) {
+  //       tempRes.url = response.url;
+  //     }
+  //     if (response.ok === true) {
+  //       tempRes.isActive = true;
+  //     } else {
+  //       tempRes.isActive = false;
+  //     }
+  //   }
+  //   fs.open('./incomingResponse.log', 'a', function (e, id) {
+  //     fs.write(id, JSON.stringify(tempRes) + "\n", null, 'utf8', function () {
+  //       fs.close(id, function () {
+  //       });
+  //     });
+  //   });
   //   return response;
   // },
 

package/package.json

@@ -1,18 +1,33 @@
 {
   "name": "scharff",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "Logger for outgoing requests",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "keywords": [
+    "logger",
+    "outgoing",
+    "request",
+    "response",
+    "error",
+    "fetch",
+    "fetch-inspector",
+    "inspector",
+    "scharff",
+    "npm"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/Minka1902/scharff.git"
   },
-  "author": "Michael Scharff",
+  "author": {
+    "name": "Michael Scharff",
+    "email": "minka.scharff@gmail.com"
+  },
   "license": "ISC",
   "dependencies": {
     "fetch-intercept": "^2.4.0"
   }
-}
+}