fix: get rid of undefined in probe location object

Author: alexey-yarmosh

Diff for: src/lib/adopted-probes.ts

@@ -200,10 +200,6 @@ export class AdoptedProbes {
 			const adoptedValue = _.get(adoptedProbe, adoptedField) as string | number;
 			const connectedValue = _.get(connectedProbe, connectedField) as string | number;
 
-			if (!adoptedValue && !connectedValue) { // undefined and null values are treated equal and don't require sync
-				return;
-			}
-
 			if (adoptedValue !== connectedValue) {
 				updateObject[adoptedField] = connectedValue;
 			}

Diff for: src/lib/geoip/client.ts

@@ -7,16 +7,15 @@ import type { ProbeLocation } from '../../probe/types.js';
 import RedisCache from '../cache/redis-cache.js';
 import { getRedisClient } from '../redis/client.js';
 import { scopedLogger } from '../logger.js';
-import { getRegionByCountry } from '../location/location.js';
 import { isAddrWhitelisted } from './whitelist.js';
 import { ipinfoLookup } from './providers/ipinfo.js';
 import { fastlyLookup } from './providers/fastly.js';
 import { maxmindLookup } from './providers/maxmind.js';
 import { ipmapLookup } from './providers/ipmap.js';
 import { type Ip2LocationBundledResponse, ip2LocationLookup } from './providers/ip2location.js';
 
-export type LocationInfo = Omit<ProbeLocation, 'region'>;
 type Provider = 'ipmap' | 'ip2location' | 'ipinfo' | 'maxmind' | 'fastly';
+export type LocationInfo = ProbeLocation & {isHosting: boolean | null};
 export type LocationInfoWithProvider = LocationInfo & {provider: Provider};
 export type NetworkInfo = {
 	network: string;
@@ -31,7 +30,7 @@ export const createGeoipClient = (): GeoipClient => new GeoipClient(new RedisCac
 export default class GeoipClient {
 	constructor (private readonly cache: CacheInterface) {}
 
-	async lookup (addr: string): Promise<ProbeLocation> {
+	async lookup (addr: string): Promise<LocationInfo> {
 		let isHosting = null;
 		const results = await Promise
 			.allSettled([
@@ -74,14 +73,12 @@ export default class GeoipClient {
 			throw new ProbeError(`unresolvable geoip: ${addr}`);
 		}
 
-		const region = getRegionByCountry(match.country);
-
 		return {
 			continent: match.continent,
 			country: match.country,
 			state: match.state,
 			city: match.city,
-			region,
+			region: match.region,
 			normalizedCity: match.normalizedCity,
 			asn: Number(networkMatch.asn),
 			latitude: Number(match.latitude),

Diff for: src/lib/geoip/fake-client.ts

@@ -1,10 +1,10 @@
-import type { ProbeLocation } from '../../probe/types.js';
+import type { LocationInfo } from './client.js';
 
-export const fakeLookup = (): ProbeLocation => {
+export const fakeLookup = (): LocationInfo => {
 	return {
 		continent: 'SA',
 		country: 'AR',
-		state: undefined,
+		state: null,
 		city: 'Buenos Aires',
 		region: 'South America',
 		normalizedCity: 'buenos aires',
@@ -13,5 +13,6 @@ export const fakeLookup = (): ProbeLocation => {
 		longitude: -58.3772,
 		network: 'InterBS S.R.L. (BAEHOST)',
 		normalizedNetwork: 'interbs s.r.l. (baehost)',
+		isHosting: null,
 	};
 };

Diff for: src/lib/geoip/providers/fastly.ts

@@ -1,4 +1,5 @@
 import got from 'got';
+import { getRegionByCountry } from '../../location/location.js';
 import { getCity } from '../city-approximation.js';
 import type { LocationInfo } from '../client.js';
 import {
@@ -38,6 +39,7 @@ export const fastlyLookup = async (addr: string): Promise<LocationInfo> => {
 
 	return {
 		continent: data.continent_code,
+		region: getRegionByCountry(data.country_code),
 		country: data.country_code,
 		state: data.country_code === 'US' ? data.region : null,
 		city: normalizeCityNamePublic(city),

Diff for: src/lib/geoip/providers/ip2location.ts

@@ -2,6 +2,7 @@ import got from 'got';
 import config from 'config';
 import {
 	getContinentByCountry,
+	getRegionByCountry,
 	getStateIsoByName,
 } from '../../location/location.js';
 import type { LocationInfo } from '../client.js';
@@ -45,6 +46,7 @@ export const ip2LocationLookup = async (addr: string): Promise<Ip2LocationBundle
 
 	const location = {
 		continent: result.country_code ? getContinentByCountry(result.country_code) : '',
+		region: result.country_code ? getRegionByCountry(result.country_code) : '',
 		state: result.country_code === 'US' && result.region_name ? getStateIsoByName(result.region_name) : null,
 		country: result.country_code ?? '',
 		city: normalizeCityNamePublic(city),

Diff for: src/lib/geoip/providers/ipinfo.ts

@@ -1,6 +1,6 @@
 import got from 'got';
 import config from 'config';
-import { getContinentByCountry, getStateIsoByName } from '../../location/location.js';
+import { getContinentByCountry, getRegionByCountry, getStateIsoByName } from '../../location/location.js';
 import type { LocationInfo } from '../client.js';
 import {
 	normalizeCityName,
@@ -34,6 +34,7 @@ export const ipinfoLookup = async (addr: string): Promise<LocationInfo> => {
 
 	return {
 		continent: result.country ? getContinentByCountry(result.country) : '',
+		region: result.country ? getRegionByCountry(result.country) : '',
 		state: result.country === 'US' && result.region ? getStateIsoByName(result.region) : null,
 		country: result.country ?? '',
 		city: normalizeCityNamePublic(city),

Diff for: src/lib/geoip/providers/ipmap.ts

@@ -1,5 +1,5 @@
 import got from 'got';
-import { getContinentByCountry } from '../../location/location.js';
+import { getContinentByCountry, getRegionByCountry } from '../../location/location.js';
 import type { LocationInfo } from '../client.js';
 import {
 	normalizeCityName,
@@ -24,6 +24,7 @@ export const ipmapLookup = async (addr: string): Promise<LocationInfo> => {
 
 	return {
 		continent: location.countryCodeAlpha2 ? getContinentByCountry(location.countryCodeAlpha2) : '',
+		region: location.countryCodeAlpha2 ? getRegionByCountry(location.countryCodeAlpha2) : '',
 		state: location.countryCodeAlpha2 === 'US' && location.stateAnsiCode ? location.stateAnsiCode : null,
 		country: location.countryCodeAlpha2 ?? '',
 		city: normalizeCityNamePublic(city),

Diff for: src/lib/geoip/providers/maxmind.ts

@@ -9,6 +9,7 @@ import {
 	normalizeNetworkName,
 } from '../utils.js';
 import { getCity } from '../city-approximation.js';
+import { getRegionByCountry } from '../../location/location.js';
 
 const client = new WebServiceClient(config.get('maxmind.accountId'), config.get('maxmind.licenseKey'));
 
@@ -39,6 +40,7 @@ export const maxmindLookup = async (addr: string): Promise<LocationInfo> => {
 
 	return {
 		continent: data.continent?.code ?? '',
+		region: data.country?.isoCode ? getRegionByCountry(data.country?.isoCode) : '',
 		country: data.country?.isoCode ?? '',
 		state: data.country?.isoCode === 'US' ? data.subdivisions?.map(s => s.isoCode)[0] ?? '' : null,
 		city: normalizeCityNamePublic(city),

Diff for: src/probe/builder.ts

@@ -12,7 +12,7 @@ import {
 	getRegionAliases,
 } from '../lib/location/location.js';
 import { ProbeError } from '../lib/probe-error.js';
-import { createGeoipClient } from '../lib/geoip/client.js';
+import { createGeoipClient, LocationInfo } from '../lib/geoip/client.js';
 import type GeoipClient from '../lib/geoip/client.js';
 import getProbeIp from '../lib/get-probe-ip.js';
 import { getRegion } from '../lib/ip-ranges.js';
@@ -118,7 +118,7 @@ export const getIndex = (location: ProbeLocation, tags: Tag[]) => {
 	return index;
 };
 
-const getLocation = (ipInfo: ProbeLocation): ProbeLocation => ({
+const getLocation = (ipInfo: LocationInfo): ProbeLocation => ({
 	continent: ipInfo.continent,
 	region: ipInfo.region,
 	country: ipInfo.country,
@@ -132,7 +132,7 @@ const getLocation = (ipInfo: ProbeLocation): ProbeLocation => ({
 	normalizedNetwork: ipInfo.normalizedNetwork,
 });
 
-const getTags = (clientIp: string, ipInfo: ProbeLocation) => {
+const getTags = (clientIp: string, ipInfo: LocationInfo) => {
 	const tags: Tag[] = [];
 	const cloudRegion = getRegion(clientIp);
 

Diff for: src/probe/types.ts

@@ -10,7 +10,6 @@ export type ProbeLocation = {
 	state: string | null;
 	network: string;
 	normalizedNetwork: string;
-	isHosting: boolean | null;
 };
 
 export type ProbeStats = {