feat: prioritize adopted probes over UUID matches in sync (#756)

Author: alexey-yarmosh

src/lib/override/adopted-probes.ts

@@ -366,27 +366,28 @@ export class AdoptedProbes {
 
 	/**
 	 * Matches probes with dProbes. Priority order:
-	 * 1. Match by UUID
+	 * 1. Match by UUID + adopted
 	 * 2. Match by IP + adopted
 	 * 3. Match by alt IP + adopted
-	 * 4. Match by IP
-	 * 5. Match by alt IP
+	 * 4. Match by UUID
+	 * 5. Match by IP
+	 * 6. Match by alt IP
 	 *
-	 * This ensures that adopted probes take precedence over non-adopted ones when matching by IP or alt IP.
+	 * This ensures that adopted probes take precedence over non-adopted ones in further logic.
 	 */
 	private matchDProbesAndProbes (probes: SocketProbe[]) {
 		const uuidToProbe = new Map(probes.map(probe => [ probe.uuid, probe ]));
 		const ipToProbe = new Map(probes.map(probe => [ probe.ipAddress, probe ]));
 		const altIpToProbe = new Map(probes.map(probe => probe.altIpAddresses.map(altIp => [ altIp, probe ] as const)).flat());
 		const dProbesWithProbe: { dProbe: DProbe; probe: SocketProbe }[] = [];
 
-		// Searching probe for the dProbe by: UUID.
+		// Searching probe for the dProbe by: adopted UUID.
 		let dProbesWithoutProbe: DProbe[] = [];
 
 		this.dProbes.forEach((dProbe) => {
 			const probe = dProbe.uuid && uuidToProbe.get(dProbe.uuid);
 
-			if (probe) {
+			if (probe && dProbe.userId) {
 				dProbesWithProbe.push({ dProbe, probe });
 				uuidToProbe.delete(probe.uuid);
 				ipToProbe.delete(probe.ipAddress);
@@ -450,6 +451,23 @@ export class AdoptedProbes {
 			dProbesWithoutProbe.push(dProbe);
 		});
 
+		// Searching probe for the dProbe by: UUID.
+		dProbesToCheck = [ ...dProbesWithoutProbe ];
+		dProbesWithoutProbe = [];
+
+		dProbesToCheck.forEach((dProbe) => {
+			const probe = dProbe.uuid && uuidToProbe.get(dProbe.uuid);
+
+			if (probe) {
+				dProbesWithProbe.push({ dProbe, probe });
+				uuidToProbe.delete(probe.uuid);
+				ipToProbe.delete(probe.ipAddress);
+				probe.altIpAddresses.forEach(altIp => altIpToProbe.delete(altIp));
+			} else {
+				dProbesWithoutProbe.push(dProbe);
+			}
+		});
+
 		// Searching probe for the dProbe by: dProbe IP -> probe IP.
 		dProbesToCheck = [ ...dProbesWithoutProbe ];
 		dProbesWithoutProbe = [];
@@ -583,24 +601,25 @@ export class AdoptedProbes {
 	private findDuplicates (updatedDProbes: DProbe[]) {
 		const dProbesToDelete: DProbe[] = [];
 		const dProbeAltIpUpdates: { dProbe: DProbe; update: { altIps: string[] } }[] = [];
+		const uniqUuids = new Map<string, DProbe>();
 		const uniqIps = new Map<string, DProbe>();
 
 		updatedDProbes.forEach((dProbe) => {
-			const existingDProbe = uniqIps.get(dProbe.ip);
+			const existingDProbe = uniqUuids.get(dProbe.uuid) || uniqIps.get(dProbe.ip);
 
 			if (
 				existingDProbe
 				&& (existingDProbe.userId === dProbe.userId || dProbe.userId === null)
 			) {
-				logger.warn(`Duplication found by IP ${dProbe.ip}`, {
+				logger.warn('Duplication found.', {
 					stay: _.pick(existingDProbe, [ 'id', 'uuid', 'ip', 'altIps', 'userId' ]),
 					delete: _.pick(dProbe, [ 'id', 'uuid', 'ip', 'altIps', 'userId' ]),
 				});
 
 				dProbesToDelete.push(dProbe);
 				return;
 			} else if (existingDProbe) {
-				logger.error(`Unremovable duplication found by IP ${dProbe.ip}`, {
+				logger.error('Unremovable duplication found.', {
 					stay: _.pick(existingDProbe, [ 'id', 'uuid', 'ip', 'altIps', 'userId' ]),
 					duplicate: _.pick(dProbe, [ 'id', 'uuid', 'ip', 'altIps', 'userId' ]),
 				});
@@ -621,6 +640,7 @@ export class AdoptedProbes {
 				dProbeAltIpUpdates.push({ dProbe, update: { altIps: newAltIps } });
 			}
 
+			uniqUuids.set(dProbe.uuid, dProbe);
 			uniqIps.set(dProbe.ip, dProbe);
 			newAltIps.forEach(altIp => uniqIps.set(altIp, dProbe));
 		});

test/tests/unit/override/adopted-probes.test.ts

@@ -8,7 +8,7 @@ describe('AdoptedProbes', () => {
 	const defaultAdoption: Row = {
 		id: 'p-1',
 		name: 'probe-1',
-		userId: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
+		userId: 'userId',
 		ip: '1.1.1.1',
 		altIps: '[]',
 		uuid: '1-1-1-1-1',
@@ -189,7 +189,7 @@ describe('AdoptedProbes', () => {
 		expect(sql.insert.callCount).to.equal(0);
 	});
 
-	it('class should match dProbe to probe by: adoption IP -> probe IP', async () => {
+	it('class should match dProbe to probe by: dProbe IP -> probe IP', async () => {
 		sql.select.resolves([
 			{ ...defaultAdoption, uuid: 'unsyncedUuid' },
 			{ ...defaultAdoption, id: 'p-2', ip: '2.2.2.2', uuid: '2-2-2-2-2', altIps: '[]' },
@@ -214,7 +214,7 @@ describe('AdoptedProbes', () => {
 		expect(sql.insert.callCount).to.equal(0);
 	});
 
-	it('class should match dProbe to probe by: adoption IP -> probe alt IP', async () => {
+	it('class should match dProbe to probe by: dProbe IP -> probe alt IP', async () => {
 		sql.select.resolves([
 			{ ...defaultAdoption, id: 'p-2', ip: '2.2.2.2', uuid: '2-2-2-2-2', altIps: '[]' },
 			{ ...defaultAdoption, id: 'p-3', ip: '3.3.3.3', uuid: '3-3-3-3-3', altIps: '["2.2.2.2"]' },
@@ -236,7 +236,7 @@ describe('AdoptedProbes', () => {
 		expect(sql.insert.callCount).to.equal(0);
 	});
 
-	it('class should match dProbe to probe by: adoption alt IP -> probe IP', async () => {
+	it('class should match dProbe to probe by: dProbe alt IP -> probe IP', async () => {
 		sql.select.resolves([
 			{ ...defaultAdoption, ip: '3.3.3.3', uuid: '3-3-3-3-3', altIps: '["1.1.1.1"]' },
 		]);
@@ -254,7 +254,7 @@ describe('AdoptedProbes', () => {
 		expect(sql.insert.callCount).to.equal(0);
 	});
 
-	it('class should match dProbe to probe by: adoption alt IP -> probe alt IP', async () => {
+	it('class should match dProbe to probe by: dProbe alt IP -> probe alt IP', async () => {
 		sql.select.resolves([
 			{ ...defaultAdoption, ip: '3.3.3.3', uuid: '3-3-3-3-3', altIps: '["2.2.2.2"]' },
 		]);
@@ -272,6 +272,26 @@ describe('AdoptedProbes', () => {
 		expect(sql.insert.callCount).to.equal(0);
 	});
 
+	it('class should prioritize adopted dProbe match over non-adopted', async () => {
+		sql.select.resolves([
+			{ ...defaultAdoption, id: 'p-1', uuid: '1-1-1-1-1', ip: '1.1.1.1', userId: 'userId', status: 'offline' },
+			{ ...defaultAdoption, id: 'p-2', uuid: '2-2-2-2-2', ip: '2.2.2.2', userId: null, status: 'offline' },
+		]);
+
+		getProbesWithAdminData.returns([{ ...defaultConnectedProbe, uuid: '2-2-2-2-2', ip: '1.1.1.1' }]);
+
+		const adoptedProbes = new AdoptedProbes(sqlStub, getProbesWithAdminData);
+		await adoptedProbes.syncDashboardData();
+
+		expect(sql.delete.callCount).to.equal(1);
+		expect(sql.whereIn.args[0]).to.deep.equal([ 'id', [ 'p-2' ] ]);
+		expect(sql.where.callCount).to.equal(1);
+		expect(sql.update.callCount).to.equal(1);
+		expect(sql.where.args[0]).to.deep.equal([{ id: 'p-1' }]);
+		expect(sql.update.args[0]).to.deep.equal([{ uuid: '2-2-2-2-2', status: 'ready' }]);
+		expect(sql.insert.callCount).to.equal(0);
+	});
+
 	it('class should match dProbe to probe by: offline dProbe token+asn+city -> probe token+asn+city', async () => {
 		sql.select.resolves([{ ...defaultAdoption, status: 'offline', adoptionToken: 'adoptionTokenValue' }]);
 
@@ -534,13 +554,13 @@ describe('AdoptedProbes', () => {
 		expect(sql.raw.callCount).to.equal(2);
 
 		expect(sql.raw.args[0]![1]).to.deep.equal({
-			recipient: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
+			recipient: 'userId',
 			subject: 'Your probe\'s location has changed',
 			message: 'Globalping detected that your probe [**probe-1**](/probes/p-1) with IP address **1.1.1.1** has changed its location from Ireland to United Kingdom. The custom city value "Dublin" is not applied anymore.\n\nIf this change is not right, please follow the steps in [this issue](https://github.com/jsdelivr/globalping/issues/660).',
 		});
 
 		expect(sql.raw.args[1]![1]).to.deep.equal({
-			recipient: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
+			recipient: 'userId',
 			subject: 'Your probe\'s location has changed',
 			message: 'Globalping detected that your probe [**probe-2**](/probes/p-9) with IP address **9.9.9.9** has changed its location from Ireland to United Kingdom. The custom city value "Dublin" is not applied anymore.\n\nIf this change is not right, please follow the steps in [this issue](https://github.com/jsdelivr/globalping/issues/660).',
 		});
@@ -658,13 +678,13 @@ describe('AdoptedProbes', () => {
 		expect(sql.raw.callCount).to.equal(4);
 
 		expect(sql.raw.args[2]![1]).to.deep.equal({
-			recipient: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
+			recipient: 'userId',
 			subject: 'Your probe\'s location has changed back',
 			message: 'Globalping detected that your probe [**probe-1**](/probes/p-1) with IP address **1.1.1.1** has changed its location back from United Kingdom to Ireland. The custom city value "Dublin" is now applied again.',
 		});
 
 		expect(sql.raw.args[3]![1]).to.deep.equal({
-			recipient: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
+			recipient: 'userId',
 			subject: `Your probe's location has changed back`,
 			message: 'Globalping detected that your probe [**probe-2**](/probes/p-9) with IP address **9.9.9.9** has changed its location back from United Kingdom to Ireland. The custom city value "Dublin" is now applied again.',
 		});

wallaby.js

@@ -21,7 +21,8 @@ export default function w (wallaby) {
 			'test/setup.ts',
 			'test/types.ts',
 			'package.json',
-			'knexfile.js',
+			'knexfile.dashboard.js',
+			'knexfile.measurement-store-1.js',
 			'data/*',
 		],
 		tests: [