makiwara 2.1.9 → 2.2.1

package/README.md

@@ -1,5 +1,6 @@
 # makiwara
 
+[![cli-available](https://badgen.net/static/cli/available/?icon=terminal)](#cli)
 [![node version](https://img.shields.io/node/v/makiwara.svg)](https://www.npmjs.com/package/makiwara)
 [![npm version](https://badge.fury.io/js/makiwara.svg)](https://badge.fury.io/js/makiwara)
 [![downloads count](https://img.shields.io/npm/dt/makiwara.svg)](https://www.npmjs.com/package/makiwara)
@@ -7,20 +8,20 @@
 [![license](https://img.shields.io/npm/l/makiwara.svg)](https://piecioshka.mit-license.org)
 [![github-ci](https://github.com/piecioshka/makiwara/actions/workflows/testing.yml/badge.svg)](https://github.com/piecioshka/makiwara/actions/workflows/testing.yml)
 
-🔨 Benchmark URL to gain HTTP requests limits
+🔨 CLI to benchmark URL to gain HTTP requests limits
 
-## Install
+## Usage
+
+Installation:
 
 ```bash
-npm install -g makiwara
+npm install makiwara
 ```
 
-## Usage
-
 ```javascript
-const { attack } = require('makiwara');
+const { benchmark } = require('makiwara');
 
-attack('https://example.org', [1, 5, 10], 'sequence')
+benchmark('https://example.org', [1, 5, 10], 'sequence')
     .then((result) => {
         console.log(result);
     })
@@ -31,9 +32,17 @@ attack('https://example.org', [1, 5, 10], 'sequence')
 
 ## CLI
 
-```text
+Installation:
+
+```bash
+npm install -g makiwara
+```
+
+```bash
 makiwara --help
+```
 
+```text
 Usage: cli [options]
 
 Example:
@@ -41,7 +50,7 @@ Example:
 
 Options:
   -V, --version                         output the version number
-  -u, --url <url>                       Define URL to attack. Ex. https://example.org/
+  -u, --url <url>                       Define URL to benchmark. Ex. https://example.org/
   -t, --timelimit [numbers]             Define list of time thresholds (in seconds). Ex. 10,100,1000
   -s, --strategy <concurrent|sequence>  Define strategy for making requests
   -h, --help                            output usage information
@@ -88,18 +97,6 @@ Result:
 ╚════════════════════════╧════════════════════════════════╝
 ```
 
-## Unit tests
-
-```bash
-npm test
-```
-
-## Code coverage
-
-```bash
-npm run coverage
-```
-
 ## License
 
-[The MIT License](https://piecioshka.mit-license.org) @ 2017-2019
+[The MIT License](https://piecioshka.mit-license.org) @ 2017

package/bin/cli.js

@@ -1,98 +1,112 @@
 #!/usr/bin/env node
 
-const fs = require('fs');
-const path = require('path');
-
-const http = require('http');
-const https = require('https');
+const http = require("http");
+const https = require("https");
 http.globalAgent.maxSockets = https.globalAgent.maxSockets = 512;
 // http.globalAgent.maxFreeSockets = https.globalAgent.maxFreeSockets = 512;
 
-const program = require('commander');
-const ora = require('ora');
-const isUrl = require('is-url');
-const bold = require('ansi-bold');
+const { Command } = require("commander");
+const program = new Command();
+
+const ora = require("ora");
+const isUrl = require("is-url");
+const bold = require("ansi-bold");
 
-const { attack } = require('../index');
-const HTTP_STATUS = require('../src/http-status-codes');
-const { displaySummary, displayError } = require('../src/display');
-const { makeRequest } = require('../src/make-requests');
+const logger = require("../src/color-logs");
+const { benchmark } = require("../index");
+const HTTP_STATUS = require("../src/http-status-codes");
+const { displaySummary } = require("../src/display");
+const { makeRequest } = require("../src/make-requests");
 
-// eslint-disable-next-line no-sync
-const pkg = JSON.parse(fs.readFileSync(
-    path.join(__dirname, '..', 'package.json')
-).toString());
+const pkg = require("../package.json");
 const STRATEGY_REGEXP = /^(concurrent|sequence)$/;
 
 program
     .version(pkg.version)
-    .option('-u, --url <url>', 'Define URL to attack. Ex. https://example.org/')
-    .option('-t, --timelimit [numbers]', 'Define list of time thresholds (in seconds). Ex. 10,100,1000')
-    .option('-s, --strategy <concurrent|sequence>', 'Define strategy for making requests')
-    .description('Example:\n\tmakiwara -u https://localhost:3000 -t 10 -s sequence')
+    .option(
+        "-u, --url <url>",
+        "Define URL to benchmark. Ex. https://example.org/"
+    )
+    .option(
+        "-t, --timelimit [numbers]",
+        "Define list of time thresholds (in seconds). Ex. 10,100,1000"
+    )
+    .option(
+        "-s, --strategy <concurrent|sequence>",
+        "Define strategy for making requests"
+    )
+    .description(
+        "Example:\n\tmakiwara -u https://localhost:3000 -t 10 -s sequence"
+    )
     .parse(process.argv);
 
-if (typeof program.url !== 'string') {
-    console.red('Error: url is not a string');
+const options = program.opts();
+
+if (typeof options.url !== "string") {
+    displayHeader();
+    logger.red("Error: url is not a string\n");
     program.help();
 }
 
-if (!isUrl(program.url)) {
-    console.red('Error: url is not correct format');
+if (!isUrl(options.url)) {
+    displayHeader();
+    logger.red("Error: url is not correct format\n");
     program.help();
 }
 
-if (!program.timelimit) {
-    program.timelimit = '1,3,5';
-    console.yellow('Ups... you did not put "timelimit" of thresholds');
-    console.yellow(`Thresholds are sets to: ${bold(program.timelimit)} (seconds)\n`);
+if (!options.timelimit) {
+    options.timelimit = "1,3,5";
+    logger.yellow('Ups... you did not define "timelimit" of thresholds');
+    logger.yellow(
+        `Thresholds are sets to: ${bold(options.timelimit)} (seconds)\n`
+    );
 }
 
-if (!(STRATEGY_REGEXP).test(program.strategy)) {
-    program.strategy = 'concurrent';
-    console.yellow('Ups... you did not put "strategy"');
-    console.yellow(`Default strategy is: ${program.strategy}\n`);
+if (!STRATEGY_REGEXP.test(options.strategy)) {
+    options.strategy = "concurrent";
+    logger.yellow('Ups... you did not define "strategy"');
+    logger.yellow(`Default strategy is: ${options.strategy}\n`);
 }
 
-const url = program.url;
-const timeLimit = program.timelimit.split(',').map(Number);
-const strategy = program.strategy;
+const url = options.url;
+const timeLimit = options.timelimit.split(",").map(Number);
+const strategy = options.strategy;
 let spinner = null;
 
 function displayDelimiter() {
-    console.gray('----------------------------------------------------\n');
+    logger.gray("----------------------------------------------------\n");
 }
 
 function displayHeader() {
-    console.log(`${pkg.name}, Version ${pkg.version}`);
-    const currentYear = new Date().getFullYear();
-    console.log(`Copyright 2017-${currentYear} ${pkg.author.name} <${pkg.author.email}> ${pkg.author.url}`);
-    console.log(`The ${pkg.license} License, https://piecioshka.mit-license.org/\n`);
-    console.log(`> ${pkg.description}\n`);
+    const author = `${pkg.author.name} <${pkg.author.email}> ${pkg.author.url}`;
+    console.log(`${pkg.name} v${pkg.version}`);
+    console.log(`Copyright (c) ${new Date().getFullYear()} ${author}\n`);
 }
 
 async function sendTestRequest(testUrl) {
     spinner.succeed(`Start testing... ${bold(testUrl)}`);
     const response = await makeRequest(testUrl, { agent: false });
     if (response.status !== HTTP_STATUS.OK) {
-        console.red(`HTTP Status Code: ${bold(response.status)}`);
-        console.yellow(`Response Body: ${bold(response.text)}`);
+        logger.red(`HTTP Status Code: ${bold(response.status)}`);
+        logger.yellow(`Response Body: ${bold(response.text)}`);
     }
-    spinner.succeed(`Testing completed (response: ${bold(response.text.length)} Bytes)`);
+    spinner.succeed(
+        `Testing completed (response: ${bold(response.text.length)} Bytes)`
+    );
 }
 
 async function main() {
     displayHeader();
 
-    spinner = ora('Loading').start();
+    spinner = ora("Loading").start();
 
     try {
         await sendTestRequest(url);
 
-        spinner.succeed('Start attacking...');
-        const results = await attack(url, timeLimit, strategy);
+        spinner.succeed("Start benchmarking...");
+        const results = await benchmark(url, timeLimit, strategy);
         spinner.stop();
-        spinner.succeed('Attacking completed\n');
+        spinner.succeed("Benchmarking completed\n");
 
         results.forEach((result, index) => {
             displaySummary(result);
@@ -103,7 +117,7 @@ async function main() {
         });
     } catch (err) {
         spinner.stop();
-        displayError(err);
+        logger.red(err);
     }
 
     // eslint-disable-next-line no-process-exit

package/index.js

@@ -1,22 +1 @@
-const { makeRequestsInConcurrentMode, makeRequestsInSequenceMode } = require('./src/make-requests');
-
-require('./src/color-logs');
-
-const strategies = new Map();
-strategies.set('sequence', makeRequestsInSequenceMode);
-strategies.set('concurrent', makeRequestsInConcurrentMode);
-
-function attack(url, timeLimits, strategy) {
-    const method = strategies.get(strategy);
-
-    return Promise.all(
-        timeLimits
-            // Remove zeros timeLimits
-            .filter((k) => k)
-            .map((duration) => method(url, duration))
-    );
-}
-
-module.exports = {
-    attack
-};
+module.exports = require("./src/benchmark");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "makiwara",
-  "description": "🔨 Benchmark URL to gain HTTP requests limits",
-  "version": "2.1.9",
+  "description": "🔨 CLI to benchmark URL to gain HTTP requests limits",
+  "version": "2.2.1",
   "license": "MIT",
   "author": {
     "name": "Piotr Kowalski",
@@ -11,43 +11,45 @@
   "scripts": {
     "clear": "rm -rf dist/ coverage/ .nyc_output/",
     "clear:all": "rm -rf node_modules/ && npm run clear",
-    "test": "jasmine test/specs/*.js",
-    "coverage": "nyc npm run test && nyc report --reporter=html",
+    "test": "jest --watchAll=false",
+    "test:watch": "jest",
+    "coverage": "jest --watchAll=false --coverage",
     "lint": "eslint src/",
     "snyk-protect": "snyk protect",
     "prepare": "npm run snyk-protect"
   },
   "dependencies": {
-    "@types/node": "^22.7.5",
+    "@types/jest": "^29.5.14",
     "ansi-bold": "^0.1.1",
-    "ansi-cyan": "^0.1.1",
     "ansi-gray": "^0.1.1",
     "ansi-red": "^0.1.1",
     "ansi-yellow": "^0.1.1",
-    "axios": "^1.7.7",
-    "commander": "^12.1.0",
+    "axios": "^1.7.9",
     "http-status-codes": "^2.3.0",
     "is-url": "^1.2.4",
+    "jest": "^29.7.0",
     "node-fetch": "^3.3.2",
-    "ora": "^8.1.0",
-    "snyk": "^1.1293.1",
-    "table": "^6.8.2"
+    "snyk": "^1.1295.0",
+    "table": "^6.9.0"
   },
   "devDependencies": {
-    "@types/jasmine": "^5.1.4",
+    "@types/node": "^22.10.7",
+    "commander": "^13.0.0",
     "eslint": "^8.6.0",
-    "eslint-config-piecioshka": "^2.3.1",
-    "jasmine": "^5.4.0",
-    "nock": "^13.5.5",
-    "nyc": "^15.1.0"
+    "eslint-config-piecioshka": "^2.3.6",
+    "nock": "^13.5.6",
+    "ora": "^5.4.1"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/piecioshka/makiwara.git"
+    "url": "git+ssh://git@github.com/piecioshka/makiwara.git"
   },
   "bugs": {
     "url": "https://github.com/piecioshka/makiwara/issues"
   },
+  "engines": {
+    "node": ">=14"
+  },
   "files": [
     "bin",
     "src",
@@ -56,9 +58,8 @@
     "README.md"
   ],
   "keywords": [
-    "app",
-    "test",
-    "attack",
+    "cli",
+    "benchmark",
     "multi",
     "statistics",
     "summary",
@@ -66,9 +67,7 @@
     "verify",
     "request",
     "time",
-    "analyze",
-    "cli",
-    "commonjs"
+    "analyze"
   ],
   "main": "./index.js",
   "bin": {

package/src/benchmark.js

@@ -0,0 +1,23 @@
+const {
+    makeRequestsInConcurrentMode,
+    makeRequestsInSequenceMode,
+} = require("./make-requests");
+
+const strategies = new Map();
+strategies.set("sequence", makeRequestsInSequenceMode);
+strategies.set("concurrent", makeRequestsInConcurrentMode);
+
+function benchmark(url, timeLimits, strategy) {
+    const method = strategies.get(strategy);
+
+    return Promise.all(
+        timeLimits
+            // Remove zeros timeLimits
+            .filter((k) => k)
+            .map((duration) => method(url, duration))
+    );
+}
+
+module.exports = {
+    benchmark,
+};

package/src/benchmark.spec.js

@@ -0,0 +1,15 @@
+const nock = require("nock");
+const HTTP_STATUS = require("./http-status-codes");
+const { benchmark } = require("./benchmark");
+
+describe("Benchmark", () => {
+    it("benchmark should send request", async () => {
+        const targetUrl = "https://localhost/";
+        nock(targetUrl).persist().get("/").reply(204, []);
+
+        const responses = await benchmark(targetUrl, [1], "sequence");
+        const requests = responses[0].requests;
+        const status = requests[0].status;
+        expect(status).toEqual(HTTP_STATUS.NO_CONTENT);
+    });
+});

package/src/color-logs.js

@@ -1,17 +1,10 @@
 function setupColorLogFunction(name) {
     const fn = require(`ansi-${name}`);
-    console[name] = (...args) => console.log(...args.map(fn));
+    return (...args) => console.log(...args.map(fn));
 }
 
-setupColorLogFunction("red");
-setupColorLogFunction("yellow");
-setupColorLogFunction("gray");
-setupColorLogFunction("cyan");
-
-/**
- * @type console
- * @property red
- * @property yellow
- * @property gray
- * @property cyan
- */
+module.exports = {
+    red: setupColorLogFunction("red"),
+    yellow: setupColorLogFunction("yellow"),
+    gray: setupColorLogFunction("gray"),
+};

package/src/display.js

@@ -2,7 +2,7 @@ const { table } = require("table");
 const HTTPStatusCodes = require("http-status-codes");
 const bold = require("ansi-bold");
 
-const { collapseArray } = require("./object-util");
+const logger = require("../src/color-logs");
 
 const SECOND_IN_MILLISECONDS = 1000;
 
@@ -13,60 +13,50 @@ const tableOptions = {
     },
 };
 
-function appendHttpStatusCodeLabel(statusCodeEntries) {
-    statusCodeEntries.forEach((entry) => {
-        let label = null;
-        try {
-            label = HTTPStatusCodes.getStatusText(entry[0]);
-        } catch (err) {
-            console.red(err);
-        }
-        if (typeof label === "string") {
-            entry[0] = `${entry[0]} ${label}`;
-        }
-    });
-}
+function displayRequestsSummary(results) {
+    const aggregateResults = results.requests.reduce((acc, item) => {
+        acc[item.status] = acc[item.status] ? acc[item.status] + 1 : 1;
+        return acc;
+    }, {});
 
-function displayRequestsSummary(attackResults) {
-    const statusCodes = collapseArray(
-        attackResults.requests.map((r) => r.status)
-    );
-    const isEmptyResults = statusCodes.length === 0;
+    const codes = Object.keys(aggregateResults).map(Number);
 
-    if (isEmptyResults) {
-        statusCodes["-"] = -1;
-    } else {
-        appendHttpStatusCodeLabel(statusCodes);
+    if (codes.length === 0) {
+        logger.error("No requests were made");
+        return;
     }
 
-    const data = [["HTTP Status Code", "Requests quantity"].map(bold)].concat(
-        statusCodes
-    );
+    const statuses = codes.reduce((acc, code) => {
+        const label = HTTPStatusCodes.getReasonPhrase(code);
+        acc[`${code} ${label}`] = aggregateResults[code];
+        return acc;
+    }, {});
+
+    const data = [
+        ["HTTP Status Code", "Requests quantity"].map(bold),
+        ...Object.entries(statuses),
+    ];
+
     console.log(table(data, tableOptions));
 }
 
-function displayAttackSummary(results) {
+function displayBenchmarkSummary(results) {
     const meta = [];
-    meta.push(["Type", results.type]);
+    meta.push([bold("Type"), results.type]);
     const durationInSeconds = results.duration / SECOND_IN_MILLISECONDS;
     meta.push([
-        "Effective Duration",
+        bold("Effective Duration"),
         `${durationInSeconds.toLocaleString()} seconds`,
     ]);
-    meta.push(["Times", `${results.times}`]);
+    meta.push([bold("Times"), results.times]);
     console.log(table(meta, tableOptions));
 }
 
-function displaySummary(attackResults) {
-    displayRequestsSummary(attackResults);
-    displayAttackSummary(attackResults);
-}
-
-function displayError(err) {
-    console.log(`${err.name}: ${err.message}\n`);
+function displaySummary(results) {
+    displayRequestsSummary(results);
+    displayBenchmarkSummary(results);
 }
 
 module.exports = {
     displaySummary,
-    displayError,
 };

package/src/local-fetch.js

@@ -18,8 +18,8 @@ async function makeRequest(url, options = {}) {
     const protocol = getProtocol(url);
     return new Promise((resolve, reject) => {
         protocol.get(url, options, (res) => {
-            res.addListener("data", (data) => {
-                response.text += data.toString();
+            res.addListener("data", (buffer) => {
+                response.text += buffer.toString();
             });
             res.addListener("error", (err) => {
                 reject(err);

package/src/make-requests.spec.js

@@ -0,0 +1,41 @@
+const nock = require("nock");
+const {
+    makeRequest,
+    makeRequestsInConcurrentMode,
+    makeRequestsInSequenceMode,
+} = require("./make-requests");
+const HTTP_STATUS = require("./http-status-codes");
+
+describe("makeRequests", () => {
+    const targetUrl = "https://localhost/";
+
+    beforeEach(() => {
+        nock(targetUrl)
+            .persist()
+            .get("/")
+            .delay(100)
+            .times(Infinity)
+            .reply(204, []);
+    });
+
+    it("should returns status code", async () => {
+        const response = await makeRequest(targetUrl, { agent: false });
+        expect(response.status).toEqual(HTTP_STATUS.NO_CONTENT);
+    });
+
+    it.skip("should make HTTP requests in concurrent mode", async (done) => {
+        const results = await makeRequestsInConcurrentMode(targetUrl, 1);
+        setTimeout(() => {
+            expect(results.requests.length).toBeGreaterThan(10);
+            done();
+        }, 100);
+    });
+
+    it.skip("should make HTTP requests in sequence mode", async (done) => {
+        const results = await makeRequestsInSequenceMode(targetUrl, 1);
+        setTimeout(() => {
+            expect(results.requests.length).toBeLessThan(11);
+            done();
+        }, 100);
+    });
+});

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-Copyright (c) 2017 Piotr Kowalski
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
-OR OTHER DEALINGS IN THE SOFTWARE.
-

package/src/object-util.js

@@ -1,17 +0,0 @@
-function collapseArray(array) {
-    const hashMap = array.reduce((mem, item) => {
-        if (!mem[item]) {
-            mem[item] = 0;
-        }
-        mem[item]++;
-        return mem;
-    }, {});
-
-    const entries = Object.entries(hashMap);
-
-    return entries.map((entry) => Number(entry[0]));
-}
-
-module.exports = {
-    collapseArray,
-};