mirror of
https://github.com/immich-app/immich.git
synced 2025-11-27 08:45: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>
180 lines
5.9 KiB
Dart
Generated
180 lines
5.9 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 ServerConfigDto {
|
|
/// Returns a new [ServerConfigDto] instance.
|
|
ServerConfigDto({
|
|
required this.externalDomain,
|
|
required this.isInitialized,
|
|
required this.isOnboarded,
|
|
required this.loginPageMessage,
|
|
required this.maintenanceMode,
|
|
required this.mapDarkStyleUrl,
|
|
required this.mapLightStyleUrl,
|
|
required this.oauthButtonText,
|
|
required this.publicUsers,
|
|
required this.trashDays,
|
|
required this.userDeleteDelay,
|
|
});
|
|
|
|
String externalDomain;
|
|
|
|
bool isInitialized;
|
|
|
|
bool isOnboarded;
|
|
|
|
String loginPageMessage;
|
|
|
|
bool maintenanceMode;
|
|
|
|
String mapDarkStyleUrl;
|
|
|
|
String mapLightStyleUrl;
|
|
|
|
String oauthButtonText;
|
|
|
|
bool publicUsers;
|
|
|
|
int trashDays;
|
|
|
|
int userDeleteDelay;
|
|
|
|
@override
|
|
bool operator ==(Object other) => identical(this, other) || other is ServerConfigDto &&
|
|
other.externalDomain == externalDomain &&
|
|
other.isInitialized == isInitialized &&
|
|
other.isOnboarded == isOnboarded &&
|
|
other.loginPageMessage == loginPageMessage &&
|
|
other.maintenanceMode == maintenanceMode &&
|
|
other.mapDarkStyleUrl == mapDarkStyleUrl &&
|
|
other.mapLightStyleUrl == mapLightStyleUrl &&
|
|
other.oauthButtonText == oauthButtonText &&
|
|
other.publicUsers == publicUsers &&
|
|
other.trashDays == trashDays &&
|
|
other.userDeleteDelay == userDeleteDelay;
|
|
|
|
@override
|
|
int get hashCode =>
|
|
// ignore: unnecessary_parenthesis
|
|
(externalDomain.hashCode) +
|
|
(isInitialized.hashCode) +
|
|
(isOnboarded.hashCode) +
|
|
(loginPageMessage.hashCode) +
|
|
(maintenanceMode.hashCode) +
|
|
(mapDarkStyleUrl.hashCode) +
|
|
(mapLightStyleUrl.hashCode) +
|
|
(oauthButtonText.hashCode) +
|
|
(publicUsers.hashCode) +
|
|
(trashDays.hashCode) +
|
|
(userDeleteDelay.hashCode);
|
|
|
|
@override
|
|
String toString() => 'ServerConfigDto[externalDomain=$externalDomain, isInitialized=$isInitialized, isOnboarded=$isOnboarded, loginPageMessage=$loginPageMessage, maintenanceMode=$maintenanceMode, mapDarkStyleUrl=$mapDarkStyleUrl, mapLightStyleUrl=$mapLightStyleUrl, oauthButtonText=$oauthButtonText, publicUsers=$publicUsers, trashDays=$trashDays, userDeleteDelay=$userDeleteDelay]';
|
|
|
|
Map<String, dynamic> toJson() {
|
|
final json = <String, dynamic>{};
|
|
json[r'externalDomain'] = this.externalDomain;
|
|
json[r'isInitialized'] = this.isInitialized;
|
|
json[r'isOnboarded'] = this.isOnboarded;
|
|
json[r'loginPageMessage'] = this.loginPageMessage;
|
|
json[r'maintenanceMode'] = this.maintenanceMode;
|
|
json[r'mapDarkStyleUrl'] = this.mapDarkStyleUrl;
|
|
json[r'mapLightStyleUrl'] = this.mapLightStyleUrl;
|
|
json[r'oauthButtonText'] = this.oauthButtonText;
|
|
json[r'publicUsers'] = this.publicUsers;
|
|
json[r'trashDays'] = this.trashDays;
|
|
json[r'userDeleteDelay'] = this.userDeleteDelay;
|
|
return json;
|
|
}
|
|
|
|
/// Returns a new [ServerConfigDto] instance and imports its values from
|
|
/// [value] if it's a [Map], null otherwise.
|
|
// ignore: prefer_constructors_over_static_methods
|
|
static ServerConfigDto? fromJson(dynamic value) {
|
|
upgradeDto(value, "ServerConfigDto");
|
|
if (value is Map) {
|
|
final json = value.cast<String, dynamic>();
|
|
|
|
return ServerConfigDto(
|
|
externalDomain: mapValueOfType<String>(json, r'externalDomain')!,
|
|
isInitialized: mapValueOfType<bool>(json, r'isInitialized')!,
|
|
isOnboarded: mapValueOfType<bool>(json, r'isOnboarded')!,
|
|
loginPageMessage: mapValueOfType<String>(json, r'loginPageMessage')!,
|
|
maintenanceMode: mapValueOfType<bool>(json, r'maintenanceMode')!,
|
|
mapDarkStyleUrl: mapValueOfType<String>(json, r'mapDarkStyleUrl')!,
|
|
mapLightStyleUrl: mapValueOfType<String>(json, r'mapLightStyleUrl')!,
|
|
oauthButtonText: mapValueOfType<String>(json, r'oauthButtonText')!,
|
|
publicUsers: mapValueOfType<bool>(json, r'publicUsers')!,
|
|
trashDays: mapValueOfType<int>(json, r'trashDays')!,
|
|
userDeleteDelay: mapValueOfType<int>(json, r'userDeleteDelay')!,
|
|
);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
static List<ServerConfigDto> listFromJson(dynamic json, {bool growable = false,}) {
|
|
final result = <ServerConfigDto>[];
|
|
if (json is List && json.isNotEmpty) {
|
|
for (final row in json) {
|
|
final value = ServerConfigDto.fromJson(row);
|
|
if (value != null) {
|
|
result.add(value);
|
|
}
|
|
}
|
|
}
|
|
return result.toList(growable: growable);
|
|
}
|
|
|
|
static Map<String, ServerConfigDto> mapFromJson(dynamic json) {
|
|
final map = <String, ServerConfigDto>{};
|
|
if (json is Map && json.isNotEmpty) {
|
|
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
|
|
for (final entry in json.entries) {
|
|
final value = ServerConfigDto.fromJson(entry.value);
|
|
if (value != null) {
|
|
map[entry.key] = value;
|
|
}
|
|
}
|
|
}
|
|
return map;
|
|
}
|
|
|
|
// maps a json object with a list of ServerConfigDto-objects as value to a dart map
|
|
static Map<String, List<ServerConfigDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
|
|
final map = <String, List<ServerConfigDto>>{};
|
|
if (json is Map && json.isNotEmpty) {
|
|
// ignore: parameter_assignments
|
|
json = json.cast<String, dynamic>();
|
|
for (final entry in json.entries) {
|
|
map[entry.key] = ServerConfigDto.listFromJson(entry.value, growable: growable,);
|
|
}
|
|
}
|
|
return map;
|
|
}
|
|
|
|
/// The list of required keys that must be present in a JSON.
|
|
static const requiredKeys = <String>{
|
|
'externalDomain',
|
|
'isInitialized',
|
|
'isOnboarded',
|
|
'loginPageMessage',
|
|
'maintenanceMode',
|
|
'mapDarkStyleUrl',
|
|
'mapLightStyleUrl',
|
|
'oauthButtonText',
|
|
'publicUsers',
|
|
'trashDays',
|
|
'userDeleteDelay',
|
|
};
|
|
}
|
|
|