Reusable TUI progress code

shockpkg · May 4, 2024 · 178474f · 178474f
1 parent dd12899
commit 178474f
Show file tree

Hide file tree

Showing 4 changed files with 92 additions and 84 deletions.
diff --git a/bin/download-flash-cn.mjs b/bin/download-flash-cn.mjs
@@ -16,6 +16,7 @@ import {download} from '../util/download.mjs';
 import {Hasher, Counter, Void} from '../util/stream.mjs';
 import {Crc64} from '../util/crc64.mjs';
 import {createPackageUrl} from '../util/ia.mjs';
+import {Progress} from '../util/tui.mjs';
 
 async function main() {
 	// eslint-disable-next-line no-process-env
@@ -105,35 +106,19 @@ async function main() {
 		};
 	};
 
-	{
-		const clear = process.stdout.isTTY
-			? '\x1B[F\x1B[2K'.repeat(resources.length)
-			: '';
-		const update = first => {
-			let output = first ? '' : clear;
-			for (const resource of resources) {
-				const {
-					info: {name},
-					progress,
-					hashes
-				} = resource;
-				const status = hashes
-					? 'DONE'
-					: `%${(progress * 100).toFixed(2)}`;
-				output += `${name}: ${status}\n`;
-			}
-			process.stdout.write(output);
-		};
-
-		update(true);
-		const interval = setInterval(update, 1000);
-		try {
-			await queue(resources, each, threads);
-		} finally {
-			clearInterval(interval);
+	const progress = new (class extends Progress {
+		line(resource) {
+			const status = resource.hashes
+				? 'DONE'
+				: `%${(resource.progress * 100).toFixed(2)}`;
+			return `${resource.info.name}: ${status}`;
 		}
-
-		update();
+	})(resources);
+	progress.start(1000);
+	try {
+		await queue(resources, each, threads);
+	} finally {
+		progress.end();
 	}
 
 	console.log('-'.repeat(80));

diff --git a/bin/download-harman-air-runtime.mjs b/bin/download-harman-air-runtime.mjs
@@ -13,6 +13,7 @@ import {download} from '../util/download.mjs';
 import {Hasher, Counter, Void} from '../util/stream.mjs';
 import {queue} from '../util/queue.mjs';
 import {createPackageUrl} from '../util/ia.mjs';
+import {Progress} from '../util/tui.mjs';
 
 async function main() {
 	// eslint-disable-next-line no-process-env
@@ -91,35 +92,19 @@ async function main() {
 		};
 	};
 
-	{
-		const clear = process.stdout.isTTY
-			? '\x1B[F\x1B[2K'.repeat(resources.length)
-			: '';
-		const update = first => {
-			let output = first ? '' : clear;
-			for (const resource of resources) {
-				const {
-					info: {name},
-					progress,
-					hashes
-				} = resource;
-				const status = hashes
-					? 'DONE'
-					: `%${(progress * 100).toFixed(2)}`;
-				output += `${name}: ${status}\n`;
-			}
-			process.stdout.write(output);
-		};
-
-		update(true);
-		const interval = setInterval(update, 1000);
-		try {
-			await queue(resources, each, threads);
-		} finally {
-			clearInterval(interval);
+	const progress = new (class extends Progress {
+		line(resource) {
+			const status = resource.hashes
+				? 'DONE'
+				: `%${(resource.progress * 100).toFixed(2)}`;
+			return `${resource.info.name}: ${status}`;
 		}
-
-		update();
+	})(resources);
+	progress.start(1000);
+	try {
+		await queue(resources, each, threads);
+	} finally {
+		progress.end();
 	}
 
 	console.log('-'.repeat(80));

diff --git a/bin/download-harman-air-sdk.mjs b/bin/download-harman-air-sdk.mjs
@@ -13,6 +13,7 @@ import {download} from '../util/download.mjs';
 import {Hasher, Counter, Void} from '../util/stream.mjs';
 import {queue} from '../util/queue.mjs';
 import {createPackageUrl} from '../util/ia.mjs';
+import {Progress} from '../util/tui.mjs';
 
 async function main() {
 	// eslint-disable-next-line no-process-env
@@ -90,35 +91,19 @@ async function main() {
 		};
 	};
 
-	{
-		const clear = process.stdout.isTTY
-			? '\x1B[F\x1B[2K'.repeat(resources.length)
-			: '';
-		const update = first => {
-			let output = first ? '' : clear;
-			for (const resource of resources) {
-				const {
-					info: {name},
-					progress,
-					hashes
-				} = resource;
-				const status = hashes
-					? 'DONE'
-					: `%${(progress * 100).toFixed(2)}`;
-				output += `${name}: ${status}\n`;
-			}
-			process.stdout.write(output);
-		};
-
-		update(true);
-		const interval = setInterval(update, 1000);
-		try {
-			await queue(resources, each, threads);
-		} finally {
-			clearInterval(interval);
+	const progress = new (class extends Progress {
+		line(resource) {
+			const status = resource.hashes
+				? 'DONE'
+				: `%${(resource.progress * 100).toFixed(2)}`;
+			return `${resource.info.name}: ${status}`;
 		}
-
-		update();
+	})(resources);
+	progress.start(1000);
+	try {
+		await queue(resources, each, threads);
+	} finally {
+		progress.end();
 	}
 
 	console.log('-'.repeat(80));

diff --git a/util/tui.mjs b/util/tui.mjs
@@ -0,0 +1,53 @@
+export class Progress {
+	constructor(items, stream = process.stdout) {
+		this.items = [...items];
+		this.stream = stream;
+		this.interval = null;
+		this._update = null;
+	}
+
+	// eslint-disable-next-line no-unused-vars
+	line(item) {
+		throw new Error('Must override in subclass');
+	}
+
+	start(interval) {
+		if (this.interval) {
+			throw new Error('Already started');
+		}
+
+		const {items, stream} = this;
+		const {isTTY} = stream;
+
+		let clear = '';
+		const update = (this._update = () => {
+			let output = clear;
+			for (const item of items) {
+				output += `${this.line(item)}\n`;
+			}
+			stream.write(output);
+		});
+
+		update();
+
+		clear = isTTY ? '\x1B[F\x1B[2K'.repeat(items.length) : '';
+		this.interval = setInterval(update, interval);
+	}
+
+	stop() {
+		const {interval} = this;
+		if (!interval) {
+			throw new Error('Not started');
+		}
+
+		clearInterval(interval);
+		this.interval = null;
+		this._update = null;
+	}
+
+	end() {
+		const {_update: update} = this;
+		this.stop();
+		update();
+	}
+}