feat(server,web): system config for admin (#959)

* feat: add admin config module for user configured config, uses it for ffmpeg

* feat: add api endpoint to retrieve admin config settings and values

* feat: add settings panel to admin page on web (wip)

* feat: add api endpoint to update the admin config

* chore: re-generate openapi spec after rebase

* refactor: move from admin config to system config naming

* chore: move away from UseGuards to new @Authenticated decorator

* style: dark mode styling for lists and fix conflicting colors

* wip: 2 column design, no edit button

* refactor: system config

* chore: generate open api

* chore: rm broken test

* chore: cleanup types

* refactor: config module names

Co-authored-by: Zack Pollard <zackpollard@ymail.com>
Co-authored-by: Zack Pollard <zack.pollard@moonpig.com>

mobile/openapi/lib/model/admin_config_response_dto.dart

@@ -0,0 +1,111 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class AdminConfigResponseDto {
+  /// Returns a new [AdminConfigResponseDto] instance.
+  AdminConfigResponseDto({
+    required this.config,
+  });
+
+  Object config;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is AdminConfigResponseDto &&
+     other.config == config;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (config.hashCode);
+
+  @override
+  String toString() => 'AdminConfigResponseDto[config=$config]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'config'] = config;
+    return _json;
+  }
+
+  /// Returns a new [AdminConfigResponseDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static AdminConfigResponseDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "AdminConfigResponseDto[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "AdminConfigResponseDto[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return AdminConfigResponseDto(
+        config: mapValueOfType<Object>(json, r'config')!,
+      );
+    }
+    return null;
+  }
+
+  static List<AdminConfigResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <AdminConfigResponseDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = AdminConfigResponseDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, AdminConfigResponseDto> mapFromJson(dynamic json) {
+    final map = <String, AdminConfigResponseDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = AdminConfigResponseDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of AdminConfigResponseDto-objects as value to a dart map
+  static Map<String, List<AdminConfigResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<AdminConfigResponseDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = AdminConfigResponseDto.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'config',
+  };
+}
+

mobile/openapi/lib/model/system_config_entity.dart

@@ -0,0 +1,202 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class SystemConfigEntity {
+  /// Returns a new [SystemConfigEntity] instance.
+  SystemConfigEntity({
+    required this.key,
+    required this.value,
+  });
+
+  SystemConfigEntityKeyEnum key;
+
+  Object value;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is SystemConfigEntity &&
+     other.key == key &&
+     other.value == value;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (key.hashCode) +
+    (value.hashCode);
+
+  @override
+  String toString() => 'SystemConfigEntity[key=$key, value=$value]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'key'] = key;
+      _json[r'value'] = value;
+    return _json;
+  }
+
+  /// Returns a new [SystemConfigEntity] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static SystemConfigEntity? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "SystemConfigEntity[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "SystemConfigEntity[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return SystemConfigEntity(
+        key: SystemConfigEntityKeyEnum.fromJson(json[r'key'])!,
+        value: mapValueOfType<Object>(json, r'value')!,
+      );
+    }
+    return null;
+  }
+
+  static List<SystemConfigEntity>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigEntity>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigEntity.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, SystemConfigEntity> mapFromJson(dynamic json) {
+    final map = <String, SystemConfigEntity>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigEntity.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of SystemConfigEntity-objects as value to a dart map
+  static Map<String, List<SystemConfigEntity>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<SystemConfigEntity>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigEntity.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'key',
+    'value',
+  };
+}
+
+
+class SystemConfigEntityKeyEnum {
+  /// Instantiate a new enum with the provided [value].
+  const SystemConfigEntityKeyEnum._(this.value);
+
+  /// The underlying value of this enum member.
+  final String value;
+
+  @override
+  String toString() => value;
+
+  String toJson() => value;
+
+  static const crf = SystemConfigEntityKeyEnum._(r'ffmpeg_crf');
+  static const preset = SystemConfigEntityKeyEnum._(r'ffmpeg_preset');
+  static const targetVideoCodec = SystemConfigEntityKeyEnum._(r'ffmpeg_target_video_codec');
+  static const targetAudioCodec = SystemConfigEntityKeyEnum._(r'ffmpeg_target_audio_codec');
+  static const targetScaling = SystemConfigEntityKeyEnum._(r'ffmpeg_target_scaling');
+
+  /// List of all possible values in this [enum][SystemConfigEntityKeyEnum].
+  static const values = <SystemConfigEntityKeyEnum>[
+    crf,
+    preset,
+    targetVideoCodec,
+    targetAudioCodec,
+    targetScaling,
+  ];
+
+  static SystemConfigEntityKeyEnum? fromJson(dynamic value) => SystemConfigEntityKeyEnumTypeTransformer().decode(value);
+
+  static List<SystemConfigEntityKeyEnum>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigEntityKeyEnum>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigEntityKeyEnum.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+}
+
+/// Transformation class that can [encode] an instance of [SystemConfigEntityKeyEnum] to String,
+/// and [decode] dynamic data back to [SystemConfigEntityKeyEnum].
+class SystemConfigEntityKeyEnumTypeTransformer {
+  factory SystemConfigEntityKeyEnumTypeTransformer() => _instance ??= const SystemConfigEntityKeyEnumTypeTransformer._();
+
+  const SystemConfigEntityKeyEnumTypeTransformer._();
+
+  String encode(SystemConfigEntityKeyEnum data) => data.value;
+
+  /// Decodes a [dynamic value][data] to a SystemConfigEntityKeyEnum.
+  ///
+  /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully,
+  /// then null is returned. However, if [allowNull] is false and the [dynamic value][data]
+  /// cannot be decoded successfully, then an [UnimplementedError] is thrown.
+  ///
+  /// The [allowNull] is very handy when an API changes and a new enum value is added or removed,
+  /// and users are still using an old app with the old code.
+  SystemConfigEntityKeyEnum? decode(dynamic data, {bool allowNull = true}) {
+    if (data != null) {
+      switch (data.toString()) {
+        case r'ffmpeg_crf': return SystemConfigEntityKeyEnum.crf;
+        case r'ffmpeg_preset': return SystemConfigEntityKeyEnum.preset;
+        case r'ffmpeg_target_video_codec': return SystemConfigEntityKeyEnum.targetVideoCodec;
+        case r'ffmpeg_target_audio_codec': return SystemConfigEntityKeyEnum.targetAudioCodec;
+        case r'ffmpeg_target_scaling': return SystemConfigEntityKeyEnum.targetScaling;
+        default:
+          if (!allowNull) {
+            throw ArgumentError('Unknown enum value to decode: $data');
+          }
+      }
+    }
+    return null;
+  }
+
+  /// Singleton [SystemConfigEntityKeyEnumTypeTransformer] instance.
+  static SystemConfigEntityKeyEnumTypeTransformer? _instance;
+}
+
+

