feat(server, web)!: Move reverse geocoding settings to the UI (#4222)

* feat: reverse geocoding settings

* chore: open api

* re-init geocoder if precision has been updated

* update docs

* chore: update verbiage

* fix: re-init logic

* fix: reset to default

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

server/src/domain/metadata/geocoding.repository.ts

@@ -1,3 +1,5 @@
+import { InitOptions } from 'local-reverse-geocoder';
+
 export const IGeocodingRepository = 'IGeocodingRepository';
 
 export interface GeoPoint {
@@ -12,7 +14,7 @@ export interface ReverseGeocodeResult {
 }
 
 export interface IGeocodingRepository {
-  init(): Promise<void>;
+  init(options: Partial<InitOptions>): Promise<void>;
   reverseGeocode(point: GeoPoint): Promise<ReverseGeocodeResult>;
   deleteCache(): Promise<void>;
 }

server/src/domain/server-info/server-info.dto.ts

@@ -90,6 +90,7 @@ export class ServerFeaturesDto implements FeatureFlags {
   configFile!: boolean;
   facialRecognition!: boolean;
   map!: boolean;
+  reverseGeocoding!: boolean;
   oauth!: boolean;
   oauthAutoLaunch!: boolean;
   passwordLogin!: boolean;

server/src/domain/server-info/server-info.service.spec.ts

@@ -151,6 +151,7 @@ describe(ServerInfoService.name, () => {
         clipEncode: true,
         facialRecognition: true,
         map: true,
+        reverseGeocoding: true,
         oauth: false,
         oauthAutoLaunch: false,
         passwordLogin: true,

server/src/domain/system-config/dto/system-config-reverse-geocoding.dto.ts

@@ -0,0 +1,12 @@
+import { CitiesFile } from '@app/infra/entities';
+import { ApiProperty } from '@nestjs/swagger';
+import { IsBoolean, IsEnum } from 'class-validator';
+
+export class SystemConfigReverseGeocodingDto {
+  @IsBoolean()
+  enabled!: boolean;
+
+  @IsEnum(CitiesFile)
+  @ApiProperty({ enum: CitiesFile, enumName: 'CitiesFile' })
+  citiesFileOverride!: CitiesFile;
+}

server/src/domain/system-config/dto/system-config.dto.ts

@@ -8,6 +8,7 @@ import { SystemConfigMachineLearningDto } from './system-config-machine-learning
 import { SystemConfigMapDto } from './system-config-map.dto';
 import { SystemConfigOAuthDto } from './system-config-oauth.dto';
 import { SystemConfigPasswordLoginDto } from './system-config-password-login.dto';
+import { SystemConfigReverseGeocodingDto } from './system-config-reverse-geocoding.dto';
 import { SystemConfigStorageTemplateDto } from './system-config-storage-template.dto';
 
 export class SystemConfigDto implements SystemConfig {
@@ -36,6 +37,11 @@ export class SystemConfigDto implements SystemConfig {
   @IsObject()
   passwordLogin!: SystemConfigPasswordLoginDto;
 
+  @Type(() => SystemConfigReverseGeocodingDto)
+  @ValidateNested()
+  @IsObject()
+  reverseGeocoding!: SystemConfigReverseGeocodingDto;
+
   @Type(() => SystemConfigStorageTemplateDto)
   @ValidateNested()
   @IsObject()

server/src/domain/system-config/system-config.core.ts

@@ -1,6 +1,7 @@
 import {
   AudioCodec,
   CQMode,
+  CitiesFile,
   Colorspace,
   SystemConfig,
   SystemConfigEntity,
@@ -81,6 +82,10 @@ export const defaults = Object.freeze<SystemConfig>({
     enabled: true,
     tileUrl: 'https://tile.openstreetmap.org/{z}/{x}/{y}.png',
   },
+  reverseGeocoding: {
+    enabled: true,
+    citiesFileOverride: CitiesFile.CITIES_500,
+  },
   oauth: {
     enabled: false,
     issuerUrl: '',
@@ -115,6 +120,7 @@ export enum FeatureFlag {
   FACIAL_RECOGNITION = 'facialRecognition',
   TAG_IMAGE = 'tagImage',
   MAP = 'map',
+  REVERSE_GEOCODING = 'reverseGeocoding',
   SIDECAR = 'sidecar',
   SEARCH = 'search',
   OAUTH = 'oauth',
@@ -177,6 +183,7 @@ export class SystemConfigCore {
       [FeatureFlag.FACIAL_RECOGNITION]: mlEnabled && config.machineLearning.facialRecognition.enabled,
       [FeatureFlag.TAG_IMAGE]: mlEnabled && config.machineLearning.classification.enabled,
       [FeatureFlag.MAP]: config.map.enabled,
+      [FeatureFlag.REVERSE_GEOCODING]: config.reverseGeocoding.enabled,
       [FeatureFlag.SIDECAR]: true,
       [FeatureFlag.SEARCH]: process.env.TYPESENSE_ENABLED !== 'false',
 

server/src/domain/system-config/system-config.service.spec.ts

@@ -1,6 +1,7 @@
 import {
   AudioCodec,
   CQMode,
+  CitiesFile,
   Colorspace,
   SystemConfig,
   SystemConfigEntity,
@@ -80,6 +81,10 @@ const updatedConfig = Object.freeze<SystemConfig>({
     enabled: true,
     tileUrl: 'https://tile.openstreetmap.org/{z}/{x}/{y}.png',
   },
+  reverseGeocoding: {
+    enabled: true,
+    citiesFileOverride: CitiesFile.CITIES_500,
+  },
   oauth: {
     autoLaunch: true,
     autoRegister: true,

server/src/infra/entities/system-config.entity.ts

@@ -64,6 +64,9 @@ export enum SystemConfigKey {
   MAP_ENABLED = 'map.enabled',
   MAP_TILE_URL = 'map.tileUrl',
 
+  REVERSE_GEOCODING_ENABLED = 'reverseGeocoding.enabled',
+  REVERSE_GEOCODING_CITIES_FILE_OVERRIDE = 'reverseGeocoding.citiesFileOverride',
+
   OAUTH_ENABLED = 'oauth.enabled',
   OAUTH_ISSUER_URL = 'oauth.issuerUrl',
   OAUTH_CLIENT_ID = 'oauth.clientId',
@@ -130,6 +133,13 @@ export enum Colorspace {
   P3 = 'p3',
 }
 
+export enum CitiesFile {
+  CITIES_15000 = 'cities15000',
+  CITIES_5000 = 'cities5000',
+  CITIES_1000 = 'cities1000',
+  CITIES_500 = 'cities500',
+}
+
 export interface SystemConfig {
   ffmpeg: {
     crf: number;
@@ -175,6 +185,10 @@ export interface SystemConfig {
     enabled: boolean;
     tileUrl: string;
   };
+  reverseGeocoding: {
+    enabled: boolean;
+    citiesFileOverride: CitiesFile;
+  };
   oauth: {
     enabled: boolean;
     issuerUrl: string;

server/src/infra/infra.config.ts

@@ -2,7 +2,6 @@ import { QueueName } from '@app/domain';
 import { RegisterQueueOptions } from '@nestjs/bullmq';
 import { QueueOptions } from 'bullmq';
 import { RedisOptions } from 'ioredis';
-import { InitOptions } from 'local-reverse-geocoder';
 import { ConfigurationOptions } from 'typesense/lib/Typesense/Configuration';
 
 function parseRedisConfig(): RedisOptions {
@@ -72,20 +71,5 @@ function parseTypeSenseConfig(): ConfigurationOptions {
 
 export const typesenseConfig: ConfigurationOptions = parseTypeSenseConfig();
 
-function parseLocalGeocodingConfig(): InitOptions {
-  const precision = Number(process.env.REVERSE_GEOCODING_PRECISION);
-
-  return {
-    citiesFileOverride: precision ? ['cities15000', 'cities5000', 'cities1000', 'cities500'][precision] : undefined,
-    load: {
-      admin1: true,
-      admin2: true,
-      admin3And4: false,
-      alternateNames: false,
-    },
-    countries: [],
-    dumpDirectory: process.env.REVERSE_GEOCODING_DUMP_DIRECTORY || process.cwd() + '/.reverse-geocoding-dump/',
-  };
-}
-
-export const localGeocodingConfig: InitOptions = parseLocalGeocodingConfig();
+export const REVERSE_GEOCODING_DUMP_DIRECTORY =
+  process.env.REVERSE_GEOCODING_DUMP_DIRECTORY || process.cwd() + '/.reverse-geocoding-dump/';

server/src/infra/repositories/geocoding.repository.ts

@@ -1,9 +1,9 @@
 import { GeoPoint, IGeocodingRepository, ReverseGeocodeResult } from '@app/domain';
-import { localGeocodingConfig } from '@app/infra';
+import { REVERSE_GEOCODING_DUMP_DIRECTORY } from '@app/infra';
 import { Injectable, Logger } from '@nestjs/common';
 import { readdir, rm } from 'fs/promises';
 import { getName } from 'i18n-iso-countries';
-import geocoder, { AddressObject } from 'local-reverse-geocoder';
+import geocoder, { AddressObject, InitOptions } from 'local-reverse-geocoder';
 import path from 'path';
 import { promisify } from 'util';
 
@@ -18,19 +18,33 @@ export type GeoData = AddressObject & {
   admin2Code?: AdminCode | string;
 };
 
-const init = (): Promise<void> => new Promise<void>((resolve) => geocoder.init(localGeocodingConfig, resolve));
 const lookup = promisify<GeoPoint[], number, AddressObject[][]>(geocoder.lookUp).bind(geocoder);
 
 @Injectable()
 export class GeocodingRepository implements IGeocodingRepository {
   private logger = new Logger(GeocodingRepository.name);
 
-  async init(): Promise<void> {
-    await init();
+  async init(options: Partial<InitOptions>): Promise<void> {
+    return new Promise<void>((resolve) => {
+      geocoder.init(
+        {
+          load: {
+            admin1: true,
+            admin2: true,
+            admin3And4: false,
+            alternateNames: false,
+          },
+          countries: [],
+          dumpDirectory: REVERSE_GEOCODING_DUMP_DIRECTORY,
+          ...options,
+        },
+        resolve,
+      );
+    });
   }
 
   async deleteCache() {
-    const dumpDirectory = localGeocodingConfig.dumpDirectory;
+    const dumpDirectory = REVERSE_GEOCODING_DUMP_DIRECTORY;
     if (dumpDirectory) {
       // delete contents
       const items = await readdir(dumpDirectory, { withFileTypes: true });

server/src/microservices/processors/metadata-extraction.processor.ts

@@ -1,4 +1,5 @@
 import {
+  FeatureFlag,
   IAlbumRepository,
   IAssetRepository,
   IBaseJob,
@@ -7,17 +8,18 @@ import {
   IGeocodingRepository,
   IJobRepository,
   IStorageRepository,
+  ISystemConfigRepository,
   JobName,
   JOBS_ASSET_PAGINATION_SIZE,
   QueueName,
   StorageCore,
   StorageFolder,
+  SystemConfigCore,
   usePagination,
   WithoutProperty,
 } from '@app/domain';
 import { AssetEntity, AssetType, ExifEntity } from '@app/infra/entities';
 import { Inject, Logger } from '@nestjs/common';
-import { ConfigService } from '@nestjs/config';
 import { DefaultReadTaskOptions, ExifDateTime, exiftool, ReadTaskOptions, Tags } from 'exiftool-vendored';
 import { firstDateTime } from 'exiftool-vendored/dist/FirstDateTime';
 import * as geotz from 'geo-tz';
@@ -51,8 +53,9 @@ const validate = <T>(value: T): T | null => (typeof value === 'string' ? null :
 
 export class MetadataExtractionProcessor {
   private logger = new Logger(MetadataExtractionProcessor.name);
-  private reverseGeocodingEnabled: boolean;
   private storageCore: StorageCore;
+  private configCore: SystemConfigCore;
+  private oldCities?: string;
 
   constructor(
     @Inject(IAssetRepository) private assetRepository: IAssetRepository,
@@ -61,31 +64,35 @@ export class MetadataExtractionProcessor {
     @Inject(IGeocodingRepository) private geocodingRepository: IGeocodingRepository,
     @Inject(ICryptoRepository) private cryptoRepository: ICryptoRepository,
     @Inject(IStorageRepository) private storageRepository: IStorageRepository,
-
-    configService: ConfigService,
+    @Inject(ISystemConfigRepository) configRepository: ISystemConfigRepository,
   ) {
-    this.reverseGeocodingEnabled = !configService.get('DISABLE_REVERSE_GEOCODING');
     this.storageCore = new StorageCore(storageRepository);
+    this.configCore = new SystemConfigCore(configRepository);
+    this.configCore.config$.subscribe(() => this.init());
   }
 
   async init(deleteCache = false) {
-    this.logger.log(`Reverse geocoding is ${this.reverseGeocodingEnabled ? 'enabled' : 'disabled'}`);
-    if (!this.reverseGeocodingEnabled) {
+    const { reverseGeocoding } = await this.configCore.getConfig();
+    const { citiesFileOverride } = reverseGeocoding;
+
+    if (!reverseGeocoding.enabled) {
       return;
     }
 
     try {
       if (deleteCache) {
         await this.geocodingRepository.deleteCache();
+      } else if (this.oldCities && this.oldCities === citiesFileOverride) {
+        return;
       }
-      this.logger.log('Initializing Reverse Geocoding');
 
       await this.jobRepository.pause(QueueName.METADATA_EXTRACTION);
-      await this.geocodingRepository.init();
+      await this.geocodingRepository.init({ citiesFileOverride });
       await this.jobRepository.resume(QueueName.METADATA_EXTRACTION);
 
-      this.logger.log('Reverse Geocoding Initialized');
-    } catch (error: any) {
+      this.logger.log(`Initialized local reverse geocoder with ${citiesFileOverride}`);
+      this.oldCities = citiesFileOverride;
+    } catch (error: Error | any) {
       this.logger.error(`Unable to initialize reverse geocoding: ${error}`, error?.stack);
     }
   }
@@ -161,7 +168,7 @@ export class MetadataExtractionProcessor {
 
   private async applyReverseGeocoding(asset: AssetEntity, exifData: ExifEntity) {
     const { latitude, longitude } = exifData;
-    if (!this.reverseGeocodingEnabled || !longitude || !latitude) {
+    if (!(await this.configCore.hasFeature(FeatureFlag.REVERSE_GEOCODING)) || !longitude || !latitude) {
       return;
     }