cache-companion 1.0.0

package/bin/cli.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const logger = require('../src/logger')('bin');
+const arg = require('arg');
+const chalk = require('chalk');
+const getConfig = require('../src/commands/config-mgr.js'); 
+const main = require('../src/index.js');
+
+
+try {
+    const args = arg({
+        '--port': Number,
+        '--origin': String,
+    });
+
+    logger.debug('Received args', args);
+
+    main(args);
+
+} catch (err) {
+    logger.warning(err.message);
+    console.log();
+    usage();
+}
+
+function usage() {
+    console.log(`${chalk.whiteBright('Tool [CMD]')}
+    ${chalk.greenBright('--start')}\t starts the app
+    ${chalk.greenBright('--build')}\t builds the project`);
+}

package/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "cache-companion",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "bin": {
+    "cache-companion": "bin/cli.js"
+  },
+  "dependencies": {
+    "accepts": "^2.0.0",
+    "ajv": "^8.20.0",
+    "ansi-styles": "^4.3.0",
+    "arg": "^5.0.2",
+    "argparse": "^2.0.1",
+    "better-ajv-errors": "^2.0.3",
+    "body-parser": "^2.2.2",
+    "bytes": "^3.1.2",
+    "call-bind-apply-helpers": "^1.0.2",
+    "call-bound": "^1.0.4",
+    "callsites": "^3.1.0",
+    "chalk": "^4.1.2",
+    "color-convert": "^2.0.1",
+    "color-name": "^1.1.4",
+    "content-disposition": "^1.1.0",
+    "content-type": "^1.0.5",
+    "cookie": "^0.7.2",
+    "cookie-signature": "^1.2.2",
+    "cosmiconfig": "^9.0.2",
+    "debug": "^4.4.3",
+    "depd": "^2.0.0",
+    "dunder-proto": "^1.0.1",
+    "ee-first": "^1.1.1",
+    "encodeurl": "^2.0.0",
+    "env-paths": "^2.2.1",
+    "error-ex": "^1.3.4",
+    "es-define-property": "^1.0.1",
+    "es-errors": "^1.3.0",
+    "es-object-atoms": "^1.1.2",
+    "escape-html": "^1.0.3",
+    "etag": "^1.8.1",
+    "express": "^5.2.1",
+    "fast-deep-equal": "^3.1.3",
+    "fast-uri": "^3.1.2",
+    "finalhandler": "^2.1.1",
+    "forwarded": "^0.2.0",
+    "fresh": "^2.0.0",
+    "function-bind": "^1.1.2",
+    "get-intrinsic": "^1.3.0",
+    "get-proto": "^1.0.1",
+    "gopd": "^1.2.0",
+    "has-flag": "^4.0.0",
+    "has-symbols": "^1.1.0",
+    "hasown": "^2.0.4",
+    "http-errors": "^2.0.1",
+    "iconv-lite": "^0.7.2",
+    "import-fresh": "^3.3.1",
+    "inherits": "^2.0.4",
+    "ipaddr.js": "^1.9.1",
+    "is-arrayish": "^0.2.1",
+    "is-promise": "^4.0.0",
+    "js-tokens": "^4.0.0",
+    "js-yaml": "^4.2.0",
+    "json-parse-even-better-errors": "^2.3.1",
+    "json-schema-traverse": "^1.0.0",
+    "jsonpointer": "^5.0.1",
+    "leven": "^3.1.0",
+    "lines-and-columns": "^1.2.4",
+    "math-intrinsics": "^1.1.0",
+    "media-typer": "^1.1.0",
+    "merge-descriptors": "^2.0.0",
+    "mime-db": "^1.54.0",
+    "mime-types": "^3.0.2",
+    "ms": "^2.1.3",
+    "negotiator": "^1.0.0",
+    "object-inspect": "^1.13.4",
+    "on-finished": "^2.4.1",
+    "once": "^1.4.0",
+    "parent-module": "^1.0.1",
+    "parse-json": "^5.2.0",
+    "parseurl": "^1.3.3",
+    "path-to-regexp": "^8.4.2",
+    "picocolors": "^1.1.1",
+    "proxy-addr": "^2.0.7",
+    "qs": "^6.15.2",
+    "range-parser": "^1.2.1",
+    "raw-body": "^3.0.2",
+    "require-from-string": "^2.0.2",
+    "resolve-from": "^4.0.0",
+    "router": "^2.2.0",
+    "safer-buffer": "^2.1.2",
+    "send": "^1.2.1",
+    "serve-static": "^2.2.1",
+    "setprototypeof": "^1.2.0",
+    "side-channel": "^1.1.1",
+    "side-channel-list": "^1.0.1",
+    "side-channel-map": "^1.0.1",
+    "side-channel-weakmap": "^1.0.2",
+    "statuses": "^2.0.2",
+    "supports-color": "^7.2.0",
+    "toidentifier": "^1.0.1",
+    "type-is": "^2.1.0",
+    "unpipe": "^1.0.0",
+    "vary": "^1.1.2",
+    "wrappy": "^1.0.2"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs"
+}

package/src/classes/cache.js

