Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.
TypeScript cloud-alternativecollaborationcollaborative-editingdropboxfile-serverfile-sharingfile-storagefile-syncfull-text-searchhomelabnextcloudon-premiseopen-sourceprivacy-firstprivate-cloudrealtimesecureself-hostedstorage-serverwebdav
refactor(backend:users): getAvatarBase64 function
johaven9e4059c4a2bf
diff --git a/backend/src/applications/files/services/files-only-office-manager.service.ts b/backend/src/applications/files/services/files-only-office-manager.service.tsindex e4fe320a..9c81db75 100644--- a/backend/src/applications/files/services/files-only-office-manager.service.ts+++ b/backend/src/applications/files/services/files-only-office-manager.service.ts@@ -24,7 +24,7 @@ import { FastifySpaceRequest } from '../../spaces/interfaces/space-request.interimport type { SpaceEnv } from '../../spaces/models/space-env.model'import { haveSpaceEnvPermissions } from '../../spaces/utils/permissions'import type { UserModel } from '../../users/models/user.model'-import { UsersManager } from '../../users/services/users-manager.service'+import { getAvatarBase64 } from '../../users/utils/avatar'import { DEPTH, LOCK_SCOPE } from '../../webdav/constants/webdav'import { CACHE_ONLY_OFFICE } from '../constants/cache'import {@@ -55,7 +55,6 @@ export class FilesOnlyOfficeManager {private readonly contextManager: ContextManager,private readonly cache: Cache,private readonly jwt: JwtService,- private readonly usersManager: UsersManager,private readonly filesLockManager: FilesLockManager,private readonly filesQueries: FilesQueries) {}@@ -180,7 +179,7 @@ export class FilesOnlyOfficeManager {lang: 'en',region: 'en',callbackUrl: callBackUrl,- user: { id: user.id.toString(), name: `${user.fullName} (${user.email})`, image: await this.usersManager.getAvatarBase64(user.login) },+ user: { id: user.id.toString(), name: `${user.fullName} (${user.email})`, image: await getAvatarBase64(user.login) },coEditing: {mode: 'fast',change: truediff --git a/backend/src/applications/links/services/links-manager.service.spec.ts b/backend/src/applications/links/services/links-manager.service.spec.tsindex 538312ac..57deea29 100644--- a/backend/src/applications/links/services/links-manager.service.spec.ts+++ b/backend/src/applications/links/services/links-manager.service.spec.ts@@ -54,7 +54,6 @@ describe(LinksManager.name, () => {} as anyusersManagerMock = {- getAvatarBase64: jest.fn(),compareUserPassword: jest.fn(),updateAccesses: jest.fn()} as any@@ -128,14 +127,12 @@ describe(LinksManager.name, () => {space: null} as anylinksQueriesMock.spaceLink.mockResolvedValueOnce(spaceLink)- usersManagerMock.getAvatarBase64.mockResolvedValueOnce('base64-avatar')const res = await service.linkValidation(identity, link.uuid)expect(res.ok).toBe(true)expect(res.error).toBeNull()expect(res.link).toBe(spaceLink)- expect(spaceLink.owner.avatar).toBe('base64-avatar')expect((spaceLink.owner as any).login).toBeUndefined()expect(linksQueriesMock.spaceLink).toHaveBeenCalledWith(link.uuid)diff --git a/backend/src/applications/links/services/links-manager.service.ts b/backend/src/applications/links/services/links-manager.service.tsindex 16a0c8a4..120f1723 100644--- a/backend/src/applications/links/services/links-manager.service.ts+++ b/backend/src/applications/links/services/links-manager.service.ts@@ -17,6 +17,7 @@ import { SpacesManager } from '../../spaces/services/spaces-manager.service'import { UserPasswordDto } from '../../users/dto/user-properties.dto'import { UserModel } from '../../users/models/user.model'import { UsersManager } from '../../users/services/users-manager.service'+import { getAvatarBase64 } from '../../users/utils/avatar'import { LINK_ERROR } from '../constants/links'import { LinkAsUser } from '../interfaces/link-guest.interface'import { SpaceLink } from '../interfaces/link-space.interface'@@ -41,7 +42,7 @@ export class LinksManager {}const spaceLink: SpaceLink = ok ? await this.linksQueries.spaceLink(uuid) : nullif (spaceLink?.owner?.login) {- spaceLink.owner.avatar = await this.usersManager.getAvatarBase64(spaceLink.owner.login)+ spaceLink.owner.avatar = await getAvatarBase64(spaceLink.owner.login)// for security reasonsdelete spaceLink.owner.login}diff --git a/backend/src/applications/notifications/services/notifications-manager.service.ts b/backend/src/applications/notifications/services/notifications-manager.service.tsindex fb36dc30..9948b8a5 100644--- a/backend/src/applications/notifications/services/notifications-manager.service.ts+++ b/backend/src/applications/notifications/services/notifications-manager.service.ts@@ -9,12 +9,12 @@ import { MailProps } from '../../../infrastructure/mailer/interfaces/mail.interfimport { Mailer } from '../../../infrastructure/mailer/mailer.service'import { USER_NOTIFICATION } from '../../users/constants/user'import { UserModel } from '../../users/models/user.model'-import { UsersManager } from '../../users/services/users-manager.service'+import { getAvatarBase64 } from '../../users/utils/avatar'import { NOTIFICATION_APP } from '../constants/notifications'import { NOTIFICATIONS_WS } from '../constants/websocket'import type { NotificationContent, NotificationFromUser, NotificationOptions } from '../interfaces/notification-properties.interface'import type { UserMailNotification } from '../interfaces/user-mail-notification'-import { auth2FaMail, commentMail, linkMail, shareMail, spaceMail, spaceRootMail, syncMail } from '../mails/models'+import { auth2FaMail, authLocked, commentMail, linkMail, shareMail, spaceMail, spaceRootMail, syncMail } from '../mails/models'import { WebSocketNotifications } from '../notifications.gateway'import { NotificationsQueries } from './notifications-queries.service'@@ -23,7 +23,6 @@ export class NotificationsManager {private readonly logger = new Logger(NotificationsManager.name)constructor(- private readonly usersManager: UsersManager,private readonly mailer: Mailer,private readonly notificationsQueries: NotificationsQueries,private readonly webSocketNotifications: WebSocketNotifications@@ -62,21 +61,12 @@ export class NotificationsManager {return this.notificationsQueries.delete(user.id, notificationId)}- private async storeNotification(toUserIds: number[], content: NotificationContent, authorId?: number): Promise<void> {- // store it in db- try {- await this.notificationsQueries.create(authorId || null, toUserIds, content)- } catch (e) {- this.logger.error(`${this.create.name} - ${e}`)- }- }-async sendEmailNotification(toUsers: UserMailNotification[], content: NotificationContent, options?: NotificationOptions): Promise<void> {if (!this.mailer.available) {return}if (options?.author) {- options.author.avatarBase64 = await this.usersManager.getAvatarBase64(options.author.login)+ options.author.avatarBase64 = await getAvatarBase64(options.author.login)}this.mailer.sendMails(@@ -94,6 +84,15 @@ export class NotificationsManager {.catch((e: Error) => this.logger.error(`${this.sendEmailNotification.name} - ${e}`))}+ private async storeNotification(toUserIds: number[], content: NotificationContent, authorId?: number): Promise<void> {+ // store it in db+ try {+ await this.notificationsQueries.create(authorId || null, toUserIds, content)+ } catch (e) {+ this.logger.error(`${this.create.name} - ${e}`)+ }+ }+private genMail(language: string, content: NotificationContent, options?: NotificationOptions): [string, string] {switch (content.app) {case NOTIFICATION_APP.COMMENTS:diff --git a/backend/src/applications/users/services/users-manager.service.spec.ts b/backend/src/applications/users/services/users-manager.service.spec.tsindex 386df94d..37751205 100755--- a/backend/src/applications/users/services/users-manager.service.spec.ts+++ b/backend/src/applications/users/services/users-manager.service.spec.ts@@ -36,8 +36,7 @@ jest.mock('../../../common/image', () => {const actual = jest.requireActual('../../../common/image')return {...actual,- generateAvatar: jest.fn(() => Readable.from([Buffer.from('PNGDATA')])),- convertImageToBase64: jest.fn(() => Promise.resolve('BASE64_IMAGE'))+ generateAvatar: jest.fn(() => Readable.from([Buffer.from('PNGDATA')]))}})@@ -273,12 +272,6 @@ describe(UsersManager.name, () => {await expect(usersManager.getAvatar(userTest.login, true)).rejects.toThrow('Unable to create avatar')usersManager.findUser = jest.fn().mockResolvedValue(null)await expect(usersManager.getAvatar(userTest.login, true)).rejects.toThrow('avatar not found')- const s1 = await usersManager.getAvatarBase64(userTest.login)- expect(s1).toBe('BASE64_IMAGE')- ;(imageModule.convertImageToBase64 as jest.Mock).mockClear()- const s2 = await usersManager.getAvatarBase64('non-existent-login')- expect(s2).toBe('BASE64_IMAGE')- expect(imageModule.convertImageToBase64).toHaveBeenCalledWith(expect.stringMatching(/avatar\.svg$/))})it('updateAvatar branches: mime error, stream error, truncated, move fail, success', async () => {diff --git a/backend/src/applications/users/services/users-manager.service.ts b/backend/src/applications/users/services/users-manager.service.tsindex aa7a04b1..19e59648 100755--- a/backend/src/applications/users/services/users-manager.service.ts+++ b/backend/src/applications/users/services/users-manager.service.ts@@ -16,8 +16,7 @@ import { LoginResponseDto } from '../../../authentication/dto/login-response.dtoimport { FastifyAuthenticatedRequest } from '../../../authentication/interfaces/auth-request.interface'import { JwtIdentityPayload } from '../../../authentication/interfaces/jwt-payload.interface'import { comparePassword } from '../../../common/functions'-import { convertImageToBase64, generateAvatar, pngMimeType, svgMimeType } from '../../../common/image'-import { STATIC_ASSETS_PATH } from '../../../configuration/config.constants'+import { generateAvatar, pngMimeType, svgMimeType } from '../../../common/image'import { configuration, serverConfig } from '../../../configuration/config.environment'import { isPathExists, moveFiles } from '../../files/utils/files'import { MEMBER_TYPE } from '../constants/member'@@ -36,14 +35,12 @@ import { UserModel } from '../models/user.model'import type { Group } from '../schemas/group.interface'import type { UserGroup } from '../schemas/user-group.interface'import type { User } from '../schemas/user.interface'+import { USER_AVATAR_FILE_NAME, USER_AVATAR_MAX_UPLOAD_SIZE, USER_DEFAULT_AVATAR_FILE_PATH } from '../utils/avatar'import { AdminUsersManager } from './admin-users-manager.service'import { UsersQueries } from './users-queries.service'@Injectable()export class UsersManager {- private readonly defaultAvatarFilePath = path.join(STATIC_ASSETS_PATH, 'avatar.svg')- private readonly userAvatarFileName = 'avatar.png'- private readonly maxAvatarUploadSize = 1024 * 1024 * 5private readonly logger = new Logger(UsersManager.name)constructor(@@ -77,12 +74,12 @@ export class UsersManager {validateUserAccess(user: UserModel, ip: string) {if (user.role === USER_ROLE.LINK) {- this.logger.error(`${this.logUser.name} - guest link account ${user} is not authorized to login`)+ this.logger.error(`${this.validateUserAccess.name} - guest link account ${user} is not authorized to login`)throw new HttpException('Account is not allowed', HttpStatus.FORBIDDEN)}if (!user.isActive || user.passwordAttempts >= USER_MAX_PASSWORD_ATTEMPTS) {- this.updateAccesses(user, ip, false).catch((e: Error) => this.logger.error(`${this.logUser.name} - ${e}`))- this.logger.error(`${this.logUser.name} - user account *${user.login}* is locked`)+ this.updateAccesses(user, ip, false).catch((e: Error) => this.logger.error(`${this.validateUserAccess.name} - ${e}`))+ this.logger.error(`${this.validateUserAccess.name} - user account *${user.login}* is locked`)throw new HttpException('Account locked', HttpStatus.FORBIDDEN)}}@@ -130,11 +127,11 @@ export class UsersManager {}async updateAvatar(req: FastifyAuthenticatedRequest) {- const part: MultipartFile = await req.file({ limits: { fileSize: this.maxAvatarUploadSize } })+ const part: MultipartFile = await req.file({ limits: { fileSize: USER_AVATAR_MAX_UPLOAD_SIZE } })if (!part.mimetype.startsWith('image/')) {throw new HttpException('Unsupported file type', HttpStatus.BAD_REQUEST)}- const dstPath = path.join(req.user.tmpPath, this.userAvatarFileName)+ const dstPath = path.join(req.user.tmpPath, USER_AVATAR_FILE_NAME)try {await pipeline(part.file, createWriteStream(dstPath))} catch (e) {@@ -146,7 +143,7 @@ export class UsersManager {throw new HttpException('Image is too large (5MB max)', HttpStatus.PAYLOAD_TOO_LARGE)}try {- await moveFiles(dstPath, path.join(req.user.homePath, this.userAvatarFileName), true)+ await moveFiles(dstPath, path.join(req.user.homePath, USER_AVATAR_FILE_NAME), true)} catch (e) {this.logger.error(`${this.updateAvatar.name} - ${e}`)throw new HttpException('Unable to create avatar', HttpStatus.INTERNAL_SERVER_ERROR)@@ -182,13 +179,13 @@ export class UsersManager {async getAvatar(userLogin: string, generate: true, generateIsNotExists?: boolean): Promise<undefined>async getAvatar(userLogin: string, generate?: false, generateIsNotExists?: boolean): Promise<[path: string, mime: string]>async getAvatar(userLogin: string, generate: boolean = false, generateIsNotExists?: boolean): Promise<[path: string, mime: string]> {- const avatarPath = path.join(UserModel.getHomePath(userLogin), this.userAvatarFileName)+ const avatarPath = path.join(UserModel.getHomePath(userLogin), USER_AVATAR_FILE_NAME)const avatarExists = await isPathExists(avatarPath)if (!avatarExists && generateIsNotExists) {generate = true}if (!generate) {- return [avatarExists ? avatarPath : this.defaultAvatarFilePath, avatarExists ? pngMimeType : svgMimeType]+ return [avatarExists ? avatarPath : USER_DEFAULT_AVATAR_FILE_PATH, avatarExists ? pngMimeType : svgMimeType]}if (!(await isPathExists(UserModel.getHomePath(userLogin)))) {throw new HttpException(`Home path for user *${userLogin}* does not exist`, HttpStatus.FORBIDDEN)@@ -210,11 +207,6 @@ export class UsersManager {}}- async getAvatarBase64(userLogin: string): Promise<string> {- const userAvatarPath = path.join(UserModel.getHomePath(userLogin), this.userAvatarFileName)- return convertImageToBase64((await isPathExists(userAvatarPath)) ? userAvatarPath : this.defaultAvatarFilePath)- }-setOnlineStatus(user: JwtIdentityPayload, onlineStatus: USER_ONLINE_STATUS) {this.usersQueries.setOnlineStatus(user.id, onlineStatus).catch((e: Error) => this.logger.error(`${this.setOnlineStatus.name} - ${e}`))}diff --git a/backend/src/applications/users/utils/avatar.ts b/backend/src/applications/users/utils/avatar.tsnew file mode 100644index 00000000..de5ee802--- /dev/null+++ b/backend/src/applications/users/utils/avatar.ts@@ -0,0 +1,20 @@+/*+ * Copyright (C) 2012-2025 Johan Legrand <[email protected]>+ * This file is part of Sync-in | The open source file sync and share solution+ * See the LICENSE file for licensing details+ */++import path from 'node:path'+import { convertImageToBase64 } from '../../../common/image'+import { STATIC_ASSETS_PATH } from '../../../configuration/config.constants'+import { isPathExists } from '../../files/utils/files'+import { UserModel } from '../models/user.model'++export const USER_DEFAULT_AVATAR_FILE_PATH = path.join(STATIC_ASSETS_PATH, 'avatar.svg')+export const USER_AVATAR_FILE_NAME = 'avatar.png'+export const USER_AVATAR_MAX_UPLOAD_SIZE = 1024 * 1024 * 5 // 5MB++export async function getAvatarBase64(userLogin: string): Promise<string> {+ const userAvatarPath = path.join(UserModel.getHomePath(userLogin), USER_AVATAR_FILE_NAME)+ return convertImageToBase64((await isPathExists(userAvatarPath)) ? userAvatarPath : USER_DEFAULT_AVATAR_FILE_PATH)+}