Update

Author: sefinek

example/lookup-watch.js

@@ -0,0 +1,15 @@
+const geoIp = require('../index.js');
+
+geoIp.startWatchingDataUpdate(err => {
+	if (err) {
+		console.error('[geoip-lite2] GeoIP reload failed:', err);
+		return;
+	}
+	console.log('[geoip-lite2] Reloaded GeoIP database');
+});
+
+const ipv4 = '79.186.130.100';
+console.log(ipv4, geoIp.lookup(ipv4));
+
+const ipv6 = '2a01:11bf:4222:900a:99ae:285f:7432:8f8e';
+console.log(ipv6, geoIp.lookup(ipv6));

test/fsWatcher.test.js

@@ -0,0 +1,107 @@
+const { afterEach, beforeEach, describe, expect, it, jest: jestGlobals } = require('@jest/globals');
+const { join } = require('node:path');
+
+describe('fsWatcher', () => {
+	beforeEach(() => {
+		jestGlobals.resetModules();
+		jestGlobals.useFakeTimers();
+	});
+
+	afterEach(() => {
+		jestGlobals.useRealTimers();
+		jestGlobals.restoreAllMocks();
+	});
+
+	it('should debounce watch events and emit the latest change details', () => {
+		let onWatchEvent;
+		const watcher = {
+			close: jestGlobals.fn(),
+			on: jestGlobals.fn().mockReturnThis(),
+		};
+		const watch = jestGlobals.fn((_directory, callback) => {
+			onWatchEvent = callback;
+			return watcher;
+		});
+
+		jestGlobals.doMock('node:fs', () => ({ watch }));
+		const fsWatcher = require('../scripts/fsWatcher.js');
+		const callback = jestGlobals.fn();
+
+		fsWatcher.makeFsWatchFilter('debounceWatcher', '/data', 200, callback);
+
+		onWatchEvent('rename', 'geoip-city.dat');
+		onWatchEvent('change', 'geoip-country.dat');
+
+		jestGlobals.advanceTimersByTime(199);
+		expect(callback).not.toHaveBeenCalled();
+
+		jestGlobals.advanceTimersByTime(1);
+		expect(callback).toHaveBeenCalledTimes(1);
+		expect(callback).toHaveBeenCalledWith({
+			event: 'change',
+			file: 'geoip-country.dat',
+			path: join('/data', 'geoip-country.dat'),
+		});
+	});
+
+	it('should filter events to requested files', () => {
+		let onWatchEvent;
+		const watcher = {
+			close: jestGlobals.fn(),
+			on: jestGlobals.fn().mockReturnThis(),
+		};
+		const watch = jestGlobals.fn((_directory, callback) => {
+			onWatchEvent = callback;
+			return watcher;
+		});
+
+		jestGlobals.doMock('node:fs', () => ({ watch }));
+		const fsWatcher = require('../scripts/fsWatcher.js');
+		const callback = jestGlobals.fn();
+
+		fsWatcher.makeFsWatchFilter('fileFilterWatcher', '/data', ['geoip-city.dat'], 100, callback);
+
+		onWatchEvent('rename', 'geoip-country.dat');
+		jestGlobals.advanceTimersByTime(100);
+		expect(callback).not.toHaveBeenCalled();
+
+		onWatchEvent('rename', 'geoip-city.dat');
+		jestGlobals.advanceTimersByTime(100);
+		expect(callback).toHaveBeenCalledTimes(1);
+	});
+
+	it('should close previous watcher when re-registering the same watcher name', () => {
+		let firstHandler;
+		let secondHandler;
+		const firstWatcher = {
+			close: jestGlobals.fn(),
+			on: jestGlobals.fn().mockReturnThis(),
+		};
+		const secondWatcher = {
+			close: jestGlobals.fn(),
+			on: jestGlobals.fn().mockReturnThis(),
+		};
+		let call = 0;
+		const watch = jestGlobals.fn((_directory, callback) => {
+			call++;
+			if (call === 1) {
+				firstHandler = callback;
+				return firstWatcher;
+			}
+			secondHandler = callback;
+			return secondWatcher;
+		});
+
+		jestGlobals.doMock('node:fs', () => ({ watch }));
+		const fsWatcher = require('../scripts/fsWatcher.js');
+		const callback = jestGlobals.fn();
+
+		fsWatcher.makeFsWatchFilter('sameNameWatcher', '/data', 100, callback);
+		fsWatcher.makeFsWatchFilter('sameNameWatcher', '/data', 100, callback);
+
+		expect(firstWatcher.close).toHaveBeenCalledTimes(1);
+		expect(secondWatcher.close).not.toHaveBeenCalled();
+		expect(typeof firstHandler).toBe('function');
+		expect(typeof secondHandler).toBe('function');
+	});
+});

test/watcher.integration.test.js

@@ -0,0 +1,52 @@
+const { afterEach, describe, expect, it, jest: jestGlobals } = require('@jest/globals');
+
+describe('Watcher integration', () => {
+	afterEach(() => {
+		jestGlobals.restoreAllMocks();
+		jestGlobals.resetModules();
+	});
+
+	it('should log detected file changes and trigger async reload', done => {
+		let watchCallback;
+		const makeFsWatchFilter = jestGlobals.fn((_name, _directory, _files, _delay, callback) => {
+			watchCallback = callback;
+		});
+
+		jestGlobals.doMock('../scripts/fsWatcher.js', () => ({
+			makeFsWatchFilter,
+			stopWatching: jestGlobals.fn(),
+		}));
+
+		const logSpy = jestGlobals.spyOn(console, 'log').mockImplementation(() => undefined);
+		const geoIp = require('../index.js');
+
+		geoIp.startWatchingDataUpdate(err => {
+			try {
+				expect(err).toBeFalsy();
+				expect(makeFsWatchFilter).toHaveBeenCalledWith(
+					'dataWatcher',
+					expect.any(String),
+					expect.arrayContaining([
+						'geoip-city.dat',
+						'geoip-city6.dat',
+						'geoip-city-names.dat',
+						'geoip-country.dat',
+						'geoip-country6.dat',
+					]),
+					60 * 1000,
+					expect.any(Function)
+				);
+				expect(logSpy).toHaveBeenCalledWith('[geoip-lite2] Detected change in "geoip-city.dat". Reloading data...');
+				done();
+			} catch (assertErr) {
+				done(assertErr);
+			}
+		});
+
+		watchCallback({
+			event: 'rename',
+			file: 'geoip-city.dat',
+			path: '/tmp/geoip-city.dat',
+		});
+	});
+});