refactor(server): system config (#9517)

server/src/utils/misc.spec.ts

@@ -0,0 +1,52 @@
+import { getKeysDeep, unsetDeep } from 'src/utils/misc';
+import { describe, expect, it } from 'vitest';
+
+describe('getKeysDeep', () => {
+  it('should handle an empty object', () => {
+    expect(getKeysDeep({})).toEqual([]);
+  });
+
+  it('should list properties', () => {
+    expect(
+      getKeysDeep({
+        foo: 'bar',
+        flag: true,
+        count: 42,
+      }),
+    ).toEqual(['foo', 'flag', 'count']);
+  });
+
+  it('should skip undefined properties', () => {
+    expect(getKeysDeep({ foo: 'bar', hello: undefined })).toEqual(['foo']);
+  });
+
+  it('should skip array indices', () => {
+    expect(getKeysDeep({ foo: 'bar', hello: ['foo', 'bar'] })).toEqual(['foo', 'hello']);
+    expect(getKeysDeep({ foo: 'bar', nested: { hello: ['foo', 'bar'] } })).toEqual(['foo', 'nested.hello']);
+  });
+
+  it('should list nested properties', () => {
+    expect(getKeysDeep({ foo: 'bar', hello: { world: true } })).toEqual(['foo', 'hello.world']);
+  });
+});
+
+describe('unsetDeep', () => {
+  it('should remove a property', () => {
+    expect(unsetDeep({ hello: 'world', foo: 'bar' }, 'foo')).toEqual({ hello: 'world' });
+  });
+
+  it('should remove the last property', () => {
+    expect(unsetDeep({ foo: 'bar' }, 'foo')).toBeUndefined();
+  });
+
+  it('should remove a nested property', () => {
+    expect(unsetDeep({ foo: 'bar', nested: { enabled: true, count: 42 } }, 'nested.enabled')).toEqual({
+      foo: 'bar',
+      nested: { count: 42 },
+    });
+  });
+
+  it('should clean up an empty property', () => {
+    expect(unsetDeep({ foo: 'bar', nested: { enabled: true } }, 'nested.enabled')).toEqual({ foo: 'bar' });
+  });
+});

server/src/utils/misc.ts

@@ -16,6 +16,47 @@ import { ImmichCookie, ImmichHeader } from 'src/dtos/auth.dto';
 import { ILoggerRepository } from 'src/interfaces/logger.interface';
 import { Metadata } from 'src/middleware/auth.guard';
 
+/**
+ * @returns a list of strings representing the keys of the object in dot notation
+ */
+export const getKeysDeep = (target: unknown, path: string[] = []) => {
+  if (!target || typeof target !== 'object') {
+    return [];
+  }
+
+  const obj = target as object;
+
+  const properties: string[] = [];
+  for (const key of Object.keys(obj as object)) {
+    const value = obj[key as keyof object];
+    if (value === undefined) {
+      continue;
+    }
+
+    if (_.isObject(value) && !_.isArray(value)) {
+      properties.push(...getKeysDeep(value, [...path, key]));
+      continue;
+    }
+
+    properties.push([...path, key].join('.'));
+  }
+
+  return properties;
+};
+
+export const unsetDeep = (object: unknown, key: string) => {
+  const parts = key.split('.');
+  while (parts.length > 0) {
+    _.unset(object, parts);
+    parts.pop();
+    if (!_.isEmpty(_.get(object, parts))) {
+      break;
+    }
+  }
+
+  return _.isEmpty(object) ? undefined : object;
+};
+
 const isMachineLearningEnabled = (machineLearning: SystemConfig['machineLearning']) => machineLearning.enabled;
 export const isSmartSearchEnabled = (machineLearning: SystemConfig['machineLearning']) =>
   isMachineLearningEnabled(machineLearning) && machineLearning.clip.enabled;