feat: update alt ips logic

Author: alexey-yarmosh

src/helper/alt-ips-handler.ts

@@ -0,0 +1,120 @@
+import os from 'node:os';
+import config from 'config';
+import is from '@sindresorhus/is';
+import _ from 'lodash';
+import { scopedLogger } from '../lib/logger.js';
+import got, { RequestError } from 'got';
+import type { Socket } from 'socket.io-client';
+
+const mainLogger = scopedLogger('general');
+const altIpsLogger = scopedLogger('api:connect:alt-ips-handler');
+
+class AltIpsManager {
+	private readonly INTERVAL_TIME = 10 * 60 * 1000;
+
+	socket: Socket;
+	ip: string;
+	private timer?: NodeJS.Timeout;
+
+	constructor (socket: Socket, ip: string) {
+		this.socket = socket;
+		this.ip = ip;
+		this.start();
+	}
+
+	updateConfig (socket: Socket, ip: string) {
+		this.socket = socket;
+		this.ip = ip;
+		this.start();
+	}
+
+	start () {
+		clearTimeout(this.timer);
+		this.run();
+	}
+
+	private run () {
+		void this.refreshAltIps().catch((error) => {
+			altIpsLogger.error(error);
+		}).finally(() => {
+			this.timer = setTimeout(() => this.run(), this.INTERVAL_TIME);
+		});
+	}
+
+
+	async refreshAltIps (): Promise<void> {
+		const acceptedIps = [ this.ip ];
+		const acceptedIpsWithTokens: { ip: string; token: string }[] = [];
+		const rejectedIps: string[] = [];
+		const addresses = _(os.networkInterfaces())
+			.values()
+			.filter(is.truthy)
+			.flatten()
+			.uniqBy('address')
+			.filter(address => !address.internal)
+			.filter(address => !address.address.startsWith('fe80:')) // filter out link-local addresses
+			.filter(address => !address.address.startsWith('169.254.')) // filter out link-local addresses
+			.value();
+
+		const results = await Promise.allSettled(addresses.map(({ address, family }) => this.getAltIp(address, family === 'IPv6' ? 6 : 4)));
+
+		results.forEach((result, index) => {
+			if (result.status === 'fulfilled') {
+				acceptedIpsWithTokens.push(result.value);
+				acceptedIps.push(result.value.ip);
+			} else {
+				if (!(result.reason instanceof RequestError)) {
+					altIpsLogger.warn(result.reason);
+				} else if (result.reason.response?.statusCode !== 400) {
+					altIpsLogger.warn(`${result.reason.message} (via ${result.reason.options.localAddress}).`);
+				} else {
+					rejectedIps.push(addresses[index]!.address);
+				}
+			}
+		});
+
+		const uniqAcceptedIps = _(acceptedIps).uniq().value();
+		const uniqRejectedIps = _(rejectedIps).uniq().value();
+
+		if (uniqRejectedIps.length === 1) {
+			altIpsLogger.info(`IP address rejected by the API: ${uniqRejectedIps.join(', ')}.`);
+		} else if (uniqRejectedIps.length > 1) {
+			altIpsLogger.info(`IP addresses rejected by the API: ${uniqRejectedIps.join(', ')}.`);
+		}
+
+		if (uniqAcceptedIps.length === 1) {
+			mainLogger.info(`IP address of the probe: ${uniqAcceptedIps[0]}.`);
+		} else {
+			mainLogger.info(`IP addresses of the probe: ${uniqAcceptedIps.join(', ')}.`);
+		}
+	}
+
+	async getAltIp (ip: string, dnsLookupIpVersion: 4 | 6) {
+		const httpHost = config.get<string>('api.httpHost');
+		const response = await got.post<{ ip: string; token: string }>(`${httpHost}/alternative-ip`, {
+			localAddress: ip,
+			dnsLookupIpVersion,
+			retry: {
+				limit: 2,
+				methods: [ 'POST' ],
+				statusCodes: [ 504 ],
+			},
+			timeout: {
+				request: 15_000,
+			},
+			responseType: 'json',
+		});
+
+		return response.body;
+	}
+}
+
+let altIpsManager: AltIpsManager | null = null;
+
+export const ipHandler = (socket: Socket) => ({ ip }: { ip: string }) => {
+	if (!altIpsManager) {
+		altIpsManager = new AltIpsManager(socket, ip);
+	} else {
+		altIpsManager.updateConfig(socket, ip);
+	}
+};

src/helper/ip-handler.ts

@@ -6,7 +6,7 @@ import { getStatusManager } from '../lib/status-manager.js';
 
 const logger = scopedLogger('api:connect:location');
 
-export const apiConnectLocationHandler = (socket: Socket) => async (data: ProbeLocation): Promise<void> => {
+export const locationHandler = (socket: Socket) => async (data: ProbeLocation): Promise<void> => {
 	logger.info(`Connected from ${data.city}, ${data.country}, ${data.continent} (${data.network}, ASN: ${data.asn}, lat: ${data.latitude} long: ${data.longitude}).`);
 	const statusManager = getStatusManager();
 	await statusManager.start();

src/helper/api-connect-handler.ts renamed to src/helper/location-handler.ts

@@ -22,7 +22,7 @@ const report = async (socket: Socket, jobCount: number) => {
 	});
 };
 
-export const run = (socket: Socket, worker: Worker) => {
+export const runStatsAgent = (socket: Socket, worker: Worker) => {
 	setInterval(() => {
 		report(socket, worker.jobs.size)
 			.catch((error: unknown) => {

src/lib/stats/client.ts

@@ -14,8 +14,8 @@ import { apiTransport, scopedLogger } from './lib/logger.js';
 import { ApiTransportSettings } from './lib/api-transport.js';
 import { initErrorHandler } from './helper/api-error-handler.js';
 import { handleTestError } from './helper/test-error-handler.js';
-import { apiConnectLocationHandler } from './helper/api-connect-handler.js';
-import { apiConnectAltIpsHandler } from './helper/alt-ips-handler.js';
+import { locationHandler } from './helper/location-handler.js';
+import { ipHandler } from './helper/ip-handler.js';
 import { adoptionStatusHandler } from './helper/adoption-status-handler.js';
 import { dnsCmd, DnsCommand } from './command/dns-command.js';
 import { pingCmd, PingCommand } from './command/ping-command.js';
@@ -24,7 +24,7 @@ import { mtrCmd, MtrCommand } from './command/mtr-command.js';
 import { httpCmd, HttpCommand } from './command/http-command.js';
 import { FakePingCommand } from './command/fake/fake-ping-command.js';
 import { FakeMtrCommand } from './command/fake/fake-mtr-command.js';
-import { run as runStatsAgent } from './lib/stats/client.js';
+import { runStatsAgent } from './lib/stats/client.js';
 import { initStatusManager } from './lib/status-manager.js';
 import { logAdoptionCode } from './lib/log-adoption-code.js';
 import { getAvailableDiskSpace, getTotalDiskSize, looksLikeV1HardwareDevice } from './lib/util.js';
@@ -120,9 +120,9 @@ function connect (workerId?: number) {
 		})
 		.on('disconnect', errorHandler.handleDisconnect)
 		.on('connect_error', errorHandler.connectError)
-		.on('api:connect:location', apiConnectLocationHandler(socket))
+		.on('api:connect:location', locationHandler(socket))
 		.on('api:connect:adoption', adoptionStatusHandler)
-		.on('api:connect:alt-ips-token', apiConnectAltIpsHandler)
+		.on('api:connect:ip', ipHandler(socket))
 		.on('probe:measurement:request', (data: MeasurementRequest) => {
 			const status = statusManager.getStatus();