scharff 1.0.0

package/README.md

@@ -0,0 +1,19 @@
+# Scharff Logger
+This project was created by Michael Scharff for logging purposes.
+The project is using the fetch-intercept NPM package.
+
+## 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()`
+
+## What to expect
+The package will create a outgoingRequest.log file and start logging the requests to the file.
+
+## 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.

package/constants/functions.js

@@ -0,0 +1,10 @@
+module.exports.removeBaseUrl = (url) => {
+    if (url) {
+        const indexOfEnd = url.indexOf('/', 7);
+        if (indexOfEnd === -1) {
+            return url;
+        } else {
+            return url.slice(indexOfEnd, url.length);
+        }
+    }
+};

package/index.js

@@ -0,0 +1,53 @@
+const fetchIntercept = require('fetch-intercept');
+const fs = require('fs');
+const { removeBaseUrl } = require('./constants/functions');
+
+module.exports.unregister = fetchIntercept.register({
+  request: function (url, config) {
+    let tempUrl = url;
+    tempUrl = removeBaseUrl(tempUrl);
+    let tempReq = { url };
+    if (tempUrl !== url) {
+      tempReq.originUrl = tempUrl;
+    }
+    if (config === undefined) {
+      tempReq.method = 'GET';
+    } else {
+      if (config) {
+        if (config.method) {
+          tempReq.method = config.method;
+        }
+        if (config.headers) {
+          tempReq.headers = config.headers;
+        }
+        if (config.body) {
+          tempReq.body = JSON.parse(config.body);
+        }
+      }
+    }
+
+    fs.open('./outgoingRequest.log', 'a', function (e, id) {
+      fs.write(id, JSON.stringify(tempReq) + "\n", null, 'utf8', function () {
+        fs.close(id, function () {
+        });
+      });
+    });
+
+    return [url, config];
+  },
+
+  // requestError: function (error) {
+  //   // Called when an error occurred during another 'request' interceptor call
+  //   return Promise.reject(error);
+  // },
+
+  // response: function (response) {
+  //   // Modify the response object
+  //   return response;
+  // },
+
+  // responseError: function (error) {
+  //   // Handle an fetch error
+  //   return Promise.reject(error);
+  // }
+});

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "scharff",
+  "version": "1.0.0",
+  "description": "Logger for outgoing requests",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Minka1902/scharff.git"
+  },
+  "author": "Michael Scharff",
+  "license": "ISC",
+  "dependencies": {
+    "fetch-intercept": "^2.4.0"
+  }
+}