feat(server): Automatic watching of library folders (#6192)

* feat: initial watch support

* allow offline files

* chore: ignore query errors when resetting e2e db

* revert db query

* add savepoint

* guard the user query

* chore: openapi and db migration

* wip

* support multiple libraries

* fix tests

* wip

* can now cleanup chokidar watchers

* fix unit tests

* add library watch queue

* add missing init from merge

* wip

* can now filter file extensions

* remove watch api from non job client

* Fix e2e test

* watch library with updated import path and exclusion pattern

* add library watch frontend ui

* case sensitive watching extensions

* can auto watch libraries

* move watcher e2e tests to separate file

* don't watch libraries from a queue

* use event emitters

* shorten e2e test timeout

* refactor chokidar code to filesystem provider

* expose chokidar parameters to config file

* fix storage mock

* set default config for library watching

* add fs provider mocks

* cleanup

* add more unit tests for watcher

* chore: fix format + sql

* add more tests

* move unwatch feature back to library service

* add file event unit tests

* chore: formatting

* add documentation

* fix e2e tests

* chore: fix e2e tests

* fix library updating

* test cleanup

* fix typo

* cleanup

* fixing as per pr comments

* reduce library watch config file

* update storage config and mocks

* move negative event tests to unit tests

* fix library watcher e2e

* make watch configuration global

* remove the feature flag

* refactor watcher teardown

* fix microservices init

* centralize asset scan job queue

* improve docs

* add more tests

* chore: open api

* initialize app service

* fix docs

* fix library watch feature flag

* Update docs/docs/features/libraries.md

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>

* fix: import right app service

* don't be truthy

* fix test speling

* stricter library update tests

* move fs watcher mock to external file

* subscribe to config changes

* docker does not need polling

* make library watch() private

* feat: add configuration ui

---------

Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
Co-authored-by: Alex Tran <alex.tran1502@gmail.com>

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

@@ -50,6 +50,13 @@ export enum SystemConfigKey {
   LIBRARY_SCAN_ENABLED = 'library.scan.enabled',
   LIBRARY_SCAN_CRON_EXPRESSION = 'library.scan.cronExpression',
 
+  LIBRARY_WATCH_ENABLED = 'library.watch.enabled',
+  LIBRARY_WATCH_USE_POLLING = 'library.watch.usePolling',
+  LIBRARY_WATCH_INTERVAL = 'library.watch.interval',
+  LIBRARY_WATCH_BINARY_INTERVAL = 'library.watch.binaryInterval',
+  LIBRARY_WATCH_WRITE_STABILITY_THRESHOLD = 'library.watch.awaitWriteFinish.stabilityThreshold',
+  LIBRARY_WATCH_WRITE_POLL_INTERVAL = 'library.watch.awaitWriteFinish.pollInterval',
+
   LOGGING_ENABLED = 'logging.enabled',
   LOGGING_LEVEL = 'logging.level',
 
@@ -253,6 +260,11 @@ export interface SystemConfig {
       enabled: boolean;
       cronExpression: string;
     };
+    watch: {
+      enabled: boolean;
+      usePolling: boolean;
+      interval: number;
+    };
   };
   server: {
     externalDomain: string;

server/src/infra/repositories/filesystem.provider.spec.ts

@@ -180,7 +180,11 @@ const tests: Test[] = [
 ];
 
 describe(FilesystemProvider.name, () => {
-  const sut = new FilesystemProvider();
+  let sut: FilesystemProvider;
+
+  beforeEach(() => {
+    sut = new FilesystemProvider();
+  });
 
   afterEach(() => {
     mockfs.restore();

server/src/infra/repositories/filesystem.provider.ts

@@ -2,12 +2,14 @@ import {
   CrawlOptionsDto,
   DiskUsage,
   ImmichReadStream,
+  ImmichWatcher,
   ImmichZipStream,
   IStorageRepository,
   mimeTypes,
 } from '@app/domain';
 import { ImmichLogger } from '@app/infra/logger';
 import archiver from 'archiver';
+import chokidar, { WatchOptions } from 'chokidar';
 import { constants, createReadStream, existsSync, mkdirSync } from 'fs';
 import fs, { copyFile, readdir, rename, writeFile } from 'fs/promises';
 import { glob } from 'glob';
@@ -132,5 +134,9 @@ export class FilesystemProvider implements IStorageRepository {
     });
   }
 
+  watch(paths: string[], options: WatchOptions): ImmichWatcher {
+    return chokidar.watch(paths, options);
+  }
+
   readdir = readdir;
 }