mirror of
https://github.com/immich-app/immich.git
synced 2025-12-25 17:24:58 +03: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>
243 lines
9.7 KiB
TypeScript
243 lines
9.7 KiB
TypeScript
import { BadRequestException, Injectable } from '@nestjs/common';
|
|
import { Insertable } from 'kysely';
|
|
import sanitize from 'sanitize-filename';
|
|
import { SystemConfig } from 'src/config';
|
|
import { SALT_ROUNDS } from 'src/constants';
|
|
import { StorageCore } from 'src/cores/storage.core';
|
|
import { UserAdmin } from 'src/database';
|
|
import { AccessRepository } from 'src/repositories/access.repository';
|
|
import { ActivityRepository } from 'src/repositories/activity.repository';
|
|
import { AlbumUserRepository } from 'src/repositories/album-user.repository';
|
|
import { AlbumRepository } from 'src/repositories/album.repository';
|
|
import { ApiKeyRepository } from 'src/repositories/api-key.repository';
|
|
import { AppRepository } from 'src/repositories/app.repository';
|
|
import { AssetJobRepository } from 'src/repositories/asset-job.repository';
|
|
import { AssetRepository } from 'src/repositories/asset.repository';
|
|
import { AuditRepository } from 'src/repositories/audit.repository';
|
|
import { ConfigRepository } from 'src/repositories/config.repository';
|
|
import { CronRepository } from 'src/repositories/cron.repository';
|
|
import { CryptoRepository } from 'src/repositories/crypto.repository';
|
|
import { DatabaseRepository } from 'src/repositories/database.repository';
|
|
import { DownloadRepository } from 'src/repositories/download.repository';
|
|
import { DuplicateRepository } from 'src/repositories/duplicate.repository';
|
|
import { EmailRepository } from 'src/repositories/email.repository';
|
|
import { EventRepository } from 'src/repositories/event.repository';
|
|
import { JobRepository } from 'src/repositories/job.repository';
|
|
import { LibraryRepository } from 'src/repositories/library.repository';
|
|
import { LoggingRepository } from 'src/repositories/logging.repository';
|
|
import { MachineLearningRepository } from 'src/repositories/machine-learning.repository';
|
|
import { MapRepository } from 'src/repositories/map.repository';
|
|
import { MediaRepository } from 'src/repositories/media.repository';
|
|
import { MemoryRepository } from 'src/repositories/memory.repository';
|
|
import { MetadataRepository } from 'src/repositories/metadata.repository';
|
|
import { MoveRepository } from 'src/repositories/move.repository';
|
|
import { NotificationRepository } from 'src/repositories/notification.repository';
|
|
import { OAuthRepository } from 'src/repositories/oauth.repository';
|
|
import { OcrRepository } from 'src/repositories/ocr.repository';
|
|
import { PartnerRepository } from 'src/repositories/partner.repository';
|
|
import { PersonRepository } from 'src/repositories/person.repository';
|
|
import { PluginRepository } from 'src/repositories/plugin.repository';
|
|
import { ProcessRepository } from 'src/repositories/process.repository';
|
|
import { SearchRepository } from 'src/repositories/search.repository';
|
|
import { ServerInfoRepository } from 'src/repositories/server-info.repository';
|
|
import { SessionRepository } from 'src/repositories/session.repository';
|
|
import { SharedLinkAssetRepository } from 'src/repositories/shared-link-asset.repository';
|
|
import { SharedLinkRepository } from 'src/repositories/shared-link.repository';
|
|
import { StackRepository } from 'src/repositories/stack.repository';
|
|
import { StorageRepository } from 'src/repositories/storage.repository';
|
|
import { SyncCheckpointRepository } from 'src/repositories/sync-checkpoint.repository';
|
|
import { SyncRepository } from 'src/repositories/sync.repository';
|
|
import { SystemMetadataRepository } from 'src/repositories/system-metadata.repository';
|
|
import { TagRepository } from 'src/repositories/tag.repository';
|
|
import { TelemetryRepository } from 'src/repositories/telemetry.repository';
|
|
import { TrashRepository } from 'src/repositories/trash.repository';
|
|
import { UserRepository } from 'src/repositories/user.repository';
|
|
import { VersionHistoryRepository } from 'src/repositories/version-history.repository';
|
|
import { ViewRepository } from 'src/repositories/view-repository';
|
|
import { WebsocketRepository } from 'src/repositories/websocket.repository';
|
|
import { WorkflowRepository } from 'src/repositories/workflow.repository';
|
|
import { UserTable } from 'src/schema/tables/user.table';
|
|
import { AccessRequest, checkAccess, requireAccess } from 'src/utils/access';
|
|
import { getConfig, updateConfig } from 'src/utils/config';
|
|
|
|
export const BASE_SERVICE_DEPENDENCIES = [
|
|
LoggingRepository,
|
|
AccessRepository,
|
|
ActivityRepository,
|
|
AlbumRepository,
|
|
AlbumUserRepository,
|
|
ApiKeyRepository,
|
|
AppRepository,
|
|
AssetRepository,
|
|
AssetJobRepository,
|
|
AuditRepository,
|
|
ConfigRepository,
|
|
CronRepository,
|
|
CryptoRepository,
|
|
DatabaseRepository,
|
|
DownloadRepository,
|
|
DuplicateRepository,
|
|
EmailRepository,
|
|
EventRepository,
|
|
JobRepository,
|
|
LibraryRepository,
|
|
MachineLearningRepository,
|
|
MapRepository,
|
|
MediaRepository,
|
|
MemoryRepository,
|
|
MetadataRepository,
|
|
MoveRepository,
|
|
NotificationRepository,
|
|
OAuthRepository,
|
|
OcrRepository,
|
|
PartnerRepository,
|
|
PersonRepository,
|
|
PluginRepository,
|
|
ProcessRepository,
|
|
SearchRepository,
|
|
ServerInfoRepository,
|
|
SessionRepository,
|
|
SharedLinkRepository,
|
|
SharedLinkAssetRepository,
|
|
StackRepository,
|
|
StorageRepository,
|
|
SyncRepository,
|
|
SyncCheckpointRepository,
|
|
SystemMetadataRepository,
|
|
TagRepository,
|
|
TelemetryRepository,
|
|
TrashRepository,
|
|
UserRepository,
|
|
VersionHistoryRepository,
|
|
ViewRepository,
|
|
WebsocketRepository,
|
|
WorkflowRepository,
|
|
];
|
|
|
|
@Injectable()
|
|
export class BaseService {
|
|
protected storageCore: StorageCore;
|
|
|
|
constructor(
|
|
protected logger: LoggingRepository,
|
|
protected accessRepository: AccessRepository,
|
|
protected activityRepository: ActivityRepository,
|
|
protected albumRepository: AlbumRepository,
|
|
protected albumUserRepository: AlbumUserRepository,
|
|
protected apiKeyRepository: ApiKeyRepository,
|
|
protected appRepository: AppRepository,
|
|
protected assetRepository: AssetRepository,
|
|
protected assetJobRepository: AssetJobRepository,
|
|
protected auditRepository: AuditRepository,
|
|
protected configRepository: ConfigRepository,
|
|
protected cronRepository: CronRepository,
|
|
protected cryptoRepository: CryptoRepository,
|
|
protected databaseRepository: DatabaseRepository,
|
|
protected downloadRepository: DownloadRepository,
|
|
protected duplicateRepository: DuplicateRepository,
|
|
protected emailRepository: EmailRepository,
|
|
protected eventRepository: EventRepository,
|
|
protected jobRepository: JobRepository,
|
|
protected libraryRepository: LibraryRepository,
|
|
protected machineLearningRepository: MachineLearningRepository,
|
|
protected mapRepository: MapRepository,
|
|
protected mediaRepository: MediaRepository,
|
|
protected memoryRepository: MemoryRepository,
|
|
protected metadataRepository: MetadataRepository,
|
|
protected moveRepository: MoveRepository,
|
|
protected notificationRepository: NotificationRepository,
|
|
protected oauthRepository: OAuthRepository,
|
|
protected ocrRepository: OcrRepository,
|
|
protected partnerRepository: PartnerRepository,
|
|
protected personRepository: PersonRepository,
|
|
protected pluginRepository: PluginRepository,
|
|
protected processRepository: ProcessRepository,
|
|
protected searchRepository: SearchRepository,
|
|
protected serverInfoRepository: ServerInfoRepository,
|
|
protected sessionRepository: SessionRepository,
|
|
protected sharedLinkRepository: SharedLinkRepository,
|
|
protected sharedLinkAssetRepository: SharedLinkAssetRepository,
|
|
protected stackRepository: StackRepository,
|
|
protected storageRepository: StorageRepository,
|
|
protected syncRepository: SyncRepository,
|
|
protected syncCheckpointRepository: SyncCheckpointRepository,
|
|
protected systemMetadataRepository: SystemMetadataRepository,
|
|
protected tagRepository: TagRepository,
|
|
protected telemetryRepository: TelemetryRepository,
|
|
protected trashRepository: TrashRepository,
|
|
protected userRepository: UserRepository,
|
|
protected versionRepository: VersionHistoryRepository,
|
|
protected viewRepository: ViewRepository,
|
|
protected websocketRepository: WebsocketRepository,
|
|
protected workflowRepository: WorkflowRepository,
|
|
) {
|
|
this.logger.setContext(this.constructor.name);
|
|
this.storageCore = StorageCore.create(
|
|
assetRepository,
|
|
configRepository,
|
|
cryptoRepository,
|
|
moveRepository,
|
|
personRepository,
|
|
storageRepository,
|
|
systemMetadataRepository,
|
|
this.logger,
|
|
);
|
|
}
|
|
|
|
get worker() {
|
|
return this.configRepository.getWorker();
|
|
}
|
|
|
|
private get configRepos() {
|
|
return {
|
|
configRepo: this.configRepository,
|
|
metadataRepo: this.systemMetadataRepository,
|
|
logger: this.logger,
|
|
};
|
|
}
|
|
|
|
getConfig(options: { withCache: boolean }) {
|
|
return getConfig(this.configRepos, options);
|
|
}
|
|
|
|
updateConfig(newConfig: SystemConfig) {
|
|
return updateConfig(this.configRepos, newConfig);
|
|
}
|
|
|
|
requireAccess(request: AccessRequest) {
|
|
return requireAccess(this.accessRepository, request);
|
|
}
|
|
|
|
checkAccess(request: AccessRequest) {
|
|
return checkAccess(this.accessRepository, request);
|
|
}
|
|
|
|
async createUser(dto: Insertable<UserTable> & { email: string }): Promise<UserAdmin> {
|
|
const exists = await this.userRepository.getByEmail(dto.email);
|
|
if (exists) {
|
|
throw new BadRequestException('User exists');
|
|
}
|
|
|
|
if (!dto.isAdmin) {
|
|
const localAdmin = await this.userRepository.getAdmin();
|
|
if (!localAdmin) {
|
|
throw new BadRequestException('The first registered account must the administrator.');
|
|
}
|
|
}
|
|
|
|
const payload: Insertable<UserTable> = { ...dto };
|
|
if (payload.password) {
|
|
payload.password = await this.cryptoRepository.hashBcrypt(payload.password, SALT_ROUNDS);
|
|
}
|
|
if (payload.storageLabel) {
|
|
payload.storageLabel = sanitize(payload.storageLabel.replaceAll('.', ''));
|
|
}
|
|
|
|
const user = await this.userRepository.create(payload);
|
|
|
|
await this.eventRepository.emit('UserCreate', user);
|
|
|
|
return user;
|
|
}
|
|
}
|