test: add unit tests

Author: alexey-yarmosh

migrations/create-tables.js.sql

@@ -1,7 +1,8 @@
 CREATE TABLE IF NOT EXISTS directus_users (
 	id CHAR(36) PRIMARY KEY,
 	github_username VARCHAR(255),
-	user_type VARCHAR(255) NOT NULL DEFAULT 'member'
+	user_type VARCHAR(255) NOT NULL DEFAULT 'member',
+	public_probes BOOLEAN DEFAULT 0
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
 CREATE TABLE IF NOT EXISTS gp_adopted_probes (

src/lib/override/adopted-probes.ts

@@ -47,7 +47,7 @@ export type Adoption = {
 	publicProbes: boolean;
 }
 
-type Row = Omit<Adoption, 'isCustomCity' | 'tags' | 'systemTags' | 'altIps' | 'isIPv4Supported' | 'isIPv6Supported' | 'publicProbes'> & {
+export type Row = Omit<Adoption, 'isCustomCity' | 'tags' | 'systemTags' | 'altIps' | 'isIPv4Supported' | 'isIPv6Supported' | 'publicProbes'> & {
 	altIps: string;
 	tags: string;
 	systemTags: string;
@@ -239,10 +239,10 @@ export class AdoptedProbes {
 	public async fetchAdoptions () {
 		const rows = await this.sql(ADOPTIONS_TABLE)
 			.leftJoin(USERS_TABLE, `${ADOPTIONS_TABLE}.userId`, `${USERS_TABLE}.id`)
-			.select<Row[]>(`${ADOPTIONS_TABLE}.*`, `${USERS_TABLE}.github_username AS githubUsername`, `${USERS_TABLE}.public_probes as publicProbes`)
 			// First item will be preserved, so we are prioritizing online probes.
 			// Sorting by id at the end so order is the same in any table state.
-			.orderByRaw(`${ADOPTIONS_TABLE}.lastSyncDate DESC, ${ADOPTIONS_TABLE}.onlineTimesToday DESC, FIELD(${ADOPTIONS_TABLE}.status, 'ready') DESC, ${ADOPTIONS_TABLE}.id DESC`);
+			.orderByRaw(`${ADOPTIONS_TABLE}.lastSyncDate DESC, ${ADOPTIONS_TABLE}.onlineTimesToday DESC, FIELD(${ADOPTIONS_TABLE}.status, 'ready') DESC, ${ADOPTIONS_TABLE}.id DESC`)
+			.select<Row[]>(`${ADOPTIONS_TABLE}.*`, `${USERS_TABLE}.github_username AS githubUsername`, `${USERS_TABLE}.public_probes as publicProbes`);
 
 		const adoptions: Adoption[] = rows.map(row => ({
 			...row,

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

@@ -1,14 +1,14 @@
 import { expect } from 'chai';
 import * as sinon from 'sinon';
 import relativeDayUtc from 'relative-day-utc';
-import { AdoptedProbes } from '../../../../src/lib/override/adopted-probes.js';
+import { AdoptedProbes, Row } from '../../../../src/lib/override/adopted-probes.js';
 import type { Probe } from '../../../../src/probe/types.js';
 
 describe('AdoptedProbes', () => {
-	const defaultAdoptedProbe = {
+	const defaultAdoptedProbe: Row = {
 		id: 'p-1',
+		name: 'probe-1',
 		userId: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
-		username: 'jimaek',
 		ip: '1.1.1.1',
 		altIps: '[]',
 		uuid: '1-1-1-1-1',
@@ -30,6 +30,8 @@ describe('AdoptedProbes', () => {
 		longitude: -6.25,
 		asn: 16509,
 		network: 'Amazon.com, Inc.',
+		githubUsername: 'jimaek',
+		publicProbes: 0,
 	};
 
 	const defaultConnectedProbe: Probe = {
@@ -87,6 +89,7 @@ describe('AdoptedProbes', () => {
 		where: sandbox.stub(),
 		orWhere: sandbox.stub(),
 		whereIn: sandbox.stub(),
+		leftJoin: sandbox.stub(),
 		orderByRaw: sandbox.stub(),
 	} as any;
 	const sqlStub = sandbox.stub() as any;
@@ -102,6 +105,7 @@ describe('AdoptedProbes', () => {
 		sql.where.returns(sql);
 		sql.orWhere.returns(sql);
 		sql.whereIn.returns(sql);
+		sql.leftJoin.returns(sql);
 		sql.orderByRaw.returns(sql);
 		sql.select.resolves([ defaultAdoptedProbe ]);
 		sqlStub.returns(sql);
@@ -412,16 +416,14 @@ describe('AdoptedProbes', () => {
 
 		expect(sql.raw.callCount).to.equal(2);
 
-		expect(sql.raw.args[0]![1]).to.deep.equal({
+		expect(sql.raw.args[0]![1]).to.deep.include({
 			recipient: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
-			subject: `Your probe's location has changed`,
-			message: 'Globalping detected that your [probe with IP address **1.1.1.1**](/probes/p-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 report it in [this issue](https://github.com/jsdelivr/globalping/issues/268).',
+			subject: 'Your probe\'s location has changed',
 		});
 
-		expect(sql.raw.args[1]![1]).to.deep.equal({
+		expect(sql.raw.args[1]![1]).to.deep.include({
 			recipient: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
 			subject: `Your probe's location has changed`,
-			message: 'Globalping detected that your probe [**probe-gb-london-01**](/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 report it in [this issue](https://github.com/jsdelivr/globalping/issues/268).',
 		});
 
 		expect(sql.where.callCount).to.equal(2);
@@ -514,10 +516,9 @@ describe('AdoptedProbes', () => {
 
 		expect(sql.raw.callCount).to.equal(4);
 
-		expect(sql.raw.args[2]![1]).to.deep.equal({
+		expect(sql.raw.args[2]![1]).to.deep.include({
 			recipient: '3cff97ae-4a0a-4f34-9f1a-155e6def0a45',
 			subject: `Your probe's location has changed back`,
-			message: 'Globalping detected that your [probe with IP address **1.1.1.1**](/probes/p-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({
@@ -761,6 +762,7 @@ describe('AdoptedProbes', () => {
 			isCustomCity: false,
 			isIPv4Supported: true,
 			isIPv6Supported: true,
+			publicProbes: false,
 		});
 	});
 
@@ -827,7 +829,17 @@ describe('AdoptedProbes', () => {
 		expect(updatedLocation).to.equal(null);
 	});
 
-	it('getUpdatedTags method should return updated tags', async () => {
+	it('getUpdatedTags method should return same tags array', async () => {
+		delete process.env['SHOULD_SYNC_ADOPTIONS'];
+		const adoptedProbes = new AdoptedProbes(sqlStub, getProbesWithAdminData);
+		sql.select.resolves([{ ...defaultAdoptedProbe, tags: '[]' }]);
+
+		await adoptedProbes.syncDashboardData();
+		const updatedTags = adoptedProbes.getUpdatedTags(defaultConnectedProbe);
+		expect(updatedTags).to.equal(defaultConnectedProbe.tags);
+	});
+
+	it('getUpdatedTags method should return user tags', async () => {
 		delete process.env['SHOULD_SYNC_ADOPTIONS'];
 		const adoptedProbes = new AdoptedProbes(sqlStub, getProbesWithAdminData);
 
@@ -839,13 +851,16 @@ describe('AdoptedProbes', () => {
 		]);
 	});
 
-	it('getUpdatedTags method should return same tags array if user tags are empty', async () => {
+	it('getUpdatedTags method should include user tag if public_probes: true', async () => {
 		delete process.env['SHOULD_SYNC_ADOPTIONS'];
 		const adoptedProbes = new AdoptedProbes(sqlStub, getProbesWithAdminData);
-		sql.select.resolves([{ ...defaultAdoptedProbe, tags: '[]' }]);
+		sql.select.resolves([{ ...defaultAdoptedProbe, tags: '[]', publicProbes: 1 }]);
 
 		await adoptedProbes.syncDashboardData();
 		const updatedTags = adoptedProbes.getUpdatedTags(defaultConnectedProbe);
-		expect(updatedTags).to.equal(defaultConnectedProbe.tags);
+		expect(updatedTags).to.deep.equal([
+			{ type: 'system', value: 'datacenter-network' },
+			{ type: 'user', value: 'u-jimaek' },
+		]);
 	});
 });