feat: add AdminData class

Author: alexey-yarmosh

src/lib/admin-data.ts

@@ -0,0 +1,26 @@
+import type { Knex } from 'knex';
+import type { Probe } from '../probe/types.js';
+import { scopedLogger } from './logger.js';
+
+const logger = scopedLogger('admin-data');
+
+export class AdminData {
+	constructor (private readonly sql: Knex) {}
+
+	scheduleSync () {
+		setTimeout(() => {
+			this.syncDashboardData()
+				.finally(() => this.scheduleSync())
+				.catch(error => logger.error(error));
+		}, 60_000).unref();
+	}
+
+	async syncDashboardData () {
+		// Implement
+	}
+
+	getUpdatedLocation (probe: Probe) {
+		// Implement
+		return probe.location;
+	}
+}

src/lib/adopted-probes.ts

@@ -2,7 +2,7 @@ import type { Knex } from 'knex';
 import Bluebird from 'bluebird';
 import _ from 'lodash';
 import { scopedLogger } from './logger.js';
-import type { fetchRawProbes as serverFetchRawProbes } from './ws/server.js';
+import type { fetchProbesWithAdminData as serverFetchProbesWithAdminData } from './ws/server.js';
 import type { Probe } from '../probe/types.js';
 import { normalizeFromPublicName } from './geoip/utils.js';
 