mobile/openapi/lib/model/system_config_key.dart

@@ -0,0 +1,94 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+
+class SystemConfigKey {
+  /// Instantiate a new enum with the provided [value].
+  const SystemConfigKey._(this.value);
+
+  /// The underlying value of this enum member.
+  final String value;
+
+  @override
+  String toString() => value;
+
+  String toJson() => value;
+
+  static const crf = SystemConfigKey._(r'ffmpeg_crf');
+  static const preset = SystemConfigKey._(r'ffmpeg_preset');
+  static const targetVideoCodec = SystemConfigKey._(r'ffmpeg_target_video_codec');
+  static const targetAudioCodec = SystemConfigKey._(r'ffmpeg_target_audio_codec');
+  static const targetScaling = SystemConfigKey._(r'ffmpeg_target_scaling');
+
+  /// List of all possible values in this [enum][SystemConfigKey].
+  static const values = <SystemConfigKey>[
+    crf,
+    preset,
+    targetVideoCodec,
+    targetAudioCodec,
+    targetScaling,
+  ];
+
+  static SystemConfigKey? fromJson(dynamic value) => SystemConfigKeyTypeTransformer().decode(value);
+
+  static List<SystemConfigKey>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigKey>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigKey.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+}
+
+/// Transformation class that can [encode] an instance of [SystemConfigKey] to String,
+/// and [decode] dynamic data back to [SystemConfigKey].
+class SystemConfigKeyTypeTransformer {
+  factory SystemConfigKeyTypeTransformer() => _instance ??= const SystemConfigKeyTypeTransformer._();
+
+  const SystemConfigKeyTypeTransformer._();
+
+  String encode(SystemConfigKey data) => data.value;
+
+  /// Decodes a [dynamic value][data] to a SystemConfigKey.
+  ///
+  /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully,
+  /// then null is returned. However, if [allowNull] is false and the [dynamic value][data]
+  /// cannot be decoded successfully, then an [UnimplementedError] is thrown.
+  ///
+  /// The [allowNull] is very handy when an API changes and a new enum value is added or removed,
+  /// and users are still using an old app with the old code.
+  SystemConfigKey? decode(dynamic data, {bool allowNull = true}) {
+    if (data != null) {
+      switch (data.toString()) {
+        case r'ffmpeg_crf': return SystemConfigKey.crf;
+        case r'ffmpeg_preset': return SystemConfigKey.preset;
+        case r'ffmpeg_target_video_codec': return SystemConfigKey.targetVideoCodec;
+        case r'ffmpeg_target_audio_codec': return SystemConfigKey.targetAudioCodec;
+        case r'ffmpeg_target_scaling': return SystemConfigKey.targetScaling;
+        default:
+          if (!allowNull) {
+            throw ArgumentError('Unknown enum value to decode: $data');
+          }
+      }
+    }
+    return null;
+  }
+
+  /// Singleton [SystemConfigKeyTypeTransformer] instance.
+  static SystemConfigKeyTypeTransformer? _instance;
+}
+

