progress bar, it's much better

Author: blackmad

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blackmad/api-diff",
-  "version": "1.0.28",
+  "version": "1.0.29",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -28,10 +28,12 @@
   },
   "homepage": "https://github.com/radarlabs/api-diff#readme",
   "dependencies": {
+    "@types/cli-progress": "^3.8.0",
     "axios": "^0.19.2",
     "axios-retry": "^3.1.8",
     "bluebird": "^3.7.2",
     "chalk": "^4.1.0",
+    "cli-progress": "^3.8.2",
     "csv-parse": "^4.11.1",
     "csv-stringify": "^5.5.0",
     "dotenv": "^8.2.0",

src/api-diff/formatters/compare-formatter.ts

@@ -1,6 +1,8 @@
 /* eslint-disable no-console */
 import * as fs from 'fs';
 import * as stats from 'stats-lite';
+import CliProgress from 'cli-progress';
+
 import { Change } from '../change';
 import { ApiEnv } from '../../apiEnv';
 import { ParsedArgs } from '../argv';
@@ -12,17 +14,17 @@ export type FormatterConstructorParams = {
   newApiEnv: ApiEnv;
   argv: FormatterArgv;
   totalQueries: number;
-}
+};
 
 export type PerHostFinishedStats = {
-  statusCodes: Record<number, number>,
+  statusCodes: Record<number, number>;
   responseTimes: number[];
-}
+};
 
 export type FinishedStats = {
-  new?: PerHostFinishedStats,
-  old: PerHostFinishedStats
-}
+  new?: PerHostFinishedStats;
+  old: PerHostFinishedStats;
+};
 
 /**
  * Convert list of response times to a dictionary of stats
@@ -59,6 +61,9 @@ export abstract class CompareFormatter {
 
   numQueriesChanged = 0;
 
+  /** cli output */
+  progressBar: CliProgress.SingleBar;
+
   /** Called when a query has actually changed */
   abstract logChange(change: Change): void;
 
@@ -72,9 +77,10 @@ export abstract class CompareFormatter {
    */
   queryCompleted(change: Change): void {
     this.numQueriesRun += 1;
-    if (this.numQueriesRun % 10 === 0) {
-      console.error(`IN PROGRESS. ${this.numQueriesRun}/${this.totalQueries} run`);
-    }
+
+    this.progressBar.update(this.numQueriesRun, {
+      numChanged: this.numQueriesChanged,
+    });
 
     if (!change.delta && !this.showUnchanged) {
       return;
@@ -131,6 +137,15 @@ export abstract class CompareFormatter {
     this.startDate = new Date();
     this.showUnchanged = argv.unchanged;
 
+    this.progressBar = new CliProgress.SingleBar({
+      etaBuffer: 250,
+      format:
+        'progress [{bar}] {percentage}% | ETA: {eta}s | {value}/{total} | {numChanged} changed',
+    });
+    this.progressBar.start(totalQueries, 0, {
+      numChanged: 0,
+    });
+
     const outputFilename = argv.output_file;
     if (outputFilename && outputFilename !== '-') {
       this.outputStream = fs.createWriteStream(outputFilename);