@@ -0,0 +1,47 @@
+const logger = require('../logger.js')('cacheClass');
+
+module.exports = class cache {
+    ttl = 10000; // Cache entries expire after 10 seconds
+    cache = new Map();
+
+    constructor(ttl) {
+        if (ttl) {
+            this.ttl = ttl;
+        }
+    }
+
+    addEntryToCache(url, data) {
+        const timeout = setTimeout(() => {
+            this.cache.delete(url);
+            logger.log('Cache entry expired for URL:', url);
+        }, this.ttl);
+        this.cache.set(url, { data, timeout });
+    }
+
+    getEntryFromCache(url) {
+        const entry = this.cache.get(url);
+        if (entry) {
+            clearTimeout(entry.timeout); // Clear the timeout for the cache entry to prevent it from expiring
+            logger.log('Cache hit for URL, expiry timer reset:', url);
+            entry.timeout = setTimeout(() => {
+                this.cache.delete(url);
+                logger.log('Cache entry expired for URL:', url);
+            }, this.ttl); // Reset the timeout for the cache entry to expire after 10 seconds of inactivity
+        }
+        return entry?.data;
+    }
+
+    hasEntryInCache(url) {
+        return this.cache.has(url);
+    }
+
+    deleteEntryFromCache(url) {
+        this.cache.delete(url);
+    }
+
+    clearCache() {
+        this.cache.clear();
+    }
+
+
+}

package/src/commands/config-mgr.js

@@ -0,0 +1,27 @@
+const logger = require('../logger.js')('config:mgr');
+const chalk = require('chalk');
+const { cosmiconfigSync } = require('cosmiconfig');
+const schema = require('../config/schema.json');
+const configLoader = cosmiconfigSync('tool');
+const Ajv = require('ajv').default;
+const ajv = new Ajv();
+const betterAjvErrors = require('better-ajv-errors').default;
+
+
+module.exports = function getConfig() {
+  const result = configLoader.search(process.cwd());
+  if (!result) {
+    logger.warning('Could not find configuration, using default');
+    return { port: 1234 };
+  } else {
+    const isValid = ajv.validate(schema, result.config);
+    if (!isValid) {
+        logger.warning('invalid configuration was supplied');
+        console.log();
+        console.log(betterAjvErrors(schema, result.config, ajv.errors));
+        process.exit(1);
+    }
+    logger.debug('Found configuration', result.config);
+    return result.config;
+  }
+}

package/src/commands/start.js

@@ -0,0 +1,35 @@
+const logger = require('../logger')('commands:start');
+const chalk = require('chalk');
+const express = require('express');
+const proxyServer = express();
+const cache = require('../classes/cache.js');
+
+const cacheInstance = new cache(10000); // Create a new cache instance with a TTL of 10 seconds
+
+module.exports = function start(port, origin) {
+  logger.highlight('  Starting the cache proxy server...');
+  logger.debug('Received port', { port });
+  logger.debug('Received origin', { origin });
+
+  proxyServer.get('/{*splat}', async (req, res) => {
+    //cache hit, return the cached response
+    if (cacheInstance.hasEntryInCache(req.url)) { 
+      res.send(cacheInstance.getEntryFromCache(req.url));
+      return;
+    } else {
+        // cache miss, Simulate fetching data from the origin server, and store it in the cache before sending the response
+        const response = await fetch(`${origin}/${req.url}`);
+        const data = await response.json();
+        cacheInstance.addEntryToCache(req.url, data);
+        res.send(data);
+    }
+  });
+
+  proxyServer.listen(port, (error) => {
+    if (error) {
+      logger.error('Error occurred while starting the proxy server:', error);
+    } else {
+      logger.debug(`Proxy server is listening on port ${port}`);
+    }
+  });
+}

package/src/config/schema.json

@@ -0,0 +1,8 @@
+{
+  "type": "object",
+  "properties": {
+    "port": {
+      "type": "number"
+    }
+  }
+}

package/src/index.js

@@ -0,0 +1,30 @@
+const logger = require('./logger.js')('main');
+const arg = require('arg');
+const chalk = require('chalk');
+const start = require('./commands/start');
+const getConfig = require('./commands/config-mgr.js');
+
+module.exports = function main(args) { 
+    try {  
+        if (args['--port'] === undefined || args['--origin'] === undefined) {
+            logger.warning('Missing required arguments, searching for configuration file...');
+            config = getConfig(); // load configuration from file if arguments are not provided
+            const port = config.port;
+            const origin = config.origin;
+            logger.debug('Using configuration from file', { port, origin });
+            start(port, origin);
+        } else if (typeof args['--port'] !== "number" || typeof args['--origin'] !== "string" || isNaN(args['--port'])) {
+            logger.warning('Invalid argument types, port should be a number and origin should be a string');
+            return;
+        } else {
+            port = args['--port'];
+            origin = args['--origin'];
+            logger.debug('Using configuration from arguments', { port, origin });
+            start(port, origin); // start the cache proxy server with the specified port and origin
+        }
+    } catch (err) {
+        logger.warning(err.message);
+        console.log();
+    }
+}
+

package/src/logger.js

@@ -0,0 +1,11 @@
+const chalk = require('chalk');
+const debug = require('debug').default;
+
+module.exports = function createLogger(name) {
+  return {
+    log: (...args) => console.log(chalk.gray(...args)),
+    warning: (...args) => console.log(chalk.yellow(...args)),
+    highlight: (...args) => console.log(chalk.bgCyanBright(...args)),
+    debug: debug(name),
+  };
+}