mobile/openapi/lib/model/system_config_response_dto.dart

@@ -0,0 +1,111 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class SystemConfigResponseDto {
+  /// Returns a new [SystemConfigResponseDto] instance.
+  SystemConfigResponseDto({
+    this.config = const [],
+  });
+
+  List<SystemConfigResponseItem> config;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is SystemConfigResponseDto &&
+     other.config == config;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (config.hashCode);
+
+  @override
+  String toString() => 'SystemConfigResponseDto[config=$config]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'config'] = config;
+    return _json;
+  }
+
+  /// Returns a new [SystemConfigResponseDto] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static SystemConfigResponseDto? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "SystemConfigResponseDto[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "SystemConfigResponseDto[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return SystemConfigResponseDto(
+        config: SystemConfigResponseItem.listFromJson(json[r'config'])!,
+      );
+    }
+    return null;
+  }
+
+  static List<SystemConfigResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigResponseDto>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigResponseDto.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, SystemConfigResponseDto> mapFromJson(dynamic json) {
+    final map = <String, SystemConfigResponseDto>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigResponseDto.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of SystemConfigResponseDto-objects as value to a dart map
+  static Map<String, List<SystemConfigResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<SystemConfigResponseDto>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigResponseDto.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'config',
+  };
+}
+

mobile/openapi/lib/model/system_config_response_item.dart

@@ -0,0 +1,135 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+class SystemConfigResponseItem {
+  /// Returns a new [SystemConfigResponseItem] instance.
+  SystemConfigResponseItem({
+    required this.name,
+    required this.key,
+    required this.value,
+    required this.defaultValue,
+  });
+
+  String name;
+
+  SystemConfigKey key;
+
+  String value;
+
+  String defaultValue;
+
+  @override
+  bool operator ==(Object other) => identical(this, other) || other is SystemConfigResponseItem &&
+     other.name == name &&
+     other.key == key &&
+     other.value == value &&
+     other.defaultValue == defaultValue;
+
+  @override
+  int get hashCode =>
+    // ignore: unnecessary_parenthesis
+    (name.hashCode) +
+    (key.hashCode) +
+    (value.hashCode) +
+    (defaultValue.hashCode);
+
+  @override
+  String toString() => 'SystemConfigResponseItem[name=$name, key=$key, value=$value, defaultValue=$defaultValue]';
+
+  Map<String, dynamic> toJson() {
+    final _json = <String, dynamic>{};
+      _json[r'name'] = name;
+      _json[r'key'] = key;
+      _json[r'value'] = value;
+      _json[r'defaultValue'] = defaultValue;
+    return _json;
+  }
+
+  /// Returns a new [SystemConfigResponseItem] instance and imports its values from
+  /// [value] if it's a [Map], null otherwise.
+  // ignore: prefer_constructors_over_static_methods
+  static SystemConfigResponseItem? fromJson(dynamic value) {
+    if (value is Map) {
+      final json = value.cast<String, dynamic>();
+
+      // Ensure that the map contains the required keys.
+      // Note 1: the values aren't checked for validity beyond being non-null.
+      // Note 2: this code is stripped in release mode!
+      assert(() {
+        requiredKeys.forEach((key) {
+          assert(json.containsKey(key), 'Required key "SystemConfigResponseItem[$key]" is missing from JSON.');
+          assert(json[key] != null, 'Required key "SystemConfigResponseItem[$key]" has a null value in JSON.');
+        });
+        return true;
+      }());
+
+      return SystemConfigResponseItem(
+        name: mapValueOfType<String>(json, r'name')!,
+        key: SystemConfigKey.fromJson(json[r'key'])!,
+        value: mapValueOfType<String>(json, r'value')!,
+        defaultValue: mapValueOfType<String>(json, r'defaultValue')!,
+      );
+    }
+    return null;
+  }
+
+  static List<SystemConfigResponseItem>? listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SystemConfigResponseItem>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SystemConfigResponseItem.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+
+  static Map<String, SystemConfigResponseItem> mapFromJson(dynamic json) {
+    final map = <String, SystemConfigResponseItem>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigResponseItem.fromJson(entry.value);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  // maps a json object with a list of SystemConfigResponseItem-objects as value to a dart map
+  static Map<String, List<SystemConfigResponseItem>> mapListFromJson(dynamic json, {bool growable = false,}) {
+    final map = <String, List<SystemConfigResponseItem>>{};
+    if (json is Map && json.isNotEmpty) {
+      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
+      for (final entry in json.entries) {
+        final value = SystemConfigResponseItem.listFromJson(entry.value, growable: growable,);
+        if (value != null) {
+          map[entry.key] = value;
+        }
+      }
+    }
+    return map;
+  }
+
+  /// The list of required keys that must be present in a JSON.
+  static const requiredKeys = <String>{
+    'name',
+    'key',
+    'value',
+    'defaultValue',
+  };
+}
+