feat(server): custom library scanning interval (#4390)

* add automatic library scan config options

* add validation

* open api

* use CronJob instead of cron-validator

* fix tests

* catch potential error of the library scan initialization

* better description for input field

* move library scan job initialization to server app service

* fix tests

* add comments to all parameters of cronjob contructor

* make scan a child of a more general library object

* open api

* chore: cleanup

* move cronjob handling to job repoistory

* web: select for common cron expressions

* fix open api

* fix tests

* put scanning settings in nested accordion

* fix system config validation

* refactor, tests

---------

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

web/src/api/open-api/api.ts

@@ -3283,6 +3283,12 @@ export interface SystemConfigDto {
      * @memberof SystemConfigDto
      */
     'job': SystemConfigJobDto;
+    /**
+     * 
+     * @type {SystemConfigLibraryDto}
+     * @memberof SystemConfigDto
+     */
+    'library': SystemConfigLibraryDto;
     /**
      * 
      * @type {SystemConfigMachineLearningDto}
@@ -3534,6 +3540,38 @@ export interface SystemConfigJobDto {
      */
     'videoConversion': JobSettingsDto;
 }
+/**
+ * 
+ * @export
+ * @interface SystemConfigLibraryDto
+ */
+export interface SystemConfigLibraryDto {
+    /**
+     * 
+     * @type {SystemConfigLibraryScanDto}
+     * @memberof SystemConfigLibraryDto
+     */
+    'scan': SystemConfigLibraryScanDto;
+}
+/**
+ * 
+ * @export
+ * @interface SystemConfigLibraryScanDto
+ */
+export interface SystemConfigLibraryScanDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof SystemConfigLibraryScanDto
+     */
+    'cronExpression': string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SystemConfigLibraryScanDto
+     */
+    'enabled': boolean;
+}
 /**
  * 
  * @export

web/src/lib/components/admin-page/settings/library-settings/library-settings.svelte

@@ -0,0 +1,145 @@
+<script lang="ts">
+  import {
+    notificationController,
+    NotificationType,
+  } from '$lib/components/shared-components/notification/notification';
+  import { api, SystemConfigLibraryDto } from '@api';
+  import SettingButtonsRow from '../setting-buttons-row.svelte';
+  import SettingInputField, { SettingInputFieldType } from '../setting-input-field.svelte';
+  import SettingSwitch from '../setting-switch.svelte';
+  import { isEqual } from 'lodash-es';
+  import { fade } from 'svelte/transition';
+  import { handleError } from '../../../../utils/handle-error';
+  import SettingAccordion from '../setting-accordion.svelte';
+
+  export let libraryConfig: SystemConfigLibraryDto; // this is the config that is being edited
+  export let disabled = false;
+
+  const cronExpressionOptions = [
+    { title: 'Every night at midnight', expression: '0 0 * * *' },
+    { title: 'Every night at 2am', expression: '0 2 * * *' },
+    { title: 'Every day at 1pm', expression: '0 13 * * *' },
+    { title: 'Every 6 hours', expression: '0 */6 * * *' },
+  ];
+
+  let savedConfig: SystemConfigLibraryDto;
+  let defaultConfig: SystemConfigLibraryDto;
+
+  async function getConfigs() {
+    [savedConfig, defaultConfig] = await Promise.all([
+      api.systemConfigApi.getConfig().then((res) => res.data.library),
+      api.systemConfigApi.getDefaults().then((res) => res.data.library),
+    ]);
+  }
+
+  async function saveSetting() {
+    try {
+      const { data: configs } = await api.systemConfigApi.getConfig();
+
+      const result = await api.systemConfigApi.updateConfig({
+        systemConfigDto: {
+          ...configs,
+          library: libraryConfig,
+        },
+      });
+
+      libraryConfig = { ...result.data.library };
+      savedConfig = { ...result.data.library };
+
+      notificationController.show({
+        message: 'Library settings saved',
+        type: NotificationType.Info,
+      });
+    } catch (e) {
+      handleError(e, 'Unable to save settings');
+    }
+  }
+
+  async function reset() {
+    const { data: resetConfig } = await api.systemConfigApi.getConfig();
+
+    libraryConfig = { ...resetConfig.library };
+    savedConfig = { ...resetConfig.library };
+
+    notificationController.show({
+      message: 'Reset library settings to the recent saved settings',
+      type: NotificationType.Info,
+    });
+  }
+
+  async function resetToDefault() {
+    const { data: configs } = await api.systemConfigApi.getDefaults();
+
+    libraryConfig = { ...configs.library };
+    defaultConfig = { ...configs.library };
+
+    notificationController.show({
+      message: 'Reset library settings to default',
+      type: NotificationType.Info,
+    });
+  }
+</script>
+
+<div>
+  {#await getConfigs() then}
+    <div in:fade={{ duration: 500 }}>
+      <SettingAccordion title="Scanning" subtitle="Settings for library scanning" isOpen>
+        <form autocomplete="off" on:submit|preventDefault>
+          <div class="ml-4 mt-4 flex flex-col gap-4">
+            <SettingSwitch
+              title="ENABLED"
+              {disabled}
+              subtitle="Enable automatic library scanning"
+              bind:checked={libraryConfig.scan.enabled}
+            />
+
+            <div class="flex flex-col my-2 dark:text-immich-dark-fg">
+              <label class="text-sm" for="expression-select">Cron Expression Presets</label>
+              <select
+                class="p-2 mt-2 text-sm rounded-lg bg-slate-200 hover:cursor-pointer dark:bg-gray-600"
+                disabled={disabled || !libraryConfig.scan.enabled}
+                name="expression"
+                id="expression-select"
+                bind:value={libraryConfig.scan.cronExpression}
+              >
+                {#each cronExpressionOptions as { title, expression }}
+                  <option value={expression}>{title}</option>
+                {/each}
+              </select>
+            </div>
+
+            <SettingInputField
+              inputType={SettingInputFieldType.TEXT}
+              required={true}
+              disabled={disabled || !libraryConfig.scan.enabled}
+              label="Cron Expression"
+              bind:value={libraryConfig.scan.cronExpression}
+              isEdited={libraryConfig.scan.cronExpression !== savedConfig.scan.cronExpression}
+            >
+              <svelte:fragment slot="desc">
+                <p class="text-sm dark:text-immich-dark-fg">
+                  Set the scanning interval using the cron format. For more information please refer to e.g. <a
+                    href="https://crontab.guru"
+                    class="underline"
+                    target="_blank"
+                    rel="noreferrer">Crontab Guru</a
+                  >
+                </p>
+              </svelte:fragment>
+            </SettingInputField>
+          </div>
+
+          <div class="ml-4">
+            <SettingButtonsRow
+              on:reset={reset}
+              on:save={saveSetting}
+              on:reset-to-default={resetToDefault}
+              showResetToDefault={!isEqual(savedConfig, defaultConfig)}
+              {disabled}
+            />
+          </div>
+        </form>
+      </SettingAccordion>
+    </div>
+  {/await}
+</div>

web/src/routes/admin/system-settings/+page.svelte

@@ -20,6 +20,7 @@
   import Icon from '$lib/components/elements/icon.svelte';
   import type { PageData } from './$types';
   import NewVersionCheckSettings from '$lib/components/admin-page/settings/new-version-check-settings/new-version-check-settings.svelte';
+  import LibrarySettings from '$lib/components/admin-page/settings/library-settings/library-settings.svelte';
   import { mdiAlert, mdiContentCopy, mdiDownload } from '@mdi/js';
 
   export let data: PageData;
@@ -69,6 +70,10 @@
         <JobSettings disabled={$featureFlags.configFile} jobConfig={configs.job} />
       </SettingAccordion>
 
+      <SettingAccordion title="Library" subtitle="Manage library settings">
+        <LibrarySettings disabled={$featureFlags.configFile} libraryConfig={configs.library} />
+      </SettingAccordion>
+
       <SettingAccordion title="Machine Learning Settings" subtitle="Manage machine learning features and settings">
         <MachineLearningSettings disabled={$featureFlags.configFile} machineLearningConfig={configs.machineLearning} />
       </SettingAccordion>