mirror of
https://github.com/immich-app/immich.git
synced 2025-11-27 00:35:16 -05:00
* feat: add a `maintenance.enabled` config flag
* feat: implement graceful restart
feat: restart when maintenance config is toggled
* feat: boot a stripped down maintenance api if enabled
* feat: cli command to toggle maintenance mode
* chore: fallback IMMICH_SERVER_URL environment variable in process
* chore: add additional routes to maintenance controller
* fix: don't wait for nest application to close to finish request response
* chore: add a failsafe on restart to prevent other exit codes from preventing restart
* feat: redirect into/from maintenance page
* refactor: use system metadata for maintenance status
* refactor: wait on WebSocket connection to refresh
* feat: broadcast websocket event on server restart
refactor: listen to WS instead of polling
* refactor: bubble up maintenance information instead of hijacking in fetch function
feat: show modal when server is restarting
* chore: increase timeout for ungraceful restart
* refactor: deduplicate code between api/maintenance workers
* fix: skip config check if database is not initialised
* fix: add `maintenanceMode` field to system config test
* refactor: move maintenance resolution code to static method in service
* chore: clean up linter issues
* chore: generate dart openapi
* refactor: use try{} block for maintenance mode check
* fix: logic error in server redirect
* chore: include `maintenanceMode` key in e2e test
* chore: add i18n entries for maintenance screens
* chore: remove negated condition from hook
* fix: should set default value not override in service
* fix: minor error in page
* feat: initial draft of maintenance module, repo., worker controller, worker service
* refactor: move broadcast code into notification service
* chore: connect websocket on client if in maintenance
* chore: set maintenance module app name
* refactor: rename repository to include worker
chore: configure websocket adapter
* feat: reimplement maintenance mode exit with new module
* refactor: add a constant enum for ExitCode
* refactor: remove redundant route for maintenance
* refactor: only spin up kysely on boot (rather than a Nest app)
* refactor(web): move redirect logic into +layout file where modal is setup
* feat: add Maintenance permission
* refactor: merge common code between api/maintenance
* fix: propagate changes from the CLI to servers
* feat: maintenance authentication guard
* refactor: unify maintenance code into repository
feat: add a step to generate maintenance mode token
* feat: jwt auth for maintenance
* refactor: switch from nest jwt to just jsonwebtokens
* feat: log into maintenance mode from CLI command
* refactor: use `secret` instead of `token` in jwt terminology
chore: log maintenance mode login URL on boot
chore: don't make CLI actions reload if already in target state
* docs: initial draft for maintenance mode page
* refactor: always validate the maintenance auth on the server
* feat: add a link to maintenance mode documentation
* feat: redirect users back to the last page they were on when exiting maintenance
* refactor: provide closeFn in both maintenance repos.
* refactor: ensure the user is also redirected by the server
* chore: swap jsonwebtoken for jose
* refactor: introduce AppRestartEvent w/o secret passing
* refactor: use navigation goto
* refactor: use `continue` instead of `next`
* chore: lint fixes for server
* chore: lint fixes for web
* test: add mock for maintenance repository
* test: add base service dependency to maintenance
* chore: remove @types/jsonwebtoken
* refactor: close database connection after startup check
* refactor: use `request#auth` key
* refactor: use service instead of repository
chore: read token from cookie if possible
chore: rename client event to AppRestartV1
* refactor: more concise redirect logic on web
* refactor: move redirect check into utils
refactor: update translation strings to be more sensible
* refactor: always validate login (i.e. check cookie)
* refactor: lint, open-api, remove old dto
* refactor: encode at point of usage
* refactor: remove business logic from repositories
* chore: fix server/web lints
* refactor: remove repository mock
* chore: fix formatting
* test: write service mocks for maintenance mode
* test: write cli service tests
* fix: catch errors when closing app
* fix: always report no maintenance when usual API is available
* test: api e2e maintenance spec
* chore: add response builder
* chore: add helper to set maint. auth cookie
* feat: add SSR to maintenance API
* test(e2e): write web spec for maintenance
* chore: clean up lint issues
* chore: format files
* feat: perform 302 redirect at server level during maintenance
* fix: keep trying to stop immich until it succeeds (CLI issue)
* chore: lint/format
* refactor: annotate references to other services in worker service
* chore: lint
* refactor: remove unnecessary await
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
* refactor: move static methods into util
* refactor: assert secret exists in maintenance worker
* refactor: remove assertion which isn't necessary anymore
* refactor: remove assertion
* refactor: remove outer try {} catch block from loadMaintenanceAuth
* refactor: undo earlier change to vite.config.ts
* chore: update tests due to refactors
* revert: vite.config.ts
* test: expect string jwt
* chore: move blanket exceptions into controllers
* test: update tests according with last change
* refactor: use respondWithCookie
refactor: merge start/end into one route
refactor: rename MaintenanceRepository to AppRepository
chore: use new ApiTag/Endpoint
refactor: apply other requested changes
* chore: regenerate openapi
* chore: lint/format
* chore: remove secureOnly for maint. cookie
* refactor: move maintenance worker code into src/maintenance\nfix: various test fixes
* refactor: use `action` property for setting maint. mode
* refactor: remove Websocket#restartApp in favour of individual methods
* chore: incomplete commit
* chore: remove stray log
* fix: call exitApp from maintenance worker on exit
* fix: add app repository mock
* fix: ensure maintenance cookies are secure
* fix: run playwright tests over secure context (localhost)
* test: update other references to 127.0.0.1
* refactor: use serverSideEmitWithAck
* chore: correct the logic in tryTerminate
* test: juggle cookies ourselves
* chore: fix lint error for e2e spec
* chore: format e2e test
* fix: set cookie secure/non-secure depending on context
* chore: format files
---------
Co-authored-by: Daniel Dietzler <36593685+danieldietzler@users.noreply.github.com>
228 lines
7.4 KiB
Dart
Generated
228 lines
7.4 KiB
Dart
Generated
//
|
|
// AUTO-GENERATED FILE, DO NOT MODIFY!
|
|
//
|
|
// @dart=2.18
|
|
|
|
// 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 QueryParam {
|
|
const QueryParam(this.name, this.value);
|
|
|
|
final String name;
|
|
final String value;
|
|
|
|
@override
|
|
String toString() => '${Uri.encodeQueryComponent(name)}=${Uri.encodeQueryComponent(value)}';
|
|
}
|
|
|
|
// Ported from the Java version.
|
|
Iterable<QueryParam> _queryParams(String collectionFormat, String name, dynamic value,) {
|
|
// Assertions to run in debug mode only.
|
|
assert(name.isNotEmpty, 'Parameter cannot be an empty string.');
|
|
|
|
final params = <QueryParam>[];
|
|
|
|
if (value is List) {
|
|
if (collectionFormat == 'multi') {
|
|
return value.map((dynamic v) => QueryParam(name, parameterToString(v)),);
|
|
}
|
|
|
|
// Default collection format is 'csv'.
|
|
if (collectionFormat.isEmpty) {
|
|
collectionFormat = 'csv'; // ignore: parameter_assignments
|
|
}
|
|
|
|
final delimiter = _delimiters[collectionFormat] ?? ',';
|
|
|
|
params.add(QueryParam(name, value.map<dynamic>(parameterToString).join(delimiter),));
|
|
} else if (value != null) {
|
|
params.add(QueryParam(name, parameterToString(value)));
|
|
}
|
|
|
|
return params;
|
|
}
|
|
|
|
/// Format the given parameter object into a [String].
|
|
String parameterToString(dynamic value) {
|
|
if (value == null) {
|
|
return '';
|
|
}
|
|
if (value is DateTime) {
|
|
return value.toUtc().toIso8601String();
|
|
}
|
|
if (value is AlbumUserRole) {
|
|
return AlbumUserRoleTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AssetJobName) {
|
|
return AssetJobNameTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AssetMediaSize) {
|
|
return AssetMediaSizeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AssetMediaStatus) {
|
|
return AssetMediaStatusTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AssetMetadataKey) {
|
|
return AssetMetadataKeyTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AssetOrder) {
|
|
return AssetOrderTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AssetTypeEnum) {
|
|
return AssetTypeEnumTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AssetVisibility) {
|
|
return AssetVisibilityTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is AudioCodec) {
|
|
return AudioCodecTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is BulkIdErrorReason) {
|
|
return BulkIdErrorReasonTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is CQMode) {
|
|
return CQModeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is Colorspace) {
|
|
return ColorspaceTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is ImageFormat) {
|
|
return ImageFormatTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is LogLevel) {
|
|
return LogLevelTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is MaintenanceAction) {
|
|
return MaintenanceActionTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is ManualJobName) {
|
|
return ManualJobNameTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is MemorySearchOrder) {
|
|
return MemorySearchOrderTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is MemoryType) {
|
|
return MemoryTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is NotificationLevel) {
|
|
return NotificationLevelTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is NotificationType) {
|
|
return NotificationTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is OAuthTokenEndpointAuthMethod) {
|
|
return OAuthTokenEndpointAuthMethodTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is PartnerDirection) {
|
|
return PartnerDirectionTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is Permission) {
|
|
return PermissionTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is PluginContext) {
|
|
return PluginContextTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is PluginTriggerType) {
|
|
return PluginTriggerTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is QueueCommand) {
|
|
return QueueCommandTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is QueueName) {
|
|
return QueueNameTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is ReactionLevel) {
|
|
return ReactionLevelTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is ReactionType) {
|
|
return ReactionTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is SearchSuggestionType) {
|
|
return SearchSuggestionTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is SharedLinkType) {
|
|
return SharedLinkTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is SourceType) {
|
|
return SourceTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is SyncEntityType) {
|
|
return SyncEntityTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is SyncRequestType) {
|
|
return SyncRequestTypeTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is ToneMapping) {
|
|
return ToneMappingTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is TranscodeHWAccel) {
|
|
return TranscodeHWAccelTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is TranscodePolicy) {
|
|
return TranscodePolicyTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is UserAvatarColor) {
|
|
return UserAvatarColorTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is UserMetadataKey) {
|
|
return UserMetadataKeyTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is UserStatus) {
|
|
return UserStatusTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is VideoCodec) {
|
|
return VideoCodecTypeTransformer().encode(value).toString();
|
|
}
|
|
if (value is VideoContainer) {
|
|
return VideoContainerTypeTransformer().encode(value).toString();
|
|
}
|
|
return value.toString();
|
|
}
|
|
|
|
/// Returns the decoded body as UTF-8 if the given headers indicate an 'application/json'
|
|
/// content type. Otherwise, returns the decoded body as decoded by dart:http package.
|
|
Future<String> _decodeBodyBytes(Response response) async {
|
|
final contentType = response.headers['content-type'];
|
|
return contentType != null && contentType.toLowerCase().startsWith('application/json')
|
|
? response.bodyBytes.isEmpty ? '' : utf8.decode(response.bodyBytes)
|
|
: response.body;
|
|
}
|
|
|
|
/// Returns a valid [T] value found at the specified Map [key], null otherwise.
|
|
T? mapValueOfType<T>(dynamic map, String key) {
|
|
final dynamic value = map is Map ? map[key] : null;
|
|
return value is T ? value : null;
|
|
}
|
|
|
|
/// Returns a valid Map<K, V> found at the specified Map [key], null otherwise.
|
|
Map<K, V>? mapCastOfType<K, V>(dynamic map, String key) {
|
|
final dynamic value = map is Map ? map[key] : null;
|
|
return value is Map ? value.cast<K, V>() : null;
|
|
}
|
|
|
|
/// Returns a valid [DateTime] found at the specified Map [key], null otherwise.
|
|
DateTime? mapDateTime(dynamic map, String key, [String? pattern]) {
|
|
final dynamic value = map is Map ? map[key] : null;
|
|
if (value != null) {
|
|
int? millis;
|
|
if (value is int) {
|
|
millis = value;
|
|
} else if (value is String) {
|
|
if (_isEpochMarker(pattern)) {
|
|
millis = int.tryParse(value);
|
|
} else {
|
|
return DateTime.tryParse(value);
|
|
}
|
|
}
|
|
if (millis != null) {
|
|
return DateTime.fromMillisecondsSinceEpoch(millis, isUtc: true);
|
|
}
|
|
}
|
|
return null;
|
|
}
|