@@ -88,7 +88,7 @@ export class AdoptedProbes {
 
 	constructor (
 		private readonly sql: Knex,
-		private readonly fetchRawProbes: typeof serverFetchRawProbes,
+		private readonly fetchProbesWithAdminData: typeof serverFetchProbesWithAdminData,
 	) {}
 
 	getByIp (ip: string) {
@@ -134,7 +134,7 @@ export class AdoptedProbes {
 	}
 
 	async syncDashboardData () {
-		const allProbes = await this.fetchRawProbes();
+		const allProbes = await this.fetchProbesWithAdminData();
 		this.connectedIpToProbe = new Map(allProbes.map(probe => [ probe.ipAddress, probe ]));
 		this.connectedUuidToIp = new Map(allProbes.map(probe => [ probe.uuid, probe.ipAddress ]));
 

src/lib/probe-override.ts

@@ -1,23 +1,38 @@
 import { getIndex } from '../probe/builder.js';
 import type { Probe } from '../probe/types.js';
 import type { AdoptedProbes } from './adopted-probes.js';
+import type { AdminData } from './admin-data.js';
 
 export class ProbeOverride {
-	constructor (private readonly adoptedProbes: AdoptedProbes) {}
+	constructor (
+		private readonly adoptedProbes: AdoptedProbes,
+		private readonly adminData: AdminData,
+	) {}
 
 	async syncDashboardData () {
-		await this.adoptedProbes.syncDashboardData();
+		await Promise.all([
+			this.adoptedProbes.syncDashboardData(),
+			this.adminData.syncDashboardData(),
+		]);
 	}
 
 	scheduleSync () {
 		this.adoptedProbes.scheduleSync();
+		this.adminData.scheduleSync();
 	}
 
 	getUpdatedLocation (probe: Probe) {
-		return this.adoptedProbes.getUpdatedLocation(probe);
+		const adminLocation = this.adminData.getUpdatedLocation(probe);
+		const adoptedLocation = this.adoptedProbes.getUpdatedLocation(probe);
+		return { ...adminLocation, ...adoptedLocation };
 	}
 
-	addOverrideData (probes: Probe[]) {
+	addAdminData (probes: Probe[]) {
+		// Implement
+		return probes;
+	}
+
+	addAdoptedData (probes: Probe[]) {
 		return probes.map((probe) => {
 			const adopted = this.adoptedProbes.getByIp(probe.ipAddress);
 

src/lib/ws/server.ts

@@ -9,6 +9,7 @@ import { client } from '../sql/client.js';
 import { ProbeOverride } from '../probe-override.js';
 import { ProbeIpLimit } from './helper/probe-ip-limit.js';
 import { AdoptedProbes } from '../adopted-probes.js';
+import { AdminData } from '../admin-data.js';
 
 export type SocketData = {
 	probe: Probe;
@@ -76,24 +77,34 @@ export const fetchRawSockets = async () => {
 	return io.of(PROBES_NAMESPACE).fetchSockets();
 };
 
-export const fetchProbes = async ({ allowStale = true } = {}): Promise<Probe[]> => {
+export const fetchRawProbes = async (): Promise<Probe[]> => {
 	if (!syncedProbeList) {
 		throw new Error('WS server not initialized yet');
 	}
 
-	return allowStale ? syncedProbeList.getProbes() : syncedProbeList.fetchProbes();
+	return syncedProbeList.getRawProbes();
 };
 
-export const fetchRawProbes = async (): Promise<Probe[]> => {
+export const fetchProbesWithAdminData = async (): Promise<Probe[]> => {
 	if (!syncedProbeList) {
 		throw new Error('WS server not initialized yet');
 	}
 
-	return syncedProbeList.getRawProbes();
+	return syncedProbeList.getProbesWithAdminData();
+};
+
+export const fetchProbes = async ({ allowStale = true } = {}): Promise<Probe[]> => {
+	if (!syncedProbeList) {
+		throw new Error('WS server not initialized yet');
+	}
+
+	return allowStale ? syncedProbeList.getProbes() : syncedProbeList.fetchProbes();
 };
 
 export const adoptedProbes = new AdoptedProbes(client, fetchRawProbes);
 
-export const probeOverride = new ProbeOverride(adoptedProbes);
+export const adminData = new AdminData(client);
+
+export const probeOverride = new ProbeOverride(adoptedProbes, adminData);
 
 export const probeIpLimit = new ProbeIpLimit(fetchProbes, fetchRawSockets);

src/lib/ws/synced-probe-list.ts

@@ -45,6 +45,7 @@ export class SyncedProbeList extends EventEmitter {
 
 	private logger: winston.Logger;
 	private rawProbes: Probe[];
+	private probesWithAdminData: Probe[];
 	private probes: Probe[];
 	private oldest: number;
 	private pushTimer: NodeJS.Timeout | undefined;
@@ -59,6 +60,7 @@ export class SyncedProbeList extends EventEmitter {
 		this.nodeId = randomBytes(8).toString('hex');
 		this.logger = scopedLogger('synced-probe-list', this.nodeId);
 		this.rawProbes = [];
+		this.probesWithAdminData = [];
 		this.probes = [];
 		this.oldest = Infinity;
 		this.lastReadEventId = Date.now().toString();
@@ -72,6 +74,18 @@ export class SyncedProbeList extends EventEmitter {
 		});
 	}
 
+	getRawProbes (): Probe[] {
+		return this.rawProbes.slice();
+	}
+
+	getProbesWithAdminData (): Probe[] {
+		return this.probesWithAdminData.slice();
+	}
+
+	getProbes (): Probe[] {
+		return this.probes.slice();
+	}
+
 	async fetchProbes (): Promise<Probe[]> {
 		const start = Date.now();
 
@@ -87,14 +101,6 @@ export class SyncedProbeList extends EventEmitter {
 		});
 	}
 
-	getProbes (): Probe[] {
-		return this.probes.slice();
-	}
-
-	getRawProbes (): Probe[] {
-		return this.rawProbes.slice();
-	}
-
 	private updateProbes () {
 		const probes = [];
 		let oldest = Infinity;
@@ -108,7 +114,8 @@ export class SyncedProbeList extends EventEmitter {
 		}
 
 		this.rawProbes = probes;
-		this.probes = this.probeOverride.addOverrideData(probes);
+		this.probesWithAdminData = this.probeOverride.addAdminData(probes);
+		this.probes = this.probeOverride.addAdoptedData(this.probesWithAdminData);
 		this.oldest = oldest;
 
 		this.emit(this.localUpdateEvent);